libraries/flicker/src/android/tools/common/flicker/ScenarioInstance.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

import android.tools.common.Scenario
import android.tools.common.flicker.assertions.ScenarioAssertion
import android.tools.common.flicker.config.ScenarioAssertionsConfig
import android.tools.common.flicker.config.ScenarioId
import android.tools.common.io.Reader
import android.tools.common.traces.wm.Transition

interface ScenarioInstance : Scenario {
    val config: ScenarioAssertionsConfig

    /** A reader to read the part of the trace associated with the scenario instance */
    val reader: Reader
    val associatedTransition: Transition?

    val type: ScenarioId
        get() = config.scenarioId

    fun generateAssertions(): Collection<ScenarioAssertion>
}