no need to overload the File.shouldBeAFile version, this one is worki…

…ng well
adamko-dev · Jan 7, 2024 · 99d3d7e · 99d3d7e
1 parent a9f3f7a
commit 99d3d7e
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 37 deletions.
diff --git a/modules/dokkatoo-plugin-integration-tests/src/testExamples/kotlin/CustomFormatExampleTest.kt b/modules/dokkatoo-plugin-integration-tests/src/testExamples/kotlin/CustomFormatExampleTest.kt
@@ -4,7 +4,7 @@ import dev.adamko.dokkatoo.internal.DokkatooConstants.DOKKA_VERSION
 import dev.adamko.dokkatoo.utils.*
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec
-import io.kotest.matchers.file.shouldBeAnExistingFile
+import io.kotest.matchers.file.shouldBeAFile
 import io.kotest.matchers.file.shouldHaveSameStructureAndContentAs
 import io.kotest.matchers.file.shouldHaveSameStructureAs
 import io.kotest.matchers.nulls.shouldNotBeNull
@@ -54,7 +54,7 @@ class CustomFormatExampleTest : FunSpec({
           dokkatooProject
             .findFiles { it.name == "dokka-worker.log" }
             .shouldBeSingleton { dokkaWorkerLog ->
-              dokkaWorkerLog.shouldNotBeNull().shouldBeAnExistingFile()
+              dokkaWorkerLog.shouldNotBeNull().shouldBeAFile()
               dokkaWorkerLog.readText() shouldContain "Generation completed successfully"
             }
         }
@@ -96,7 +96,7 @@ class CustomFormatExampleTest : FunSpec({
           dokkatooProject
             .findFiles { it.name == "dokka-worker.log" }
             .shouldBeSingleton { dokkaWorkerLog ->
-              dokkaWorkerLog.shouldNotBeNull().shouldBeAnExistingFile()
+              dokkaWorkerLog.shouldNotBeNull().shouldBeAFile()
               dokkaWorkerLog.readText() shouldContain "Generation completed successfully"
             }
         }

diff --git a/modules/dokkatoo-plugin-integration-tests/src/testExamples/kotlin/GradleExampleTest.kt b/modules/dokkatoo-plugin-integration-tests/src/testExamples/kotlin/GradleExampleTest.kt
@@ -5,7 +5,7 @@ import dev.adamko.dokkatoo.utils.*
 import dev.adamko.dokkatoo.utils.GradleProjectTest.Companion.projectTestTempDir
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec
-import io.kotest.matchers.file.shouldBeAnExistingFile
+import io.kotest.matchers.file.shouldBeAFile
 import io.kotest.matchers.file.shouldHaveSameStructureAndContentAs
 import io.kotest.matchers.file.shouldHaveSameStructureAs
 import io.kotest.matchers.nulls.shouldNotBeNull
@@ -56,7 +56,7 @@ class GradleExampleTest : FunSpec({
           dokkatooProject
             .findFiles { it.name == "dokka-worker.log" }
             .shouldBeSingleton { dokkaWorkerLog ->
-              dokkaWorkerLog.shouldNotBeNull().shouldBeAnExistingFile()
+              dokkaWorkerLog.shouldNotBeNull().shouldBeAFile()
               dokkaWorkerLog.readText() shouldContain "Generation completed successfully"
             }
         }
@@ -98,7 +98,7 @@ class GradleExampleTest : FunSpec({
           dokkatooProject
             .findFiles { it.name == "dokka-worker.log" }
             .shouldBeSingleton { dokkaWorkerLog ->
-              dokkaWorkerLog.shouldNotBeNull().shouldBeAnExistingFile()
+              dokkaWorkerLog.shouldNotBeNull().shouldBeAFile()
               dokkaWorkerLog.readText() shouldContain "Generation completed successfully"
             }
         }

diff --git a/...kkatoo-plugin-integration-tests/src/testExamples/kotlin/KotlinMultiplatformExampleTest.kt b/...kkatoo-plugin-integration-tests/src/testExamples/kotlin/KotlinMultiplatformExampleTest.kt
@@ -11,7 +11,6 @@ import io.kotest.matchers.shouldBe
 import io.kotest.matchers.string.shouldContain
 import io.kotest.matchers.string.shouldNotContain
 import java.io.File
-import shouldBeAnExistingFile
 
 class KotlinMultiplatformExampleTest : FunSpec({
 
@@ -106,7 +105,7 @@ class KotlinMultiplatformExampleTest : FunSpec({
             dokkatooProject
               .findFiles { it.name == "dokka-worker.log" }
               .shouldBeSingleton { dokkaWorkerLog ->
-                dokkaWorkerLog.shouldBeAnExistingFile()
+                dokkaWorkerLog.shouldBeAFile()
                 dokkaWorkerLog.readText().shouldNotContainAnyOf(
                   "[ERROR]",
                   "[WARN]",

diff --git a/modules/dokkatoo-plugin-integration-tests/src/testExamples/kotlin/MultimoduleExampleTest.kt b/modules/dokkatoo-plugin-integration-tests/src/testExamples/kotlin/MultimoduleExampleTest.kt
@@ -6,14 +6,14 @@ import dev.adamko.dokkatoo.utils.GradleProjectTest.Companion.projectTestTempDir
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.inspectors.shouldForAll
 import io.kotest.matchers.collections.shouldHaveSize
+import io.kotest.matchers.file.shouldBeAFile
 import io.kotest.matchers.file.shouldHaveSameStructureAndContentAs
 import io.kotest.matchers.file.shouldHaveSameStructureAs
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.string.shouldContain
 import io.kotest.matchers.string.shouldNotContain
 import java.io.File
 import org.gradle.testkit.runner.TaskOutcome.UP_TO_DATE
-import shouldBeAnExistingFile
 
 class MultimoduleExampleTest : FunSpec({
 
@@ -59,7 +59,7 @@ class MultimoduleExampleTest : FunSpec({
             dokkatooProject
               .findFiles { it.name == "dokka-worker.log" }
               .shouldForAll { dokkaWorkerLog ->
-                dokkaWorkerLog.shouldBeAnExistingFile()
+                dokkaWorkerLog.shouldBeAFile()
                 dokkaWorkerLog.readText().shouldNotContainAnyOf(
                   "[ERROR]",
                   "[WARN]",
@@ -108,7 +108,7 @@ class MultimoduleExampleTest : FunSpec({
             dokkatooProject
               .findFiles { it.name == "dokka-worker.log" }
               .shouldForAll { dokkaWorkerLog ->
-                dokkaWorkerLog.shouldBeAnExistingFile()
+                dokkaWorkerLog.shouldBeAFile()
                 dokkaWorkerLog.readText().shouldNotContainAnyOf(
                   "[ERROR]",
                   "[WARN]",

diff --git a/modules/dokkatoo-plugin-integration-tests/src/testExamples/kotlin/kotestUtils.kt b/modules/dokkatoo-plugin-integration-tests/src/testExamples/kotlin/kotestUtils.kt
diff --git a/...atoo-plugin-integration-tests/src/testIntegration/kotlin/AndroidProjectIntegrationTest.kt b/...atoo-plugin-integration-tests/src/testIntegration/kotlin/AndroidProjectIntegrationTest.kt
@@ -2,7 +2,7 @@ package dev.adamko.dokkatoo.tests.integration
 
 import dev.adamko.dokkatoo.utils.*
 import io.kotest.core.spec.style.FunSpec
-import io.kotest.matchers.file.shouldBeAnExistingFile
+import io.kotest.matchers.file.shouldBeAFile
 import io.kotest.matchers.file.shouldHaveSameStructureAndContentAs
 import io.kotest.matchers.file.shouldHaveSameStructureAs
 import io.kotest.matchers.shouldBe
@@ -56,7 +56,7 @@ class AndroidProjectIntegrationTest : FunSpec({
             dokkatooProject
               .findFiles { it.name == "dokka-worker.log" }
               .shouldBeSingleton { dokkaWorkerLog ->
-                dokkaWorkerLog.shouldBeAnExistingFile()
+                dokkaWorkerLog.shouldBeAFile()
                 dokkaWorkerLog.readText().shouldNotContainAnyOf(
                   "[ERROR]",
                   "[WARN]",

diff --git a/...kkatoo-plugin-integration-tests/src/testIntegration/kotlin/BasicProjectIntegrationTest.kt b/...kkatoo-plugin-integration-tests/src/testIntegration/kotlin/BasicProjectIntegrationTest.kt
@@ -3,7 +3,7 @@ package dev.adamko.dokkatoo.tests.integration
 import dev.adamko.dokkatoo.utils.*
 import dev.adamko.dokkatoo.utils.GradleProjectTest.Companion.projectTestTempDir
 import io.kotest.core.spec.style.FunSpec
-import io.kotest.matchers.file.shouldBeAnExistingFile
+import io.kotest.matchers.file.shouldBeAFile
 import io.kotest.matchers.file.shouldHaveSameStructureAndContentAs
 import io.kotest.matchers.file.shouldHaveSameStructureAs
 import io.kotest.matchers.shouldBe
@@ -56,7 +56,7 @@ class BasicProjectIntegrationTest : FunSpec({
             dokkatooProject
               .findFiles { it.name == "dokka-worker.log" }
               .shouldBeSingleton { dokkaWorkerLog ->
-                dokkaWorkerLog.shouldBeAnExistingFile()
+                dokkaWorkerLog.shouldBeAFile()
                 dokkaWorkerLog.readText().shouldNotContainAnyOf(
                   "[ERROR]",
                   "[WARN]",

diff --git a/modules/dokkatoo-plugin/build.gradle.kts b/modules/dokkatoo-plugin/build.gradle.kts
@@ -25,7 +25,6 @@ dependencies {
   // that would be used as an implementation dependency, while dokka-core would be used as a compileOnly dependency
   // https://github.com/Kotlin/dokka/issues/2933
   implementation(libs.kotlin.dokkaCore)
-  testImplementation(project(":modules:dokkatoo-plugin-integration-tests"))
 
   compileOnly(libs.gradlePlugin.kotlin)
   compileOnly(libs.gradlePlugin.kotlin.klibCommonizerApi)

diff --git a/modules/dokkatoo-plugin/src/testFunctional/kotlin/KotlinMultiplatformFunctionalTest.kt b/modules/dokkatoo-plugin/src/testFunctional/kotlin/KotlinMultiplatformFunctionalTest.kt
@@ -5,6 +5,7 @@ import dev.adamko.dokkatoo.utils.*
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.inspectors.shouldForAll
+import io.kotest.matchers.file.shouldBeAFile
 import io.kotest.matchers.sequences.shouldNotBeEmpty
 import io.kotest.matchers.string.shouldContain
 import io.kotest.matchers.string.shouldNotContain
@@ -31,7 +32,7 @@ class KotlinMultiplatformFunctionalTest : FunSpec({
       project
         .findFiles { it.name == "dokka-worker.log" }
         .shouldBeSingleton { dokkaWorkerLog ->
-          dokkaWorkerLog.shouldBeAnExistingFile()
+          dokkaWorkerLog.shouldBeAFile()
           dokkaWorkerLog.readText().shouldNotContainAnyOf(
             "[ERROR]",
             "[WARN]",

diff --git a/modules/dokkatoo-plugin/src/testFunctional/kotlin/MultiModuleFunctionalTest.kt b/modules/dokkatoo-plugin/src/testFunctional/kotlin/MultiModuleFunctionalTest.kt
@@ -6,6 +6,7 @@ import io.kotest.core.spec.style.FunSpec
 import io.kotest.inspectors.shouldForAll
 import io.kotest.matchers.collections.shouldBeIn
 import io.kotest.matchers.collections.shouldContainAll
+import io.kotest.matchers.file.shouldBeAFile
 import io.kotest.matchers.paths.shouldNotExist
 import io.kotest.matchers.string.shouldBeEmpty
 import io.kotest.matchers.string.shouldContain
@@ -34,7 +35,7 @@ class MultiModuleFunctionalTest : FunSpec({
       project
         .findFiles { it.name == "dokka-worker.log" }
         .shouldForAll { dokkaWorkerLog ->
-          dokkaWorkerLog.shouldBeAnExistingFile()
+          dokkaWorkerLog.shouldBeAFile()
           dokkaWorkerLog.readText().shouldNotContainAnyOf(
             "[ERROR]",
             "[WARN]",
@@ -100,7 +101,7 @@ class MultiModuleFunctionalTest : FunSpec({
             project
               .findFiles { it.name == "dokka-worker.log" }
               .shouldForAll { dokkaWorkerLog ->
-                dokkaWorkerLog.shouldBeAnExistingFile()
+                dokkaWorkerLog.shouldBeAFile()
                 dokkaWorkerLog.readText().shouldNotContainAnyOf(
                   "[ERROR]",
                   "[WARN]",
@@ -166,7 +167,7 @@ class MultiModuleFunctionalTest : FunSpec({
         project
           .findFiles { it.name == "dokka-worker.log" }
           .shouldForAll { dokkaWorkerLog ->
-            dokkaWorkerLog.shouldBeAnExistingFile()
+            dokkaWorkerLog.shouldBeAFile()
             dokkaWorkerLog.readText().shouldNotContainAnyOf(
               "[ERROR]",
               "[WARN]",

diff --git a/modules/dokkatoo-plugin/src/testFunctional/kotlin/kotestUtils.kt b/modules/dokkatoo-plugin/src/testFunctional/kotlin/kotestUtils.kt
@@ -11,8 +11,3 @@ internal fun Path.shouldBeAnExistingFile(): Unit = run {
   shouldExist()
   shouldBeAFile()
 }
-
-internal fun File.shouldBeAnExistingFile(): Unit = run {
-  shouldExist()
-  shouldBeAFile()
-}