ignoreLines feature for filtering the input file

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/IgnoreLines/Bug1Expected.kt

@@ -0,0 +1,21 @@
+package org.cqfn.save.IgnoreLinesTest.IgnoreLines
+
+class D {
+    val x = 0
+
+    /**
+     * @return
+     */
+    fun bar(): Bar {
+        val qux = 42
+        return Bar(qux)
+    }
+}
+
+/**
+ * @param foo
+ */
+fun readFile(foo: Foo) {
+    var bar: Bar
+}
+// ;warn:0: [TEST] JUST_A_TEST

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/IgnoreLines/Bug1Test.kt

@@ -0,0 +1,12 @@
+package test.smoke.src.main.kotlin
+
+fun readFile(foo: Foo) {
+    var bar: Bar
+}
+
+class D {val x = 0
+fun bar(): Bar {val qux = 42; return Bar(qux)}
+}
+// ;warn:0: [TEST] JUST_A_TEST
+// IGNORE_ME
+# I WILL DISSAPEAR AS WELL

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/IgnoreLines/save.toml

@@ -0,0 +1,7 @@
+[general]
+    tags = ["FixIgnoreLines"]
+    description = "Test for ignoreLines option in Fix"
+    suiteName = "Autofix: Smoke Tests"
+
+[fix]
+    ignoreLines = ["^// IGNORE.*", "^#.*"]

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/IgnoreLinesIsEmpty/Bug1Expected.kt

@@ -0,0 +1,22 @@
+package org.cqfn.save.IgnoreLinesTest.IgnoreLinesIsEmpty
+
+class D {
+    val x = 0
+
+    /**
+     * @return
+     */
+    fun bar(): Bar {
+        val qux = 42
+        return Bar(qux)
+    }
+}
+
+/**
+ * @param foo
+ */
+fun readFile(foo: Foo) {
+    var bar: Bar
+}
+// ;warn:0: [TEST] JUST_A_TEST
+// IGNORE_ME

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/IgnoreLinesIsEmpty/Bug1Test.kt

@@ -0,0 +1,11 @@
+package test.smoke.src.main.kotlin
+
+fun readFile(foo: Foo) {
+    var bar: Bar
+}
+
+class D {val x = 0
+fun bar(): Bar {val qux = 42; return Bar(qux)}
+}
+// ;warn:0: [TEST] JUST_A_TEST
+// IGNORE_ME

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/IgnoreLinesIsEmpty/save.toml

@@ -0,0 +1,7 @@
+[general]
+    tags = ["smoke"]
+    description = "Smoke tests for diktat"
+    suiteName = "Autofix: Smoke Tests"
+
+[fix]
+    ignoreLines = []

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/NoIgnoreLines/Bug1Expected.kt

@@ -0,0 +1,21 @@
+package org.cqfn.save.IgnoreLinesTest.NoIgnoreLines
+
+class D {
+    val x = 0
+
+    /**
+     * @return
+     */
+    fun bar(): Bar {
+        val qux = 42
+        return Bar(qux)
+    }
+}
+
+/**
+ * @param foo
+ */
+fun readFile(foo: Foo) {
+    var bar: Bar
+}
+// IGNORE_ME

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/NoIgnoreLines/Bug1Test.kt

@@ -0,0 +1,11 @@
+package test.smoke.src.main.kotlin
+
+fun readFile(foo: Foo) {
+    var bar: Bar
+}
+
+class D {val x = 0
+fun bar(): Bar {val qux = 42; return Bar(qux)}
+}
+// ;warn:0: [TEST] JUST_A_TEST
+// IGNORE_ME

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/NoIgnoreLines/save.toml

@@ -0,0 +1,6 @@
+[general]
+    tags = ["smoke"]
+    description = "Smoke tests for diktat"
+    suiteName = "Autofix: Smoke Tests"
+
+[fix]

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/save/chapter1/save.toml

