improve data driven unit tests to use kotest withData()

irmen · Sep 8, 2024 · edc5a5a · edc5a5a
1 parent c5b7eda
commit edc5a5a
Show file tree

Hide file tree

Showing 35 changed files with 117 additions and 125 deletions.
diff --git a/.idea/libraries/io_kotest_framework_datatest.xml b/.idea/libraries/io_kotest_framework_datatest.xml
diff --git a/codeGenCpu6502/build.gradle b/codeGenCpu6502/build.gradle
@@ -28,6 +28,7 @@ dependencies {
     implementation "com.michael-bull.kotlin-result:kotlin-result-jvm:2.0.0"
 
     testImplementation 'io.kotest:kotest-runner-junit5-jvm:5.9.1'
+    testImplementation 'io.kotest:kotest-framework-datatest:5.9.1'
     testImplementation 'org.junit.jupiter:junit-jupiter:5.9.2'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }

diff --git a/codeGenCpu6502/codeGenCpu6502.iml b/codeGenCpu6502/codeGenCpu6502.iml
@@ -14,5 +14,6 @@
     <orderEntry type="library" name="michael.bull.kotlin.result.jvm" level="project" />
     <orderEntry type="library" name="io.kotest.assertions.core.jvm" level="project" />
     <orderEntry type="library" name="io.kotest.runner.junit5.jvm" level="project" />
+    <orderEntry type="library" name="io.kotest.framework.datatest" level="project" />
   </component>
 </module>
diff --git a/codeGenIntermediate/build.gradle b/codeGenIntermediate/build.gradle
@@ -31,6 +31,7 @@ dependencies {
 
     testImplementation 'io.kotest:kotest-runner-junit5-jvm:5.9.1'
     testImplementation 'org.junit.jupiter:junit-jupiter:5.9.2'
+    testImplementation 'io.kotest:kotest-framework-datatest:5.9.1'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 
 }

diff --git a/codeGenIntermediate/codeGenIntermediate.iml b/codeGenIntermediate/codeGenIntermediate.iml
@@ -14,6 +14,7 @@
     <orderEntry type="module" module-name="intermediate" />
     <orderEntry type="library" name="io.kotest.assertions.core.jvm" level="project" />
     <orderEntry type="library" name="io.kotest.runner.junit5.jvm" level="project" />
+    <orderEntry type="library" name="io.kotest.framework.datatest" level="project" />
     <orderEntry type="library" name="michael.bull.kotlin.result.jvm" level="project" />
   </component>
 </module>
diff --git a/compiler/test/ModuleImporterTests.kt b/compiler/test/ModuleImporterTests.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import com.github.michaelbull.result.getErrorOrElse
 import com.github.michaelbull.result.getOrElse

diff --git a/compiler/test/ProjectConfig.kt b/compiler/test/ProjectConfig.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.core.config.AbstractProjectConfig
 import io.kotest.core.spec.SpecExecutionOrder

diff --git a/compiler/test/TestBuiltinFunctions.kt b/compiler/test/TestBuiltinFunctions.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe

diff --git a/compiler/test/TestCallgraph.kt b/compiler/test/TestCallgraph.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestCompilerOnCharLit.kt b/compiler/test/TestCompilerOnCharLit.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.fail
 import io.kotest.assertions.withClue

diff --git a/compiler/test/TestCompilerOnExamples.kt b/compiler/test/TestCompilerOnExamples.kt
@@ -1,6 +1,7 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.core.spec.style.FunSpec
+import io.kotest.datatest.withData
 import io.kotest.matchers.shouldNotBe
 import prog8.code.core.ICompilationTarget
 import prog8.code.target.*
@@ -11,7 +12,6 @@ import prog8tests.helpers.*
 import java.nio.file.Path
 import kotlin.io.path.absolute
 import kotlin.io.path.exists
