Manually merge PR128 to add unit testing of the cat functionality backend. Made a number of smaller adjustments in line with comments on github. Spliced the new _temppath function back into the existing temppath function with a new skip_output_anchor=False argument instead. Changed the semi-private _ensuredirs to a public ensure_dirs_exist function for general use. It overlaps with shared.fileio.makedirs_rec but it's probably better to keep tests independent of code there. Renamed and eliminated a few leftover WSGI and CGI references. Unwrapped a one-liner conditional and changed default prefix to empty string to eliminate None vs empty consideration. Added missing docstrings. Wrapped some long lines and fixed a comment typo.

git-svn-id: svn+ssh://svn.code.sf.net/p/migrid/code/trunk@6148 b75ad72c-e7d7-11dd-a971-7dbc132099af

Author: jonasbardino

mig/shared/accountstate.py

@@ -31,6 +31,7 @@
 
 from __future__ import print_function
 from __future__ import absolute_import
+from past.builtins import basestring
 
 import os
 import time

mig/shared/functionality/cat.py

@@ -54,13 +54,25 @@ def signature():
 
 
 def main(client_id, user_arguments_dict, environ=None):
-    """Main function used by front end"""
+    """Main function wrapper used by front end"""
 
     if environ is None:
         environ = os.environ
 
     (configuration, logger, output_objects, op_name) = \
         initialize_main_variables(client_id)
+
+    return _main(configuration, logger, op_name=op_name,
+                 output_objects=output_objects, client_id=client_id,
+                 user_arguments_dict=user_arguments_dict)
+
+
+def _main(configuration, logger, op_name='', output_objects=[], client_id=None,
+          user_arguments_dict=None, environ=None):
+    """Actual main function to generate contents for the front end"""
+    if logger is None:
+        logger = configuration.logger
+
     client_dir = client_id_dir(client_id)
     defaults = signature()[1]
     status = returnvalues.OK
@@ -71,6 +83,7 @@ def main(client_id, user_arguments_dict, environ=None):
         client_id,
         configuration,
         allow_rejects=False,
+        environ=environ,
         # NOTE: path can use wildcards, dst cannot
         typecheck_overrides={'path': valid_path_pattern},
     )

tests/fixture/MiG-users.db--example.binary

