libraries/flicker/src/android/tools/common/flicker/config/FlickerConfig.kt

/*
 * Copyright (C) 2023 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 android.tools.common.flicker.config

import android.tools.common.flicker.AssertionInvocationGroup
import android.tools.common.flicker.assertors.AssertionId
import android.tools.common.flicker.assertors.AssertionTemplate
import android.tools.common.flicker.extractors.ScenarioExtractor

interface FlickerConfig {
    fun registerScenario(
        scenario: ScenarioId,
        extractorProvider: ScenarioExtractorProvider,
        assertions: Map<AssertionTemplate, AssertionInvocationGroup>? = null
    )

    fun registerExtractor(scenario: ScenarioId, extractorProvider: ScenarioExtractorProvider)

    fun registerAssertion(
        scenario: ScenarioId,
        assertion: AssertionTemplate,
        stabilityGroup: AssertionInvocationGroup = AssertionInvocationGroup.BLOCKING
    )

    fun getExtractors(): Collection<ScenarioExtractor>

    fun unregisterScenario(scenario: ScenarioId)

    fun overrideAssertionStabilityGroup(
        scenario: ScenarioId,
        assertionId: AssertionId,
        stabilityGroup: AssertionInvocationGroup
    )

    fun unregisterAssertion(scenario: ScenarioId, assertionId: AssertionId)

    fun use(flickerConfigEntries: Collection<FlickerConfigEntry>): FlickerConfig

    fun use(vararg flickerConfigEntries: FlickerConfigEntry): FlickerConfig =
        use(flickerConfigEntries.asList())
}