@@ -0,0 +1,6 @@
+[general]
+    tags = ["smoke"]
+    description = "Smoke tests for diktat"
+    suiteName = "Autofix: Smoke Tests"
+
+[fix]

examples/kotlin-diktat/save.toml

@@ -5,4 +5,3 @@
     expectedWarningsPattern = "// ;warn:?(.*):(\\d*): (.+)"
     timeOutMillis = 30000
 
-

examples/kotlin-diktat/warn/chapter1/IgnoreLinesTest/EnumTestDetection.kt

@@ -0,0 +1,16 @@
+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: EnumTestDetection (cannot be auto-corrected)
+// ;warn:30: [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 EnumTestDetection {
+    // ;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{{.*}}
+}
+// ;warn:0:0: [YOU SHOULD NOT SEE THIS] this warning should not be shown

examples/kotlin-diktat/warn/chapter1/IgnoreLinesTest/save.toml

@@ -0,0 +1,7 @@
+[general]
+    tags = ["WarnIgnoreLines"]
+    description = "Test suite that checks if filtering by regex work."
+
+[warn]
+    testNameRegex = "^E.*T.*D.*"
+    ignoreLines = [".*// ;warn:0:0: \\[YOU SHOULD NOT SEE THIS\\] this warning should not be shown.*"]

examples/kotlin-diktat/warn/save.toml

@@ -17,4 +17,4 @@
     messageCaptureGroupOut = 4
     exactWarningsMatch = false
     warningTextHasColumn = true
-    warningTextHasLine = true
+    warningTextHasLine = true

save-common/src/commonMain/kotlin/org/cqfn/save/core/plugin/PluginConfig.kt

@@ -25,6 +25,11 @@ interface PluginConfig {
      */
     val type: TestConfigSections
 
+    /**
+     * list of regexes to be ignored
+     */
+    val ignoreLinesPatterns: MutableList<Regex>
+
     /**
      * Location of the toml config
      */
@@ -76,6 +81,7 @@ data class GeneralConfig(
     val timeOutMillis: Long? = null,
 ) : PluginConfig {
     override val type = TestConfigSections.GENERAL
+    override val ignoreLinesPatterns: MutableList<Regex> = mutableListOf()
 
     @Transient
     override var configLocation: Path = "undefined_toml_location".toPath()

save-core/src/commonNonJsTest/kotlin/org/cqfn/save/core/integration/ClassicFixTest.kt

@@ -19,7 +19,7 @@ class ClassicFixTest {
         runTestsWithDiktat(
             listOf(
                 "fix/save.toml"
-            ), 2
+            ), 5
         )
     }
 
@@ -28,7 +28,43 @@ class ClassicFixTest {
         runTestsWithDiktat(
             listOf(
                 "fix/smoke/save.toml"
-            ), 2
+            ), 5
+        )
+    }
+
+    @Test
+    fun `execute fix plugin on folder`() {
+        runTestsWithDiktat(
+            listOf(
+                "fix/smoke/src/main/kotlin/org/cqfn/save/"
+            ), 5
+        )
+    }
+
+    @Test
+    fun `check NoIgnoreLines`() {
+        runTestsWithDiktat(
+            listOf(
+                "fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/NoIgnoreLines"
+            ), 1
+        )
+    }
+
+    @Test
+    fun `check IgnoreLinesIsEmpty`() {
+        runTestsWithDiktat(
+            listOf(
+                "fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/IgnoreLinesIsEmpty"
+            ), 1
+        )
+    }
+
+    @Test
+    fun `check IgnoreLines`() {
+        runTestsWithDiktat(
+            listOf(
+                "fix/smoke/src/main/kotlin/org/cqfn/save/IgnoreLinesTest/IgnoreLines"
+            ), 1
         )
     }
 }

save-core/src/commonNonJsTest/kotlin/org/cqfn/save/core/integration/ClassicWarnTest.kt

