danger-sarif 0.1.0

data/spec/fixtures/detekt.sarif

@@ -0,0 +1,61 @@
+{
+  "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
+  "version": "2.1.0",
+  "runs": [
+    {
+      "originalUriBaseIds": {
+        "%SRCROOT%": {
+          "uri": "file:///Users/user_name/./"
+        }
+      },
+      "results": [
+        {
+          "level": "warning",
+          "locations": [
+            {
+              "physicalLocation": {
+                "artifactLocation": {
+                  "uri": "app/src/main/kotlin/MyClass.kt",
+                  "uriBaseId": "%SRCROOT%"
+                },
+                "region": {
+                  "endColumn": 8,
+                  "endLine": 10,
+                  "startColumn": 20,
+                  "startLine": 10
+                }
+              }
+            }
+          ],
+          "message": {
+            "text": "This expression contains a magic number. Consider defining it to a well named constant."
+          },
+          "ruleId": "detekt.style.MagicNumber"
+        }
+      ],
+      "tool": {
+        "driver": {
+          "downloadUri": "https://github.com/detekt/detekt/releases/download/v1.22.0/detekt",
+          "fullName": "detekt",
+          "guid": "022ca8c2-f6a2-4c95-b107-bb72c43263f3",
+          "informationUri": "https://detekt.dev",
+          "language": "en",
+          "name": "detekt",
+          "organization": "detekt",
+          "rules": [
+            {
+              "helpUri": "https://detekt.dev/style.html#magicnumber",
+              "id": "detekt.style.MagicNumber",
+              "name": "MagicNumber",
+              "shortDescription": {
+                "text": "Report magic numbers. Magic number is a numeric literal that is not defined as a constant and hence it's unclear what the purpose of this number is. It's better to declare such numbers as constants and give them a proper name. By default, -1, 0, 1, and 2 are not considered to be magic numbers."
+              }
+            }
+          ],
+          "semanticVersion": "1.22.0",
+          "version": "1.22.0"
+        }
+      }
+    }
+  ]
+}

data/spec/fixtures/ktlint.sarif

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
+  "version": "2.1.0",
+  "runs": [
+    {
+      "originalUriBaseIds": {
+        "%SRCROOT%": {
+          "uri": "file:///Users/user_name/"
+        }
+      },
+      "results": [
+        {
+          "level": "error",
+          "locations": [
+            {
+              "physicalLocation": {
+                "artifactLocation": {
+                  "uri": "project/app/src/main/kotlin/File.kt",
+                  "uriBaseId": "%SRCROOT%"
+                },
+                "region": {
+                  "startColumn": 20,
+                  "startLine": 10
+                }
+              }
+            }
+          ],
+          "message": {
+            "text": "Error Message from ktlint"
+          },
+          "ruleId": "ktlint-check-rule-id"
+        }
+      ],
+      "tool": {
+        "driver": {
+          "downloadUri": "https://github.com/pinterest/ktlint/releases/tag/0.47.1",
+          "fullName": "ktlint",
+          "informationUri": "https://github.com/pinterest/ktlint/",
+          "language": "en",
+          "name": "ktlint",
+          "organization": "pinterest",
+          "rules": [
+          ],
+          "semanticVersion": "0.47.1",
+          "version": "0.47.1"
+        }
+      }
+    }
+  ]
+}

data/spec/fixtures/pull_request_event.json

@@ -0,0 +1,6 @@
+{
+  "number": 1,
+  "repository": {
+    "clone_url": "https://github.com/danger/danger.git"
+  }
+}

data/spec/fixtures/qodana-community-android-short.sarif

