libraries/flicker/src/android/tools/device/flicker/legacy/runner/Utils.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.device.flicker.legacy.runner

import android.app.Instrumentation
import android.os.Bundle
import android.tools.common.CrossPlatform
import android.tools.common.IScenario
import android.tools.common.traces.ConditionList
import android.tools.common.traces.ConditionsFactory
import android.tools.device.traces.parsers.WindowManagerStateHelper
import androidx.test.platform.app.InstrumentationRegistry
import org.junit.runner.Description

/** Helper class for flicker transition rules */
object Utils {
    /**
     * Conditions that determine when the UI is in a stable and no windows or layers are animating
     * or changing state.
     */
    private val UI_STABLE_CONDITIONS =
        ConditionList(
            listOf(
                ConditionsFactory.isWMStateComplete(),
                ConditionsFactory.hasLayersAnimating().negate()
            )
        )
    private val instrumentation: Instrumentation = InstrumentationRegistry.getInstrumentation()

    internal fun doWaitForUiStabilize(wmHelper: WindowManagerStateHelper) {
        wmHelper.StateSyncBuilder().add(UI_STABLE_CONDITIONS).waitFor()
    }

    internal fun notifyRunnerProgress(scenario: IScenario, msg: String) {
        CrossPlatform.log.d(FLICKER_RUNNER_TAG, "${scenario.key} - $msg")
        val results = Bundle()
        results.putString(Instrumentation.REPORT_KEY_STREAMRESULT, "$msg\n")
        instrumentation.sendStatus(1, results)
    }

    internal fun expandDescription(description: Description?, suffix: String): Description? =
        Description.createTestDescription(
            description?.className,
            "${description?.displayName}-$suffix",
            description?.annotations?.toTypedArray()
        )
}