Truncate long summaries

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.0](releases/tag/v2.1.0) - Unreleased
+
+### Fixed
+
+- #39 Truncate long summaries.
+
+### Compatibility
+
+- Python 3.8+
+
 ## [2.0.0](releases/tag/v2.0.0) - 2022-11-07
 
 ### Breaking Changes

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sarif-tools"
-version = "2.0.0"
+version = "2.1.0"
 description = "SARIF tools"
 authors = ["Microsoft"]
 readme = "README.md"

sarif/__init__.py

@@ -1,6 +1,7 @@
 """
 Top-level version information for sarif-tools.
 """
+
 import importlib.metadata
 
 

sarif/operations/upgrade_filter_op.py

@@ -56,9 +56,11 @@ def upgrade_filter_file(old_filter_file, output_file):
         exclude_patterns,
     ) = _load_blame_filter_file(old_filter_file)
     new_filter_definition = {
-        "description": filter_description
-        if filter_description
-        else f"Migrated from {os.path.basename(old_filter_file)}",
+        "description": (
+            filter_description
+            if filter_description
+            else f"Migrated from {os.path.basename(old_filter_file)}"
+        ),
         "configuration": {"default-include": True, "check-line-number": True},
     }
     if include_patterns:

sarif/sarif_file.py

@@ -7,12 +7,15 @@
 import datetime
 import os
 import re
+import textwrap
 from typing import Dict, Iterator, List, Optional, Tuple
 
 from sarif import sarif_file_utils
 from sarif.filter.general_filter import GeneralFilter
 from sarif.filter.filter_stats import FilterStats
 
+# SARIF severity levels as per
+# https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html#_Toc141790898
 SARIF_SEVERITIES = ["error", "warning", "note"]
 
 BASIC_RECORD_ATTRIBUTES = [
@@ -62,7 +65,7 @@ def _count_records_by_issue_code(records, severity) -> List[Tuple]:
     code_to_count = {}
     for record in records:
         if record["Severity"] == severity:
-            code = combine_code_and_description(record)
+            code = record["Code"].strip()
             code_to_count[code] = code_to_count.get(code, 0) + 1
     return sorted(code_to_count.items(), key=lambda x: x[1], reverse=True)
 
@@ -86,12 +89,25 @@ def combine_code_and_description(record: dict) -> str:
     Combine code and description fields into one string.
     """
     (code, description) = (record["Code"], record["Description"])
-    if code and description:
-        return f"{code.strip()} {description.strip()}"
-    if code:
-        return code.strip()
     if description:
-        return description.strip()
+        if "\n" in description:
+            description = description[: description.index("\n")]
+        description = description.strip()
+    if description:
+        if len(description) > 120:
+            shorter_description = textwrap.shorten(
+                description, width=103, placeholder="..."
+            )
+            if len(shorter_description) < 40:
+                description = description[:100] + "..."
+            else:
+                description = shorter_description
+        if code:
+            return f"{code.strip()} {description}"
+        else:
+            return description
+    elif code:
+        return code.strip()
     return "<NONE>"
 
 
@@ -139,9 +155,11 @@ def __init__(self, sarif_file_object, run_index, run_data):
                     filter_date = conversion_driver["properties"].get("processed", None)
                     self._filter.rehydrate_filter_stats(
                         dehydrated_filter_stats,
-                        datetime.datetime.fromisoformat(filter_date)
-                        if filter_date
-                        else None,
+                        (
+                            datetime.datetime.fromisoformat(filter_date)
+                            if filter_date
+                            else None
+                        ),
                     )
 
     def init_path_prefix_stripping(self, autotrim=False, path_prefixes=None):
@@ -311,9 +329,11 @@ def result_to_record(self, result, include_blame_info=False):
             "Line": line_number,
             "Severity": severity,
             "Code": error_id,
-            "Description": message[len(error_id) + 1].strip()
-            if message.startswith(error_id) and len(message) > len(error_id) + 1
-            else message,
+            "Description": (
+                message[len(error_id) + 1].strip()
+                if message.startswith(error_id) and len(message) > len(error_id) + 1
+                else message
+            ),
         }
         if include_blame_info:
             record["Author"] = _get_author_mail_from_blame_info(