| #!/usr/bin/env python2 |
| # -*- coding: utf-8 -*- |
| # |
| # Copyright (c) 2014 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. |
| |
| """Unittest for suite_runner.""" |
| |
| from __future__ import print_function |
| |
| import json |
| import os.path |
| import time |
| |
| import unittest |
| import mock |
| |
| import suite_runner |
| import label |
| |
| from benchmark import Benchmark |
| |
| from cros_utils import command_executer |
| from cros_utils import logger |
| from cros_utils.device_setup_utils import DutWrapper |
| from machine_manager import MockCrosMachine |
| |
| |
| class SuiteRunnerTest(unittest.TestCase): |
| """Class of SuiteRunner test.""" |
| real_logger = logger.GetLogger() |
| |
| mock_json = mock.Mock(spec=json) |
| mock_cmd_exec = mock.Mock(spec=command_executer.CommandExecuter) |
| mock_cmd_term = mock.Mock(spec=command_executer.CommandTerminator) |
| mock_logger = mock.Mock(spec=logger.Logger) |
| mock_label = label.MockLabel('lumpy', 'build', 'lumpy_chromeos_image', '', '', |
| '/tmp/chromeos', 'lumpy', |
| ['lumpy1.cros', 'lumpy.cros2'], '', '', False, |
| 'average', 'gcc', False, '') |
| telemetry_crosperf_bench = Benchmark( |
| 'b1_test', # name |
| 'octane', # test_name |
| '', # test_args |
| 3, # iterations |
| False, # rm_chroot_tmp |
| 'record -e cycles', # perf_args |
| 'telemetry_Crosperf', # suite |
| True) # show_all_results |
| |
| test_that_bench = Benchmark( |
| 'b2_test', # name |
| 'octane', # test_name |
| '', # test_args |
| 3, # iterations |
| False, # rm_chroot_tmp |
| 'record -e cycles') # perf_args |
| |
| telemetry_bench = Benchmark( |
| 'b3_test', # name |
| 'octane', # test_name |
| '', # test_args |
| 3, # iterations |
| False, # rm_chroot_tmp |
| 'record -e cycles', # perf_args |
| 'telemetry', # suite |
| False) # show_all_results |
| |
| def __init__(self, *args, **kwargs): |
| super(SuiteRunnerTest, self).__init__(*args, **kwargs) |
| self.call_test_that_run = False |
| self.skylab_run_args = [] |
| self.test_that_args = [] |
| self.telemetry_run_args = [] |
| self.telemetry_crosperf_args = [] |
| self.call_skylab_run = False |
| self.call_telemetry_crosperf_run = False |
| |
| def setUp(self): |
| self.runner = suite_runner.SuiteRunner( |
| {}, self.mock_logger, 'verbose', self.mock_cmd_exec, self.mock_cmd_term) |
| |
| def test_get_profiler_args(self): |
| input_str = ("--profiler=custom_perf --profiler_args='perf_options" |
| '="record -a -e cycles,instructions"\'') |
| output_str = ("profiler=custom_perf profiler_args='record -a -e " |
| "cycles,instructions'") |
| res = suite_runner.GetProfilerArgs(input_str) |
| self.assertEqual(res, output_str) |
| |
| def test_run(self): |
| |
| def reset(): |
| self.call_test_that_run = False |
| self.call_skylab_run = False |
| self.call_telemetry_crosperf_run = False |
| self.skylab_run_args = [] |
| self.test_that_args = [] |
| self.telemetry_run_args = [] |
| self.telemetry_crosperf_args = [] |
| |
| def FakeSkylabRun(test_label, benchmark, test_args, profiler_args): |
| self.skylab_run_args = [test_label, benchmark, test_args, profiler_args] |
| self.call_skylab_run = True |
| return 'Ran FakeSkylabRun' |
| |
| def FakeTelemetryCrosperfRun(machine, test_label, benchmark, test_args, |
| profiler_args): |
| self.telemetry_crosperf_args = [ |
| machine, test_label, benchmark, test_args, profiler_args |
| ] |
| self.call_telemetry_crosperf_run = True |
| return 'Ran FakeTelemetryCrosperfRun' |
| |
| def FakeTestThatRun(machine, test_label, benchmark, test_args, |
| profiler_args): |
| self.test_that_args = [ |
| machine, test_label, benchmark, test_args, profiler_args |
| ] |
| self.call_test_that_run = True |
| return 'Ran FakeTestThatRun' |
| |
| def FakeRunner(command, ignore_status=False): |
| # pylint fix for unused variable. |
| del command, ignore_status |
| return 0, '', '' |
| |
| self.runner.Skylab_Run = FakeSkylabRun |
| self.runner.Telemetry_Crosperf_Run = FakeTelemetryCrosperfRun |
| self.runner.Test_That_Run = FakeTestThatRun |
| self.runner.SetupDevice = mock.Mock() |
| DutWrapper.RunCommandOnDut = mock.Mock(return_value=FakeRunner) |
| |
| self.runner.dut_config['enable_aslr'] = False |
| self.runner.dut_config['cooldown_time'] = 0 |
| self.runner.dut_config['governor'] = 'fake_governor' |
| self.runner.dut_config['cpu_freq_pct'] = 65 |
| machine = 'fake_machine' |
| cros_machine = MockCrosMachine(machine, self.mock_label.chromeos_root, |
| self.mock_logger) |
| test_args = '' |
| profiler_args = '' |
| |
| reset() |
| self.mock_label.skylab = True |
| self.runner.Run(cros_machine, self.mock_label, self.telemetry_bench, |
| test_args, profiler_args) |
| self.assertTrue(self.call_skylab_run) |
| self.assertFalse(self.call_test_that_run) |
| self.assertFalse(self.call_telemetry_crosperf_run) |
| self.assertEqual(self.skylab_run_args, |
| [self.mock_label, self.telemetry_bench, '', '']) |
| self.runner.SetupDevice.assert_not_called() |
| self.mock_label.skylab = False |
| |
| reset() |
| self.runner.Run(cros_machine, self.mock_label, self.test_that_bench, |
| test_args, profiler_args) |
| self.assertTrue(self.call_test_that_run) |
| self.assertFalse(self.call_telemetry_crosperf_run) |
| self.assertEqual( |
| self.test_that_args, |
| ['fake_machine', self.mock_label, self.test_that_bench, '', '']) |
| |
| reset() |
| self.runner.Run(cros_machine, self.mock_label, |
| self.telemetry_crosperf_bench, test_args, profiler_args) |
| self.assertFalse(self.call_test_that_run) |
| self.assertTrue(self.call_telemetry_crosperf_run) |
| self.assertEqual(self.telemetry_crosperf_args, [ |
| 'fake_machine', self.mock_label, self.telemetry_crosperf_bench, '', '' |
| ]) |
| |
| def test_setup_device(self): |
| |
| def FakeRunner(command, ignore_status=False): |
| # pylint fix for unused variable. |
| del command, ignore_status |
| return 0, '', '' |
| |
| machine = 'fake_machine' |
| mock_run_on_dut = mock.Mock(spec=DutWrapper) |
| cros_machine = MockCrosMachine(machine, self.mock_label.chromeos_root, |
| self.mock_logger) |
| |
| mock_run_on_dut.RunCommandOnDut = mock.Mock(return_value=FakeRunner) |
| mock_run_on_dut.WaitCooldown = mock.Mock(return_value=0) |
| mock_run_on_dut.GetCpuOnline = mock.Mock(return_value={0: 1, 1: 1, 2: 0}) |
| |
| self.runner.dut_config['enable_aslr'] = False |
| self.runner.dut_config['cooldown_time'] = 0 |
| self.runner.dut_config['governor'] = 'fake_governor' |
| self.runner.dut_config['cpu_freq_pct'] = 65 |
| |
| self.runner.SetupDevice(mock_run_on_dut, cros_machine) |
| |
| mock_run_on_dut.SetupCpuUsage.assert_called_once_with() |
| mock_run_on_dut.SetupCpuFreq.assert_called_once_with([0, 1]) |
| mock_run_on_dut.GetCpuOnline.assert_called_once_with() |
| mock_run_on_dut.SetCpuGovernor.assert_called_once_with( |
| 'fake_governor', ignore_status=False) |
| mock_run_on_dut.DisableTurbo.assert_called_once_with() |
| mock_run_on_dut.StopUI.assert_called_once_with() |
| mock_run_on_dut.StartUI.assert_called_once_with() |
| mock_run_on_dut.WaitCooldown.assert_not_called() |
| |
| def test_setup_device_with_cooldown(self): |
| |
| def FakeRunner(command, ignore_status=False): |
| # pylint fix for unused variable. |
| del command, ignore_status |
| return 0, '', '' |
| |
| machine = 'fake_machine' |
| mock_run_on_dut = mock.Mock(spec=DutWrapper) |
| cros_machine = MockCrosMachine(machine, self.mock_label.chromeos_root, |
| self.mock_logger) |
| |
| mock_run_on_dut.RunCommandOnDut = mock.Mock(return_value=FakeRunner) |
| mock_run_on_dut.WaitCooldown = mock.Mock(return_value=0) |
| mock_run_on_dut.GetCpuOnline = mock.Mock(return_value={0: 0, 1: 1}) |
| |
| self.runner.dut_config['enable_aslr'] = False |
| self.runner.dut_config['cooldown_time'] = 10 |
| self.runner.dut_config['governor'] = 'fake_governor' |
| self.runner.dut_config['cpu_freq_pct'] = 75 |
| |
| self.runner.SetupDevice(mock_run_on_dut, cros_machine) |
| |
| mock_run_on_dut.WaitCooldown.assert_called_once_with() |
| mock_run_on_dut.DisableASLR.assert_called_once() |
| mock_run_on_dut.DisableTurbo.assert_called_once_with() |
| mock_run_on_dut.SetupCpuUsage.assert_called_once_with() |
| mock_run_on_dut.SetupCpuFreq.assert_called_once_with([1]) |
| mock_run_on_dut.SetCpuGovernor.assert_called() |
| mock_run_on_dut.GetCpuOnline.assert_called_once_with() |
| mock_run_on_dut.StopUI.assert_called_once_with() |
| mock_run_on_dut.StartUI.assert_called_once_with() |
| self.assertGreater(mock_run_on_dut.SetCpuGovernor.call_count, 1) |
| self.assertEqual(mock_run_on_dut.SetCpuGovernor.call_args, |
| mock.call('fake_governor', ignore_status=False)) |
| |
| def test_setup_device_with_exception(self): |
| """Test SetupDevice with an exception.""" |
| |
| machine = 'fake_machine' |
| mock_run_on_dut = mock.Mock(spec=DutWrapper) |
| cros_machine = MockCrosMachine(machine, self.mock_label.chromeos_root, |
| self.mock_logger) |
| |
| mock_run_on_dut.SetupCpuUsage = mock.Mock(side_effect=RuntimeError()) |
| self.runner.dut_config['enable_aslr'] = False |
| |
| with self.assertRaises(RuntimeError): |
| self.runner.SetupDevice(mock_run_on_dut, cros_machine) |
| |
| # This called injected an exception. |
| mock_run_on_dut.SetupCpuUsage.assert_called_once_with() |
| # Calls following the expeption are skipped. |
| mock_run_on_dut.WaitCooldown.assert_not_called() |
| mock_run_on_dut.DisableTurbo.assert_not_called() |
| mock_run_on_dut.SetupCpuFreq.assert_not_called() |
| mock_run_on_dut.SetCpuGovernor.assert_not_called() |
| mock_run_on_dut.GetCpuOnline.assert_not_called() |
| # Check that Stop/Start UI are always called. |
| mock_run_on_dut.StopUI.assert_called_once_with() |
| mock_run_on_dut.StartUI.assert_called_once_with() |
| |
| @mock.patch.object(command_executer.CommandExecuter, 'CrosRunCommand') |
| @mock.patch.object(command_executer.CommandExecuter, |
| 'ChrootRunCommandWOutput') |
| def test_test_that_run(self, mock_chroot_runcmd, mock_cros_runcmd): |
| |
| def FakeLogMsg(fd, termfd, msg, flush=True): |
| if fd or termfd or msg or flush: |
| pass |
| |
| save_log_msg = self.real_logger.LogMsg |
| self.real_logger.LogMsg = FakeLogMsg |
| self.runner.logger = self.real_logger |
| |
| raised_exception = False |
| try: |
| self.runner.Test_That_Run('lumpy1.cros', self.mock_label, |
| self.test_that_bench, '', 'record -a -e cycles') |
| except SystemExit: |
| raised_exception = True |
| self.assertTrue(raised_exception) |
| |
| mock_chroot_runcmd.return_value = 0 |
| self.mock_cmd_exec.ChrootRunCommandWOutput = mock_chroot_runcmd |
| self.mock_cmd_exec.CrosRunCommand = mock_cros_runcmd |
| res = self.runner.Test_That_Run('lumpy1.cros', self.mock_label, |
| self.test_that_bench, '--iterations=2', '') |
| self.assertEqual(mock_cros_runcmd.call_count, 1) |
| self.assertEqual(mock_chroot_runcmd.call_count, 1) |
| self.assertEqual(res, 0) |
| self.assertEqual(mock_cros_runcmd.call_args_list[0][0], |
| ('rm -rf /usr/local/autotest/results/*',)) |
| args_list = mock_chroot_runcmd.call_args_list[0][0] |
| args_dict = mock_chroot_runcmd.call_args_list[0][1] |
| self.assertEqual(len(args_list), 2) |
| self.assertEqual(args_list[0], '/tmp/chromeos') |
| self.assertEqual(args_list[1], ('/usr/bin/test_that ' |
| '--fast --board=lumpy ' |
| '--iterations=2 lumpy1.cros octane')) |
| self.assertEqual(args_dict['command_terminator'], self.mock_cmd_term) |
| self.real_logger.LogMsg = save_log_msg |
| |
| @mock.patch.object(os.path, 'isdir') |
| @mock.patch.object(command_executer.CommandExecuter, |
| 'ChrootRunCommandWOutput') |
| def test_telemetry_crosperf_run(self, mock_chroot_runcmd, mock_isdir): |
| |
| mock_isdir.return_value = True |
| mock_chroot_runcmd.return_value = 0 |
| self.mock_cmd_exec.ChrootRunCommandWOutput = mock_chroot_runcmd |
| profiler_args = ("--profiler=custom_perf --profiler_args='perf_options" |
| '="record -a -e cycles,instructions"\'') |
| self.runner.dut_config['turbostat'] = True |
| self.runner.dut_config['top_interval'] = 3 |
| res = self.runner.Telemetry_Crosperf_Run('lumpy1.cros', self.mock_label, |
| self.telemetry_crosperf_bench, '', |
| profiler_args) |
| self.assertEqual(res, 0) |
| self.assertEqual(mock_chroot_runcmd.call_count, 1) |
| args_list = mock_chroot_runcmd.call_args_list[0][0] |
| args_dict = mock_chroot_runcmd.call_args_list[0][1] |
| self.assertEqual(args_list[0], '/tmp/chromeos') |
| self.assertEqual(args_list[1], |
| ('/usr/bin/test_that --autotest_dir ' |
| '~/trunk/src/third_party/autotest/files --fast ' |
| '--board=lumpy --args=" run_local=False test=octane ' |
| 'turbostat=True top_interval=3 profiler=custom_perf ' |
| 'profiler_args=\'record -a -e cycles,instructions\'" ' |
| 'lumpy1.cros telemetry_Crosperf')) |
| self.assertEqual(args_dict['cros_sdk_options'], |
| ('--no-ns-pid --chrome_root= ' |
| '--chrome_root_mount=/tmp/chrome_root ' |
| 'FEATURES="-usersandbox" CHROME_ROOT=/tmp/chrome_root')) |
| self.assertEqual(args_dict['command_terminator'], self.mock_cmd_term) |
| self.assertEqual(len(args_dict), 2) |
| |
| @mock.patch.object(command_executer.CommandExecuter, 'RunCommandWOutput') |
| @mock.patch.object(json, 'loads') |
| def test_skylab_run(self, mock_json_loads, mock_runcmd): |
| |
| def FakeDownloadResult(l, task_id): |
| if l and task_id: |
| self.assertEqual(task_id, '12345') |
| return 0 |
| |
| mock_runcmd.return_value = \ |
| (0, |
| 'Created Swarming task https://swarming/task/b12345', |
| '') |
| self.mock_cmd_exec.RunCommandWOutput = mock_runcmd |
| |
| mock_json_loads.return_value = { |
| 'child-results': [{ |
| 'success': True, |
| 'task-run-url': 'https://swarming/task?id=12345' |
| }] |
| } |
| self.mock_json.loads = mock_json_loads |
| |
| self.mock_label.skylab = True |
| self.runner.DownloadResult = FakeDownloadResult |
| res = self.runner.Skylab_Run(self.mock_label, self.test_that_bench, '', '') |
| ret_tup = (0, '\nResults placed in tmp/swarming-12345\n', '') |
| self.assertEqual(res, ret_tup) |
| self.assertEqual(mock_runcmd.call_count, 2) |
| |
| args_list = mock_runcmd.call_args_list[0][0] |
| args_dict = mock_runcmd.call_args_list[0][1] |
| self.assertEqual(args_list[0], |
| ('/usr/local/bin/skylab create-test ' |
| '-dim dut_name:lumpy1 -dim dut_name:lumpy.cros2 ' |
| '-board=lumpy -image=build ' |
| '-pool=toolchain octane')) |
| self.assertEqual(args_dict['command_terminator'], self.mock_cmd_term) |
| |
| args_list = mock_runcmd.call_args_list[1][0] |
| self.assertEqual(args_list[0], ('skylab wait-task 12345')) |
| self.assertEqual(args_dict['command_terminator'], self.mock_cmd_term) |
| |
| @mock.patch.object(time, 'sleep') |
| @mock.patch.object(command_executer.CommandExecuter, 'RunCommand') |
| def test_download_result(self, mock_runcmd, mock_sleep): |
| mock_runcmd.return_value = 0 |
| mock_sleep.return_value = 0 |
| self.mock_cmd_exec.RunCommand = mock_runcmd |
| |
| self.runner.DownloadResult(self.mock_label, '12345') |
| |
| self.assertEqual(mock_runcmd.call_count, 2) |
| cmd = mock_runcmd.call_args_list[0][0][0] |
| self.assertEqual(cmd, |
| ('/tmp/chromeos/src/chromium/depot_tools/gsutil.py ls ' |
| 'gs://chromeos-autotest-results/swarming-12345/' |
| 'autoserv_test')) |
| cmd = mock_runcmd.call_args_list[1][0][0] |
| self.assertEqual(cmd, |
| ('/tmp/chromeos/src/chromium/depot_tools/gsutil.py -mq ' |
| 'cp -r gs://chromeos-autotest-results/swarming-12345 ' |
| '/tmp/chromeos/chroot/tmp')) |
| |
| |
| if __name__ == '__main__': |
| unittest.main() |