@@ -0,0 +1,109 @@
+{
+  "$schema": "https://raw.githubusercontent.com/schemastore/schemastore/master/src/schemas/json/sarif-2.1.0-rtm.5.json",
+  "version": "2.1.0",
+  "runs": [
+    {
+      "tool": {
+        "driver": {
+          "name": "QDANDC",
+          "fullName": "Qodana Community for Android",
+          "version": "232.9641.89",
+          "rules": [],
+          "taxa": [],
+          "language": "en-US",
+          "contents": [
+            "localizedData",
+            "nonLocalizedData"
+          ],
+          "isComprehensive": false
+        },
+        "extensions": []
+      },
+      "invocations": [
+        {
+          "exitCode": 0,
+          "toolExecutionNotifications": [
+            {
+              "message": {
+                "text": "Reporting from [\"Sanity\"] 'sanity' inspections was suspended due to high problems count."
+              },
+              "level": "error"
+            }
+          ],
+          "executionSuccessful": true
+        }
+      ],
+      "language": "en-US",
+      "results": [],
+      "automationDetails": {
+        "id": "MyApplication/qodana/2023-08-27",
+        "guid": "56e8951f-0de0-4b46-b3b4-0d1a7e33a49a",
+        "properties": {
+          "jobUrl": ""
+        }
+      },
+      "newlineSequences": [
+        "\r\n",
+        "\n"
+      ],
+      "properties": {
+        "qodana.sanity.results": [
+          {
+            "ruleId": "QodanaSanity",
+            "kind": "fail",
+            "level": "error",
+            "message": {
+              "text": "Unresolved reference: os",
+              "markdown": "Unresolved reference: os"
+            },
+            "locations": [
+              {
+                "physicalLocation": {
+                  "artifactLocation": {
+                    "uri": "app/src/main/kotlin/com/example/myapplication/MainActivity.kt",
+                    "uriBaseId": "SRCROOT"
+                  },
+                  "region": {
+                    "startLine": 3.0,
+                    "startColumn": 16.0,
+                    "charOffset": 50.0,
+                    "charLength": 2.0,
+                    "snippet": {
+                      "text": "os"
+                    },
+                    "sourceLanguage": "kotlin"
+                  },
+                  "contextRegion": {
+                    "startLine": 1.0,
+                    "startColumn": 1.0,
+                    "charOffset": 0.0,
+                    "charLength": 146.0,
+                    "snippet": {
+                      "text": "package com.example.myapplication\n\nimport android.os.Bundle\nimport androidx.activity.ComponentActivity\nimport androidx.activity.compose.setContent"
+                    },
+                    "sourceLanguage": "kotlin"
+                  }
+                },
+                "logicalLocations": [
+                  {
+                    "fullyQualifiedName": "MyApplication.app.main",
+                    "kind": "module"
+                  }
+                ]
+              }
+            ],
+            "partialFingerprints": {
+              "equalIndicator/v1": "4c0b407f01032b20116d0a01c377a8abb3d536838213a94b6b56ec41cc59ebfd"
+            },
+            "properties": {
+              "ideaSeverity": "ERROR",
+              "qodanaSeverity": "Critical"
+            }
+          }
+        ],
+        "configProfile": "recommended",
+        "deviceId": "200820300000000-0000-0000-0000-000000000000"
+      }
+    }
+  ]
+}

data/spec/fixtures/qodana-community-android.sarif

