Initial Commit

The main realm setup codes lives in `k5test.realm`, while the unit
test helper and decorators live in `k5test.unit`.

Author: DirectXMan12

.gitignore

@@ -0,0 +1,13 @@
+*.egg-info
+*.egg
+*~
+*.pyc
+/build/
+*.swp
+*.swo
+*.so
+.tox
+dist
+**/__pycache__
+.eggs
+.venv

K5TEST-LICENSE.txt

@@ -0,0 +1,18 @@
+Export of this software from the United States of America may
+  require a specific license from the United States Government.
+  It is the responsibility of any person or organization contemplating
+  export to obtain such a license before exporting.
+
+WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
+distribute this software and its documentation for any purpose and
+without fee is hereby granted, provided that the above copyright
+notice appear in all copies and that both that copyright notice and
+this permission notice appear in supporting documentation, and that
+the name of M.I.T. not be used in advertising or publicity pertaining
+to distribution of the software without specific, written prior
+permission.  Furthermore if you modify this software you must label
+your software as modified software and not distribute it in such a
+fashion that it might be confused with the original M.I.T. software.
+M.I.T. makes no representations about the suitability of
+this software for any purpose.  It is provided "as is" without express
+or implied warranty.

LICENSE.txt

@@ -0,0 +1,7 @@
+NOTE: The file k5test/realm.py falls under the MIT License.  See the file K5TEST-LICENSE.txt for the full text.
+
+Copyright (c) 2015, The Python GSSAPI Team
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

MANIFEST.in

@@ -0,0 +1,2 @@
+include *.txt
+include *.md

README.md

@@ -0,0 +1,33 @@
+K5Test
+======
+
+*k5test* is a library for setting up self-contained Kerberos 5 environments,
+and running Python unit tests inside those environments.  It is based on
+the file of the same name found alongside the MIT Kerberos 5 unit tests.
+
+Using k5test to set up a Kerberos 5 deployment
+----------------------------------------------
+
+*k5test* can be used to set up a self-contained MIT Kerberos 5 environment.
+This is useful for testing applications without having to manipulate existing
+Kerberos realms, or having to set up a full Kerberos deployment by hand.
+
+To set up a realm, use the `k5test.K5Realm` class.  The constructor accepts
+several useful arguments for controlling which parts get set up; refer to the
+inline documentation for more information.
+
+Using k5test to run unit tests
+------------------------------
+
+Instead of having test cases inherit from `unittest.TestCase`, inherit from
+`k5test.KerberosTestCase`, which will automatically set up a Kerberos 5 environment,
+before the test case, and tear it down afterwards.
+
+Additionally, several decorators are defined.  the
+`k5test.gssapi_extension_test(extension_name, human_readable_name)` decorator
+(which requires `python-gssapi`) allows you to skip tests with installations that don't
+support a particular GSSAPI extension.  The the
+`k5test.krb_minversion_test(target_version, problem_name)` decorator allows you to skip tests
+when running a version of krb5 less that the required version.  The
+`k5test.krb_plugin_test(plugin_type, plugin_name)` decorator allows you to skip tests for
+installations that don't have a particular plugin installed.

k5test/__init__.py

@@ -0,0 +1,2 @@
+from k5test.realm import K5Realm  # noqa
+from k5test.unit import *  # noqa

k5test/_utils.py

@@ -0,0 +1,112 @@
+import os
+import sys
+import subprocess
+
+
+# general use
+def get_output(*args, **kwargs):
+    res = subprocess.check_output(*args, shell=True, **kwargs)
+    decoded = res.decode('utf-8')
+    return decoded.strip()
+
+
+# python-gssapi related
+def import_gssapi_extension(name):
+    """Import a GSSAPI extension module
+
+    This method imports a GSSAPI extension module based
+    on the name of the extension (not including the
+    'ext_' prefix).  If the extension is not available,
+    the method retuns None.
+
+    Args:
+        name (str): the name of the extension
+
+    Returns:
+        module: Either the extension module or None
+    """
+
+    try:
+        path = 'gssapi.raw.ext_{0}'.format(name)
+        __import__(path)
+        return sys.modules[path]
+    except ImportError:
+        return None
+
+
+# krb5-plugin related
+_PLUGIN_DIR = None
+
+
+def find_plugin_dir():
+    global _PLUGIN_DIR
+    if _PLUGIN_DIR is not None:
+        return _PLUGIN_DIR
+
+    # if we've set a LD_LIBRARY_PATH, use that first
+    ld_path_raw = os.environ.get('LD_LIBRARY_PATH')
+    if ld_path_raw is not None:
+        # first, try assuming it's just a normal install
+
+        ld_paths = [path for path in ld_path_raw.split(':') if path]
+
+        for ld_path in ld_paths:
+            if not os.path.exists(ld_path):
+                continue
+
+            _PLUGIN_DIR = _decide_plugin_dir(
+                _find_plugin_dirs_installed(ld_path))
+            if _PLUGIN_DIR is None:
+                _PLUGIN_DIR = _decide_plugin_dir(
+                    _find_plugin_dirs_src(ld_path))
+
+            if _PLUGIN_DIR is not None:
+                break
+
+    # if there was no LD_LIBRARY_PATH, or the above failed
+    if _PLUGIN_DIR is None:
+        # if we don't have a LD_LIBRARY_PATH, just search in
+        # $prefix/lib
+
+        lib_dir = os.path.join(get_output('krb5-config --prefix'), 'lib')
+        _PLUGIN_DIR = _decide_plugin_dir(_find_plugin_dirs_installed(lib_dir))
+
+    if _PLUGIN_DIR is not None:
+        _PLUGIN_DIR = os.path.normpath(_PLUGIN_DIR)
+        return _PLUGIN_DIR
+    else:
+        return None
+
+
+def _decide_plugin_dir(dirs):
+    if dirs is None:
+        return None
+
+    # the shortest path is probably more correct
+    shortest_first = sorted(dirs, key=len)
+
+    for path in shortest_first:
+        # check to see if it actually contains .so files
+        if get_output('find %s -name "*.so"' % path):
+            return path
+
+    return None
+
+
+def _find_plugin_dirs_installed(search_path):
+    options_raw = get_output('find %s/ -type d '
+                             '-path "*/krb5/plugins"' % search_path)
+
+    if options_raw:
+        return options_raw.split('\n')
+    else:
+        return None
+
+
+def _find_plugin_dirs_src(search_path):
+    options_raw = get_output('find %s/../ -type d -name plugins' % search_path)
+
+    if options_raw:
+        return options_raw.split('\n')
+    else:
+        return None