Migrated smoke test to diktat cli (#1782)

- moved smoke tests from `diktat-ruleset` to `diktat-cli` - updated `save.toml`
saveourtool · Nov 8, 2023 · 6c04a7a · 6c04a7a
1 parent d981125
commit 6c04a7a
Show file tree

Hide file tree

Showing 46 changed files with 14 additions and 40 deletions.
diff --git a/diktat-cli/build.gradle.kts b/diktat-cli/build.gradle.kts
@@ -19,9 +19,11 @@ dependencies {
  implementation(projects.diktatRules)
  implementation(libs.kotlinx.cli)
  implementation(libs.kotlin.logging)
+ implementation(libs.slf4j.api)
  implementation(libs.log4j2.core)
  implementation(libs.log4j2.slf4j2)
 
+ testImplementation(projects.diktatTestFramework)
  testImplementation(libs.junit.jupiter)
  testImplementation(libs.junit.platform.suite)
  testImplementation(libs.assertj.core)

diff --git a/...ktat/ruleset/smoke/DiktatSaveSmokeTest.kt → ...rtool/diktat/smoke/DiktatSaveSmokeTest.kt b/...ktat/ruleset/smoke/DiktatSaveSmokeTest.kt → ...rtool/diktat/smoke/DiktatSaveSmokeTest.kt
@@ -1,19 +1,16 @@
-package com.saveourtool.diktat.ruleset.smoke
+package com.saveourtool.diktat.smoke
 
 import com.saveourtool.diktat.api.DiktatError
 import com.saveourtool.diktat.test.framework.processing.TestComparatorUnit
 import com.saveourtool.diktat.test.framework.util.checkForkedJavaHome
-import com.saveourtool.diktat.test.framework.util.deleteIfExistsRecursively
 import com.saveourtool.diktat.test.framework.util.deleteIfExistsSilently
 import com.saveourtool.diktat.test.framework.util.inheritJavaHome
 import com.saveourtool.diktat.test.framework.util.isWindows
 import com.saveourtool.diktat.test.framework.util.temporaryDirectory
-import generated.KTLINT_VERSION
 
 import io.github.oshai.kotlinlogging.KotlinLogging
 import org.assertj.core.api.Assertions.fail
 import org.assertj.core.api.SoftAssertions.assertSoftly
-import org.junit.jupiter.api.AfterAll
 import org.junit.jupiter.api.BeforeAll
 import org.junit.jupiter.api.condition.DisabledOnOs
 import org.junit.jupiter.api.condition.OS
@@ -73,15 +70,6 @@ class DiktatSaveSmokeTest : DiktatSmokeTestBase() {
  */
  inheritJavaHome()
 
- /*
- * On Windows, ktlint is often unable to relativize paths
- * (see https://github.com/pinterest/ktlint/issues/1608).
- *
- * Also, ktlint needs `.editorconfig` to disable standard rules
- *
- * So let's force the temporary directory to be the
- * sub-directory of the project root.
- */
  temporaryDirectory(baseDirectoryPath / TEMP_DIRECTORY)
  }
 
@@ -152,9 +140,9 @@ class DiktatSaveSmokeTest : DiktatSmokeTestBase() {
  }
 
  /*
- * The fat JAR should reside in the same directory as `ktlint` and
- * `save*` and be named `diktat.jar`
- * (see `diktat-rules/src/test/resources/test/smoke/save.toml`).
+ * The fat JAR should reside in the same directory as `save*` and
+ * be named `diktat.jar`
+ * (see `diktat-cli/src/test/resources/test/smoke/save.toml`).
  */
  val buildDirectory = Path(BUILD_DIRECTORY)
  softly.assertThat(buildDirectory)
@@ -170,10 +158,8 @@ class DiktatSaveSmokeTest : DiktatSmokeTestBase() {
 
  val diktat = baseDirectoryPath / DIKTAT_FAT_JAR
  val save = baseDirectoryPath / getSaveForCurrentOs()
- val ktlint = baseDirectoryPath / KTLINT_FAT_JAR
 
  downloadFile(URL("https://github.com/saveourtool/save-cli/releases/download/v$SAVE_VERSION/${getSaveForCurrentOs()}"), save)
- downloadFile(URL("https://github.com/pinterest/ktlint/releases/download/$KTLINT_VERSION/ktlint"), ktlint)
 
  diktatFrom?.copyTo(diktat, overwrite = true)
  }

diff --git a/...l/diktat/ruleset/smoke/DiktatSmokeTest.kt → ...veourtool/diktat/smoke/DiktatSmokeTest.kt b/...l/diktat/ruleset/smoke/DiktatSmokeTest.kt → ...veourtool/diktat/smoke/DiktatSmokeTest.kt
@@ -1,4 +1,4 @@
-package com.saveourtool.diktat.ruleset.smoke
+package com.saveourtool.diktat.smoke
 
 import com.saveourtool.diktat.api.DiktatError
 import com.saveourtool.diktat.ktlint.format

diff --git a/...ktat/ruleset/smoke/DiktatSmokeTestBase.kt → ...rtool/diktat/smoke/DiktatSmokeTestBase.kt b/...ktat/ruleset/smoke/DiktatSmokeTestBase.kt → ...rtool/diktat/smoke/DiktatSmokeTestBase.kt
@@ -4,7 +4,7 @@
  "BACKTICKS_PROHIBITED",
 )
 
-package com.saveourtool.diktat.ruleset.smoke
+package com.saveourtool.diktat.smoke
 
 import com.saveourtool.diktat.api.DiktatError
 import com.saveourtool.diktat.common.config.rules.DIKTAT_COMMON
@@ -414,7 +414,6 @@ abstract class DiktatSmokeTestBase {
  "Example1Test.kt" -> dest.copyTo(dest.parent.resolve("Example1-2Test.kt"))
  }
  }
