Added Save in diktat smoke tests

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/smoke/DiktatSmokeTest.kt

@@ -86,7 +86,7 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test with multiplatform project layout`() {
-        fixAndCompare("../../jsMain/kotlin/org/cqfn/diktat/scripts/ScriptExpected.kt",
+        fixAndCompareSmokeTest("../../jsMain/kotlin/org/cqfn/diktat/scripts/ScriptExpected.kt",
             "../../jsMain/kotlin/org/cqfn/diktat/scripts/ScriptTest.kt")
     }
 
@@ -95,19 +95,19 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
     fun `regression - should not fail if package is not set`() {
         overrideRulesConfig(listOf(Warnings.PACKAGE_NAME_MISSING, Warnings.PACKAGE_NAME_INCORRECT_PATH,
             Warnings.PACKAGE_NAME_INCORRECT_PREFIX))
-        fixAndCompare("DefaultPackageExpected.kt", "DefaultPackageTest.kt")
+        fixAndCompareSmokeTest("DefaultPackageExpected.kt", "DefaultPackageTest.kt")
     }
 
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test #7`() {
-        fixAndCompare("Example7Expected.kt", "Example7Test.kt")
+        fixAndCompareSmokeTest("Example7Expected.kt", "Example7Test.kt")
     }
 
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test #6`() {
-        fixAndCompare("Example6Expected.kt", "Example6Test.kt")
+        fixAndCompareSmokeTest("Example6Expected.kt", "Example6Test.kt")
     }
 
     @Test
@@ -131,7 +131,7 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
                 )
             )
         )
-        fixAndCompare("Example5Expected.kt", "Example5Test.kt")
+        fixAndCompareSmokeTest("Example5Expected.kt", "Example5Test.kt")
 
         Assertions.assertFalse(
             unfixedLintErrors.contains(LintError(line = 1, col = 1, ruleId = "diktat-ruleset:comments", detail = "${Warnings.COMMENTED_OUT_CODE.warnText()} /*"))
@@ -145,25 +145,25 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test #4`() {
-        fixAndCompare("Example4Expected.kt", "Example4Test.kt")
+        fixAndCompareSmokeTest("Example4Expected.kt", "Example4Test.kt")
     }
 
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test #3`() {
-        fixAndCompare("Example3Expected.kt", "Example3Test.kt")
+        fixAndCompareSmokeTest("Example3Expected.kt", "Example3Test.kt")
     }
 
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `regression - shouldn't throw exception in cases similar to #371`() {
-        fixAndCompare("Bug1Expected.kt", "Bug1Test.kt")
+        fixAndCompareSmokeTest("Bug1Expected.kt", "Bug1Test.kt")
     }
 
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test #2`() {
-        fixAndCompare("Example2Expected.kt", "Example2Test.kt")
+        fixAndCompareSmokeTest("Example2Expected.kt", "Example2Test.kt")
         unfixedLintErrors.assertEquals(
             LintError(1, 1, "$DIKTAT_RULE_SET_ID:header-comment", "${HEADER_MISSING_IN_NON_SINGLE_CLASS_FILE.warnText()} there are 2 declared classes and/or objects", false),
             LintError(15, 23, "$DIKTAT_RULE_SET_ID:kdoc-methods",
@@ -176,7 +176,7 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test #1`() {
-        fixAndCompare("Example1Expected.kt", "Example1Test.kt")
+        fixAndCompareSmokeTest("Example1Expected.kt", "Example1Test.kt")
         unfixedLintErrors.assertEquals(
             LintError(1, 1, "$DIKTAT_RULE_SET_ID:file-naming", "${FILE_NAME_MATCH_CLASS.warnText()} Example1Test.kt vs Example", true),
             LintError(1, 1, "$DIKTAT_RULE_SET_ID:kdoc-formatting", "${KDOC_NO_EMPTY_TAGS.warnText()} @return", false),
@@ -220,7 +220,7 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test with gradle script plugin`() {
-        fixAndCompare("kotlin-library-expected.gradle.kts", "kotlin-library.gradle.kts")
+        fixAndCompareSmokeTest("kotlin-library-expected.gradle.kts", "kotlin-library.gradle.kts")
         Assertions.assertEquals(
             LintError(2, 1, "$DIKTAT_RULE_SET_ID:comments", "[COMMENTED_OUT_CODE] you should not comment out code, " +
                     "use VCS to save it in history and delete this block: import org.jetbrains.kotlin.gradle.dsl.jvm", false),
@@ -231,14 +231,14 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test with kts files #2`() {
-        fixAndCompare("script/SimpleRunInScriptExpected.kts", "script/SimpleRunInScriptTest.kts")
+        fixAndCompareSmokeTest("script/SimpleRunInScriptExpected.kts", "script/SimpleRunInScriptTest.kts")
         Assertions.assertEquals(3, unfixedLintErrors.size)
     }
 
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `smoke test with kts files with package name`() {
-        fixAndCompare("script/PackageInScriptExpected.kts", "script/PackageInScriptTest.kts")
+        fixAndCompareSmokeTest("script/PackageInScriptExpected.kts", "script/PackageInScriptTest.kts")
         Assertions.assertEquals(3, unfixedLintErrors.size)
     }
 
@@ -254,7 +254,7 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
                 )
             )
         )
