Adding the support for the actual input of analyzers in SARIF format (#357)

### What's done:
- supported reading of actual warnings in SARIF format

Author: orchestr7

buildSrc/src/main/kotlin/Versions.kt

@@ -2,9 +2,14 @@
 
 object Versions {
     object IntegrationTest {
-        const val ktlint = "0.39.0"
+        const val ktlint = "0.43.2"
         const val ktlintLink = "https://github.com/pinterest/ktlint/releases/download/$ktlint/ktlint"
-        const val diktat = "1.0.0-rc.2"
+        const val diktat = "1.0.2"
         const val diktatLink = "https://github.com/cqfn/diKTat/releases/download/v$diktat/diktat-$diktat.jar"
+
+        const val oldKtlint = "0.39.0"
+        const val oldKtlintLink = "https://github.com/pinterest/ktlint/releases/download/$oldKtlint/ktlint"
+        const val oldDiktat = "1.0.0-rc.2"
+        const val oldDiktatLink = "https://github.com/cqfn/diKTat/releases/download/v$oldDiktat/diktat-$oldDiktat.jar"
     }
 }

buildSrc/src/main/kotlin/org/cqfn/save/buildutils/DiktatConfiguration.kt

@@ -33,6 +33,8 @@ fun Project.createDiktatTask() {
         apply<DiktatGradlePlugin>()
         configure<DiktatExtension> {
             diktatConfigFile = rootProject.file("diktat-analysis.yml")
+            // FixMe: temporary before the release 1.0.3 of diktat
+            // reporterType = "sarif"
             inputs {
                 include(
                     "$rootDir/buildSrc/src/**/*.kt",
@@ -54,4 +56,9 @@ fun Project.createDiktatTask() {
             tasks.findByName("diktatFix")?.let { this@register.dependsOn(it) }
         }
     }
+
+    // FixMe: temporary before the release 1.0.3 of diktat
+    /* this.configurations.getByName("diktat").dependencies.add(
+        this.dependencies.create("com.pinterest.ktlint:ktlint-reporter-sarif:0.43.2")
+    ) */
 }

examples/kotlin-diktat/fix_and_warn/save.toml

@@ -2,7 +2,6 @@
 tags = ["fix and warn"]
 description = "Autofixing of issues discovered by diKTat on smoke tests and warn about issues, which couldn't be auto-corrected"
 suiteName = "Autofix and Warn"
-execCmd = "java -jar ktlint -R diktat.jar"
 
 ["fix and warn"]
     ["fix and warn".fix]

examples/kotlin-diktat/sarif-actual/save.toml

@@ -0,0 +1,21 @@
+[general]
+    tags = ["warn", "sarif"]
+    description = "Test warnings discovered by diKTat, reading expected warnings from SARIF file"
+    suiteName = "Only Warnings: with SARIF format"
+    expectedWarningsPattern = "// ;warn:?(.*):(\\d+):? ?(.+)?"
+    execCmd = "java -jar ktlint --disabled_rules=standard -R diktat.jar"
+
+
+
+[warn]
+    execFlags = "--reporter=sarif"
+    # regular expression to detect tests
+    testNameRegex = ".*Test.kt"
+    actualWarningsFormat = "SARIF"
+    fileNameCaptureGroupOut = 1
+    lineCaptureGroupOut = 2
+    columnCaptureGroupOut = 3
+    messageCaptureGroupOut = 4
+    exactWarningsMatch = false
+    warningTextHasColumn = true
+    warningTextHasLine = true

…rif/src/kotlin/EnumValueSnakeCaseTest.kt …ual/src/kotlin/EnumValueSnakeCaseTest.ktexamples/kotlin-diktat/sarif/src/kotlin/EnumValueSnakeCaseTest.kt renamed to examples/kotlin-diktat/sarif-actual/src/kotlin/EnumValueSnakeCaseTest.kt examples/kotlin-diktat/sarif/src/kotlin/EnumValueSnakeCaseTest.kt renamed to examples/kotlin-diktat/sarif-actual/src/kotlin/EnumValueSnakeCaseTest.kt

@@ -0,0 +1,15 @@
+package org.cqfn.diktat.test.resources.test.paragraph1.naming.enum_
+
+// ;warn:3:1: [MISSING_KDOC_TOP_LEVEL] all public and internal top-level classes and functions should have Kdoc: EnumValueSnakeCaseTest (cannot be auto-corrected)
+// ;warn:35: [WRONG_DECLARATIONS_ORDER] declarations of constants and enum members should be sorted alphabetically: enum entries order is incorrect
+// ;warn:10:5: [ENUMS_SEPARATED] enum is incorrectly formatted: enums must end with semicolon
+enum class EnumValueSnakeCaseTest {
+    // ;warn:$line+1:5: [ENUM_VALUE] enum values should be{{ in }}selected UPPER_CASE snake/PascalCase format: paSC_SAl_l
+    paSC_SAl_l,
+
+    // ;warn:5: [ENUM_VALUE] enum values{{ should }}be in selected{{ UPPER_CASE }}snake/PascalCase format: PascAsl_f
+    PascAsl_f
+    // ;warn:$line-2:5: [ENUMS_SEPARATED] enum is incorrectly formatted: last enum entry must end with a comma
+
+    // ;warn:1:9: {{.*}}[PACKAGE_NAME_INCORRECT_PREFIX] package name should start from company's domain: org.cqfn.save{{.*}}
+}

…/kotlin-diktat/sarif/save-warnings.sarif …iktat/sarif-expected/save-warnings.sarifexamples/kotlin-diktat/sarif/save-warnings.sarif renamed to examples/kotlin-diktat/sarif-expected/save-warnings.sarif examples/kotlin-diktat/sarif/save-warnings.sarif renamed to examples/kotlin-diktat/sarif-expected/save-warnings.sarif

@@ -1,5 +1,5 @@
 [general]
-    execCmd = "java -jar ktlint -R diktat.jar"
+    execCmd = "java -jar ktlint-old --disabled_rules=standard -R diktat-old.jar"
     description = "Test for diktat - linter and formatter for Kotlin"
     language = "Kotlin"
     # this is the default value, you don't need to add it explicitly, but can be useful, if you have different pattern:

examples/kotlin-diktat/sarif/save.toml …s/kotlin-diktat/sarif-expected/save.tomlexamples/kotlin-diktat/sarif/save.toml renamed to examples/kotlin-diktat/sarif-expected/save.toml examples/kotlin-diktat/sarif/save.toml renamed to examples/kotlin-diktat/sarif-expected/save.toml

@@ -1,5 +1,5 @@
 [general]
-    execCmd = "java -jar ktlint --disabled_rules=standard -R diktat.jar"
+    execCmd = "java -jar ktlint-old --disabled_rules=standard -R diktat-old.jar"
     tags = ["warn"]
     description = "Test for directory mode"