Created AbstractKlibBinaryCompatibilityTest and AbstractJsKlibBinaryCompatibilityTest

A common test runner for klib binary compatibility tests and its js counterpart
2021-01-14 15:51:20 +03:00
parent e7cf34a2a9
commit 16b3fedcd4
4 changed files with 448 additions and 1 deletions
@@ -0,0 +1,104 @@
+/*
+ * Copyright 2010-2021 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.compatibility.binary
+
+import org.jetbrains.kotlin.test.*
+import org.jetbrains.kotlin.test.util.KtTestUtil
+import org.jetbrains.kotlin.utils.DFS
+import java.io.File
+
+class TestFile(val module: TestModule, fileName: String, text: String, directives: Directives)
+    : KotlinBaseTest.TestFile(fileName, text, directives) {
+    init {
+        module.files.add(this)
+    }
+    val version: Int? = directives["VERSION"]?.toInt()
+}
+
+class TestModule(name: String, dependenciesSymbols: List<String>, friends: List<String>)
+    : KotlinBaseTest.TestModule(name, dependenciesSymbols, friends) {
+
+    val files = mutableListOf<TestFile>()
+    val hasVersions get() = files.any { it.version != null }
+    fun versionFiles(version: Int) = files.filter { it.version == null || it.version == version }
+}
+
+abstract class AbstractKlibBinaryCompatibilityTest : KotlinTestWithEnvironment() {
+
+    private val pathToRootOutputDir = System.getProperty("kotlin.js.test.root.out.dir") ?: error("'kotlin.js.test.root.out.dir' is not set")
+    private val testGroupSuffix = "binaryCompatibility/"
+    protected lateinit var workingDir: File
+
+    fun doTest(filePath: String) {
+        workingDir = File(pathToRootOutputDir + "out/$testGroupSuffix" + filePath)
+        workingDir.mkdirs()
+        doTestWithIgnoringByFailFile(filePath)
+    }
+
+    fun doTestWithIgnoringByFailFile(filePath: String) {
+        val failFile = File("$filePath.fail")
+        try {
+            doTest(filePath, "OK")
+        } catch (e: Throwable) {
+            if (failFile.exists()) {
+                KotlinTestUtils.assertEqualsToFile(failFile, e.message ?: "")
+            } else {
+                throw e
+            }
+        }
+    }
+
+    fun doTest(filePath: String, expectedResult: String) {
+        val file = File(filePath)
+        val fileContent = KtTestUtil.doLoadFile(file)
+
+        val inputFiles = TestFiles.createTestFiles(
+            file.name,
+            fileContent,
+            object : TestFiles.TestFileFactory<TestModule, TestFile> {
+                override fun createFile(module: TestModule?, fileName: String, text: String, directives: Directives) =
+                    module?.let {
+                        TestFile(module, fileName, text, directives)
+                    } ?: error("Expected a module for $fileName in $filePath")
+
+                override fun createModule(name: String, dependencies: List<String>, friends: List<String>) =
+                    TestModule(name, dependencies, friends)
+
+            },
+            true,
+            true
+        )
+        val modules = inputFiles
+            .map { it.module }.distinct()
+            .map { it.name to it }.toMap()
+
+        val orderedModules = DFS.topologicalOrder(modules.values) { module ->
+            module.dependenciesSymbols.mapNotNull { modules[it] }
+        }
+
+        val mainModuleName = DEFAULT_MODULE
+        val mainModule = modules[mainModuleName] ?: error("No module with name \"$mainModuleName\"")
+
+        orderedModules.reversed().filterNot { it === mainModule }.forEach {
+            produceKlib(it, 1)
+            if (it.hasVersions) {
+                produceKlib(it, 2)
+            }
+        }
+        produceProgram(mainModule)
+
+        runProgram(mainModule, expectedResult)
+    }
+
+    abstract fun produceKlib(module: TestModule, version: Int)
+    abstract fun produceProgram(module: TestModule)
+    abstract fun runProgram(module: TestModule, expectedResult: String)
+
+    companion object {
+        val TEST_FUNCTION = "box"
+        val DEFAULT_MODULE = "main"
+    }
+}