@@ -0,0 +1,187 @@
+(dp0
+V/C=DK/ST=NA/L=NA/O=Test Org/OU=NA/CN=b'Test User'/emailAddress=dummy-user
+p1
+(dp2
+Vfull_name
+p3
+Vb'Test User'
+p4
+sVorganization
+p5
+VTest Org
+p6
+sVstate
+p7
+VNA
+p8
+sVcountry
+p9
+VDK
+p10
+sVemail
+p11
+Vdummy-user
+p12
+sVcomment
+p13
+VThis is the create comment
+p14
+sVpassword
+p15
+V
+p16
+sVpassword_hash
+p17
+VPBKDF2$sha256$10000$b't0JM/JjkQ347th0Q'$b'QupJt53hA5KhESEeqDhTQTCPOrCBvZ6H'
+p18
+sVdistinguished_name
+p19
+V/C=DK/ST=NA/L=NA/O=Test Org/OU=NA/CN=b'Test User'/emailAddress=dummy-user
+p20
+sVlocality
+p21
+g16
+sVorganizational_unit
+p22
+g16
+sVexpire
+p23
+I1757925298
+sVcreated
+p24
+F1726233828.2676349
+sVunique_id
+p25
+VktyCKIRg9HvsVzXMQ22EaKS67t9atchv9JKTiJqrtBiGN3qksKrbTTYIH8mitY2K
+p26
+sVopenid_names
+p27
+(lp28
+sVold_password_hash
+p29
+VPBKDF2$sha256$10000$b'GL7Qq92iLe/hZXBo'$b'ZwB/5IZqgU7onP+ZqZk9zcHVZOx7jmWz'
+p30
+sVrenewed
+p31
+F1726389298.7801197
+ssV/C=DK/ST=NA/L=NA/O=Test Org/OU=NA/CN=Test User/emailAddress=dummy-user
+p32
+(dp33
+Vfull_name
+p34
+VTest User
+p35
+sVorganization
+p36
+VTest Org
+p37
+sVstate
+p38
+VNA
+p39
+sVcountry
+p40
+VDK
+p41
+sVemail
+p42
+Vdummy-user
+p43
+sVcomment
+p44
+VThis is the create comment
+p45
+sVpassword
+p46
+g16
+sVpassword_hash
+p47
+VPBKDF2$sha256$10000$b'kZ8WgLNH+wg3X11d'$b't1d08MV4g215WYW7S7EbkjHqDF+MCjMa'
+p48
+sVdistinguished_name
+p49
+V/C=DK/ST=NA/L=NA/O=Test Org/OU=NA/CN=Test User/emailAddress=dummy-user
+p50
+sVlocality
+p51
+g16
+sVorganizational_unit
+p52
+g16
+sVexpire
+p53
+I1759243332
+sVcreated
+p54
+F1726602273.7987707
+sVunique_id
+p55
+VKdYHJ21t37jAoHUmBq6t8Xnsnih6JWR5i0QepHoVXfDpQxz9fQGnEmegoDNrPzbe
+p56
+sVopenid_names
+p57
+(lp58
+sVold_password_hash
+p59
+VPBKDF2$sha256$10000$b'yObizsUepZvvJ0/r'$b'uKIt7n6Lf/7WXD6pKDGyvT30L2uowBnV'
+p60
+sVrenewed
+p61
+F1727707333.0969944
+ssV/C=DK/ST=NA/L=NA/O=Test Org/OU=NA/CN=Test User/emailAddress=test@example.com
+p62
+(dp63
+Vfull_name
+p64
+VTest User
+p65
+sVorganization
+p66
+VTest Org
+p67
+sVstate
+p68
+VNA
+p69
+sVcountry
+p70
+VDK
+p71
+sVemail
+p72
+Vtest@example.com
+p73
+sVcomment
+p74
+VThis is the create comment
+p75
+sVpassword
+p76
+g16
+sVpassword_hash
+p77
+VPBKDF2$sha256$10000$b'/TkhLk4yMGf6XhaY'$b'7HUeQ9iwCkE4YMQAaCd+ZdrN+y8EzkJH'
+p78
+sVdistinguished_name
+p79
+g62
+sVlocality
+p80
+g16
+sVorganizational_unit
+p81
+g16
+sVexpire
+p82
+I1758970812
+sVcreated
+p83
+F1727434813.0792377
+sVunique_id
+p84
+VaTza92klrnN2wfylm6HnphCy9C3PReGpQ6jklJ7zF3xjeaUDw36tW95Avx43vtba
+p85
+sVopenid_names
+p86
+(lp87
+ss.

tests/support/__init__.py

@@ -276,7 +276,17 @@ def is_path_within(path, start=None, _msg=None):
     return not relative.startswith('..')
 
 
-def fixturefile(relative_path, fixture_format=None):
+def ensure_dirs_exist(absolute_dir):
+    """A simple helper to create absolute_dir and any parents if missing"""
+    try:
+        os.makedirs(absolute_dir)
+    except OSError as oserr:
+        if oserr.errno != errno.EEXIST:
+            raise
+    return absolute_dir
+
+
+def fixturefile(relative_path, fixture_format=None, include_path=False):
     """Support function for loading fixtures from their serialised format.
 
     Doing so is a little more involved than it may seem because serialisation
@@ -296,12 +306,27 @@ def fixturefile(relative_path, fixture_format=None):
     #_, extension = os.path.splitext(os.path.basename(tmp_path))
     #assert fixture_format == extension, "fixture file does not match format"
 
-    if fixture_format == 'json':
-        return _fixturefile_json(tmp_path)
+    data = None
+
+    if fixture_format == 'binary':
+        with open(tmp_path, 'rb') as binfile:
+            data = binfile.read()
+    elif fixture_format == 'json':
+        data = _fixturefile_json(tmp_path)
     else:
         raise AssertionError(
             "unsupported fixture format: %s" % (fixture_format,))
 
+    return (data, tmp_path) if include_path else data
+
+
+def fixturefile_normname(relative_path, prefix=''):
+    """Grab normname from relative_path and optionally add a path prefix"""
+    normname, _ = relative_path.split('--')
+    if prefix:
+        return os.path.join(prefix, normname)
+    return normname
+
 
 _FIXTUREFILE_HINTAPPLIERS = {
     'array_of_tuples': lambda value: [tuple(x) for x in value]
@@ -311,7 +336,7 @@ def fixturefile(relative_path, fixture_format=None):
 def _fixturefile_json(json_path):
     hints = ConfigParser()
 
-    # leti's see if there are loading hints
+    # let's see if there are loading hints
     try:
         hints_path = "%s.ini" % (json_path,)
         with open(hints_path) as hints_file:
@@ -336,16 +361,25 @@ def fixturepath(relative_path):
     return tmp_path
 
 
-def temppath(relative_path, test_case, ensure_dir=False, skip_clean=False):
-    """Get absolute temp path for relative_path"""
+def temppath(relative_path, test_case, ensure_dir=False, skip_clean=False,
+             skip_output_anchor=False):
+    """Register relative_path as a temp path and schedule automatic clean up
+    after unit tests unless skip_clean is set. Anchors the temp path in
+    internal test output dir unless skip_output_anchor is set. Returns
+    resulting temp path.
+    """
     assert isinstance(test_case, MigTestCase)
-    tmp_path = os.path.join(TEST_OUTPUT_DIR, relative_path)
+    if not skip_output_anchor:
+        tmp_path = os.path.join(TEST_OUTPUT_DIR, relative_path)
+    else:
+        tmp_path = relative_path
     if ensure_dir:
         try:
             os.mkdir(tmp_path)
-        except FileExistsError:
-            raise AssertionError(
-                "ABORT: use of unclean output path: %s" % relative_path)
+        except OSError as oserr:
+            if oserr.errno == errno.EEXIST:
+                raise AssertionError(
+                    "ABORT: use of unclean output path: %s" % tmp_path)
     if not skip_clean:
         test_case._cleanup_paths.add(tmp_path)
     return tmp_path