tests/tests/batterysaving/src/android/os/cts/batterysaving/BatterySavingTestBase.java

/*
 * Copyright (C) 2018 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.os.cts.batterysaving;

import static com.android.compatibility.common.util.BatteryUtils.enableBatterySaver;
import static com.android.compatibility.common.util.BatteryUtils.runDumpsysBatteryReset;
import static com.android.compatibility.common.util.BatteryUtils.turnOnScreen;
import static com.android.compatibility.common.util.SystemUtil.runCommandAndPrintOnLogcat;
import static com.android.compatibility.common.util.SystemUtil.runShellCommand;
import static com.android.compatibility.common.util.TestUtils.waitUntil;

import android.content.Context;
import android.content.pm.PackageManager;
import android.location.LocationManager;
import android.os.BatteryManager;
import android.os.PowerManager;
import android.util.Log;

import androidx.test.InstrumentationRegistry;

import com.android.compatibility.common.util.BeforeAfterRule;
import com.android.compatibility.common.util.OnFailureRule;

import org.junit.Assume;
import org.junit.Rule;
import org.junit.rules.RuleChain;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;

public class BatterySavingTestBase {
    private static final String TAG = "BatterySavingTestBase";

    public static final int DEFAULT_TIMEOUT_SECONDS = 30;

    public static final boolean DEBUG = false;

    protected final BroadcastRpc mRpc = new BroadcastRpc();

    private final OnFailureRule mDumpOnFailureRule = new OnFailureRule(TAG) {
        @Override
        protected void onTestFailure(Statement base, Description description, Throwable t) {
            runCommandAndPrintOnLogcat(TAG, "dumpsys power");
            runCommandAndPrintOnLogcat(TAG, "dumpsys alarm");
            runCommandAndPrintOnLogcat(TAG, "dumpsys jobscheduler");
            runCommandAndPrintOnLogcat(TAG, "dumpsys content");
        }
    };

    private final BeforeAfterRule mInitializeAndCleanupRule = new BeforeAfterRule() {
        @Override
        protected void onBefore(Statement base, Description description) throws Throwable {
            // Don't run any battery saver tests on wear.
            final PackageManager pm = getPackageManager();
            Assume.assumeFalse(pm.hasSystemFeature(PackageManager.FEATURE_WATCH));

            turnOnScreen(true);
        }

        @Override
        protected void onAfter(Statement base, Description description) throws Throwable {
            enableBatterySaver(false);
            runDumpsysBatteryReset();
            turnOnScreen(true);
        }
    };

    @Rule
    public RuleChain Rules = RuleChain.outerRule(mInitializeAndCleanupRule)
            .around(mDumpOnFailureRule);

    public String getLogTag() {
        return TAG;
    }

    /** Print a debug log on logcat. */
    public void debug(String message) {
        if (DEBUG || Log.isLoggable(TAG, Log.DEBUG)) {
            Log.d(getLogTag(), message);
        }
    }

    public void waitUntilAlarmForceAppStandby(boolean expected) throws Exception {
        waitUntil("Force all apps standby still " + !expected + " (alarm)", () ->
                runShellCommand("dumpsys alarm").contains("Force all apps standby: " + expected));
    }

    public void waitUntilJobForceAppStandby(boolean expected) throws Exception {
        waitUntil("Force all apps standby still " + !expected + " (job)", () ->
                runShellCommand("dumpsys jobscheduler")
                        .contains("Force all apps standby: " + expected));
    }

    public void waitUntilForceBackgroundCheck(boolean expected) throws Exception {
        waitUntil("Force background check still " + !expected + " (job)", () ->
                runShellCommand("dumpsys activity").contains("mForceBackgroundCheck=" + expected));
    }

    public static Context getContext() {
        return InstrumentationRegistry.getContext();
    }

    public PackageManager getPackageManager() {
        return getContext().getPackageManager();
    }

    public PowerManager getPowerManager() {
        return getContext().getSystemService(PowerManager.class);
    }

    public BatteryManager getBatteryManager() {
        return getContext().getSystemService(BatteryManager.class);
    }

    public LocationManager getLocationManager() {
        return getContext().getSystemService(LocationManager.class);
    }
}