libraries/collectors-helper/statsd/test/src/com/android/helpers/CpuUsageHelperTest.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 com.android.helpers;

import android.platform.helpers.HelperAccessor;
import android.platform.helpers.ICalculatorHelper;

import androidx.test.runner.AndroidJUnit4;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

import java.util.Map;

import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertEquals;

/**
 * Android Unit tests for {@link CpuUsageHelperTest}.
 *
 * To run:
 * Disable SELinux: adb shell setenforce 0; if this fails with "permission denied",
 * try "adb shell su 0 setenforce 0"
 * atest CollectorsHelperTest:com.android.helpers.CpuUsageHelperTest
 */
@RunWith(AndroidJUnit4.class)
public class CpuUsageHelperTest {

    // Kill the calculator app.
    private static final String KILL_TEST_APP_CMD = "am force-stop com.google.android.calculator";
    // Key prefix used for cpu usage by package name or uid
    private static final String CPU_USAGE_PKG_UID_PREFIX = "cpu_usage_pkg_or_uid";
    // Key used for total CPU usage
    private static final String TOTAL_CPU_USAGE = "total_cpu_usage";
    // key used for total CPU time
    private static final String TOTAL_CPU_TIME = "total_cpu_time";
    // Key used for CPU utilization average over each core
    private static final String CPU_UTILIZATION = "cpu_utilization_average_per_core_percent";

    private CpuUsageHelper mCpuUsageHelper;
    private HelperAccessor<ICalculatorHelper> mHelper =
            new HelperAccessor<>(ICalculatorHelper.class);

    @Before
    public void setUp() {
        mCpuUsageHelper = new CpuUsageHelper();
    }

    /**
     * Test successfull cpu usage config.
     */
    @Test
    public void testCpuUsageConfig() throws Exception {
        assertTrue(mCpuUsageHelper.startCollecting());
        assertTrue(mCpuUsageHelper.stopCollecting());
    }

    /**
     * Test cpu usage metrics are collected.
     */
    @Test
    public void testCpuUsageMetrics() throws Exception {
        assertTrue(mCpuUsageHelper.startCollecting());
        mHelper.get().open();
        Map<String, Long> cpuUsage = mCpuUsageHelper.getMetrics();
        // Which includes two default total usage per pkg and per freq
        assertTrue(cpuUsage.size() > 2);
        assertTrue(mCpuUsageHelper.stopCollecting());
        mHelper.get().exit();
    }

    /**
     * Test that at least one cpu usage per pkg or uid and per preq index is collected,
     * the total usage is collected, and that the total usage is indeed the sum of the per pkg/uid
     * and frequency usage, respectively.
     */
    @Test
    public void testCpuUsageMetricsKey() throws Exception {
        // Variables to verify existence of collected metrics.
        boolean isPkgorUidPresent = false;
        boolean isUIDUsed = false;
        boolean isTotalCpuUsageEntryPresent = false;
        boolean isTotalCpuUsageValuePresent = false;
        assertTrue(mCpuUsageHelper.startCollecting());
        mHelper.get().open();
        // Variables to Verify that the reported usage does sum up to the reported total usage.
        Long sumCpuUsage = 0L;
        Long reportedTotalCpuUsage = 0L;
        for (Map.Entry<String, Long> cpuUsageEntry : mCpuUsageHelper.getMetrics().entrySet()) {
            if (cpuUsageEntry.getKey().startsWith(CPU_USAGE_PKG_UID_PREFIX)) {
                isPkgorUidPresent = true;
                if (cpuUsageEntry.getValue() > 0) {
                    isUIDUsed = true;
                }
                sumCpuUsage += cpuUsageEntry.getValue();
            }
            if (cpuUsageEntry.getKey().equals(TOTAL_CPU_USAGE)) {
                isTotalCpuUsageEntryPresent = true;
                if (cpuUsageEntry.getValue() > 0) {
                    isTotalCpuUsageValuePresent = true;
                }
                reportedTotalCpuUsage = cpuUsageEntry.getValue();
            }
        }
        assertTrue(isPkgorUidPresent && isUIDUsed);
        assertTrue(isTotalCpuUsageEntryPresent && isTotalCpuUsageValuePresent);
        assertEquals(sumCpuUsage, reportedTotalCpuUsage);
        assertTrue(mCpuUsageHelper.stopCollecting());
        mHelper.get().exit();
    }

    /**
     * Test cpu usage metrics are not collected per pkg and per freq and collected only total cpu
     * usage by freq and packages.
     */
    @Test
    public void testCpuDisabledPerPkg() throws Exception {
        mCpuUsageHelper.setDisablePerPackage();
        assertTrue(mCpuUsageHelper.startCollecting());
        mHelper.get().open();
        Map<String, Long> cpuUsage = mCpuUsageHelper.getMetrics();
        assertTrue(cpuUsage.size() == 1);
        assertTrue(cpuUsage.containsKey(TOTAL_CPU_USAGE));
        assertTrue(mCpuUsageHelper.stopCollecting());
        mHelper.get().exit();
    }

    /**
     * Test cpu usage metrics are not collected per freq, total
     * usage per freq and package and collected only cpu usage
     * per package.
     */
    @Test
    public void testCpuUsageOnlyPerPkg() throws Exception {
        mCpuUsageHelper.setDisableTotalPackage();
        assertTrue(mCpuUsageHelper.startCollecting());
        mHelper.get().open();
        Map<String, Long> cpuUsage = mCpuUsageHelper.getMetrics();
        assertTrue(cpuUsage.size() > 2);
        for (Map.Entry<String, Long> cpuUsageEntry : mCpuUsageHelper.getMetrics().entrySet()) {
            assertTrue(cpuUsageEntry.getKey().startsWith(CPU_USAGE_PKG_UID_PREFIX));
        }
        assertTrue(mCpuUsageHelper.stopCollecting());
        mHelper.get().exit();
    }

    /**
     * Test cpu utilization is collected.
     */
    @Test
    public void testCpuEnableCpuUtilization() throws Exception {
        mCpuUsageHelper.setEnableCpuUtilization();
        assertTrue(mCpuUsageHelper.startCollecting());
        mHelper.get().open();
        Map<String, Long> cpuUsage = mCpuUsageHelper.getMetrics();
        assertTrue(cpuUsage.size() > 3);
        assertTrue(cpuUsage.containsKey(TOTAL_CPU_USAGE));
        assertTrue(cpuUsage.containsKey(TOTAL_CPU_TIME));
        assertTrue(cpuUsage.containsKey(CPU_UTILIZATION));
        // TOTAL_CPU_TIME >= TOTAL_CPU_USAGE > 0
        assertTrue(cpuUsage.get(TOTAL_CPU_TIME) >= cpuUsage.get(TOTAL_CPU_USAGE));
        assertTrue(cpuUsage.get(TOTAL_CPU_USAGE) > 0);
        // 100 >= CPU_UTILIZATION >=0 (%), it could be equal to 0 due to rounding.
        assertTrue(100 >= cpuUsage.get(CPU_UTILIZATION));
        assertTrue(cpuUsage.get(CPU_UTILIZATION) >= 0);
        assertTrue(mCpuUsageHelper.stopCollecting());
        mHelper.get().exit();
    }

    @After
    public void tearDown() {
        mCpuUsageHelper.stopCollecting();
    }
}