-import kotlin.io.path.readText
 
 
 /**
@@ -89,13 +89,14 @@ class TestCompilerOnExamplesC64: FunSpec({
         listOf(false, true)
     )
 
-    onlyC64.forEach {
-        val (source, optimize) = it
-        val target = C64Target()
-        val (displayName, filepath) = prepareTestFiles(source, optimize, target)
-        test(displayName) {
-            compileTheThing(filepath, optimize, target) shouldNotBe null
-        }
+    val target = C64Target()
+    withData(
+        nameFn = { it.second.first },
+        onlyC64.map { it to prepareTestFiles(it.first, it.second, target) }
+    ) { (params, prep) ->
+        val filepath = prep.second
+        val optimize = params.second
+        compileTheThing(filepath, optimize, target) shouldNotBe null
     }
 })
 
@@ -145,13 +146,14 @@ class TestCompilerOnExamplesCx16: FunSpec({
         listOf(false, true)
     )
 
-    onlyCx16.forEach {
-        val (source, optimize) = it
-        val target = Cx16Target()
-        val (displayName, filepath) = prepareTestFiles(source, optimize, target)
-        test(displayName) {
-            compileTheThing(filepath, optimize, target) shouldNotBe null
-        }
+    val target = Cx16Target()
+    withData(
+        nameFn = { it.second.first },
+        onlyCx16.map { it to prepareTestFiles(it.first, it.second, target) }
+    ) { (params, prep) ->
+        val filepath = prep.second
+        val optimize = params.second
+        compileTheThing(filepath, optimize, target) shouldNotBe null
     }
 })
 
@@ -181,40 +183,39 @@ class TestCompilerOnExamplesBothC64andCx16: FunSpec({
             "tehtriz",
             "textelite",
         ),
-        listOf(false, true)
+        listOf(false, true),
+        listOf(C64Target(), Cx16Target())
     )
 
-    bothCx16AndC64.forEach {
-        val (source, optimize) = it
-        val c64target = C64Target()
-        val cx16target = Cx16Target()
-        val (displayNameC64, filepathC64) = prepareTestFiles(source, optimize, c64target)
-        val (displayNameCx16, filepathCx16) = prepareTestFiles(source, optimize, cx16target)
-        test(displayNameC64) {
-            compileTheThing(filepathC64, optimize, c64target) shouldNotBe null
-        }
-        test(displayNameCx16) {
-            compileTheThing(filepathCx16, optimize, cx16target) shouldNotBe null
-        }
+    withData(
+        nameFn = { it.third.first },
+        bothCx16AndC64.map { Triple(it.second, it.third, prepareTestFiles(it.first, it.second, it.third)) }
+    ) { params ->
+        val filepath = params.third.second
+        val optimize = params.first
+        compileTheThing(filepath, optimize, params.second) shouldNotBe null
     }
 })
 
 class TestCompilerOnExamplesVirtual: FunSpec({
 
-    val onlyVirtual = listOf(
+    val onlyVirtual = cartesianProduct(
+        listOf(
             "bouncegfx",
             "bsieve",
             "pixelshader",
             "sincos"
-        )
-
-    onlyVirtual.forEach {
-        val target = VMTarget()
-        val (displayName, filepath) = prepareTestFiles(it, false, target)
-        test(displayName) {
-            val src = filepath.readText()
-            compileText(target, false, src, writeAssembly = true) shouldNotBe null
-            compileText(target, true, src, writeAssembly = true) shouldNotBe null
-        }
+        ),
+        listOf(false, true)
+    )
+
+    val target = VMTarget()
+    withData(
+        nameFn = { it.second.first },
+        onlyVirtual.map { it to prepareTestFiles(it.first, it.second, target) }
+    ) { (params, prep) ->
+        val filepath = prep.second
+        val optimize = params.second
+        compileTheThing(filepath, optimize, target) shouldNotBe null
     }
 })
diff --git a/compiler/test/TestCompilerOnImportsAndIncludes.kt b/compiler/test/TestCompilerOnImportsAndIncludes.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestCompilerOnRanges.kt b/compiler/test/TestCompilerOnRanges.kt
@@ -1,7 +1,8 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec
+import io.kotest.datatest.withData
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.shouldNotBe
 import io.kotest.matchers.string.shouldContain
@@ -93,26 +94,26 @@ class TestCompilerOnRanges: FunSpec({
     }
 
     context("floatArrayInitializerWithRange") {
-        val combos = cartesianProduct(
-            listOf("", "42", "41"),                 // sizeInDecl
-            listOf("%import floats", ""),           // optEnableFloats
-            listOf(Cx16Target(), C64Target()),          // platform
-            listOf(false, true)                     // optimize
-        )
-
-        combos.forEach {
-            val (sizeInDecl, optEnableFloats, platform, optimize) = it
-            val displayName =
-                when (sizeInDecl) {
+        withData(
+            nameFn = {
+                when (it.first) {
                     "" -> "no"
                     "42" -> "correct"
                     else -> "wrong"
                 } + " array size given" +
-                        ", " + (if (optEnableFloats == "") "without" else "with") + " %option enable_floats" +
-                        ", ${platform.name}, optimize: $optimize"
-
-            test(displayName) {
-                val result = compileText(platform, optimize, """
+                        ", " + (if (it.second == "") "without" else "with") + " %option enable_floats" +
+                        ", ${it.third.name}, optimize: ${it.fourth}"
+            },
+            cartesianProduct(
+                listOf("", "42", "41"),                 // sizeInDecl
+                listOf("%import floats", ""),           // optEnableFloats
+                listOf(Cx16Target(), C64Target()),          // platform
+                listOf(false, true)                     // optimize
+            )
+        ) { seq ->
+            val (sizeInDecl, optEnableFloats, platform, optimize) = seq
+
+            val result = compileText(platform, optimize, """
                     $optEnableFloats
                     main {
                         sub start() {
@@ -121,12 +122,10 @@ class TestCompilerOnRanges: FunSpec({
                         }
                     }
                 """)
-                if (optEnableFloats != "" && (sizeInDecl=="" || sizeInDecl=="42"))
-                    result shouldNotBe null
-                else
-                    result shouldBe null
-
-            }
+            if (optEnableFloats != "" && (sizeInDecl=="" || sizeInDecl=="42"))
+                result shouldNotBe null
+            else
+                result shouldBe null
         }
     }
 

diff --git a/compiler/test/TestCompilerOptionLibdirs.kt b/compiler/test/TestCompilerOptionLibdirs.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldNotBe

diff --git a/compiler/test/TestGoldenRam.kt b/compiler/test/TestGoldenRam.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import com.github.michaelbull.result.expectError
 import com.github.michaelbull.result.getOrThrow

diff --git a/compiler/test/TestImportedModulesOrderAndOptions.kt b/compiler/test/TestImportedModulesOrderAndOptions.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestLaunchEmu.kt b/compiler/test/TestLaunchEmu.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.core.spec.style.FunSpec
 import prog8.code.target.VMTarget

diff --git a/compiler/test/TestMemory.kt b/compiler/test/TestMemory.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestNumbers.kt b/compiler/test/TestNumbers.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestNumericLiteral.kt b/compiler/test/TestNumericLiteral.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestOptimization.kt b/compiler/test/TestOptimization.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestPtNumber.kt b/compiler/test/TestPtNumber.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestScoping.kt b/compiler/test/TestScoping.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestStringEncodings.kt b/compiler/test/TestStringEncodings.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import com.github.michaelbull.result.Ok
 import com.github.michaelbull.result.expectError

diff --git a/compiler/test/TestSubroutines.kt b/compiler/test/TestSubroutines.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestSymbolTable.kt b/compiler/test/TestSymbolTable.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.assertions.fail
 import io.kotest.core.spec.style.FunSpec

diff --git a/compiler/test/TestTypecasts.kt b/compiler/test/TestTypecasts.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.ints.shouldBeGreaterThan

diff --git a/compiler/test/TestZeropage.kt b/compiler/test/TestZeropage.kt
@@ -1,4 +1,4 @@
-package prog8tests
+package prog8tests.compiler
 
 import com.github.michaelbull.result.expectError
 import com.github.michaelbull.result.getOrElse