Add support for rendering any expression as SPDX #63

Signed-off-by: tdruez <tdruez@nexb.com>

component_catalog/license_expression_dje.py

@@ -426,9 +426,17 @@ def get_formatted_expression(licensing, license_expression, show_policy, show_ca
     )
 
 
-def render_expression_for_ui(expression_str, dataspace):
+def render_expression_as_html(expression, dataspace):
+    """Return the ``expression`` as rendered HTML content."""
     show_policy = dataspace.show_usage_policy_in_user_views
     licensing = get_dataspace_licensing(dataspace)
 
-    formatted_expression = get_formatted_expression(licensing, expression_str, show_policy)
+    formatted_expression = get_formatted_expression(licensing, expression, show_policy)
     return format_html(formatted_expression)
+
+
+def get_expression_as_spdx(expression, dataspace):
+    """Return an SPDX license expression built from the ``expression``."""
+    licensing = get_dataspace_licensing(dataspace)
+    parsed_expression = parse_expression(expression, licensing)
+    return parsed_expression.render(template="{symbol.spdx_license_key}")

component_catalog/models.py

@@ -44,6 +44,7 @@
 from packageurl.contrib.django.utils import without_empty_values
 
 from component_catalog.license_expression_dje import build_licensing
+from component_catalog.license_expression_dje import get_expression_as_spdx
 from component_catalog.license_expression_dje import get_license_objects
 from component_catalog.license_expression_dje import parse_expression
 from dejacode_toolkit import spdx
@@ -196,6 +197,9 @@ def get_license_expression_spdx_id(self):
         "LicenseRef-".
 
         See discussion at https://github.com/spdx/tools-java/issues/73
+
+        Note: A new get_expression_as_spdx function is available and should be used in
+        place of this one.
         """
         expression = self.get_license_expression("{symbol.spdx_id}")
         if expression:
@@ -215,6 +219,14 @@ def _get_primary_license(self):
 
     primary_license = cached_property(_get_primary_license)
 
+    def get_expression_as_spdx(self, expression):
+        if expression:
+            return get_expression_as_spdx(expression, self.dataspace)
+
+    @property
+    def concluded_license_expression_spdx(self):
+        return self.get_expression_as_spdx(self.license_expression)
+
     def save(self, *args, **kwargs):
         """
         Call the handle_assigned_licenses method on save, except during copy.
@@ -341,6 +353,14 @@ class LicenseFieldsMixin(models.Model):
     class Meta:
         abstract = True
 
+    @property
+    def declared_license_expression_spdx(self):
+        return self.get_expression_as_spdx(self.declared_license_expression)
+
+    @property
+    def other_license_expression_spdx(self):
+        return self.get_expression_as_spdx(self.other_license_expression)
+
 
 def get_cyclonedx_properties(instance):
     """

dje/views.py

@@ -74,7 +74,7 @@
 from notifications import views as notifications_views
 
 from component_catalog.license_expression_dje import get_license_objects
-from component_catalog.license_expression_dje import render_expression_for_ui
+from component_catalog.license_expression_dje import render_expression_as_html
 from dejacode_toolkit.purldb import PurlDB
 from dejacode_toolkit.scancodeio import ScanCodeIO
 from dejacode_toolkit.vulnerablecode import VulnerableCode
@@ -916,7 +916,7 @@ def tab_license(self):
 
         for license_field in license_fields:
             if expression := getattr(obj, license_field, None):
-                rendered_expression = render_expression_for_ui(expression, obj.dataspace)
+                rendered_expression = render_expression_as_html(expression, obj.dataspace)
                 tab_fields.append(TabField(license_field, value=rendered_expression))
 
         if getattr(obj, "reference_notes", False):

reporting/forms.py

@@ -189,6 +189,9 @@ def get_model_data_for_column_template(dataspace=None):
             "Properties": [
                 "urn",
                 "details_url",
+                "concluded_license_expression_spdx",
+                "declared_license_expression_spdx",
+                "other_license_expression_spdx",
                 "primary_license",
                 "attribution_required",
                 "redistribution_required",
@@ -201,6 +204,9 @@ def get_model_data_for_column_template(dataspace=None):
                 "identifier",
                 "urn",
                 "details_url",
+                "concluded_license_expression_spdx",
+                "declared_license_expression_spdx",
+                "other_license_expression_spdx",
                 "primary_license",
                 "attribution_required",
                 "redistribution_required",

reporting/tests/test_models.py

@@ -2059,6 +2059,21 @@ def test_get_model_data_for_component_column_template(self):
             {"group": "Related Fields", "label": "related_parents", "value": "related_parents"},
             {"group": "Properties", "label": "urn", "value": "urn"},
             {"group": "Properties", "label": "details_url", "value": "details_url"},
+            {
+                "group": "Properties",
+                "label": "concluded_license_expression_spdx",
+                "value": "concluded_license_expression_spdx",
+            },
+            {
+                "group": "Properties",
+                "label": "declared_license_expression_spdx",
+                "value": "declared_license_expression_spdx",
+            },
+            {
+                "group": "Properties",
+                "label": "other_license_expression_spdx",
+                "value": "other_license_expression_spdx",
+            },
             {"group": "Properties", "value": "primary_license", "label": "primary_license"},
             {
                 "group": "Properties",