[Build] Move utils for generation JUnit 5 tests to :generators module
This commit is contained in:
Dmitriy Novozhilov
committed by
TeamCityServer
TeamCityServer
parent
48aa063b21
commit
e56c87a17a
@@ -10,7 +10,12 @@ dependencies {
|
||||
testApi(projectTests(":compiler:test-infrastructure-utils"))
|
||||
testApi(kotlinStdlib())
|
||||
testApi(commonDep("junit:junit"))
|
||||
testApiJUnit5()
|
||||
testApi(project(":generators"))
|
||||
|
||||
testCompileOnly(project(":kotlin-reflect-api"))
|
||||
testRuntimeOnly(project(":kotlin-reflect"))
|
||||
testRuntimeOnly(project(":core:descriptors.runtime"))
|
||||
}
|
||||
|
||||
sourceSets {
|
||||
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
/*
|
||||
* 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.generators
|
||||
|
||||
fun generateTestGroupSuiteWithJUnit5(
|
||||
args: Array<String>,
|
||||
init: TestGroupSuite.() -> Unit
|
||||
) {
|
||||
generateTestGroupSuiteWithJUnit5(InconsistencyChecker.hasDryRunArg(args), init)
|
||||
}
|
||||
|
||||
fun generateTestGroupSuiteWithJUnit5(
|
||||
dryRun: Boolean = false,
|
||||
init: TestGroupSuite.() -> Unit
|
||||
) {
|
||||
val suite = TestGroupSuite(ReflectionBasedTargetBackendComputer).apply(init)
|
||||
for (testGroup in suite.testGroups) {
|
||||
for (testClass in testGroup.testClasses) {
|
||||
val (changed, testSourceFilePath) = NewTestGeneratorImpl.generateAndSave(testClass, dryRun)
|
||||
if (changed) {
|
||||
InconsistencyChecker.inconsistencyChecker(dryRun).add(testSourceFilePath)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+276
@@ -0,0 +1,276 @@
|
||||
/*
|
||||
* 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.generators
|
||||
|
||||
import org.jetbrains.kotlin.generators.impl.SimpleTestClassModelTestAllFilesPresentMethodGenerator
|
||||
import org.jetbrains.kotlin.generators.impl.SimpleTestMethodGenerator
|
||||
import org.jetbrains.kotlin.generators.impl.SingleClassTestModelAllFilesPresentedMethodGenerator
|
||||
import org.jetbrains.kotlin.generators.model.*
|
||||
import org.jetbrains.kotlin.generators.util.GeneratorsFileUtil
|
||||
import org.jetbrains.kotlin.test.TestMetadata
|
||||
import org.jetbrains.kotlin.test.util.KtTestUtil
|
||||
import org.jetbrains.kotlin.utils.Printer
|
||||
import org.junit.jupiter.api.Nested
|
||||
import org.junit.jupiter.api.Tag
|
||||
import org.junit.jupiter.api.Test
|
||||
import java.io.File
|
||||
import java.io.IOException
|
||||
import java.util.*
|
||||
|
||||
private const val TEST_GENERATOR_NAME = "GenerateNewCompilerTests.kt"
|
||||
|
||||
private val METHOD_GENERATORS = listOf(
|
||||
SimpleTestClassModelTestAllFilesPresentMethodGenerator,
|
||||
SimpleTestMethodGenerator,
|
||||
SingleClassTestModelAllFilesPresentedMethodGenerator
|
||||
)
|
||||
|
||||
object NewTestGeneratorImpl : TestGenerator(METHOD_GENERATORS) {
|
||||
private val GENERATED_FILES = HashSet<String>()
|
||||
|
||||
private fun Printer.generateMetadata(testDataSource: TestEntityModel) {
|
||||
val dataString = testDataSource.dataString
|
||||
if (dataString != null) {
|
||||
println("@TestMetadata(\"", dataString, "\")")
|
||||
}
|
||||
}
|
||||
|
||||
private fun Printer.generateTestAnnotation() {
|
||||
println("@Test")
|
||||
}
|
||||
|
||||
private fun Printer.generateNestedAnnotation(isNested: Boolean) {
|
||||
if (isNested) {
|
||||
println("@Nested")
|
||||
}
|
||||
}
|
||||
|
||||
private fun Printer.generateTestDataPath(testClassModel: TestClassModel) {
|
||||
val dataPathRoot = testClassModel.dataPathRoot
|
||||
if (dataPathRoot != null) {
|
||||
println("@TestDataPath(\"", dataPathRoot, "\")")
|
||||
}
|
||||
}
|
||||
|
||||
private fun Printer.generateParameterAnnotations(testClassModel: TestClassModel) {
|
||||
for (annotationModel in testClassModel.annotations) {
|
||||
annotationModel.generate(this)
|
||||
println()
|
||||
}
|
||||
}
|
||||
|
||||
private fun Printer.generateTags(testEntityModel: TestEntityModel) {
|
||||
for (tag in testEntityModel.tags) {
|
||||
println("@Tag(\"$tag\")")
|
||||
}
|
||||
}
|
||||
|
||||
private fun Printer.generateSuppressAllWarnings() {
|
||||
println("@SuppressWarnings(\"all\")")
|
||||
}
|
||||
|
||||
override fun generateAndSave(testClass: TestGroup.TestClass, dryRun: Boolean): GenerationResult {
|
||||
val generatorInstance = TestGeneratorInstance(
|
||||
testClass.baseDir,
|
||||
testClass.suiteTestClassName,
|
||||
testClass.baseTestClassName,
|
||||
testClass.testModels,
|
||||
methodGenerators
|
||||
)
|
||||
return generatorInstance.generateAndSave(dryRun)
|
||||
}
|
||||
|
||||
private class TestGeneratorInstance(
|
||||
baseDir: String,
|
||||
suiteTestClassFqName: String,
|
||||
baseTestClassFqName: String,
|
||||
private val testClassModels: Collection<TestClassModel>,
|
||||
private val methodGenerators: Map<MethodModel.Kind, MethodGenerator<*>>
|
||||
) {
|
||||
private val baseTestClassPackage: String = baseTestClassFqName.substringBeforeLast('.', "")
|
||||
private val baseTestClassName: String = baseTestClassFqName.substringAfterLast('.', baseTestClassFqName)
|
||||
private val suiteClassPackage: String = suiteTestClassFqName.substringBeforeLast('.', baseTestClassPackage)
|
||||
private val suiteClassName: String = suiteTestClassFqName.substringAfterLast('.', suiteTestClassFqName)
|
||||
private val testSourceFilePath: String = baseDir + "/" + this.suiteClassPackage.replace(".", "/") + "/" + this.suiteClassName + ".java"
|
||||
|
||||
init {
|
||||
if (!GENERATED_FILES.add(testSourceFilePath)) {
|
||||
throw IllegalArgumentException("Same test file already generated in current session: $testSourceFilePath")
|
||||
}
|
||||
}
|
||||
|
||||
@Throws(IOException::class)
|
||||
fun generateAndSave(dryRun: Boolean): GenerationResult {
|
||||
val generatedCode = generate()
|
||||
|
||||
val testSourceFile = File(testSourceFilePath)
|
||||
val changed =
|
||||
GeneratorsFileUtil.isFileContentChangedIgnoringLineSeparators(testSourceFile, generatedCode)
|
||||
if (!dryRun) {
|
||||
GeneratorsFileUtil.writeFileIfContentChanged(testSourceFile, generatedCode, false)
|
||||
}
|
||||
return GenerationResult(changed, testSourceFilePath)
|
||||
}
|
||||
|
||||
private fun generate(): String {
|
||||
val out = StringBuilder()
|
||||
val p = Printer(out)
|
||||
|
||||
val copyright = File("license/COPYRIGHT_HEADER.txt").readText()
|
||||
p.println(copyright)
|
||||
p.println()
|
||||
p.println("package $suiteClassPackage;")
|
||||
p.println()
|
||||
p.println("import com.intellij.testFramework.TestDataPath;")
|
||||
p.println("import ${KtTestUtil::class.java.canonicalName};")
|
||||
|
||||
for (clazz in testClassModels.flatMapTo(mutableSetOf()) { classModel -> classModel.imports }) {
|
||||
p.println("import ${clazz.name};")
|
||||
}
|
||||
|
||||
if (suiteClassPackage != baseTestClassPackage) {
|
||||
p.println("import $baseTestClassPackage.$baseTestClassName;")
|
||||
}
|
||||
|
||||
p.println("import ${TestMetadata::class.java.canonicalName};")
|
||||
p.println("import ${Nested::class.java.canonicalName};")
|
||||
p.println("import ${Test::class.java.canonicalName};")
|
||||
if (testClassModels.any { it.containsTags() }) {
|
||||
p.println("import ${Tag::class.java.canonicalName};")
|
||||
}
|
||||
p.println()
|
||||
p.println("import java.io.File;")
|
||||
p.println("import java.util.regex.Pattern;")
|
||||
p.println()
|
||||
p.println("/** This class is generated by {@link ", TEST_GENERATOR_NAME, "}. DO NOT MODIFY MANUALLY */")
|
||||
|
||||
p.generateSuppressAllWarnings()
|
||||
|
||||
val model: TestClassModel
|
||||
if (testClassModels.size == 1) {
|
||||
model = object : DelegatingTestClassModel(testClassModels.single()) {
|
||||
override val name: String
|
||||
get() = suiteClassName
|
||||
}
|
||||
} else {
|
||||
model = object : TestClassModel() {
|
||||
override val innerTestClasses: Collection<TestClassModel>
|
||||
get() = testClassModels
|
||||
|
||||
override val methods: Collection<MethodModel>
|
||||
get() = emptyList()
|
||||
|
||||
override val isEmpty: Boolean
|
||||
get() = false
|
||||
|
||||
override val name: String
|
||||
get() = suiteClassName
|
||||
|
||||
override val dataString: String?
|
||||
get() = null
|
||||
|
||||
override val dataPathRoot: String?
|
||||
get() = null
|
||||
|
||||
override val annotations: Collection<AnnotationModel>
|
||||
get() = emptyList()
|
||||
|
||||
override val imports: Set<Class<*>>
|
||||
get() = super.imports
|
||||
|
||||
override val tags: List<String>
|
||||
get() = emptyList()
|
||||
}
|
||||
}
|
||||
|
||||
generateTestClass(p, model, false)
|
||||
return out.toString()
|
||||
}
|
||||
|
||||
private fun generateTestClass(p: Printer, testClassModel: TestClassModel, isNested: Boolean) {
|
||||
p.generateNestedAnnotation(isNested)
|
||||
p.generateTags(testClassModel)
|
||||
p.generateMetadata(testClassModel)
|
||||
p.generateTestDataPath(testClassModel)
|
||||
p.generateParameterAnnotations(testClassModel)
|
||||
|
||||
val extendsClause = if (!isNested) " extends $baseTestClassName" else ""
|
||||
|
||||
p.println("public class ${testClassModel.name}$extendsClause {")
|
||||
p.pushIndent()
|
||||
|
||||
val testMethods = testClassModel.methods
|
||||
val innerTestClasses = testClassModel.innerTestClasses
|
||||
|
||||
var first = true
|
||||
|
||||
for (methodModel in testMethods) {
|
||||
if (methodModel is RunTestMethodModel) continue
|
||||
if (!methodModel.shouldBeGenerated()) continue
|
||||
|
||||
if (first) {
|
||||
first = false
|
||||
} else {
|
||||
p.println()
|
||||
}
|
||||
|
||||
generateTestMethod(p, methodModel)
|
||||
}
|
||||
|
||||
for (innerTestClass in innerTestClasses) {
|
||||
if (!innerTestClass.isEmpty) {
|
||||
if (first) {
|
||||
first = false
|
||||
} else {
|
||||
p.println()
|
||||
}
|
||||
|
||||
generateTestClass(p, innerTestClass, true)
|
||||
}
|
||||
}
|
||||
|
||||
p.popIndent()
|
||||
p.println("}")
|
||||
}
|
||||
|
||||
private fun generateTestMethod(p: Printer, methodModel: MethodModel) {
|
||||
val generator = methodGenerators.getValue(methodModel.kind)
|
||||
|
||||
p.generateTestAnnotation()
|
||||
p.generateTags(methodModel)
|
||||
p.generateMetadata(methodModel)
|
||||
generator.hackyGenerateSignature(methodModel, p)
|
||||
p.printWithNoIndent(" {")
|
||||
p.println()
|
||||
|
||||
p.pushIndent()
|
||||
|
||||
generator.hackyGenerateBody(methodModel, p)
|
||||
|
||||
p.popIndent()
|
||||
p.println("}")
|
||||
}
|
||||
|
||||
private fun <T : MethodModel> MethodGenerator<T>.hackyGenerateBody(method: MethodModel, p: Printer) {
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
generateBody(method as T, p)
|
||||
}
|
||||
|
||||
private fun <T : MethodModel> MethodGenerator<T>.hackyGenerateSignature(method: MethodModel, p: Printer) {
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
generateSignature(method as T, p)
|
||||
}
|
||||
}
|
||||
|
||||
private fun TestEntityModel.containsTags(): Boolean {
|
||||
if (this.tags.isNotEmpty()) return true
|
||||
if (this is TestClassModel) {
|
||||
if (innerTestClasses.any { it.containsTags() }) return true
|
||||
if (methods.any { it.containsTags() }) return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
}
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* 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.generators
|
||||
|
||||
import org.jetbrains.kotlin.generators.model.DefaultTargetBackendComputer
|
||||
import org.jetbrains.kotlin.generators.model.TargetBackendComputer
|
||||
import org.jetbrains.kotlin.test.TargetBackend
|
||||
import org.jetbrains.kotlin.test.runners.RunnerWithTargetBackendForTestGeneratorMarker
|
||||
import kotlin.reflect.KClass
|
||||
import kotlin.reflect.full.createInstance
|
||||
import kotlin.reflect.full.declaredMemberProperties
|
||||
import kotlin.reflect.full.isSubclassOf
|
||||
|
||||
object ReflectionBasedTargetBackendComputer : TargetBackendComputer {
|
||||
private val runnerMarkerKClass = RunnerWithTargetBackendForTestGeneratorMarker::class
|
||||
private const val TARGET_BACKEND_PROPERTY_NAME = "targetBackend"
|
||||
|
||||
override fun compute(definedTargetBackend: TargetBackend?, testKClass: KClass<*>): TargetBackend {
|
||||
if (!testKClass.isSubclassOf(runnerMarkerKClass)) return DefaultTargetBackendComputer.compute(definedTargetBackend, testKClass)
|
||||
require(definedTargetBackend == null) {
|
||||
"""
|
||||
Test ${testKClass.simpleName} is inheritor of ${runnerMarkerKClass.simpleName} which means that
|
||||
target you should not specify targetBackend in test generation DSL, because it will be
|
||||
read from test runner class itself
|
||||
""".trimIndent()
|
||||
}
|
||||
require(testKClass.isOpen) {
|
||||
"""
|
||||
Test runner which inherits from ${runnerMarkerKClass.simpleName} and used as base class
|
||||
for real test should have `open` modality
|
||||
""".trimIndent()
|
||||
}
|
||||
val instance = testKClass.createInstance() as RunnerWithTargetBackendForTestGeneratorMarker
|
||||
val kProperty = runnerMarkerKClass.declaredMemberProperties.single { it.name == TARGET_BACKEND_PROPERTY_NAME }
|
||||
return kProperty.get(instance) as TargetBackend
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user