-
  }
  }
  }

diff --git a/...tat/ruleset/smoke/DiktatSmokeTestUtils.kt → ...tool/diktat/smoke/DiktatSmokeTestUtils.kt b/...tat/ruleset/smoke/DiktatSmokeTestUtils.kt → ...tool/diktat/smoke/DiktatSmokeTestUtils.kt
@@ -1,6 +1,6 @@
 @file:Suppress("HEADER_MISSING_IN_NON_SINGLE_CLASS_FILE")
 
-package com.saveourtool.diktat.ruleset.smoke
+package com.saveourtool.diktat.smoke
 
 import com.saveourtool.diktat.test.framework.util.retry
 import io.github.oshai.kotlinlogging.KotlinLogging
@@ -13,8 +13,7 @@ import kotlin.system.measureNanoTime
 
 internal const val BUILD_DIRECTORY = "build/libs"
 internal const val DIKTAT_FAT_JAR = "diktat.jar"
-internal const val DIKTAT_FAT_JAR_GLOB = "diktat-*.jar"
-internal const val KTLINT_FAT_JAR = "ktlint"
+internal const val DIKTAT_FAT_JAR_GLOB = "diktat-cli-*.jar"
 
 private val logger = KotlinLogging.logger {}
 

diff --git a/...c/test/resources/test/smoke/.editorconfig → ...c/test/resources/test/smoke/.editorconfig b/...c/test/resources/test/smoke/.editorconfig → ...c/test/resources/test/smoke/.editorconfig
diff --git a/.../src/test/resources/test/smoke/.gitignore → .../src/test/resources/test/smoke/.gitignore b/.../src/test/resources/test/smoke/.gitignore → .../src/test/resources/test/smoke/.gitignore
diff --git a/...st/resources/test/smoke/build.gradle.kts_ → ...st/resources/test/smoke/build.gradle.kts_ b/...st/resources/test/smoke/build.gradle.kts_ → ...st/resources/test/smoke/build.gradle.kts_
diff --git a/...t/src/test/resources/test/smoke/save.toml → ...i/src/test/resources/test/smoke/save.toml b/...t/src/test/resources/test/smoke/save.toml → ...i/src/test/resources/test/smoke/save.toml
@@ -1,5 +1,5 @@
 [general]
