Silence noise when running the test suite. (#505)

* Silence noise when running the test suite.

When the testcore boilerplate was copied for other legacy tests the main
methods were not made to fit to the same extent, particularly around the
print override. Meanwhile, we now use only PY3 which allows shadowing the
print function. So, use this to avoid filling the console with arbitrary
messages while the tests are run.

While here make things consistent - always pass in a test configuration,
use the passed in value and try to consistently use legacy main naming.

* Minor: added missing class docstrings on a couple of legacy self test classes.

---------

Signed-off-by: Jonas Bardino <bardino@science.ku.dk>
Co-authored-by: Jonas Bardino <bardino@science.ku.dk>

Author: albu-diku

mig/lib/events.py

@@ -557,11 +557,9 @@ def run_events_command(
     #                                               ret_msg, txt_out))
 
 
-def main(_exit=sys.exit, _print=print):
+def legacy_main(conf, print=print, _exit=sys.exit):
     """Run module self-tests"""
-    from mig.shared.conf import get_configuration_object
 
-    conf = get_configuration_object()
     client_id = "/C=DK/ST=NA/L=NA/O=NBI/OU=NA/CN=Jonas Bardino/emailAddress=bardino@nbi.ku.dk"
     now = datetime.datetime.now()
     now = now.replace(second=0, microsecond=0)
@@ -621,6 +619,10 @@ def main(_exit=sys.exit, _print=print):
                 "At %s job is %dm in the future for rule" % (timestamp, remain)
             )
 
+    _exit(0)
+
 
 if __name__ == "__main__":
-    main()
+    from mig.shared.conf import get_configuration_object
+    conf = get_configuration_object(skip_log=True, disable_auth_log=True)
+    legacy_main(conf)

mig/shared/base.py

@@ -951,7 +951,7 @@ def auth_type_description(configuration, auth_type=keyword_all):
         return auth_map.get(auth_type, 'UNKNOWN')
 
 
-def legacy_main(_exit=sys.exit, _print=print):
+def legacy_main(configuration, print=print, _exit=sys.exit):
     """Run module self-tests"""
     orig_id = '/C=DK/ST=NA/L=NA/O=Ajax Inc/OU=NA/CN=John Doe/emailAddress=john.doe@ajaxinc.org'
     client_dir = client_id_dir(orig_id)
@@ -986,9 +986,6 @@ def legacy_main(_exit=sys.exit, _print=print):
     for path in legal:
         print("  %s: %s" % (path, not invisible_path(path)))
 
-    from mig.shared.conf import get_configuration_object
-    configuration = get_configuration_object(
-        skip_log=True, disable_auth_log=True)
     print("check script restrictions:")
     for script_name in ['reqoid.py', 'ls.py', 'sharelink.py', 'put']:
         (allow, msg) = allow_script(configuration, script_name, '')
@@ -1035,6 +1032,10 @@ def legacy_main(_exit=sys.exit, _print=print):
         print("Found unsafe page for %r : %s" %
               (script_uri, requested_page(include_unsafe=True)))
 
+    _exit(0)
+
 
 if __name__ == '__main__':
-    legacy_main()
+    from mig.shared.conf import get_configuration_object
+    conf = get_configuration_object(skip_log=True, disable_auth_log=True)
+    legacy_main(conf)

mig/shared/pwcrypto.py

@@ -1028,10 +1028,8 @@ def generate_random_password(configuration, tries=42):
     raise ValueError("Failed to generate suitable password!")
 
 
-def main(_exit=sys.exit, _print=print):
+def legacy_main(configuration, print=print, _exit=sys.exit):
     """Run module self-tests"""
-    from mig.shared.conf import get_configuration_object
-    configuration = get_configuration_object()
     dummy_user = {'distinguished_name': 'Test User', 'password_hash': ''}
     pw_tests = (
         '', 'abc', 'dbey3h', 'abcdefgh', '12345678', 'test1234',
@@ -1117,6 +1115,10 @@ def main(_exit=sys.exit, _print=print):
             print(
                 "Failed to handle aesgcm static encrypt/decrypt %s : %s" % (pw, exc))
 
+    _exit(0)
+
 
 if __name__ == "__main__":
-    main()
+    from mig.shared.conf import get_configuration_object
+    conf = get_configuration_object(skip_log=True, disable_auth_log=True)
+    legacy_main(conf)

mig/shared/userio.py

@@ -575,20 +575,18 @@ def __clean_test_files(configuration, test_path):
                                                            exc))
 
 
