Merge pull request pinterest#1390 from paul-dingemans/migrate-to-junit-5

Migrate to junit 5
paul-dingemans · Mar 3, 2022 · 07e452c · 07e452c
2 parents a5bda83 + 7bfb283
commit 07e452c
Show file tree

Hide file tree

Showing 79 changed files with 420 additions and 462 deletions.
diff --git a/build.gradle b/build.gradle
@@ -20,10 +20,7 @@ ext.deps = [
  // Use logback-classic as the logger for kotlin-logging / slf4j as it allow changing the log level at runtime.
  'logback' : 'ch.qos.logback:logback-classic:1.2.9',
  // Testing libraries
- 'junit' : 'junit:junit:4.13.1',
- 'junit5Api' : 'org.junit.jupiter:junit-jupiter-api:5.8.2',
- 'junit5Jupiter' : 'org.junit.jupiter:junit-jupiter-engine:5.8.2',
- 'junit5Vintage' : 'org.junit.vintage:junit-vintage-engine:5.8.2',
+ 'junit5' : 'org.junit.jupiter:junit-jupiter:5.8.2',
  'assertj' : 'org.assertj:assertj-core:3.12.2',
  'sarif4k' : 'io.github.detekt.sarif4k:sarif4k:0.0.1',
  'jimfs' : 'com.google.jimfs:jimfs:1.1'
@@ -33,11 +30,17 @@ repositories {
  mavenCentral()
 }
 
-if (project.hasProperty('isKotlinDev')) {
- allprojects { p ->
+def isKotlinDev = project.hasProperty('isKotlinDev')
+
+allprojects { p ->
+ if (isKotlinDev) {
  String definedVersion = p.ext."VERSION_NAME".minus("-SNAPSHOT")
  p.ext."VERSION_NAME" = "$definedVersion-kotlin-dev-SNAPSHOT".toString()
  }
+
+ tasks.withType(Test).configureEach {
+ it.useJUnitPlatform()
+ }
 }
 
 configurations {

diff --git a/ktlint-core/build.gradle b/ktlint-core/build.gradle
@@ -9,8 +9,9 @@ dependencies {
  api deps.logging
  api deps.logback
 
- testImplementation deps.junit
+ // Standard ruleset is required for EditConfigLoaderTest only
+ testImplementation project(":ktlint-ruleset-standard")
+ testImplementation deps.junit5
  testImplementation deps.assertj
  testImplementation deps.jimfs
- testImplementation project(":ktlint-ruleset-standard")
 }
diff --git a/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/DisabledRulesTest.kt b/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/DisabledRulesTest.kt
@@ -4,7 +4,7 @@ import com.pinterest.ktlint.core.ast.ElementType
 import java.util.ArrayList
 import org.assertj.core.api.Assertions.assertThat
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class DisabledRulesTest {
  @Test

diff --git a/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/ErrorSuppressionTest.kt b/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/ErrorSuppressionTest.kt
@@ -6,7 +6,7 @@ import java.util.ArrayList
 import org.assertj.core.api.Assertions.assertThat
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
 import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class ErrorSuppressionTest {
 

diff --git a/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/KtLintTest.kt b/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/KtLintTest.kt
@@ -3,7 +3,7 @@ package com.pinterest.ktlint.core
 import com.pinterest.ktlint.core.ast.isRoot
 import org.assertj.core.api.Assertions.assertThat
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class KtLintTest {
 

diff --git a/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/VisitorProviderTest.kt b/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/VisitorProviderTest.kt
@@ -10,7 +10,7 @@ import org.jetbrains.kotlin.com.intellij.lang.ASTNode
 import org.jetbrains.kotlin.com.intellij.psi.tree.IElementType
 import org.jetbrains.kotlin.idea.KotlinLanguage
 import org.jetbrains.kotlin.psi.KtFile
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class VisitorProviderTest {
  @Test

diff --git a/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/BaselineSupportTest.kt b/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/BaselineSupportTest.kt
@@ -3,12 +3,10 @@ package com.pinterest.ktlint.core.internal
 import com.pinterest.ktlint.core.LintError
 import java.io.ByteArrayInputStream
 import java.io.InputStream
-import org.junit.Assert.assertEquals
-import org.junit.Assert.assertTrue
-import org.junit.Test
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Test
 
 class BaselineSupportTest {
-
  @Test
  fun testParseBaselineFile() {
  val filename = "TestBaselineFile.kt"
@@ -36,9 +34,10 @@ class BaselineSupportTest {
 
  val baselineFiles = parseBaseline(baseline)
 
- assertTrue(baselineFiles.containsKey(filename))
- assertEquals(2, baselineFiles[filename]?.size)
- assertTrue(true == baselineFiles[filename]?.containsLintError(errorOne))
- assertTrue(true == baselineFiles[filename]?.containsLintError(errorTwo))
+ assertThat(baselineFiles).containsKey(filename)
+ val lintErrors = baselineFiles[filename]
+ assertThat(lintErrors).hasSize(2)
+ assertThat(lintErrors?.containsLintError(errorOne))
+ assertThat(lintErrors?.containsLintError(errorTwo))
  }
 }
diff --git a/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigGeneratorTest.kt b/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigGeneratorTest.kt
@@ -11,7 +11,7 @@ import java.nio.file.Path
 import org.assertj.core.api.Assertions.assertThat
 import org.ec4j.core.model.PropertyType
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 @OptIn(FeatureInAlphaState::class)
 internal class EditorConfigGeneratorTest {

diff --git a/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigLoaderTest.kt b/ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigLoaderTest.kt
@@ -15,8 +15,8 @@ import org.assertj.core.api.Assertions.entry
 import org.ec4j.core.model.PropertyType
 import org.intellij.lang.annotations.Language
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
-import org.junit.After
-import org.junit.Test
+import org.junit.jupiter.api.AfterEach
+import org.junit.jupiter.api.Test
 
 @OptIn(FeatureInAlphaState::class)
 internal class EditorConfigLoaderTest {
@@ -37,7 +37,7 @@ internal class EditorConfigLoaderTest {
  Files.write(normalizedPath("$filePath/.editorconfig"), content.toByteArray())
  }
 
- @After
+ @AfterEach
  fun tearDown() {
  tempFileSystem.close()
  }

diff --git a/ktlint-reporter-baseline/build.gradle b/ktlint-reporter-baseline/build.gradle
@@ -6,6 +6,6 @@ plugins {
 dependencies {
  implementation project(':ktlint-core')
 
- testImplementation deps.junit
+ testImplementation deps.junit5
  testImplementation deps.assertj
 }
diff --git a/...r-baseline/src/test/kotlin/com/pinterest/ktlint/reporter/baseline/BaselineReporterTest.kt b/...r-baseline/src/test/kotlin/com/pinterest/ktlint/reporter/baseline/BaselineReporterTest.kt
@@ -5,7 +5,7 @@ import java.io.ByteArrayOutputStream
 import java.io.PrintStream
 import java.nio.file.Paths
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class BaselineReporterTest {
 

diff --git a/ktlint-reporter-checkstyle/build.gradle b/ktlint-reporter-checkstyle/build.gradle
@@ -6,6 +6,6 @@ plugins {
 dependencies {
  implementation project(':ktlint-core')
 
- testImplementation deps.junit
+ testImplementation deps.junit5
  testImplementation deps.assertj
 }
diff --git a/...kstyle/src/test/kotlin/com/pinterest/ktlint/reporter/checkstyle/CheckStyleReporterTest.kt b/...kstyle/src/test/kotlin/com/pinterest/ktlint/reporter/checkstyle/CheckStyleReporterTest.kt
@@ -4,7 +4,7 @@ import com.pinterest.ktlint.core.LintError
 import java.io.ByteArrayOutputStream
 import java.io.PrintStream
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class CheckStyleReporterTest {
 

diff --git a/ktlint-reporter-html/build.gradle b/ktlint-reporter-html/build.gradle
@@ -6,6 +6,6 @@ plugins {
 dependencies {
  implementation project(':ktlint-core')
 
- testImplementation deps.junit
+ testImplementation deps.junit5
  testImplementation deps.assertj
 }
diff --git a/ktlint-reporter-html/src/test/kotlin/com/pinterest/ktlint/reporter/html/HtmlReporterTest.kt b/ktlint-reporter-html/src/test/kotlin/com/pinterest/ktlint/reporter/html/HtmlReporterTest.kt
@@ -27,11 +27,10 @@ package com.pinterest.ktlint.reporter.html
 import com.pinterest.ktlint.core.LintError
 import java.io.ByteArrayOutputStream
 import java.io.PrintStream
-import org.junit.Assert.assertEquals
-import org.junit.Test
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Test
 
 class HtmlReporterTest {
-
  @Test
  fun shouldRenderEmptyReportWhen_NoIssuesFound() {
  val out = ByteArrayOutputStream()
@@ -59,8 +58,7 @@ class HtmlReporterTest {
 
  """.trimIndent().replace("\n", System.lineSeparator())
 
- val expected = String(out.toByteArray())
- assertEquals(actual, expected)
+ assertThat(actual).isEqualTo(String(out.toByteArray()))
  }
 
  @Test
@@ -103,8 +101,7 @@ class HtmlReporterTest {
 
  """.trimIndent().replace("\n", System.lineSeparator())
 
- val expected = String(out.toByteArray())
- assertEquals(actual, expected)
+ assertThat(actual).isEqualTo(String(out.toByteArray()))
  }
 
  @Test
@@ -153,8 +150,7 @@ class HtmlReporterTest {
 
  """.trimIndent().replace("\n", System.lineSeparator())
 
- val expected = String(out.toByteArray())
- assertEquals(actual, expected)
+ assertThat(actual).isEqualTo(String(out.toByteArray()))
  }
 
  @Test
@@ -204,7 +200,6 @@ class HtmlReporterTest {
 
  """.trimIndent().replace("\n", System.lineSeparator())
 
- val expected = String(out.toByteArray())
- assertEquals(actual, expected)
+ assertThat(actual).isEqualTo(String(out.toByteArray()))
  }
 }
diff --git a/ktlint-reporter-json/build.gradle b/ktlint-reporter-json/build.gradle
@@ -6,6 +6,6 @@ plugins {
 dependencies {
  implementation project(':ktlint-core')
 
- testImplementation deps.junit
+ testImplementation deps.junit5
  testImplementation deps.assertj
 }
diff --git a/ktlint-reporter-json/src/test/kotlin/com/pinterest/ktlint/reporter/json/JsonReporterTest.kt b/ktlint-reporter-json/src/test/kotlin/com/pinterest/ktlint/reporter/json/JsonReporterTest.kt
@@ -4,7 +4,7 @@ import com.pinterest.ktlint.core.LintError
 import java.io.ByteArrayOutputStream
 import java.io.PrintStream
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class JsonReporterTest {
 

diff --git a/ktlint-reporter-plain/build.gradle b/ktlint-reporter-plain/build.gradle
@@ -6,6 +6,6 @@ plugins {
 dependencies {
  implementation project(':ktlint-core')
 
- testImplementation deps.junit
+ testImplementation deps.junit5
  testImplementation deps.assertj
 }
diff --git a/...er-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProviderTest.kt b/...er-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProviderTest.kt
@@ -4,7 +4,7 @@ import java.io.PrintStream
 import java.lang.System.out
 import org.assertj.core.api.Assertions.assertThat
 import org.assertj.core.api.Assertions.assertThatExceptionOfType
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class PlainReporterProviderTest {
  @Test

diff --git a/...t-reporter-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterTest.kt b/...t-reporter-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterTest.kt
@@ -7,11 +7,9 @@ import java.io.ByteArrayOutputStream
 import java.io.File
 import java.io.PrintStream
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Assert.assertEquals
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class PlainReporterTest {
-
  @Test
  fun testReportGeneration() {
  val out = ByteArrayOutputStream()
@@ -97,11 +95,10 @@ class PlainReporterTest {
  ),
  false
  )
-
  val outputString = String(out.toByteArray())
 
- // We don't expect class name, or first line to be colored
- val expectedOutput =
+ assertThat(outputString).isEqualTo(
+  // We don't expect class name, or first line to be colored
  File.separator.color(outputColor) +
  "one-fixed-and-one-not.kt" +
  ":".color(outputColor) +
@@ -110,8 +107,7 @@ class PlainReporterTest {
  " <\"&'> " +
  "(rule-1)".color(outputColor) +
  System.lineSeparator()
-
- assertEquals(expectedOutput, outputString)
+ )
  }
 
  @Test

diff --git a/ktlint-reporter-sarif/build.gradle b/ktlint-reporter-sarif/build.gradle
@@ -7,7 +7,7 @@ dependencies {
  implementation project(':ktlint-core')
  implementation deps.sarif4k
 
- testImplementation deps.junit
+ testImplementation deps.junit5
  testImplementation deps.assertj
 }
 

diff --git a/...t-reporter-sarif/src/test/kotlin/com/pinterest/ktlint/reporter/sarif/SarifReporterTest.kt b/...t-reporter-sarif/src/test/kotlin/com/pinterest/ktlint/reporter/sarif/SarifReporterTest.kt
@@ -4,13 +4,12 @@ import com.pinterest.ktlint.core.LintError
 import java.io.ByteArrayOutputStream
 import java.io.File
 import java.io.PrintStream
-import org.junit.Assert.assertEquals
-import org.junit.Ignore
-import org.junit.Test
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Disabled
+import org.junit.jupiter.api.Test
 
 class SarifReporterTest {
-
- @Ignore("https://github.com/pinterest/ktlint/issues/1191")
+ @Disabled("https://github.com/pinterest/ktlint/issues/1191")
  @Test
  fun testReportGeneration() {
  val workingDirectory = System.getProperty("user.home").sanitize()
@@ -49,6 +48,6 @@ class SarifReporterTest {
  .readText()
  .replace("{WORKINDG_DIR}", workingDirectory)
  .replace("\\s".toRegex(), "")
- assertEquals("actual = $actual, expected = $expected", expected, actual)
+ assertThat(actual).isEqualTo(expected)
  }
 }
diff --git a/ktlint-ruleset-experimental/build.gradle b/ktlint-ruleset-experimental/build.gradle
@@ -8,6 +8,6 @@ dependencies {
 
  testImplementation project(':ktlint-test')
  testImplementation project(':ktlint-ruleset-standard')
- testImplementation deps.junit
+ testImplementation deps.junit5
  testImplementation deps.assertj
 }
diff --git a/...erimental/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/AnnotationRuleTest.kt b/...erimental/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/AnnotationRuleTest.kt
@@ -4,7 +4,7 @@ import com.pinterest.ktlint.core.LintError
 import com.pinterest.ktlint.test.format
 import com.pinterest.ktlint.test.lint
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class AnnotationRuleTest {
 

diff --git a/...al/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/AnnotationSpacingRuleTest.kt b/...al/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/AnnotationSpacingRuleTest.kt
@@ -6,7 +6,7 @@ import com.pinterest.ktlint.test.format
 import com.pinterest.ktlint.test.lint
 import java.util.ArrayList
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class AnnotationSpacingRuleTest {
 

diff --git a/...src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/ArgumentListWrappingRuleTest.kt b/...src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/ArgumentListWrappingRuleTest.kt
@@ -8,7 +8,7 @@ import com.pinterest.ktlint.test.EditorConfigOverride
 import com.pinterest.ktlint.test.format
 import com.pinterest.ktlint.test.lint
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 @FeatureInAlphaState
 class ArgumentListWrappingRuleTest {

diff --git a/...al/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/EnumEntryNameCaseRuleTest.kt b/...al/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/EnumEntryNameCaseRuleTest.kt
@@ -4,7 +4,7 @@ import com.pinterest.ktlint.core.LintError
 import com.pinterest.ktlint.test.format
 import com.pinterest.ktlint.test.lint
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class EnumEntryNameCaseRuleTest {
 

diff --git a/...ntal/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/MultiLineIfElseRuleTest.kt b/...ntal/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/MultiLineIfElseRuleTest.kt
@@ -4,7 +4,7 @@ import com.pinterest.ktlint.core.LintError
 import com.pinterest.ktlint.test.format
 import com.pinterest.ktlint.test.lint
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
 class MultiLineIfElseRuleTest {