client/site_tests/power_ThermalLoad/power_ThermalLoad.py

# Lint as: python2, python3
# Copyright 2018 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import logging
import time

from autotest_lib.client.common_lib.cros import chrome
from autotest_lib.client.cros.input_playback import keyboard
from autotest_lib.client.cros.power import power_dashboard
from autotest_lib.client.cros.power import power_status
from autotest_lib.client.cros.power import power_test

FISHES_COUNT = {
        1: 'setSetting0',
        100: 'setSetting1',
        500: 'setSetting2',
        1000: 'setSetting3',
        3000: 'setSetting4',
        5000: 'setSetting5',
        10000: 'setSetting6',
        15000: 'setSetting7',
        20000: 'setSetting8',
        25000: 'setSetting9',
        30000: 'setSetting10',
}


class power_ThermalLoad(power_test.power_Test):
    """class for power_ThermalLoad test.
    """
    version = 2

    FISHTANK_URL = 'http://crospower.page.link/power_ThermalLoad'
    HOUR = 60 * 60

    def select_fishes(self, tab, fish_settings):
        """Simple wrapper to select the required fish count

        @param tab: An Autotest Chrome tab instance.
        @param fish_settings: Webgl fish count settings
        """
        tab.ExecuteJavaScript('%s.click();' % fish_settings)

    def run_once(self,
                 test_url=FISHTANK_URL,
                 duration=2.5 * HOUR,
                 numFish=3000):
        """run_once method.

        @param test_url: url of webgl heavy page.
        @param duration: time in seconds to display url and measure power.
        @param numFish: number of fish to pass to WebGL Aquarium.
        """
        # --disable-sync disables test account info sync, eg. Wi-Fi credentials,
        # so that each test run does not remember info from last test run.
        extra_browser_args = ['--disable-sync']
        # b/228256145 to avoid powerd restart
        extra_browser_args.append('--disable-features=FirmwareUpdaterApp')
        with chrome.Chrome(extra_browser_args=extra_browser_args,
                           init_network_controller=True) as self.cr:
            tab = self.cr.browser.tabs.New()
            tab.Activate()

            # Just measure power in full-screen.
            fullscreen = tab.EvaluateJavaScript('document.webkitIsFullScreen')
            if not fullscreen:
                with keyboard.Keyboard() as keys:
                    keys.press_key('f4')

            # Stop services again as Chrome might have restarted them.
            self._services.stop_services()

            self.backlight.set_percent(100)

            logging.info('Navigating to url: %s', test_url)
            tab.Navigate(test_url)
            tab.WaitForDocumentReadyStateToBeComplete()
            logging.info("Selecting %d Fishes", numFish)
            self.select_fishes(tab, FISHES_COUNT[numFish])

            self._flog = FishTankFpsLogger(tab,
                    seconds_period=self._seconds_period,
                    checkpoint_logger=self._checkpoint_logger)
            self._meas_logs.append(self._flog)
            power_dashboard.get_dashboard_factory().registerDataType(
                FishTankFpsLogger, power_dashboard.VideoFpsLoggerDashboard)

            self.start_measurements()
            while time.time() - self._start_time < duration:
                time.sleep(60)
                self.status.refresh()
                if self.status.is_low_battery():
                    logging.info(
                        'Low battery, stop test early after %.0f minutes',
                        (time.time() - self._start_time) / 60)
                    return


class FishTankFpsLogger(power_status.MeasurementLogger):
    """Class to measure Video WebGL Aquarium fps & fish per sec."""

    def __init__(self, tab, seconds_period=20.0, checkpoint_logger=None):
        """Initialize a FishTankFpsLogger.

        Args:
            tab: Chrome tab object
        """
        super(FishTankFpsLogger, self).__init__([], seconds_period,
                                                    checkpoint_logger)
        self._tab = tab
        (frameCount, frameTime) = self._tab.EvaluateJavaScript(
                '[frameCount, Date.now()/1000]')
        fishCount = self.get_fish_count(tab)
        self.domains = ['avg_fps_%04d_fishes' % fishCount]
        self._lastFrameCount = frameCount
        self._lastFrameTime = frameTime

    def get_fish_count(self, tab):
        style_string = 'color: red;'
        for count, setting in FISHES_COUNT.items():
            style = tab.EvaluateJavaScript('%s.getAttribute("style")' %
                                           setting)
            if style == style_string:
                return count

    def refresh(self):
        (frameCount, frameTime
         ) = self._tab.EvaluateJavaScript('[frameCount, Date.now()/1000]')
        period = frameTime - self._lastFrameTime
        fps = (frameCount - self._lastFrameCount) / period
        self._lastFrameCount = frameCount
        self._lastFrameTime = frameTime
        return [fps]

    def save_results(self, resultsdir, fname_prefix=None):
        if not fname_prefix:
            fname_prefix = '%s_results_%.0f' % (self.domains[0], time.time())
        super(FishTankFpsLogger, self).save_results(resultsdir, fname_prefix)

    def calc(self, mtype='fps'):
        return super(FishTankFpsLogger, self).calc(mtype)