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

import android.tools.common.flicker.IScenarioInstance
import android.tools.common.flicker.assertors.AssertionTemplate
import android.tools.common.flicker.subject.layers.LayersTraceSubject

/**
 * Checks if the stack space of all displays is fully covered by any visible layer, during the whole
 * transitions
 */
class EntireScreenCoveredAlways : AssertionTemplate() {
    /** {@inheritDoc} */
    override fun doEvaluate(scenarioInstance: IScenarioInstance, layerSubject: LayersTraceSubject) {
        layerSubject
            .invoke("entireScreenCovered") { entry ->
                val displays = entry.entry.displays
                if (displays.isEmpty()) {
                    entry.fail("No displays found")
                }
                displays.forEach { display ->
                    entry.visibleRegion().coversAtLeast(display.layerStackSpace)
                }
            }
            .forAllEntries()
    }

    override fun equals(other: Any?): Boolean {
        return other is EntireScreenCoveredAlways
    }

    override fun hashCode(): Int {
        return this::class.hashCode()
    }
}