-def legacy_main(_exit=sys.exit, _print=print):
+def legacy_main(configuration, print=print, _exit=sys.exit, _argv=sys.argv):
     """Run module self-tests"""
     from mig.shared.base import client_id_dir
-    from mig.shared.conf import get_configuration_object
     from mig.shared.defaults import htaccess_filename
     print("Unit testing user I/O")
     client_id = "/C=DK/ST=NA/L=NA/O=NBI/OU=NA/CN=Jonas Bardino/emailAddress=bardino@nbi.ku.dk"
     sub_dir = '.'
-    if sys.argv[1:]:
-        client_id = sys.argv[1]
-    if sys.argv[2:]:
-        sub_dir = sys.argv[2]
+    if _argv[1:]:
+        client_id = _argv[1]
+    if _argv[2:]:
+        sub_dir = _argv[2]
     client_dir = client_id_dir(client_id)
-    configuration = get_configuration_object()
     configuration.mig_server_id = "localhost"
     tmp_dir = os.path.join("userio-testdir", sub_dir)
     real_tmp = os.path.normpath(os.path.join(configuration.user_home,
@@ -680,6 +678,10 @@ def legacy_main(_exit=sys.exit, _print=print):
         events_path = os.path.join(configuration.events_home, name)
         print("%s : %db" % (name, os.stat(events_path).st_size))
 
+    _exit(0)
+
 
 if __name__ == "__main__":
-    legacy_main()
+    from mig.shared.conf import get_configuration_object
+    conf = get_configuration_object(skip_log=True, disable_auth_log=True)
+    legacy_main(conf)

mig/shared/vgrid.py

@@ -2321,9 +2321,7 @@ def vgrid_rm_entry(configuration, vgrid):
     return (success, msg)
 
 
-def legacy_main(_exit=sys.exit, _print=print):
-    from mig.shared.conf import get_configuration_object
-    conf = get_configuration_object(skip_log=True, disable_auth_log=True)
+def legacy_main(conf, print=print, _exit=sys.exit):
     client_id = '/C=DK/CN=John Doe/emailAddress=john@doe.org'
     if sys.argv[1:]:
         client_id = sys.argv[1]
@@ -2445,6 +2443,10 @@ def legacy_main(_exit=sys.exit, _print=print):
         print(vgrid_set_members(conf, dummy_vgrid, orig_members))
     print(vgrid_members(dummy_vgrid, conf))
 
+    _exit(0)
+
 
 if __name__ == "__main__":
-    legacy_main()
+    from mig.shared.conf import get_configuration_object
+    conf = get_configuration_object(skip_log=True, disable_auth_log=True)
+    legacy_main(conf)

mig/unittest/testcore.py

@@ -36,48 +36,11 @@
 import time
 import logging
 
-sys.path.append(os.path.realpath(
-    os.path.join(os.path.dirname(__file__), "../..")))
-from tests.support import MIG_BASE, PY2, is_path_within
-
 from mig.shared.base import client_id_dir, client_dir_id, get_short_id, \
     invisible_path, allow_script, brief_list
 
 
-_TEST_CONF_FILE = os.environ['MIG_CONF']
-_TEST_CONF_DIR = os.path.dirname(_TEST_CONF_FILE)
-_TEST_CONF_SYMLINK = os.path.join(MIG_BASE, "envhelp/output/testconfs")
-
-
-def _assert_local_config():
-    try:
-        #link_stat = os.lstat(_TEST_CONF_SYMLINK)
-        #assert stat.S_ISLNK(link_stat.st_mode)
-        _test_conf_dir = os.path.dirname(_TEST_CONF_DIR)
-        configdir_stat = os.stat(_test_conf_dir)
-        assert stat.S_ISDIR(configdir_stat.st_mode)
-        config = ConfigParser()
-        config.read([_TEST_CONF_FILE])
-        return config
-    except Exception as exc:
-        raise AssertionError(
-            'local configuration invalid or missing: %s' % (str(exc),))
-
-
-def _assert_local_config_global_values(config):
-    config_global_values = dict(config.items('GLOBAL'))
-
-    for path in ('mig_path', 'certs_path', 'state_path'):
-        path_value = config_global_values.get(path)
-        if not is_path_within(path_value, start=MIG_BASE):
-            raise AssertionError('local config contains bad path: %s=%s' % (path, path_value))
-
-    return config_global_values
-
-
-def main(configuration, _exit=sys.exit):
-    config = _assert_local_config()
-    config_global_values = _assert_local_config_global_values(config)
+def legacy_main(configuration, print=print, _exit=sys.exit):
 
     print("Running unit test on shared core functions ..")
 
@@ -188,4 +151,5 @@ def main(configuration, _exit=sys.exit):
 
 if __name__ == "__main__":
     from mig.shared.conf import get_configuration_object
-    main(get_configuration_object())
+    conf = get_configuration_object(skip_log=True, disable_auth_log=True)
+    legacy_main(conf)

tests/test_mig_lib_events.py

@@ -34,10 +34,9 @@
 # Imports of the code under test
 from mig.lib.events import _restore_env, _save_env, at_remain, cron_match, \
     get_path_expand_map, get_time_expand_map, load_atjobs, load_crontab
-from mig.lib.events import main as events_main
 from mig.lib.events import parse_and_save_atjobs, parse_and_save_crontab, \
     parse_atjobs, parse_atjobs_contents, parse_crontab, \
-    parse_crontab_contents, run_cron_command, run_events_command
+    parse_crontab_contents, run_cron_command, run_events_command, legacy_main
 # Imports required for the unit tests themselves
 from tests.support import MigTestCase, ensure_dirs_exist
 
@@ -3395,15 +3394,14 @@ def raise_on_error_exit(exit_code):
                 else:
                     identifying_message = "unknown"
                 raise AssertionError(
-                    "failure in unittest/testcore: %s" % (identifying_message,)
-                )
+                    'legacy test failure: %s' % (identifying_message,))
 
         raise_on_error_exit.last_print = None
 
         def record_last_print(value):
             raise_on_error_exit.last_print = value
 
-        events_main(_exit=raise_on_error_exit, _print=record_last_print)
+        legacy_main(self.configuration, print=record_last_print, _exit=raise_on_error_exit)
 
 
 if __name__ == "__main__":

tests/test_mig_shared_base.py

@@ -1347,25 +1347,28 @@ def test_brief_list_edge_cases(self):
                          ['a', 'b', ' ... shortened ... ', 'f', 'g'])
 
 
