WRONG_INDENTATION: add more tests for extendedIndentAfterOperators (

#1401) * `WRONG_INDENTATION`: add more tests for `extendedIndentAfterOperators` ### What's done: * Tests for expressions wrapped on an operator have been added. * Both cases (when `extendedIndentAfterOperators` is `true` and `false`) are tested. * Both binary operators and functions are tested. * Test resources extracted into a separate class so that DeteKT remains quiet. * Related: #1340
saveourtool · Jun 27, 2022 · 5f77cad · 5f77cad
1 parent 0351f52
commit 5f77cad
Show file tree

Hide file tree

Showing 9 changed files with 1,099 additions and 563 deletions.
diff --git a/diktat-analysis.yml b/diktat-analysis.yml
@@ -282,6 +282,9 @@
 # Checks that backticks (``) are not used in the identifier name, except the case when it is test method (marked with @Test annotation)
 - name: BACKTICKS_PROHIBITED
   enabled: true
+  # all code blocks annotated with  @Nested, @ParameterizedTest (JUnit 5) will
+  # be ignored and not checked.
+  ignoreAnnotated: [ Nested, ParameterizedTest ]
 # Checks that a single line concatenation of strings is not used
 - name: STRING_CONCATENATION
   enabled: true

diff --git a/diktat-rules/pom.xml b/diktat-rules/pom.xml
@@ -69,6 +69,11 @@
             <artifactId>junit-jupiter</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.junit.platform</groupId>
+            <artifactId>junit-platform-suite-engine</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.assertj</groupId>
             <artifactId>assertj-core</artifactId>

diff --git a/...t-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/spaces/IndentationRuleFixTest.kt b/...t-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/spaces/IndentationRuleFixTest.kt
@@ -1,22 +1,37 @@
 package org.cqfn.diktat.ruleset.chapter3.spaces
 
 import org.cqfn.diktat.common.config.rules.RulesConfig
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestMixin.IndentationConfig
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestMixin.asRulesConfigList
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestMixin.asSequenceWithConcatenation
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestMixin.describe
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestMixin.extendedIndent
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestMixin.withCustomParameters
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestResources.expressionBodyFunctionsContinuationIndent
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestResources.expressionBodyFunctionsSingleIndent
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestResources.expressionsWrappedAfterOperatorContinuationIndent
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestResources.expressionsWrappedAfterOperatorSingleIndent
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestResources.whitespaceInStringLiteralsContinuationIndent
+import org.cqfn.diktat.ruleset.chapter3.spaces.IndentationRuleTestResources.whitespaceInStringLiteralsSingleIndent
 import org.cqfn.diktat.ruleset.constants.Warnings.WRONG_INDENTATION
 import org.cqfn.diktat.ruleset.rules.chapter3.files.IndentationRule
 import org.cqfn.diktat.util.FixTestBase
 
 import generated.WarningNames
 import org.assertj.core.api.SoftAssertions.assertSoftly
 import org.intellij.lang.annotations.Language
-import org.junit.jupiter.api.MethodOrderer.MethodName
+import org.junit.jupiter.api.MethodOrderer.DisplayName
+import org.junit.jupiter.api.Nested
 import org.junit.jupiter.api.Tag
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.TestMethodOrder
 import org.junit.jupiter.api.io.TempDir
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.ValueSource
 
 import java.nio.file.Path
 
-@TestMethodOrder(MethodName::class)
+@TestMethodOrder(DisplayName::class)
 class IndentationRuleFixTest : FixTestBase("test/paragraph3/indentation",
     ::IndentationRule,
     listOf(
@@ -30,7 +45,7 @@ class IndentationRuleFixTest : FixTestBase("test/paragraph3/indentation",
             )
         )
     )
-), IndentationRuleTestMixin {
+) {
     @Test
     @Tag(WarningNames.WRONG_INDENTATION)
     fun `parameters should be properly aligned`() {
@@ -61,138 +76,6 @@ class IndentationRuleFixTest : FixTestBase("test/paragraph3/indentation",
         fixAndCompare("MultilionStringExpected.kt", "MultilionStringTest.kt")
     }
 
-    /**
-     * This test has a counterpart under [IndentationRuleWarnTest].
-     *
-     * See [#1330](https://github.com/saveourtool/diktat/issues/1330).
-     */
-    @Test
-    @Tag(WarningNames.WRONG_INDENTATION)
-    fun `expression body functions should remain unchanged if properly indented (extendedIndentAfterOperators = true)`(@TempDir tempDir: Path) {
-        val defaultConfig = IndentationConfig("newlineAtEnd" to false)
-        val customConfig = defaultConfig.withCustomParameters("extendedIndentAfterOperators" to true)
-
-        lintMultipleMethods(
-            expressionBodyFunctionsContinuationIndent,
-            tempDir = tempDir,
-            rulesConfigList = customConfig.asRulesConfigList())
-    }
-
-    /**
-     * This test has a counterpart under [IndentationRuleWarnTest].
-     *
-     * See [#1330](https://github.com/saveourtool/diktat/issues/1330).
-     */
-    @Test
-    @Tag(WarningNames.WRONG_INDENTATION)
-    fun `expression body functions should remain unchanged if properly indented (extendedIndentAfterOperators = false)`(@TempDir tempDir: Path) {
-        val defaultConfig = IndentationConfig("newlineAtEnd" to false)
-        val customConfig = defaultConfig.withCustomParameters("extendedIndentAfterOperators" to false)
-
-        lintMultipleMethods(
-            expressionBodyFunctionsSingleIndent,
-            tempDir = tempDir,
-            rulesConfigList = customConfig.asRulesConfigList())
-    }
-
-    /**
-     * This test has a counterpart under [IndentationRuleWarnTest].
-     *
-     * See [#1330](https://github.com/saveourtool/diktat/issues/1330).
-     */
-    @Test
-    @Tag(WarningNames.WRONG_INDENTATION)
-    fun `expression body functions should be reformatted if mis-indented (extendedIndentAfterOperators = true)`(@TempDir tempDir: Path) {
-        val defaultConfig = IndentationConfig("newlineAtEnd" to false)
-        val customConfig = defaultConfig.withCustomParameters("extendedIndentAfterOperators" to true)
-
-        lintMultipleMethods(
-            actualContent = expressionBodyFunctionsSingleIndent,
-            expectedContent = expressionBodyFunctionsContinuationIndent,
-            tempDir = tempDir,
-            rulesConfigList = customConfig.asRulesConfigList())
-    }
-
-    /**
-     * This test has a counterpart under [IndentationRuleWarnTest].
-     *
-     * See [#1330](https://github.com/saveourtool/diktat/issues/1330).
-     */
-    @Test
-    @Tag(WarningNames.WRONG_INDENTATION)
-    fun `expression body functions should be reformatted if mis-indented (extendedIndentAfterOperators = false)`(@TempDir tempDir: Path) {
-        val defaultConfig = IndentationConfig("newlineAtEnd" to false)
-        val customConfig = defaultConfig.withCustomParameters("extendedIndentAfterOperators" to false)
-
-        lintMultipleMethods(
-            actualContent = expressionBodyFunctionsContinuationIndent,
-            expectedContent = expressionBodyFunctionsSingleIndent,
-            tempDir = tempDir,
-            rulesConfigList = customConfig.asRulesConfigList())
-    }
-
-    /**
-     * See [#1347](https://github.com/saveourtool/diktat/issues/1347).
-     */
-    @Test
-    @Tag(WarningNames.WRONG_INDENTATION)
-    fun `no whitespace should be injected into multi-line string literals (code matches settings, extendedIndent = true)`(@TempDir tempDir: Path) {
-        val defaultConfig = IndentationConfig("newlineAtEnd" to false)
-        val customConfig = defaultConfig.withCustomParameters(*extendedIndent(enabled = true))
-
-        lintMultipleMethods(
-            whitespaceInStringLiteralsContinuationIndent,
-            tempDir = tempDir,
-            rulesConfigList = customConfig.asRulesConfigList())
-    }
-
-    /**
-     * See [#1347](https://github.com/saveourtool/diktat/issues/1347).
-     */
-    @Test
-    @Tag(WarningNames.WRONG_INDENTATION)
-    fun `no whitespace should be injected into multi-line string literals (code matches settings, extendedIndent = false)`(@TempDir tempDir: Path) {
-        val defaultConfig = IndentationConfig("newlineAtEnd" to false)
-        val customConfig = defaultConfig.withCustomParameters(*extendedIndent(enabled = false))
-
-        lintMultipleMethods(
-            whitespaceInStringLiteralsSingleIndent,
-            tempDir = tempDir,
-            rulesConfigList = customConfig.asRulesConfigList())
-    }
-
-    /**
-     * See [#1347](https://github.com/saveourtool/diktat/issues/1347).
-     */
-    @Test
-    @Tag(WarningNames.WRONG_INDENTATION)
-    fun `no whitespace should be injected into multi-line string literals (mis-indented code reformatted, extendedIndent = true)`(@TempDir tempDir: Path) {
-        val defaultConfig = IndentationConfig("newlineAtEnd" to false)
-        val customConfig = defaultConfig.withCustomParameters(*extendedIndent(enabled = true))
-
-        lintMultipleMethods(
-            actualContent = whitespaceInStringLiteralsSingleIndent,
-            expectedContent = whitespaceInStringLiteralsContinuationIndent,
-            tempDir = tempDir,
-            rulesConfigList = customConfig.asRulesConfigList())
-    }
-
-    /**
-     * See [#1347](https://github.com/saveourtool/diktat/issues/1347).
-     */
-    @Test
-    @Tag(WarningNames.WRONG_INDENTATION)
-    fun `no whitespace should be injected into multi-line string literals (mis-indented code reformatted, extendedIndent = false)`(@TempDir tempDir: Path) {
-        val defaultConfig = IndentationConfig("newlineAtEnd" to false)
-        val customConfig = defaultConfig.withCustomParameters(*extendedIndent(enabled = false))
-
-        lintMultipleMethods(
-            actualContent = whitespaceInStringLiteralsContinuationIndent,
-            expectedContent = whitespaceInStringLiteralsSingleIndent,
-            tempDir = tempDir,
-            rulesConfigList = customConfig.asRulesConfigList())
-    }
-
     /**
      * @param actualContent the original file content (may well be modified as
      *   fixes are applied).
@@ -230,4 +113,148 @@ class IndentationRuleFixTest : FixTestBase("test/paragraph3/indentation",
             }
         }
     }
+
+    /**
+     * See [#1330](https://github.com/saveourtool/diktat/issues/1330).
+     */
+    @Nested
+    @TestMethodOrder(DisplayName::class)
+    inner class `Expression body functions` {
+        @ParameterizedTest(name = "extendedIndentAfterOperators = {0}")
+        @ValueSource(booleans = [false, true])
+        @Tag(WarningNames.WRONG_INDENTATION)
+        fun `should remain unchanged if properly indented`(extendedIndentAfterOperators: Boolean, @TempDir tempDir: Path) {
+            val defaultConfig = IndentationConfig("newlineAtEnd" to false)
+            val customConfig = defaultConfig.withCustomParameters("extendedIndentAfterOperators" to extendedIndentAfterOperators)
+
+            val expressionBodyFunctions = when {
+                extendedIndentAfterOperators -> expressionBodyFunctionsContinuationIndent
+                else -> expressionBodyFunctionsSingleIndent
+            }
+
+            lintMultipleMethods(
+                expressionBodyFunctions,
+                tempDir = tempDir,
+                rulesConfigList = customConfig.asRulesConfigList())
+        }
+
+        @ParameterizedTest(name = "extendedIndentAfterOperators = {0}")
+        @ValueSource(booleans = [false, true])
+        @Tag(WarningNames.WRONG_INDENTATION)
+        fun `should be reformatted if mis-indented`(extendedIndentAfterOperators: Boolean, @TempDir tempDir: Path) {
+            val defaultConfig = IndentationConfig("newlineAtEnd" to false)
+            val customConfig = defaultConfig.withCustomParameters("extendedIndentAfterOperators" to extendedIndentAfterOperators)
+
+            val expressionBodyFunctionsActual = when {
+                extendedIndentAfterOperators -> expressionBodyFunctionsSingleIndent
+                else -> expressionBodyFunctionsContinuationIndent
+            }
+            val expressionBodyFunctionsExpected = when {
+                extendedIndentAfterOperators -> expressionBodyFunctionsContinuationIndent
+                else -> expressionBodyFunctionsSingleIndent
+            }
+
+            lintMultipleMethods(
+                actualContent = expressionBodyFunctionsActual,
+                expectedContent = expressionBodyFunctionsExpected,
+                tempDir = tempDir,
+                rulesConfigList = customConfig.asRulesConfigList())
+        }
+    }
+
+    /**
+     * See [#1347](https://github.com/saveourtool/diktat/issues/1347).
+     */
+    @Nested
+    @TestMethodOrder(DisplayName::class)
+    inner class `Multi-line string literals` {
+        @ParameterizedTest(name = "extendedIndent = {0}")
+        @ValueSource(booleans = [false, true])
+        @Tag(WarningNames.WRONG_INDENTATION)
+        fun `no whitespace should be injected (code matches settings)`(extendedIndent: Boolean, @TempDir tempDir: Path) {
+            val defaultConfig = IndentationConfig("newlineAtEnd" to false)
+            val customConfig = defaultConfig.withCustomParameters(*extendedIndent(enabled = extendedIndent))
+
+            val whitespaceInStringLiterals = when {
+                extendedIndent -> whitespaceInStringLiteralsContinuationIndent
+                else -> whitespaceInStringLiteralsSingleIndent
+            }
+
+            lintMultipleMethods(
+                whitespaceInStringLiterals,
+                tempDir = tempDir,
+                rulesConfigList = customConfig.asRulesConfigList())
+        }
+
+        @ParameterizedTest(name = "extendedIndent = {0}")
+        @ValueSource(booleans = [false, true])
+        @Tag(WarningNames.WRONG_INDENTATION)
+        fun `no whitespace should be injected (mis-indented code reformatted)`(extendedIndent: Boolean, @TempDir tempDir: Path) {
+            val defaultConfig = IndentationConfig("newlineAtEnd" to false)
+            val customConfig = defaultConfig.withCustomParameters(*extendedIndent(enabled = extendedIndent))
+
+            val whitespaceInStringLiteralsActual = when {
+                extendedIndent -> whitespaceInStringLiteralsSingleIndent
+                else -> whitespaceInStringLiteralsContinuationIndent
+            }
+            val whitespaceInStringLiteralsExpected = when {
+                extendedIndent -> whitespaceInStringLiteralsContinuationIndent
+                else -> whitespaceInStringLiteralsSingleIndent
+            }
+
+            lintMultipleMethods(
+                actualContent = whitespaceInStringLiteralsActual,
+                expectedContent = whitespaceInStringLiteralsExpected,
+                tempDir = tempDir,
+                rulesConfigList = customConfig.asRulesConfigList())
+        }
+    }
+
+    /**
+     * See [#1340](https://github.com/saveourtool/diktat/issues/1340).
+     */
+    @Nested
+    @TestMethodOrder(DisplayName::class)
+    inner class `Expressions wrapped after operator` {
+        @ParameterizedTest(name = "extendedIndentAfterOperators = {0}")
+        @ValueSource(booleans = [false, true])
+        @Tag(WarningNames.WRONG_INDENTATION)
+        fun `should be properly indented`(extendedIndentAfterOperators: Boolean, @TempDir tempDir: Path) {
+            val defaultConfig = IndentationConfig("newlineAtEnd" to false)
+            val customConfig = defaultConfig.withCustomParameters("extendedIndentAfterOperators" to extendedIndentAfterOperators)
+
+            val expressionsWrappedAfterOperator = when {
+                extendedIndentAfterOperators -> expressionsWrappedAfterOperatorContinuationIndent
+                else -> expressionsWrappedAfterOperatorSingleIndent
+            }
+
+            lintMultipleMethods(
+                expressionsWrappedAfterOperator,
+                tempDir = tempDir,
+                rulesConfigList = customConfig.asRulesConfigList())
+        }
+
+        @ParameterizedTest(name = "extendedIndentAfterOperators = {0}")
+        @ValueSource(booleans = [false, true])
+        @Tag(WarningNames.WRONG_INDENTATION)
+        fun `should be reformatted if mis-indented`(extendedIndentAfterOperators: Boolean, @TempDir tempDir: Path) {
+            val defaultConfig = IndentationConfig("newlineAtEnd" to false)
+            val customConfig = defaultConfig.withCustomParameters("extendedIndentAfterOperators" to extendedIndentAfterOperators)
+
+            val expressionsWrappedAfterOperatorActual = when {
+                extendedIndentAfterOperators -> expressionsWrappedAfterOperatorSingleIndent
+                else -> expressionsWrappedAfterOperatorContinuationIndent
+            }
+            val expressionsWrappedAfterOperatorExpected = when {
+                extendedIndentAfterOperators -> expressionsWrappedAfterOperatorContinuationIndent
+                else -> expressionsWrappedAfterOperatorSingleIndent
+            }
+
+            lintMultipleMethods(
+                actualContent = expressionsWrappedAfterOperatorActual,
+                expectedContent = expressionsWrappedAfterOperatorExpected,
+                tempDir = tempDir,
+                rulesConfigList = customConfig.asRulesConfigList())
+        }
+    }
 }
diff --git a/diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/spaces/IndentationRuleTest.kt b/diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/spaces/IndentationRuleTest.kt
@@ -0,0 +1,10 @@
+package org.cqfn.diktat.ruleset.chapter3.spaces
+
+import org.junit.platform.suite.api.SelectClasses
+import org.junit.platform.suite.api.Suite
+
+@Suite
+@SelectClasses(
+    IndentationRuleWarnTest::class,
+    IndentationRuleFixTest::class)
+class IndentationRuleTest