1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.tools.flicker.config
18 
19 import android.tools.flicker.AssertionInvocationGroup
20 import android.tools.flicker.assertors.AssertionId
21 import android.tools.flicker.assertors.AssertionTemplate
22 import android.tools.flicker.extractors.ScenarioExtractor
23 
24 interface FlickerConfig {
registerScenarionull25     fun registerScenario(
26         scenario: ScenarioId,
27         extractor: ScenarioExtractor,
28         assertions: Map<AssertionTemplate, AssertionInvocationGroup>? = null
29     ): FlickerConfig
30 
31     fun registerAssertions(
32         scenario: ScenarioId,
33         vararg assertions: AssertionTemplate,
34         stabilityGroup: AssertionInvocationGroup = AssertionInvocationGroup.BLOCKING
35     ): FlickerConfig
36 
37     fun getEntries(): Collection<FlickerConfigEntry>
38 
39     fun unregisterScenario(scenario: ScenarioId): FlickerConfig
40 
41     fun overrideAssertionStabilityGroup(
42         scenario: ScenarioId,
43         assertionId: AssertionId,
44         stabilityGroup: AssertionInvocationGroup
45     ): FlickerConfig
46 
47     fun unregisterAssertion(scenario: ScenarioId, assertionId: AssertionId): FlickerConfig
48 
49     fun use(flickerConfigEntries: Collection<FlickerConfigEntry>): FlickerConfig
50 
51     fun use(vararg flickerConfigEntries: FlickerConfigEntry): FlickerConfig =
52         use(flickerConfigEntries.asList())
53 }
54