-class TestMigSharedBase__legacy(MigTestCase):
+class TestMigSharedBase__legacy_main(MigTestCase):
     """Run mig.shared.base legacy self-test"""
 
+    def _provide_configuration(self):
+        return 'testconfig'
+
     # TODO: migrate all legacy self-check functionality into the above?
     def test_existing_main(self):
         """Run built-in self-tests and check output"""
+
         def raise_on_error_exit(exit_code):
             if exit_code != 0:
                 if raise_on_error_exit.last_print is not None:
                     identifying_message = raise_on_error_exit.last_print
                 else:
                     identifying_message = 'unknown'
                 raise AssertionError(
-                    'failure in unittest/testcore: %s' %
-                    (identifying_message,))
+                    'legacy test failure: %s' % (identifying_message,))
         raise_on_error_exit.last_print = None
 
         def record_last_print(value):
             """Keep track of printed output"""
             raise_on_error_exit.last_print = value
 
-        legacy_main(_exit=raise_on_error_exit, _print=record_last_print)
+        legacy_main(self.configuration, print=record_last_print, _exit=raise_on_error_exit)

tests/test_mig_shared_pwcrypto.py

@@ -37,7 +37,6 @@
 
 from mig.shared.defaults import POLICY_NONE, POLICY_WEAK, POLICY_MEDIUM, \
     POLICY_HIGH, POLICY_MODERN, POLICY_CUSTOM, PASSWORD_POLICIES
