Add rule attributes to todo items

In case of license detection issues in todo items,
add rule attributes as additional context which are
usually not added to license match data.

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

Author: AyanSinhaMahapatra

src/licensedcode/detection.py

@@ -643,6 +643,7 @@ def to_dict(
         include_text=False,
         license_text_diagnostics=False,
         whole_lines=True,
+        rule_details=False,
     ):
         """
         Return a "result" scan data built from a LicenseMatch object.
@@ -668,6 +669,14 @@ def to_dict(
         result['rule_relevance'] = self.rule.relevance
         result['rule_url'] = self.rule.rule_url
 
+        # Extra rule details added optionally
+        if rule_details:
+            result.update(self.rule.get_flags_mapping())
+            result["rule_length"] = self.rule.length
+            result["rule_text"] = self.rule.text
+            result["rule_notes"] = self.rule.notes
+            result["referenced_filenames"] = self.rule.referenced_filenames
+
         if include_text:
             result['matched_text'] = matched_text
 

src/licensedcode/models.py

@@ -1950,6 +1950,33 @@ def get_min_high_matched_length(self, unique=False):
         return (self.min_high_matched_length_unique if unique
                 else self.min_high_matched_length)
 
+    def get_flags_mapping(self):
+        """
+        Return a list of boolean attributes for a rule which are set to True.
+        """
+
+        rule_boolean_attributes = [
+            'is_license_text',
+            'is_license_text',
+            'is_license_notice',
+            'is_license_reference',
+            'is_license_tag',
+            'is_license_intro',
+            'is_license_clue',
+            'is_continuous',
+            'is_builtin',
+            'is_from_license',
+            'is_synthetic',
+        ]
+
+        mapping = {}
+        for attribute in rule_boolean_attributes:
+            value = getattr(self, attribute)
+            if value:
+                mapping[attribute] = True
+
+        return mapping
+
     def to_reference(self):
         """
         Return a mapping of reference data for this Rule object.

src/summarycode/todo.py

@@ -20,6 +20,7 @@
 from licensedcode.detection import get_ambiguous_license_detections_by_type
 from licensedcode.detection import get_uuid_on_content
 from licensedcode.detection import UniqueDetection
+from licensedcode.detection import LicenseMatchFromResult
 from plugincode.post_scan import PostScanPlugin, post_scan_impl
 from packageurl import PackageURL
 
@@ -222,13 +223,23 @@ class AmbiguousDetection:
     """
     Detections which needs review.
     """
+
+    detection_type = attr.ib(
+        default=None,
+        metadata=dict(
+            help='A string determining what type of detection this object is, '
+            'the possible values for this are : `package` and `license` '
+        )
+    )
+
     detection_id = attr.ib(
         default=None,
         metadata=dict(
             help='A detection ID identifying an unique detection. '
-            'This has two parts one with the type of detection in string, '
-            'like `package`/`license` and a positive integer '
-            'denoting the detection number.'
+            'For a license detection this is an id with the license, '
+            'expression and an UUID based on the match content. '
+            'For a package detection this is the purl and the UUID as '
+            'a qualifier.'
         )
     )
 
