test_urn.py

#
# Copyright (c) nexB Inc. and others. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
# See https://github.com/aboutcode-org/commoncode for support or download.
# See https://aboutcode.org for more information about nexB OSS projects.
#

import unittest

from commoncode import urn


class URNTestCase(unittest.TestCase):
    def test_encode_license(self):
        u1 = urn.encode("license", key="somekey")
        assert u1 == "urn:dje:license:somekey"

    def test_encode_owner(self):
        u1 = urn.encode("owner", name="somekey")
        assert u1 == "urn:dje:owner:somekey"

    def test_encode_component(self):
        u1 = urn.encode("component", name="name", version="version")
        assert u1 == "urn:dje:component:name:version"

    def test_encode_component_no_version(self):
        u1 = urn.encode("component", name="name", version="")
        assert u1 == "urn:dje:component:name:"

    def test_encode_license_with_extra_fields_are_ignored(self):
        u1 = urn.encode("license", key="somekey", junk="somejunk")
        assert u1 == "urn:dje:license:somekey"

    def test_encode_missing_field_raise_keyerror(self):
        with self.assertRaises(KeyError):
            urn.encode("license")

    def test_encode_missing_field_component_raise_keyerror(self):
        with self.assertRaises(KeyError):
            urn.encode("component", name="this")

    def test_encode_unknown_object_type_raise_keyerror(self):
        with self.assertRaises(KeyError):
            urn.encode("some", key="somekey")

    def test_encode_component_with_spaces_are_properly_quoted(self):
        u1 = urn.encode("component", name="name space", version="version space")
        assert u1 == "urn:dje:component:name+space:version+space"

    def test_encode_leading_and_trailing_spaces_are_trimmed_and_ignored(self):
        u1 = urn.encode(" component ", name=" name space    ", version="""  version space """)
        assert u1 == "urn:dje:component:name+space:version+space"

    def test_encode_component_with_semicolon_are_properly_quoted(self):
        u1 = urn.encode("component", name="name:", version=":version")
        assert u1 == "urn:dje:component:name%3A:%3Aversion"

    def test_encode_component_with_plus_are_properly_quoted(self):
        u1 = urn.encode("component", name="name+", version="version+")
        assert u1 == "urn:dje:component:name%2B:version%2B"

    def test_encode_component_with_percent_are_properly_quoted(self):
        u1 = urn.encode("component", name="name%", version="version%")
        assert u1 == "urn:dje:component:name%25:version%25"

    def test_encode_object_type_case_is_not_significant(self):
        u1 = urn.encode("license", key="key")
        u2 = urn.encode("lICENSe", key="key")
        assert u2 == u1

    def test_decode_component(self):
        u = "urn:dje:component:name:version"
        parsed = ("component", {"name": "name", "version": "version"})
        assert urn.decode(u) == parsed

    def test_decode_license(self):
        u = "urn:dje:license:lic"
        parsed = ("license", {"key": "lic"})
        assert urn.decode(u) == parsed

    def test_decode_org(self):
        u = "urn:dje:owner:name"
        parsed = ("owner", {"name": "name"})
        assert urn.decode(u) == parsed

    def test_decode_build_is_idempotent(self):
        u1 = urn.encode("component", owner__name="org%", name="name%", version="version%")
        m, f = urn.decode(u1)
        u3 = urn.encode(m, **f)
        assert u3 == u1

    def test_decode_raise_exception_if_incorrect_prefix(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("arn:dje:a:a")

    def test_decode_raise_exception_if_incorrect_ns(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:x:x:x")

    def test_decode_raise_exception_if_incorrect_prefix_or_ns(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("x:x:x:x")

    def test_decode_raise_exception_if_too_short_license(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:dje:license")

    def test_decode_raise_exception_if_too_short_component(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:dje:component")

    def test_decode_raise_exception_if_too_long(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:dje:owner:o:n")

    def test_decode_raise_exception_if_too_long1(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:dje:component:o:n:v:junk")

    def test_decode_raise_exception_if_too_long2(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:dje:owner:org:junk")

    def test_decode_raise_exception_if_too_long3(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:dje:license:key:junk")

    def test_decode_raise_exception_if_unknown_object_type(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:dje:marshmallows:dsds")

    def test_decode_raise_exception_if_missing_object_type(self):
        with self.assertRaises(urn.URNValidationError):
            urn.decode("urn:dje::dsds")

    def test_encode_decode_is_idempotent(self):
        object_type = "component"
        fields = {"name": "SIP Servlets (MSS)", "version": "v 1.4.0.FINAL"}
        encoded = "urn:dje:component:SIP+Servlets+%28MSS%29:v+1.4.0.FINAL"
        assert urn.encode(object_type, **fields) == encoded
        assert urn.decode(encoded) == (object_type, fields)


class TruncatedURNTestCase(unittest.TestCase):
    def test_truncated_urns_raise_validation_error(self):
        for value in ("", "urn", "urn:", "urn:dje"):
            with self.subTest(value=value):
                with self.assertRaises(urn.URNValidationError):
                    urn.decode(value)