libraries/flicker/src/com/android/server/wm/traces/common/service/assertors/assertions/AppLayerRemainInsideDisplayBounds.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 com.android.server.wm.traces.common.service.assertors.assertions

import com.android.server.wm.traces.common.service.IScenarioInstance
import com.android.server.wm.traces.common.service.assertors.ComponentTemplate
import com.android.server.wm.traces.common.subjects.layers.LayersTraceSubject

/**
 * Checks if the [component] layer remains inside the display bounds throughout the whole animation
 */
class AppLayerRemainInsideDisplayBounds(component: ComponentTemplate) :
    AssertionTemplateWithComponent(component) {
    /** {@inheritDoc} */
    override fun doEvaluate(scenarioInstance: IScenarioInstance, layerSubject: LayersTraceSubject) {
        layerSubject
            .invoke("appLayerRemainInsideDisplayBounds") { entry ->
                val displays = entry.entry.displays
                if (displays.isEmpty()) {
                    entry.fail("No displays found")
                }
                displays.forEach { display ->
                    entry
                        .visibleRegion(component.build(scenarioInstance))
                        .coversAtMost(display.layerStackSpace)
                }
            }
            .forAllEntries()
    }
}