@@ -0,0 +1,224 @@
+{
+  "$schema": "https://raw.githubusercontent.com/schemastore/schemastore/master/src/schemas/json/sarif-2.1.0-rtm.5.json",
+  "version": "2.1.0",
+  "runs": [
+    {
+      "tool": {
+        "driver": {
+          "name": "QDANDC",
+          "fullName": "Qodana Community for Android",
+          "version": "232.9641.89",
+          "rules": [],
+          "taxa": [
+            {
+              "id": "Language injection",
+              "name": "Language injection"
+            },
+            {
+              "id": "JVM languages",
+              "name": "JVM languages"
+            },
+            {
+              "id": "Kotlin",
+              "name": "Kotlin"
+            }
+          ],
+          "language": "en-US",
+          "contents": [
+            "localizedData",
+            "nonLocalizedData"
+          ],
+          "isComprehensive": false
+        },
+        "extensions": [
+          {
+            "name": "org.intellij.qodana",
+            "version": "232.9641",
+            "rules": [
+              {
+                "id": "QodanaSanity",
+                "shortDescription": {
+                  "text": "Sanity"
+                },
+                "fullDescription": {
+                  "text": "Reports issues essential to this file like syntax errors, unresolved methods and variables, etc...",
+                  "markdown": "Reports issues essential to this file like syntax errors, unresolved methods and variables, etc..."
+                },
+                "defaultConfiguration": {
+                  "enabled": false,
+                  "level": "error",
+                  "parameters": {
+                    "suppressToolId": "QodanaSanity",
+                    "ideaSeverity": "ERROR",
+                    "qodanaSeverity": "Critical"
+                  }
+                },
+                "relationships": [
+                  {
+                    "target": {
+                      "id": "Qodana",
+                      "index": 130,
+                      "toolComponent": {
+                        "name": "QDANDC"
+                      }
+                    },
+                    "kinds": [
+                      "superset"
+                    ]
+                  }
+                ]
+              }
+            ],
+            "language": "en-US",
+            "contents": [
+              "localizedData",
+              "nonLocalizedData"
+            ],
+            "isComprehensive": false
+          }
+        ]
+      },
+      "invocations": [
+        {
+          "exitCode": 0,
+          "toolExecutionNotifications": [
+            {
+              "message": {
+                "text": "Reporting from [\"Sanity\"] 'sanity' inspections was suspended due to high problems count."
+              },
+              "level": "error"
+            }
+          ],
+          "executionSuccessful": true
+        }
+      ],
+      "language": "en-US",
+      "results": [
+        {
+          "ruleId": "UnusedSymbol",
+          "kind": "fail",
+          "level": "warning",
+          "message": {
+            "text": "Function \"GreetingPreview\" is never used",
+            "markdown": "Function \"GreetingPreview\" is never used"
+          },
+          "locations": [
+            {
+              "physicalLocation": {
+                "artifactLocation": {
+                  "uri": "app/src/main/kotlin/com/example/myapplication/MainActivity.kt",
+                  "uriBaseId": "SRCROOT"
+                },
+                "region": {
+                  "startLine": 42,
+                  "startColumn": 5,
+                  "charOffset": 1258,
+                  "charLength": 15,
+                  "snippet": {
+                    "text": "GreetingPreview"
+                  },
+                  "sourceLanguage": "kotlin"
+                },
+                "contextRegion": {
+                  "startLine": 40,
+                  "startColumn": 1,
+                  "charOffset": 1210,
+                  "charLength": 120,
+                  "snippet": {
+                    "text": "@Preview(showBackground = true)\n@Composable\nfun GreetingPreview() {\n    MyApplicationTheme {\n        Greeting(\"Android\")"
+                  },
+                  "sourceLanguage": "kotlin"
+                }
+              },
+              "logicalLocations": [
+                {
+                  "fullyQualifiedName": "My_Application.app.main",
+                  "kind": "module"
+                }
+              ]
+            }
+          ],
+          "partialFingerprints": {
+            "equalIndicator/v1": "0377b1cd2e526ed175953f909a3fdb1ea390c702f0c0d2b7b28d9cbcce2d8bc7"
+          },
+          "properties": {
+            "ideaSeverity": "WARNING",
+            "qodanaSeverity": "High",
+            "tags": [
+              "kotlin"
+            ]
+          }
+        }
+      ],
+      "automationDetails": {
+        "id": "My Application/qodana/2023-08-27",
+        "guid": "56e8951f-0de0-4b46-b3b4-0d1a7e33a49a",
+        "properties": {
+          "jobUrl": ""
+        }
+      },
+      "newlineSequences": [
+        "\r\n",
+        "\n"
+      ],
+      "properties": {
+        "qodana.sanity.results": [
+          {
+            "ruleId": "QodanaSanity",
+            "kind": "fail",
+            "level": "error",
+            "message": {
+              "text": "Unresolved reference: os",
+              "markdown": "Unresolved reference: os"
+            },
+            "locations": [
+              {
+                "physicalLocation": {
+                  "artifactLocation": {
+                    "uri": "app/src/main/kotlin/com/example/myapplication/MainActivity.kt",
+                    "uriBaseId": "SRCROOT"
+                  },
+                  "region": {
+                    "startLine": 3,
+                    "startColumn": 16,
+                    "charOffset": 50,
+                    "charLength": 2,
+                    "snippet": {
+                      "text": "os"
+                    },
+                    "sourceLanguage": "kotlin"
+                  },
+                  "contextRegion": {
+                    "startLine": 1,
+                    "startColumn": 1,
+                    "charOffset": 0,
+                    "charLength": 146,
+                    "snippet": {
+                      "text": "package com.example.myapplication\n\nimport android.os.Bundle\nimport androidx.activity.ComponentActivity\nimport androidx.activity.compose.setContent"
+                    },
+                    "sourceLanguage": "kotlin"
+                  }
+                },
+                "logicalLocations": [
+                  {
+                    "fullyQualifiedName": "My_Application.app.main",
+                    "kind": "module"
+                  }
+                ]
+              }
+            ],
+            "partialFingerprints": {
+              "equalIndicator/v1": "4c0b407f01032b20116d0a01c377a8abb3d536838213a94b6b56ec41cc59ebfd"
+            },
+            "properties": {
+              "ideaSeverity": "ERROR",
+              "qodanaSeverity": "Critical"
+            }
+          }
+        ],
+        "configProfile": "recommended",
+        "deviceId": "200820300000000-0000-0000-0000-000000000000"
+      }
+    }
+  ]
+}

