src/test/java/com/android/tools/metalava/TestUtils.kt

/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.tools.metalava

import com.android.tools.lint.checks.infrastructure.TestFile
import com.android.tools.lint.checks.infrastructure.TestFiles
import org.intellij.lang.annotations.Language
import org.junit.rules.TestRule
import org.junit.runner.Description
import org.junit.runners.model.Statement
import java.io.File
import kotlin.io.path.createTempDirectory

fun java(to: String, @Language("JAVA") source: String): TestFile {
    return TestFiles.java(to, source.trimIndent())
}

fun java(@Language("JAVA") source: String): TestFile {
    return TestFiles.java(source.trimIndent())
}

fun kotlin(@Language("kotlin") source: String): TestFile {
    return TestFiles.kotlin(source.trimIndent())
}

fun kotlin(to: String, @Language("kotlin") source: String): TestFile {
    return TestFiles.kotlin(to, source.trimIndent())
}

/** Marks tests to run against both Kotlin PSI and UAST based models */
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class TestKotlinPsi(
    /** Set this to a bug ID to skip the Kotlin PSI run for temporarily broken tests */
    val skipDueToBugId: Long = 0L
)

/**
 * Rule that runs tests annotated with [TestKotlinPsi] twice: first with the Kotlin PSI model
 * [enabled] and then without to ensure consistent behavior between UAST and Kotlin PSI models.
 */
class KotlinPsiRule : TestRule {
    var enabled: Boolean = false
        private set

    override fun apply(base: Statement, description: Description): Statement {
        enabled = false
        val annotation = description.getAnnotation(TestKotlinPsi::class.java)

        return if (annotation != null && annotation.skipDueToBugId == 0L) {
            object : Statement() {
                override fun evaluate() {
                    enabled = true
                    base.evaluate()
                    enabled = false
                    base.evaluate()
                }
            }
        } else {
            base
        }
    }
}

/** Creates a temporary directory and cleans up afterwards */
inline fun tempDirectory(action: (File) -> Unit) {
    val tempDirectory = createTempDirectory().toFile()
    try {
        action(tempDirectory)
    } finally {
        tempDirectory.deleteRecursively()
    }
}