Fail verbosely in build_spdx_license_expression

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

Author: AyanSinhaMahapatra

src/licensedcode/cache.py

@@ -510,5 +510,47 @@ def build_spdx_license_expression(license_expression, licensing=None):
     """
     if not licensing:
         licensing = get_licensing()
+    validate_spdx_license_keys(license_expression=license_expression, licensing=licensing)
     parsed = licensing.parse(license_expression)
     return parsed.render(template='{symbol.wrapped.spdx_license_key}')
+
+
+def validate_spdx_license_keys(license_expression, licensing):
+    """
+    Raise InvalidLicenseKeyError for the cases where the there is no corresponding :
+
+    """
+    from licensedcode.models import load_licenses
+
+    license_keys = licensing.license_keys(license_expression)
+    license_db = get_licenses_db()
+
+    messages = []
+
+    for key in license_keys:
+        if not type(key) == str:
+            msg = f"Invalid license key: {key} of type {type(key)}, license key should be a string"
+            messages.append(msg)
+    
+        lic = license_db.get(key, None)
+        if not lic:
+            licenses = load_licenses(with_deprecated=True)
+            if licenses.get(key, None):
+                msg = f"License key: {key} is deprecated license key in LicenseDB"
+            else:
+                msg = f"License key: {key} is not a valid license key from LicenseDB"
+            messages.append(msg)
+
+        parsed = licensing.parse(key)
+        try:
+            parsed.render(template='{symbol.wrapped.spdx_license_key}')
+        except AttributeError:
+            messages.append(msg)
+            pass
+
+    if messages:
+        raise InvalidLicenseKeyError(messages)
+
+
+class InvalidLicenseKeyError(Exception):
+    pass

tests/licensedcode/test_zzzz_cache.py

@@ -155,3 +155,32 @@ def test_get_spdx_symbols_checks_duplicates_with_deprecated_on_live_db(self):
         from licensedcode.models import load_licenses
         test_licenses = load_licenses(with_deprecated=True)
         cache.get_spdx_symbols(licenses_db=test_licenses)
+
+    def test_build_spdx_license_expression(self):
+        from licensedcode.cache import build_spdx_license_expression
+        assert build_spdx_license_expression("mit")
+    
+    def test_build_spdx_license_expression_fails_on_invalid_key_none(self):
+        from licensedcode.cache import build_spdx_license_expression
+        from licensedcode.cache import InvalidLicenseKeyError
+        try:
+            build_spdx_license_expression("mit AND None")
+        except InvalidLicenseKeyError:
+            pass
+
+    def test_build_spdx_license_expression_fails_on_deprecated_license(self):
+        # TODO: this should not fail, see https://github.com/nexB/scancode-toolkit/issues/3400
+        from licensedcode.cache import build_spdx_license_expression
+        from licensedcode.cache import InvalidLicenseKeyError
+        try:
+            assert build_spdx_license_expression("broadcom-linking-unmodified")
+        except InvalidLicenseKeyError:
+            pass
+
+    def test_build_spdx_license_expression_fails_on_invalid_key(self):
+        from licensedcode.cache import build_spdx_license_expression
+        from licensedcode.cache import InvalidLicenseKeyError
+        try:
+            assert build_spdx_license_expression("mitt")
+        except InvalidLicenseKeyError:
+            pass