Add test built from JSON test data file

pombredanne · pombredanne · commit 97549385eeb3 · 2017-11-14T19:04:03.000+01:00
* test methods are create dynamically from the data
 * there is no dependencies on py.test

Signed-off-by: Philippe Ombredanne &lt;pombredanne@nexb.com&gt;
diff --git a/test_purl.py b/test_purl.py
@@ -0,0 +1,118 @@
+# Copyright (c) the purl authors
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# Visit https://github.com/package-url/purl-python for support and download.
+
+from __future__ import absolute_import
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import json
+import re
+import unittest
+
+from purl import PackageURL
+
+# Python 2 and 3 support
+try:
+    # Python 2
+    unicode
+    str = unicode
+    basestring = basestring
+except NameError:
+    # Python 3
+    unicode = str
+    basestring = (bytes, str,)
+
+
+def create_test_function(description, purl, canonical_purl, is_invalid,
+                         type, name, namespace, version, qualifiers, subpath,
+                         test_func_prefix='test_purl_', **kwargs):
+    """
+    Return a new (test function, test_name) where the test_function closed on
+    test arguments. If is_error is True the tests are expected to raise an
+    Exception.
+    """
+    def test_purl(self):
+        # TODO: add tests for is_invalid data
+
+        # parsing the test canonical `purl` then re-building a `purl` from these
+        # parsed components should return the test canonical `purl`
+        cano = PackageURL.from_string(purl)
+        assert canonical_purl == cano.to_string()
+
+        # parsing the test `purl` should return the components parsed from the
+        # test canonical `purl`
+        parsed = PackageURL.from_string(canonical_purl)
+        assert cano.to_dict() == parsed.to_dict()
+
+        # parsing the test `purl` then re-building a `purl` from these parsed
+        # components should return the test canonical `purl`
+        assert canonical_purl == parsed.to_string()
+
+        # building a `purl` from the test components should return the test
+        # canonical `purl`
+        built = PackageURL(type, namespace, name, version, qualifiers, subpath)
+        assert canonical_purl == built.to_string()
+
+    # create a good function name for use in test discovery
+    if not description:
+        description = purl
+    test_name = python_safe_name(test_func_prefix + description)
+    test_purl.__name__ = test_name
+    test_purl.funcname = test_name
+    return test_purl, test_name
+
+
+def python_safe_name(s):
+    """
+    Return a name derived from string `s` safe to use as a Python function name.
+
+    For example:
+    >>> s = "not `\\a /`good` -safe name ??"
+    >>> assert python_safe_name(s) == 'not_good_safe_name'
+    """
+    no_punctuation = re.compile(r'[\W_]', re.MULTILINE).sub
+    s = s.lower()
+    s = no_punctuation(' ', s)
+    s = '_'.join(s.split())
+    if isinstance(s, unicode):
+        s = s.encode('ascii', 'ignore')
+    return s
+
+
+class PurlTest(unittest.TestCase):
+    pass
+
+
+def build_tests(clazz=PurlTest, test_file='test-suite-data.json'):
+    """
+    Dynamically build test methods for each purl test found in the `test_file`
+    JSON file and attach a test method to the `clazz` class.
+    """
+    with open(test_file) as tf:
+        tests_data = json.load(tf)
+    for items in tests_data:
+        test_func, test_name = create_test_function(**items)
+        # attach that method to the class
+        setattr(clazz, test_name, test_func)
+
+
+build_tests()