-from mig.shared.pwcrypto import main as pwcrypto_main
 from mig.shared.pwcrypto import *
 
 DUMMY_USER = "dummy-user"
@@ -708,6 +707,13 @@ def test_generate_random_password_fixed_seed(self):
         self.assertEqual(expected, result,
                          "failed generate password with fixed seed")
 
+
+class MigSharedPwCrypto__legacy_main(MigTestCase):
+    """Legacy tests for corresponding module self-checks"""
+
+    def _provide_configuration(self):
+        return 'testconfig'
+
     # TODO: migrate remaining inline checks from module here instead
     def test_existing_main(self):
         def raise_on_error_exit(exit_code):
@@ -717,13 +723,13 @@ def raise_on_error_exit(exit_code):
                 else:
                     identifying_message = 'unknown'
                 raise AssertionError(
-                    'failure in unittest/testcore: %s' % (identifying_message,))
+                    'legacy test failure: %s' % (identifying_message,))
         raise_on_error_exit.last_print = None
 
         def record_last_print(value):
             raise_on_error_exit.last_print = value
 
-        pwcrypto_main(_exit=raise_on_error_exit, _print=record_last_print)
+        legacy_main(self.configuration, print=record_last_print, _exit=raise_on_error_exit)
 
 
 if __name__ == '__main__':

tests/test_mig_shared_userio.py

@@ -66,7 +66,7 @@
 TEST_OWNER_DN = "/C=DK/ST=NA/L=NA/O=Test Org/OU=NA/CN=Test Owner/emailAddress=owner@example.org"
 
 
-class TestMigSharedUserIO_legacy_main(MigTestCase, UserAssertMixin):
+class TestMigSharedUserIO(MigTestCase, UserAssertMixin):
     """Unit tests for userio related helper functions"""
 
     def _provide_configuration(self):
@@ -520,29 +520,32 @@ def test_touch_path(self):
 
 
 class TestMigSharedUserIO__legacy_main(MigTestCase):
-    """Legacy tests for safeinput module self-checks"""
+    """Legacy tests for corresponding module self-checks"""
+
+    def _provide_configuration(self):
+        return 'testconfig'
 
     # TODO: migrate all legacy self-check functionality into the above?
     def test_existing_main(self):
         """Wrap old inline self-test as an additional unit test"""
 
+        self.logger.forgive_errors()
+
         def raise_on_error_exit(exit_code):
             if exit_code != 0:
                 if raise_on_error_exit.last_print is not None:
                     identifying_message = raise_on_error_exit.last_print
                 else:
                     identifying_message = "unknown"
                 raise AssertionError(
-                    "failure in unittest/testcore: %s" % (identifying_message,)
-                )
-
+                    'legacy test failure: %s' % (identifying_message,))
         raise_on_error_exit.last_print = None
 
         def record_last_print(value):
             """Helper to show last print on error"""
             raise_on_error_exit.last_print = value
 
-        legacy_main(_exit=raise_on_error_exit, _print=record_last_print)
+        legacy_main(self.configuration, print=record_last_print, _exit=raise_on_error_exit, _argv=[])
 
 
 if __name__ == "__main__":