@@ -269,6 +280,7 @@ def from_package(cls, package_data, detection_log, file_path):
         )
         review_comments = get_review_comments(detection_log)
         return cls(
+            detection_type='package',
             detection_id=detection_id,
             detection=package_data,
             review_comments=review_comments,
@@ -287,6 +299,7 @@ def from_license(cls, detection, detection_log, file_regions):
             license_diagnostics=license_diagnostics,
         )
         return cls(
+            detection_type='license',
             detection_id=detection.identifier,
             detection=detection_mapping,
             review_comments=review_comments,
@@ -299,9 +312,25 @@ def dict_fields(attr, value):
             if attr.name == 'file_regions':
                 return False
 
+            if attr.name == 'detection_type':
+                return False
+
             return True
 
-        return attr.asdict(self, filter=dict_fields, dict_factory=dict)
+        detection_mapping = attr.asdict(self, filter=dict_fields, dict_factory=dict)
+        if self.detection_type == 'license':
+            # add rule attributes to the match details
+            matches_with_details = []
+            for license_match in detection_mapping["detection"]["matches"]:
+                license_match_obj = LicenseMatchFromResult.from_dict(license_match)
+                matches_with_details.append(license_match_obj.to_dict(
+                    include_text=True,
+                    license_text_diagnostics=True,
+                    rule_details=True,
+                ))
+            detection_mapping["detection"]["matches"] = matches_with_details
+
+        return detection_mapping
 
 
 class PackageDetectionCategory(Enum):

tests/summarycode/data/todo/todo_present/README.multi-orig-tarball-package-expected-diag.json

@@ -21,6 +21,13 @@
             "rule_identifier": "borceux.LICENSE",
             "rule_relevance": 100,
             "rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/borceux.LICENSE",
+            "is_license_text": true,
+            "is_builtin": true,
+            "is_from_license": true,
+            "rule_length": 85,
+            "rule_text": "Copyright 1993 Francis Borceux\nYou may freely use, modify, and/or distribute each of the files in this package without limitation.  The package consists of the following files:\n\nREADME\ncompatibility/OldDiagram\ncompatibility/OldMaxiDiagram\ncompatibility/OldMicroDiagram\ncompatibility/OldMiniDiagram\ncompatibility/OldMultipleArrows\ndiagram/Diagram\ndiagram/MaxiDiagram\ndiagram/MicroDiagram\ndiagram/MiniDiagram\ndiagram/MultipleArrows\nuser-guides/Diagram_Mode_d_Emploi\nuser-guides/Diagram_Read_Me\n\nOf course no support is guaranteed, but the author will attempt to assist with problems.  Current email address:\nfrancis dot borceux at uclouvain dot be.",
+            "rule_notes": null,
+            "referenced_filenames": [],
             "matched_text": "package consists of [various] [tarballs].\n\n[This] README"
           }
         ],

tests/summarycode/data/todo/todo_present/unknown-license-expected-diag.json

@@ -46,6 +46,13 @@
             "rule_identifier": "license-detection-unknown-3d4d4e847eacf4b9efcc80ca90df1eea689f5cee",
             "rule_relevance": 100,
             "rule_url": null,
+            "is_license_notice": true,
+            "is_builtin": true,
+            "is_synthetic": true,
+            "rule_length": 53,
+            "rule_text": "form shall mean the preferred form for making\nthe purposes of this definition control\n[software] [is] [modified] [by] [someone] [else]\n\n\n\nrepresent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) [to] [the] interfaces of,\n      the Work and Derivative Works thereof.",
+            "rule_notes": "Unknown license based on a composite of license words.",
+            "referenced_filenames": [],
             "matched_text": "form shall mean the preferred form for making\nthe purposes of this definition control\n[software] [is] [modified] [by] [someone] [else]\n\n\n\nrepresent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) [to] [the] interfaces of,\n      the Work and Derivative Works thereof."
           }
         ],

tests/summarycode/data/todo/todo_present/unknown-license-expected.json

@@ -43,6 +43,13 @@
             "rule_identifier": "license-detection-unknown-51bcd994ad60981fff8c5f1b1b9af6e3d4f5ba67",
             "rule_relevance": 100,
             "rule_url": null,
+            "is_license_notice": true,
+            "is_builtin": true,
+            "is_synthetic": true,
+            "rule_length": 53,
+            "rule_text": "form shall mean the preferred form for making\nthe purposes of this definition control\nsoftware is modified by someone else\n\n\n\nrepresent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) to the interfaces of,\n      the Work and Derivative Works thereof.",
+            "rule_notes": "Unknown license based on a composite of license words.",
+            "referenced_filenames": [],
             "matched_text": "form shall mean the preferred form for making\nthe purposes of this definition control\nsoftware is modified by someone else\n\n\n\nrepresent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) to the interfaces of,\n      the Work and Derivative Works thereof."
           }
         ],