Update JSON reporting schema

modelscan/issues.py

@@ -64,6 +64,7 @@ def __eq__(self, other: Any) -> bool:
             and self.details.module == other.details.module  # type: ignore[attr-defined]
             and self.details.operator == other.details.operator  # type: ignore[attr-defined]
             and str(self.details.source) == str(other.details.source)  # type: ignore[attr-defined]
+            and self.details.severity == other.severity  # type: ignore[attr-defined]
         )
 
     def __repr__(self) -> str:
@@ -76,6 +77,7 @@ def __hash__(self) -> int:
             + str(self.details.module)  # type: ignore[attr-defined]
             + str(self.details.operator)  # type: ignore[attr-defined]
             + str(self.details.source)  # type: ignore[attr-defined]
+            + str(self.details.severity)  # type: ignore[attr-defined]
         )
 
     def print(self) -> None:
@@ -121,11 +123,17 @@ def group_by_severity(self) -> Dict[str, List[Issue]]:
 
 class OperatorIssueDetails(IssueDetails):
     def __init__(
-        self, module: str, operator: str, source: Union[Path, str], scanner: str = ""
+        self,
+        module: str,
+        operator: str,
+        severity: IssueSeverity,
+        source: Union[Path, str],
+        scanner: str = "",
     ) -> None:
         self.module = module
         self.operator = operator
         self.source = source
+        self.severity = severity
         self.scanner = scanner
 
     def output_lines(self) -> List[str]:
@@ -141,7 +149,8 @@ def output_json(self) -> Dict[str, str]:
             "module": f"{self.module}",
             "source": f"{str(self.source)}",
             "scanner": f"{self.scanner}",
+            "severity": f"{self.severity.name}",
         }
 
     def __repr__(self) -> str:
-        return f"<OperatorIssueDetails(module={self.module}, operator={self.operator}, source={str(self.source)})>"
+        return f"<OperatorIssueDetails(module={self.module}, operator={self.operator}, severity={self.severity.name}, source={str(self.source)})>"

modelscan/modelscan.py

@@ -141,10 +141,6 @@ def _generate_results(self) -> Dict[str, Any]:
         issues_by_severity = self._issues.group_by_severity()
         total_issue_count = len(self._issues.all_issues)
 
-        report["modelscan_version"] = __version__
-        report["timestamp"] = datetime.now().isoformat()
-        report["input_path"] = self._input_path
-        report["total_issues"] = total_issue_count
         report["summary"] = {"total_issues_by_severity": {}}
         for severity in IssueSeverity:
             if severity.name in issues_by_severity:
@@ -154,24 +150,25 @@ def _generate_results(self) -> Dict[str, Any]:
             else:
                 report["summary"]["total_issues_by_severity"][severity.name] = 0
 
-        report["issues_by_severity"] = {}
-        for issue_key in issues_by_severity.keys():
-            report["issues_by_severity"][issue_key] = [
-                issue.details.output_json() for issue in issues_by_severity[issue_key]
-            ]
-
-        report["errors"] = [str(error) for index, error in enumerate(self._errors)]
-
-        report["scanned"] = {"total_scanned": len(self._scanned)}
-        report["scanned"]["scanned_files"] = [
+        report["summary"]["total_issues"] = total_issue_count
+        report["summary"]["input_path"] = self._input_path
+        report["summary"]["modelscan_version"] = __version__
+        report["summary"]["timestamp"] = datetime.now().isoformat()
+        report["summary"]["skipped"] = {"total_skipped": len(self._skipped)}
+        report["summary"]["skipped"]["skipped_files"] = [
+            str(file_name) for file_name in self._skipped
+        ]
+        report["summary"]["scanned"] = {"total_scanned": len(self._scanned)}
+        report["summary"]["scanned"]["scanned_files"] = [
             str(file_name) for file_name in self._scanned
         ]
 
-        report["skipped"] = {"total_skipped": len(self._skipped)}
-        report["skipped"]["skipped_files"] = [
-            str(file_name) for file_name in self._skipped
+        report["issues"] = [
+            issue.details.output_json() for issue in self._issues.all_issues
         ]
 
+        report["errors"] = [str(error) for index, error in enumerate(self._errors)]
+
         return report
 
     def is_compatible(self, path: str) -> bool:

modelscan/reports.py

@@ -89,7 +89,7 @@ def generate(
     ) -> None:
         report: Dict[str, Any] = scan._generate_results()
         if not settings["show_skipped"]:
-            del report["skipped"]
+            del report["summary"]["skipped"]
 
         print(json.dumps(report))
 

modelscan/scanners/saved_model/scan.py

@@ -81,7 +81,10 @@ def _check_for_unsafe_tf_keras_operator(
                     code=IssueCode.UNSAFE_OPERATOR,
                     severity=severity,
                     details=OperatorIssueDetails(
-                        module=module_name, operator=op, source=source
+                        module=module_name,
+                        operator=op,
+                        source=source,
+                        severity=severity,
                     ),
                 )
             )

modelscan/tools/picklescanner.py

@@ -165,7 +165,10 @@ def scan_pickle_bytes(
                     code=IssueCode.UNSAFE_OPERATOR,
                     severity=severity,
                     details=OperatorIssueDetails(
-                        module=global_module, operator=global_name, source=source
+                        module=global_module,
+                        operator=global_name,
+                        source=source,
+                        severity=severity,
                     ),
                 )
             )