/*
 * Copyright 2020 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 androidx.room.compiler.processing.util.runner

import androidx.room.compiler.processing.ExperimentalProcessingApi
import androidx.room.compiler.processing.XProcessingEnvConfig
import androidx.room.compiler.processing.util.CompilationResult
import androidx.room.compiler.processing.util.Source
import androidx.room.compiler.processing.util.XTestInvocation
import java.io.File

/**
 * Common interface for compilation tests
 */
@ExperimentalProcessingApi
internal interface CompilationTestRunner {
    // user visible name that we can print in assertions
    val name: String

    fun canRun(params: TestCompilationParameters): Boolean

    fun compile(workingDir: File, params: TestCompilationParameters): CompilationResult
}

@ExperimentalProcessingApi
internal data class TestCompilationParameters(
    val sources: List<Source> = emptyList(),
    val classpath: List<File> = emptyList(),
    val options: Map<String, String> = emptyMap(),
    val javacArguments: List<String> = emptyList(),
    val kotlincArguments: List<String> = emptyList(),
    val config: XProcessingEnvConfig,
    val handlers: List<(XTestInvocation) -> Unit>,
)