data/spec/sarif_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerSarif do
+    it "should be a plugin" do
+      expect(Danger::DangerSarif.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @sarif = @dangerfile.sarif
+      end
+
+      describe "parse fixtures" do
+        describe "with android-lint.sarif" do
+          subject(:warnings) {
+            @sarif.parse("spec/fixtures/android-lint.sarif", base_dir: "/Users/user_name")
+          }
+          it "have a warning" do
+            expect(warnings.size).to eq 1
+          end
+          it "exact warning" do
+            expect(warnings[0].message).to eq "Duplicate id @+id/view_id, defined or included multiple times in layout/my_layout.xml: [layout/my_layout.xml defines @+id/view_id, layout/my_layout.xml => layout/my_layout2.xml defines @+id/view_id]"
+            expect(warnings[0].file).to eq "app/src/main/res/layout/my_layout.xml"
+            expect(warnings[0].line).to eq 10
+          end
+        end
+        describe "with detekt.sarif" do
+          subject(:warnings) {
+            @sarif.parse("spec/fixtures/detekt.sarif",  base_dir: "/Users/user_name")
+          }
+          it "have a warning" do
+            expect(warnings.size).to eq 1
+          end
+          it "exact warning" do
+            expect(warnings[0].message).to eq "This expression contains a magic number. Consider defining it to a well named constant."
+            expect(warnings[0].file).to eq "app/src/main/kotlin/MyClass.kt"
+            expect(warnings[0].line).to eq 10
+          end
+        end
+        describe "with ktlint.sarif" do
+          subject(:warnings) {
+            @sarif.parse("spec/fixtures/ktlint.sarif", base_dir: "/Users/user_name")
+          }
+          it "have a warning" do
+            expect(warnings.size).to eq 1
+          end
+          it "exact warning" do
+            expect(warnings[0].message).to eq "Error Message from ktlint"
+            expect(warnings[0].file).to eq "project/app/src/main/kotlin/File.kt"
+            expect(warnings[0].line).to eq 10
+          end
+        end
+        describe "with qodana-community-android.sarif" do
+          subject(:warnings) {
+            @sarif.parse("spec/fixtures/qodana-community-android.sarif")
+          }
+          it "have a warning" do
+            expect(warnings.size).to eq 1
+          end
+          it "exact warning" do
+            expect(warnings[0].message).to eq "Function \"GreetingPreview\" is never used"
+            expect(warnings[0].file).to eq "app/src/main/kotlin/com/example/myapplication/MainActivity.kt"
+            expect(warnings[0].line).to eq 42
+          end
+        end
+        describe "with qodana-community-android-short.sarif" do
+          subject(:warnings) {
+            @sarif.parse("spec/fixtures/qodana-community-android-short.sarif")
+          }
+          it "empty warning" do
+            expect(warnings.size).to eq 0
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.unshift("#{ROOT}lib".to_s)
+$:.unshift("#{ROOT}spec".to_s)
+
+require "bundler/setup"
+require "rspec"
+require "danger"
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+
+def testing_env
+  {
+    "GITHUB_ACTION" => "name_of_action",
+    "GITHUB_EVENT_NAME" => "pull_request",
+    "GITHUB_REPOSITORY" => "danger/danger",
+    "GITHUB_EVENT_PATH" => File.expand_path("fixtures/pull_request_event.json", __dir__),
+    "GITHUB_TOKEN" => "github_token"
+  }
+end
+
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end