@@ -46,7 +46,7 @@ class ClassicWarnTest {
         runTestsWithDiktat(
             listOf(
                 "warn/chapter1"
-            ), 6
+            ), 7
         )
     }
 
@@ -59,6 +59,15 @@ class ClassicWarnTest {
         )
     }
 
+    @Test
+    fun `lines that match ignoreLines should be ignored`() {
+        runTestsWithDiktat(
+            listOf(
+                "warn/chapter1/IgnoreLinesTest"
+            ), 1
+        )
+    }
+
     @Test
     fun `test output file set`() {
         runTestsWithDiktat(
@@ -85,7 +94,7 @@ class ClassicWarnTest {
         runTestsWithDiktat(
             listOf(
                 "warn/save.toml"
-            ), 8
+            ), 9
         )
     }
 
@@ -94,16 +103,7 @@ class ClassicWarnTest {
         runTestsWithDiktat(
             listOf(
                 "warn/chapter1/save.toml"
-            ), 6
-        )
-    }
-
-    @Test
-    fun `executing warn plugin so that no resources will be found`() {
-        runTestsWithDiktat(
-            listOf(
-                "warn/chapter1/TestsWithRegex/NoMatchingTests/",
-            ), 0
+            ), 7
         )
     }
 

save-core/src/commonNonJsTest/kotlin/org/cqfn/save/core/integration/FixDirTest.kt

@@ -6,7 +6,7 @@ import kotlin.test.Test
 class FixDirTest {
     @Test
     fun `execute fix plugin`() {
-        runTestsWithDiktat(listOf("fix/smoke/src/main/kotlin/org/cqfn/save"), 2)
+        runTestsWithDiktat(listOf("fix/smoke/src/main/kotlin/org/cqfn/save"), 5)
     }
 
     @Test

save-plugins/fix-and-warn-plugin/src/commonMain/kotlin/org/cqfn/save/plugins/fixandwarn/FixAndWarnPlugin.kt

@@ -138,7 +138,6 @@ class FixAndWarnPlugin(
         files.forEach { file ->
             val fileData = fs.readLines(file)
             filesAndTheirWarningsMap[file] = mutableListOf()
-
             val fileDataWithoutWarnings = fileData.filterIndexed { index, line ->
                 val isLineWithWarning = (generalConfig.expectedWarningsPattern!!.find(line)?.groups != null)
                 if (isLineWithWarning) {

save-plugins/fix-and-warn-plugin/src/commonMain/kotlin/org/cqfn/save/plugins/fixandwarn/FixAndWarnPluginConfig.kt

@@ -26,14 +26,19 @@ data class FixAndWarnPluginConfig(
     override var configLocation: Path = "undefined_toml_location".toPath()
     override val resourceNamePatternStr: String = "(${fix.resourceNamePatternStr})|(${warn.resourceNamePatternStr})"
 
+    @Transient
+    override val ignoreLinesPatterns: MutableList<Regex> = mutableListOf()
+
     override fun mergeWith(otherConfig: PluginConfig): PluginConfig {
         val other = otherConfig as FixAndWarnPluginConfig
         val mergedFixPluginConfig = fix.mergeWith(other.fix)
         val mergedWarnPluginConfig = warn.mergeWith(other.warn)
         return FixAndWarnPluginConfig(
             mergedFixPluginConfig as FixPluginConfig,
             mergedWarnPluginConfig as WarnPluginConfig
-        ).also { it.configLocation = this.configLocation }
+        ).also {
+            it.configLocation = this.configLocation
+        }
     }
 
     override fun validateAndSetDefaults(): PluginConfig {
@@ -49,6 +54,8 @@ data class FixAndWarnPluginConfig(
         return FixAndWarnPluginConfig(
             fix.validateAndSetDefaults(),
             warn.validateAndSetDefaults()
-        ).also { it.configLocation = this.configLocation }
+        ).also {
+            it.configLocation = this.configLocation
+        }
     }
 }