-        fixAndCompare("Example1-2Expected.kt", "Example1Test.kt")
+        fixAndCompareSmokeTest("Example1-2Expected.kt", "Example1Test.kt")
         unfixedLintErrors.assertEquals(
             LintError(1, 1, "$DIKTAT_RULE_SET_ID:kdoc-formatting", "${KDOC_NO_EMPTY_TAGS.warnText()} @return", false),
             LintError(3, 1, "$DIKTAT_RULE_SET_ID:kdoc-comments", "${MISSING_KDOC_TOP_LEVEL.warnText()} example", false),
@@ -271,13 +271,13 @@ class DiktatSmokeTest : FixTestBase("test/smoke/src/main/kotlin",
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `regression - should correctly handle tags with empty lines`() {
-        fixAndCompare("KdocFormattingMultilineTagsExpected.kt", "KdocFormattingMultilineTagsTest.kt")
+        fixAndCompareSmokeTest("KdocFormattingMultilineTagsExpected.kt", "KdocFormattingMultilineTagsTest.kt")
     }
 
     @Test
     @Tag("DiktatRuleSetProvider")
     fun `regression - FP of local variables rule`() {
-        fixAndCompare("LocalVariableWithOffsetExpected.kt", "LocalVariableWithOffsetTest.kt")
+        fixAndCompareSmokeTest("LocalVariableWithOffsetExpected.kt", "LocalVariableWithOffsetTest.kt")
         org.assertj.core.api.Assertions.assertThat(unfixedLintErrors).noneMatch {
             it.ruleId == "diktat-ruleset:local-variables"
         }

diktat-rules/src/test/kotlin/org/cqfn/diktat/util/FixTestBase.kt

@@ -39,6 +39,17 @@ open class FixTestBase(protected val resourceFilePath: String,
         )
     }
 
+    /**
+     * @param expectedPath path to file with expected result, relative to [resourceFilePath]
+     * @param testPath path to file with code that will be transformed by formatter, relative to [resourceFilePath]
+     */
+    protected fun fixAndCompareSmokeTest(expectedPath: String, testPath: String) {
+        Assertions.assertTrue(
+            testComparatorUnit
+                .compareFilesFromResources(expectedPath, testPath, true)
+        )
+    }
+
     /**
      * @param expectedPath path to file with expected result, relative to [resourceFilePath]
      * @param testPath path to file with code that will be transformed by formatter, relative to [resourceFilePath]

diktat-rules/src/test/resources/test/smoke/save.toml

@@ -0,0 +1,11 @@
+[general]
+execCmd="./ktlint -R diktat-1.0.0-rc.2.jar"
+tags = ["smokeTest"]
+description = "SmokeTest"
+suiteName = "SmokeTest"
+
+["fix and warn"]
+    ["fix and warn".fix]
+        execFlags="-F"
+    ["fix and warn".warn]
+        actualWarningsPattern="(\\w+\\..+):(\\d+):(\\d+): (\\[.*\\].*)$"

diktat-rules/src/test/resources/test/smoke/src/jsMain/kotlin/org/cqfn/diktat/scripts/ScriptExpected.kt

@@ -5,4 +5,3 @@ import kotlinx.browser.document
 fun main() {
     (document.getElementById("myId") as HTMLElement).click()
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Bug1Expected.kt

@@ -1,12 +1,19 @@
+// ;warn:1:1: [FILE_NAME_MATCH_CLASS] file name is incorrect - it should match with the class described in it if there is the only one class declared: Bug1Expected.kt vs D
 package org.cqfn.diktat
 
+// ;warn:4:1: [MISSING_KDOC_TOP_LEVEL] all public and internal top-level classes and functions should have Kdoc: D (cannot be auto-corrected)
+// ;warn:7:7: [CLASS_NAME_INCORRECT] class/enum/interface name should be in PascalCase and should contain only latin (ASCII) letters or numbers: D
+// ;warn:7:7: [IDENTIFIER_LENGTH] identifier's length is incorrect, it should be in range of [2, 64] symbols: D (cannot be auto-corrected)
 class D {
+    // ;warn:8:5: [MISSING_KDOC_CLASS_ELEMENTS] all public, internal and protected classes, functions and variables inside the class should have Kdoc: x (cannot be auto-corrected)
     val x = 0
+    // ;warn:13:8: [KDOC_NO_EMPTY_TAGS] no empty descriptions in tag blocks are allowed: @return (cannot be auto-corrected)
 
     /**
      * @return
      */
     fun bar(): Bar {
+        // ;warn:17:19: [MAGIC_NUMBER] avoid using magic numbers, instead define constants with clear names describing what the magic number means: 42 (cannot be auto-corrected)
         val qux = 42
         return Bar(qux)
     }
@@ -18,4 +25,3 @@ class D {
 fun readFile(foo: Foo) {
     var bar: Bar
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/DefaultPackageExpected.kt

@@ -1,6 +1,10 @@
+@file:Suppress(
+    "PACKAGE_NAME_MISSING",
+    "PACKAGE_NAME_INCORRECT_PATH",
+    "PACKAGE_NAME_INCORRECT_PREFIX"
+)
 
 /**
  * Dolor sit amet
  */
 class Example
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/DefaultPackageTest.kt

@@ -1,4 +1,8 @@
-
+@file:Suppress(
+    "PACKAGE_NAME_MISSING",
+    "PACKAGE_NAME_INCORRECT_PATH",
+    "PACKAGE_NAME_INCORRECT_PREFIX"
+)
 /**
  * Dolor sit amet
  */

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example1-2Expected.kt

@@ -45,4 +45,3 @@ fun foo(x :  Int
   )
     }
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example1Expected.kt

@@ -41,4 +41,3 @@ class Example {
                     bar(x, y)
             )
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example2Expected.kt

@@ -50,4 +50,3 @@ private fun foo(node: ASTNode) {
 
     setOf<Object>(IOException(), Properties(), LoggerFactory())
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example3Expected.kt

@@ -68,4 +68,3 @@ fun mains() {
         }
     httpClient.doRequest()
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example4Expected.kt

@@ -57,4 +57,3 @@ fun foo() {
     val y = "akgjsaujtmaksdkfasakgjsaujtmaksdkfasakgjsaujtmaksdkfasakgjsaujtm" +
             " aksdkfasfasakgjsaujtmaksdfasafasakgjsaujtmaksdfasakgjsaujtmaksdfasakgjsaujtmaksdfasakgjsaujtmaksdfasakgjsaujtmaksdkgjsaujtmaksdfasakgjsaujtmaksd"
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example5Expected.kt

@@ -12,4 +12,3 @@ package org.cqfn.diktat
 class Some {
     val config = Config()
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example6Expected.kt

@@ -24,4 +24,3 @@ val dockerFileAsText =
             COPY resources $resourcesPath
             RUN /bin/bash
         """.trimIndent()  // RUN command shouldn't matter because it will be replaced on container creation
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example7Expected.kt

@@ -20,4 +20,3 @@ fun foo() {
             doSmth()
         }
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/KdocFormattingMultilineTagsExpected.kt

@@ -19,4 +19,3 @@ fun foo1(bar: Bar): Baz {
 fun foo2(bar: Bar): Baz {
     // placeholder
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/LocalVariableWithOffsetExpected.kt

@@ -6,4 +6,3 @@ override fun boo() {
         handleTestFile(chunk.map { it.single() }, warnPluginConfig, generalConfig)
     }.forEach { listTestResult.addAll(it) }
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/kotlin-library-expected.gradle.kts

@@ -4,4 +4,3 @@ import org.gradle.kotlin.dsl.plugins
 plugins {
     kotlin("jvm")
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/script/PackageInScriptExpected.kts

@@ -17,4 +17,3 @@ run {
 also {
     println("a")
 }
-

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/script/SimpleRunInScriptExpected.kts

@@ -16,4 +16,3 @@ run {
 also {
     println("a")
 }
-

diktat-test-framework/src/main/kotlin/org/cqfn/diktat/test/framework/processing/FileComparator.kt

@@ -40,14 +40,22 @@ class FileComparator {
      * @return true in case files are different
      * false - in case they are equals
      */
-    @Suppress("ReturnCount", "FUNCTION_BOOLEAN_PREFIX")
+    @Suppress(
+        "ReturnCount",
+        "FUNCTION_BOOLEAN_PREFIX",
+        "TOO_LONG_FUNCTION")
     fun compareFilesEqual(): Boolean {
         try {
             val expect = readFile(expectedResultFile.absolutePath)
             if (expect.isEmpty()) {
                 return false
             }
-            val patch = diff(expect, actualResultList)
+            val regex = (".*// ;warn:(\\d+):(\\d+): (.*)").toRegex()
+            val expectWithoutWarn = expect.filter { line ->
+                !line.contains(regex)
+            }
+            val patch = diff(expectWithoutWarn, actualResultList)
+
             if (patch.deltas.isEmpty()) {
                 return true
             }

diktat-test-framework/src/main/kotlin/org/cqfn/diktat/test/framework/processing/TestComparatorUnit.kt

@@ -21,10 +21,14 @@ class TestComparatorUnit(private val resourceFilePath: String,
     /**
      * @param expectedResult
      * @param testFileStr
+     * @param trimLastEmptyLine
      * @return true if transformed file equals expected result, false otherwise
      */
     @Suppress("FUNCTION_BOOLEAN_PREFIX")
-    fun compareFilesFromResources(expectedResult: String, testFileStr: String): Boolean {
+    fun compareFilesFromResources(
+        expectedResult: String,
+        testFileStr: String,
+        trimLastEmptyLine: Boolean = false): Boolean {
         val expectedPath = javaClass.classLoader.getResource("$resourceFilePath/$expectedResult")
         val testPath = javaClass.classLoader.getResource("$resourceFilePath/$testFileStr")
         if (testPath == null || expectedPath == null) {
@@ -43,6 +47,12 @@ class TestComparatorUnit(private val resourceFilePath: String,
             copyTestFile.absolutePath
         )
 
+        if (trimLastEmptyLine) {
+            val actual: MutableList<String> = mutableListOf()
+            actual.addAll(actualResult.split("\n").dropLast(1))
+            return FileComparator(expectedFile, actual).compareFilesEqual()
+        }
+
         // fixme: actualResult is separated by KtLint#determineLneSeparator, should be split by it here too
         return FileComparator(expectedFile, actualResult.split("\n")).compareFilesEqual()
     }