Use a python parser for rubocop (#352)

Author: Chris Clearwater

linters/rubocop/plugin.yaml

@@ -10,15 +10,18 @@ lint:
       commands:
         - name: lint
           # Custom parser type defined in the trunk cli to handle rubocop's JSON output.
-          output: rubocop
+          output: sarif
           run: rubocop --format json ${target}
-          success_codes: [0, 1, 2]
+          success_codes: [0, 1]
           batch: true
+          parser:
+            runtime: python
+            run: python3 ${plugin}/linters/rubocop/rubocop_to_sarif.py
         - name: fix-layout
           formatter: true
           output: rewrite
           run: rubocop --fix-layout ${target}
-          success_codes: [0, 1, 2]
+          success_codes: [0, 1]
           in_place: true
           batch: true
       issue_url_format: https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/{}

linters/rubocop/rubocop_to_sarif.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+
+import json
+import sys
+
+
+def map_severity(severity):
+    if severity in ["convention", "refactor", "info"]:
+        return "note"
+    if severity in ["warning"]:
+        return "warning"
+    if severity in ["error", "fatal"]:
+        return "error"
+    return "none"
+
+
+results = []
+
+for file in json.load(sys.stdin)["files"]:
+    for offense in file["offenses"]:
+        parse = {
+            "level": map_severity(offense["severity"]),
+            "locations": [
+                {
+                    "physicalLocation": {
+                        "artifactLocation": {
+                            "uri": file["path"],
+                        },
+                        "region": {
+                            "startLine": offense["location"]["start_line"],
+                            "startColumn": offense["location"]["start_column"],
+                            "endLine": offense["location"]["last_line"],
+                            "endColumn": offense["location"]["last_column"],
+                        },
+                    }
+                }
+            ],
+            "message": {"text": offense["message"]},
+            "ruleId": offense["cop_name"],
+        }
+        results.append(parse)
+
+sarif = {
+    "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
+    "version": "2.1.0",
+    "runs": [{"results": results}],
+}
+
+print(json.dumps(sarif, indent=2))

linters/rubocop/test_data/rubocop_v1.39.0_basic.check.shot

@@ -15,7 +15,7 @@ exports[`Testing linter rubocop test basic 1`] = `
       "ranges": [
         {
           "filePath": "test_data/basic.rb",
-          "length": "20",
+          "length": "19",
         },
       ],
       "targetType": "ruby",
@@ -29,12 +29,6 @@ exports[`Testing linter rubocop test basic 1`] = `
       "line": "1",
       "linter": "rubocop",
       "message": "Missing frozen string literal comment.",
-      "ranges": [
-        {
-          "filePath": "test_data/basic.rb",
-          "length": "1",
-        },
-      ],
       "targetType": "ruby",
     },
     {
@@ -49,7 +43,7 @@ exports[`Testing linter rubocop test basic 1`] = `
       "ranges": [
         {
           "filePath": "test_data/basic.rb",
-          "length": "7",
+          "length": "6",
           "offset": "5",
         },
       ],
@@ -71,7 +65,7 @@ exports[`Testing linter rubocop test basic 1`] = `
       "ranges": [
         {
           "filePath": "test_data/basic.rb",
-          "length": "44",
+          "length": "43",
           "offset": "59",
         },
       ],
@@ -89,7 +83,7 @@ exports[`Testing linter rubocop test basic 1`] = `
       "ranges": [
         {
           "filePath": "test_data/basic.rb",
-          "length": "5",
+          "length": "4",
           "offset": "69",
         },
       ],
@@ -107,7 +101,7 @@ exports[`Testing linter rubocop test basic 1`] = `
       "ranges": [
         {
           "filePath": "test_data/basic.rb",
-          "length": "5",
+          "length": "4",
           "offset": "87",
         },
       ],
@@ -212,13 +206,6 @@ exports[`Testing linter rubocop test basic 1`] = `
       "line": "9",
       "linter": "rubocop",
       "message": "Use 2 (not 1) spaces for indentation.",
-      "ranges": [
-        {
-          "filePath": "test_data/basic.rb",
-          "length": "1",
-          "offset": "37",
-        },
-      ],
       "targetType": "ruby",
     },
     {
@@ -233,7 +220,7 @@ exports[`Testing linter rubocop test basic 1`] = `
       "ranges": [
         {
           "filePath": "test_data/basic.rb",
-          "length": "15",
+          "length": "14",
           "offset": "38",
         },
       ],