Implement a test covering operation of the cat funcitonality file.

Make use of the seam that exists by virtue of the functionality files
return output objects which are intrepreted by a wrapper to unit test
the behaviour of cat.

Specifically, we can arrange for a suitable environment plus arguments
and then check the right output_objects are created. Allow doing this
by exposing a variant of the cat main method which returns them rather
than invoking the outer wrapper. Name this _main and call it from the
original main.

Note that this change is in effect a blueprint that can be used when
adding coverage for other functionaity files.

Author: albu-diku

mig/shared/functionality/cat.py

@@ -61,6 +61,13 @@ def main(client_id, user_arguments_dict, environ=None):
 
     (configuration, logger, output_objects, op_name) = \
         initialize_main_variables(client_id)
+
+    return _main(configuration, logger, client_id=client_id, output_objects=output_objects, user_arguments_dict=user_arguments_dict)
+
+def _main(configuration, logger, client_id=None, output_objects=[], user_arguments_dict=None, environ=None):
+    if logger is None:
+        logger = configuration.logger
+
     client_dir = client_id_dir(client_id)
     defaults = signature()[1]
     status = returnvalues.OK

tests/support/__init__.py

@@ -340,12 +340,16 @@ def temppath(relative_path, test_case, ensure_dir=False, skip_clean=False):
     """Get absolute temp path for relative_path"""
     assert isinstance(test_case, MigTestCase)
     tmp_path = os.path.join(TEST_OUTPUT_DIR, relative_path)
+    return _temppath(tmp_path, test_case, ensure_dir=ensure_dir, skip_clean=skip_clean)
+
+
+def _temppath(tmp_path, test_case, ensure_dir=False, skip_clean=False):
     if ensure_dir:
         try:
             os.mkdir(tmp_path)
         except FileExistsError:
             raise AssertionError(
-                "ABORT: use of unclean output path: %s" % relative_path)
+                "ABORT: use of unclean output path: %s" % tmp_path)
     if not skip_clean:
         test_case._cleanup_paths.add(tmp_path)
     return tmp_path

tests/test_mig_cgibin_cat.py

@@ -0,0 +1,50 @@
+from __future__ import print_function
+import importlib
+import os
+import sys
+
+from tests.support import MIG_BASE, MigTestCase, testmain, _temppath
+
+from mig.shared.base import client_id_dir
+from mig.shared.functionality.cat import _main as main
+
+
+def create_wsgi_environ(configuration, wsgi_variables={}):
+    environ = {}
+    environ['wsgi.input'] = ()
+    environ['MIG_CONF'] = configuration.config_file
+    environ['HTTP_HOST'] = wsgi_variables.get('http_host', 'localhost')
+    environ['PATH_INFO'] = wsgi_variables.get('path_info', '/')
+    environ['REMOTE_ADDR'] = wsgi_variables.get('remote_addr', '127.0.0.1')
+    environ['SCRIPT_URI'] = ''.join(('http://', environ['HTTP_HOST'], environ['PATH_INFO']))
+    return environ
+
+
+class MigCgibinCat(MigTestCase):
+    TEST_CLIENT_ID = '/C=DK/ST=NA/L=NA/O=Test Org/OU=NA/CN=Test User/emailAddress=test@example.com'
+
+    def _provide_configuration(self):
+        return 'testconfig'
+
+    def before_each(self):
+        user_home = self.configuration.user_home[:-1]
+        client_dir = client_id_dir(self.TEST_CLIENT_ID)
+        # create the test user home directory
+        self.test_user_dir = _temppath(os.path.join(user_home, client_dir), self, ensure_dir=True)
+        self.test_environ = create_wsgi_environ(self.configuration)
+
+    def test_returns_file_output_with_single_file_match(self):
+        with open(os.path.join(self.test_user_dir, 'foobar.txt'), 'w'):
+            pass
+        payload = {
+            'path': ['foobar.txt'],
+        }
+
+        (output_objects, status) = main(self.configuration, self.logger, self.TEST_CLIENT_ID, user_arguments_dict=payload, environ=self.test_environ)
+        self.assertEqual(len(output_objects), 1)
+        output_obj = output_objects[0]
+        self.assertEqual(output_obj['object_type'], 'file_output')
+
+
+if __name__ == '__main__':
+    testmain()