-execCmd="java -showversion -jar ktlint --log-level=debug -R diktat.jar"
+execCmd="java -showversion -jar diktat.jar --log-level debug"
 tags = ["smokeTest"]
 description = "SmokeTest"
 suiteName = "SmokeTest"
@@ -9,7 +9,7 @@ timeOutMillis = 3600000
 
 ["fix and warn"]
  ["fix and warn".fix]
- execFlags="-F"
+ execFlags="--mode fix"
  ["fix and warn".warn]
  lineCaptureGroup = 1
  columnCaptureGroup = 2

diff --git a/...eourtool/diktat/scripts/ScriptExpected.kt → ...eourtool/diktat/scripts/ScriptExpected.kt b/...eourtool/diktat/scripts/ScriptExpected.kt → ...eourtool/diktat/scripts/ScriptExpected.kt
diff --git a/.../saveourtool/diktat/scripts/ScriptTest.kt → .../saveourtool/diktat/scripts/ScriptTest.kt b/.../saveourtool/diktat/scripts/ScriptTest.kt → .../saveourtool/diktat/scripts/ScriptTest.kt
diff --git a/...est/smoke/src/main/kotlin/Bug1Expected.kt → ...est/smoke/src/main/kotlin/Bug1Expected.kt b/...est/smoke/src/main/kotlin/Bug1Expected.kt → ...est/smoke/src/main/kotlin/Bug1Expected.kt
diff --git a/...es/test/smoke/src/main/kotlin/Bug1Test.kt → ...es/test/smoke/src/main/kotlin/Bug1Test.kt b/...es/test/smoke/src/main/kotlin/Bug1Test.kt → ...es/test/smoke/src/main/kotlin/Bug1Test.kt
diff --git a/...src/main/kotlin/DefaultPackageExpected.kt → ...src/main/kotlin/DefaultPackageExpected.kt b/...src/main/kotlin/DefaultPackageExpected.kt → ...src/main/kotlin/DefaultPackageExpected.kt
diff --git a/...oke/src/main/kotlin/DefaultPackageTest.kt → ...oke/src/main/kotlin/DefaultPackageTest.kt b/...oke/src/main/kotlin/DefaultPackageTest.kt → ...oke/src/main/kotlin/DefaultPackageTest.kt
diff --git a/...oke/src/main/kotlin/Example1-2Expected.kt → ...oke/src/main/kotlin/Example1-2Expected.kt b/...oke/src/main/kotlin/Example1-2Expected.kt → ...oke/src/main/kotlin/Example1-2Expected.kt
diff --git a/...smoke/src/main/kotlin/Example1Expected.kt → ...smoke/src/main/kotlin/Example1Expected.kt b/...smoke/src/main/kotlin/Example1Expected.kt → ...smoke/src/main/kotlin/Example1Expected.kt
diff --git a/...est/smoke/src/main/kotlin/Example1Test.kt → ...est/smoke/src/main/kotlin/Example1Test.kt b/...est/smoke/src/main/kotlin/Example1Test.kt → ...est/smoke/src/main/kotlin/Example1Test.kt
diff --git a/...smoke/src/main/kotlin/Example2Expected.kt → ...smoke/src/main/kotlin/Example2Expected.kt b/...smoke/src/main/kotlin/Example2Expected.kt → ...smoke/src/main/kotlin/Example2Expected.kt
diff --git a/...est/smoke/src/main/kotlin/Example2Test.kt → ...est/smoke/src/main/kotlin/Example2Test.kt b/...est/smoke/src/main/kotlin/Example2Test.kt → ...est/smoke/src/main/kotlin/Example2Test.kt
diff --git a/...smoke/src/main/kotlin/Example3Expected.kt → ...smoke/src/main/kotlin/Example3Expected.kt b/...smoke/src/main/kotlin/Example3Expected.kt → ...smoke/src/main/kotlin/Example3Expected.kt
diff --git a/...est/smoke/src/main/kotlin/Example3Test.kt → ...est/smoke/src/main/kotlin/Example3Test.kt b/...est/smoke/src/main/kotlin/Example3Test.kt → ...est/smoke/src/main/kotlin/Example3Test.kt
diff --git a/...smoke/src/main/kotlin/Example4Expected.kt → ...smoke/src/main/kotlin/Example4Expected.kt b/...smoke/src/main/kotlin/Example4Expected.kt → ...smoke/src/main/kotlin/Example4Expected.kt
diff --git a/...est/smoke/src/main/kotlin/Example4Test.kt → ...est/smoke/src/main/kotlin/Example4Test.kt b/...est/smoke/src/main/kotlin/Example4Test.kt → ...est/smoke/src/main/kotlin/Example4Test.kt
diff --git a/...smoke/src/main/kotlin/Example5Expected.kt → ...smoke/src/main/kotlin/Example5Expected.kt b/...smoke/src/main/kotlin/Example5Expected.kt → ...smoke/src/main/kotlin/Example5Expected.kt
diff --git a/...est/smoke/src/main/kotlin/Example5Test.kt → ...est/smoke/src/main/kotlin/Example5Test.kt b/...est/smoke/src/main/kotlin/Example5Test.kt → ...est/smoke/src/main/kotlin/Example5Test.kt
diff --git a/...smoke/src/main/kotlin/Example6Expected.kt → ...smoke/src/main/kotlin/Example6Expected.kt b/...smoke/src/main/kotlin/Example6Expected.kt → ...smoke/src/main/kotlin/Example6Expected.kt
diff --git a/...est/smoke/src/main/kotlin/Example6Test.kt → ...est/smoke/src/main/kotlin/Example6Test.kt b/...est/smoke/src/main/kotlin/Example6Test.kt → ...est/smoke/src/main/kotlin/Example6Test.kt
diff --git a/...smoke/src/main/kotlin/Example7Expected.kt → ...smoke/src/main/kotlin/Example7Expected.kt b/...smoke/src/main/kotlin/Example7Expected.kt → ...smoke/src/main/kotlin/Example7Expected.kt
diff --git a/...est/smoke/src/main/kotlin/Example7Test.kt → ...est/smoke/src/main/kotlin/Example7Test.kt b/...est/smoke/src/main/kotlin/Example7Test.kt → ...est/smoke/src/main/kotlin/Example7Test.kt
diff --git a/...smoke/src/main/kotlin/Example8Expected.kt → ...smoke/src/main/kotlin/Example8Expected.kt b/...smoke/src/main/kotlin/Example8Expected.kt → ...smoke/src/main/kotlin/Example8Expected.kt
diff --git a/...est/smoke/src/main/kotlin/Example8Test.kt → ...est/smoke/src/main/kotlin/Example8Test.kt b/...est/smoke/src/main/kotlin/Example8Test.kt → ...est/smoke/src/main/kotlin/Example8Test.kt
diff --git a/...in/KdocFormattingMultilineTagsExpected.kt → ...in/KdocFormattingMultilineTagsExpected.kt b/...in/KdocFormattingMultilineTagsExpected.kt → ...in/KdocFormattingMultilineTagsExpected.kt
diff --git a/...kotlin/KdocFormattingMultilineTagsTest.kt → ...kotlin/KdocFormattingMultilineTagsTest.kt b/...kotlin/KdocFormattingMultilineTagsTest.kt → ...kotlin/KdocFormattingMultilineTagsTest.kt
diff --git a/...kotlin/LocalVariableWithOffsetExpected.kt → ...kotlin/LocalVariableWithOffsetExpected.kt b/...kotlin/LocalVariableWithOffsetExpected.kt → ...kotlin/LocalVariableWithOffsetExpected.kt
diff --git a/...ain/kotlin/LocalVariableWithOffsetTest.kt → ...ain/kotlin/LocalVariableWithOffsetTest.kt b/...ain/kotlin/LocalVariableWithOffsetTest.kt → ...ain/kotlin/LocalVariableWithOffsetTest.kt
diff --git a/...in/ManyLineTransformInLongLineExpected.kt → ...in/ManyLineTransformInLongLineExpected.kt b/...in/ManyLineTransformInLongLineExpected.kt → ...in/ManyLineTransformInLongLineExpected.kt
diff --git a/...kotlin/ManyLineTransformInLongLineTest.kt → ...kotlin/ManyLineTransformInLongLineTest.kt b/...kotlin/ManyLineTransformInLongLineTest.kt → ...kotlin/ManyLineTransformInLongLineTest.kt
diff --git a/...kotlin/kotlin-library-expected.gradle.kts → ...kotlin/kotlin-library-expected.gradle.kts b/...kotlin/kotlin-library-expected.gradle.kts → ...kotlin/kotlin-library-expected.gradle.kts
diff --git a/...src/main/kotlin/kotlin-library.gradle.kts → ...src/main/kotlin/kotlin-library.gradle.kts b/...src/main/kotlin/kotlin-library.gradle.kts → ...src/main/kotlin/kotlin-library.gradle.kts
diff --git a/...rces/test/smoke/src/main/kotlin/save.toml → ...rces/test/smoke/src/main/kotlin/save.toml b/...rces/test/smoke/src/main/kotlin/save.toml → ...rces/test/smoke/src/main/kotlin/save.toml
@@ -1,5 +1,5 @@
 [general]
-execCmd="java -showversion -jar ktlint --log-level=debug -R diktat.jar"
+execCmd="java -showversion -jar diktat.jar --log-level debug"
 tags = ["smokeTest"]
 description = "SmokeTest"
 suiteName = "SmokeTest"
@@ -8,7 +8,7 @@ expectedWarningsPattern = "// ;warn:?(.*):(\\d*): (.+)"
 
 ["fix and warn"]
  ["fix and warn".fix]
- execFlags="-F"
+ execFlags="--mode fix"
  ["fix and warn".warn]
  actualWarningsPattern = "(\\w+\\..+):(\\d+):(\\d+): (\\[.*\\].*)$"
  exactWarningsMatch = false
diff --git a/...kotlin/script/PackageInScriptExpected.kts → ...kotlin/script/PackageInScriptExpected.kts b/...kotlin/script/PackageInScriptExpected.kts → ...kotlin/script/PackageInScriptExpected.kts
diff --git a/...ain/kotlin/script/PackageInScriptTest.kts → ...ain/kotlin/script/PackageInScriptTest.kts b/...ain/kotlin/script/PackageInScriptTest.kts → ...ain/kotlin/script/PackageInScriptTest.kts
diff --git a/...tlin/script/SimpleRunInScriptExpected.kts → ...tlin/script/SimpleRunInScriptExpected.kts b/...tlin/script/SimpleRunInScriptExpected.kts → ...tlin/script/SimpleRunInScriptExpected.kts
diff --git a/...n/kotlin/script/SimpleRunInScriptTest.kts → ...n/kotlin/script/SimpleRunInScriptTest.kts b/...n/kotlin/script/SimpleRunInScriptTest.kts → ...n/kotlin/script/SimpleRunInScriptTest.kts
diff --git a/diktat-ruleset/build.gradle.kts b/diktat-ruleset/build.gradle.kts
@@ -31,18 +31,6 @@ dependencies {
  implementation(libs.ktlint.cli.ruleset.core)
  implementation(libs.ktlint.logger)
  implementation(libs.slf4j.api)
- testImplementation(projects.diktatTestFramework)
- testImplementation(projects.diktatKtlintEngine)
- testImplementation(libs.log4j2.slf4j2)
- testImplementation(libs.kotlin.stdlib.common)
- testImplementation(libs.kotlin.stdlib.jdk7)
- testImplementation(libs.kotlin.stdlib.jdk8)
- testImplementation(libs.kotlin.stdlib)
- testImplementation(libs.kotlin.compiler.embeddable)
- testImplementation(libs.junit.jupiter)
- testImplementation(libs.junit.platform.suite)
- testImplementation(libs.assertj.core)
- testImplementation(libs.mockito)
 }
 
 tasks.named<ShadowJar>("shadowJar") {