suite_runner.py revision 23e403298416d3036eab179a94d210441e69cc6e 
1# Copyright (c) 2013~2015 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4"""SuiteRunner defines the interface from crosperf to test script."""
5
6from __future__ import print_function
7
8import os
9import time
10import shlex
11
12from cros_utils import command_executer
13import test_flag
14
15TEST_THAT_PATH = '/usr/bin/test_that'
16CHROME_MOUNT_DIR = '/tmp/chrome_root'
17
18
19def GetProfilerArgs(profiler_args):
20  # Remove "--" from in front of profiler args.
21  args_list = shlex.split(profiler_args)
22  new_list = []
23  for arg in args_list:
24    if arg[0:2] == '--':
25      arg = arg[2:]
26    new_list.append(arg)
27  args_list = new_list
28
29  # Remove "perf_options=" from middle of profiler args.
30  new_list = []
31  for arg in args_list:
32    idx = arg.find('perf_options=')
33    if idx != -1:
34      prefix = arg[0:idx]
35      suffix = arg[idx + len('perf_options=') + 1:-1]
36      new_arg = prefix + "'" + suffix + "'"
37      new_list.append(new_arg)
38    else:
39      new_list.append(arg)
40  args_list = new_list
41
42  return ' '.join(args_list)
43
44
45class SuiteRunner(object):
46  """This defines the interface from crosperf to test script."""
47
48  def __init__(self,
49               logger_to_use=None,
50               log_level='verbose',
51               cmd_exec=None,
52               cmd_term=None):
53    self._logger = logger_to_use
54    self.log_level = log_level
55    self._ce = cmd_exec or command_executer.GetCommandExecuter(
56        self._logger,
57        log_level=self.log_level)
58    self._ct = cmd_term or command_executer.CommandTerminator()
59
60  def Run(self, machine, label, benchmark, test_args, profiler_args):
61    for i in range(0, benchmark.retries + 1):
62      self.PinGovernorExecutionFrequencies(machine, label.chromeos_root)
63      if benchmark.suite == 'telemetry':
64        ret_tup = self.Telemetry_Run(machine, label, benchmark, profiler_args)
65      elif benchmark.suite == 'telemetry_Crosperf':
66        ret_tup = self.Telemetry_Crosperf_Run(machine, label, benchmark,
67                                              test_args, profiler_args)
68      else:
69        ret_tup = self.Test_That_Run(machine, label, benchmark, test_args,
70                                     profiler_args)
71      if ret_tup[0] != 0:
72        self._logger.LogOutput('benchmark %s failed. Retries left: %s' %
73                               (benchmark.name, benchmark.retries - i))
74      elif i > 0:
75        self._logger.LogOutput('benchmark %s succeded after %s retries' %
76                               (benchmark.name, i))
77        break
78      else:
79        self._logger.LogOutput('benchmark %s succeded on first try' %
80                               benchmark.name)
81        break
82    return ret_tup
83
84  def GetHighestStaticFrequency(self, machine_name, chromeos_root):
85    """Gets the highest static frequency for the specified machine."""
86    get_avail_freqs = ('cd /sys/devices/system/cpu/cpu0/cpufreq/; '
87                       'if [[ -e scaling_available_frequencies ]]; then '
88                       '  cat scaling_available_frequencies; '
89                       'else '
90                       '  cat scaling_max_freq ; '
91                       'fi')
92    ret, freqs_str, _ = self._ce.CrosRunCommandWOutput(
93        get_avail_freqs,
94        machine=machine_name,
95        chromeos_root=chromeos_root)
96    self._logger.LogFatalIf(ret, 'Could not get available frequencies '
97                            'from machine: %s' % machine_name)
98    freqs = freqs_str.split()
99    # We need to make sure that the frequencies are sorted in decreasing
100    # order
101    freqs.sort(key=int, reverse=True)
102
103    ## When there is no scaling_available_frequencies file,
104    ## we have only 1 choice.
105    if len(freqs) == 1:
106      return freqs[0]
107    # The dynamic frequency ends with a "1000". So, ignore it if found.
108    if freqs[0].endswith('1000'):
109      return freqs[1]
110    else:
111      return freqs[0]
112
113  def PinGovernorExecutionFrequencies(self, machine_name, chromeos_root):
114    """Set min and max frequencies to max static frequency."""
115    highest_freq = self.GetHighestStaticFrequency(machine_name, chromeos_root)
116    BASH_FOR = 'for f in {list}; do {body}; done'
117    CPUFREQ_DIRS = '/sys/devices/system/cpu/cpu*/cpufreq/'
118    change_max_freq = BASH_FOR.format(list=CPUFREQ_DIRS + 'scaling_max_freq',
119                                      body='echo %s > $f' % highest_freq)
120    change_min_freq = BASH_FOR.format(list=CPUFREQ_DIRS + 'scaling_min_freq',
121                                      body='echo %s > $f' % highest_freq)
122    change_perf_gov = BASH_FOR.format(list=CPUFREQ_DIRS + 'scaling_governor',
123                                      body='echo performance > $f')
124    if self.log_level == 'average':
125      self._logger.LogOutput('Pinning governor execution frequencies for %s' %
126                             machine_name)
127    ret = self._ce.CrosRunCommand(' && '.join((
128        'set -e ', change_max_freq, change_min_freq, change_perf_gov)),
129                                  machine=machine_name,
130                                  chromeos_root=chromeos_root)
131    self._logger.LogFatalIf(ret, 'Could not pin frequencies on machine: %s' %
132                            machine_name)
133
134  def RebootMachine(self, machine_name, chromeos_root):
135    command = 'reboot && exit'
136    self._ce.CrosRunCommand(command,
137                            machine=machine_name,
138                            chromeos_root=chromeos_root)
139    time.sleep(60)
140    # Whenever we reboot the machine, we need to restore the governor settings.
141    self.PinGovernorExecutionFrequencies(machine_name, chromeos_root)
142
143  def Test_That_Run(self, machine, label, benchmark, test_args, profiler_args):
144    """Run the test_that test.."""
145    options = ''
146    if label.board:
147      options += ' --board=%s' % label.board
148    if test_args:
149      options += ' %s' % test_args
150    if profiler_args:
151      self._logger.LogFatal('test_that does not support profiler.')
152    command = 'rm -rf /usr/local/autotest/results/*'
153    self._ce.CrosRunCommand(command,
154                            machine=machine,
155                            chromeos_root=label.chromeos_root)
156
157    # We do this because some tests leave the machine in weird states.
158    # Rebooting between iterations has proven to help with this.
159    self.RebootMachine(machine, label.chromeos_root)
160
161    command = (
162        ('%s --autotest_dir ~/trunk/src/third_party/autotest/files --fast '
163         '%s %s %s') % (TEST_THAT_PATH, options, machine, benchmark.test_name))
164    if self.log_level != 'verbose':
165      self._logger.LogOutput('Running test.')
166      self._logger.LogOutput('CMD: %s' % command)
167    # Use --no-ns-pid so that cros_sdk does not create a different
168    # process namespace and we can kill process created easily by
169    # their process group.
170    return self._ce.ChrootRunCommandWOutput(label.chromeos_root,
171                                            command,
172                                            command_terminator=self._ct,
173                                            cros_sdk_options='--no-ns-pid')
174
175  def RemoveTelemetryTempFile(self, machine, chromeos_root):
176    filename = 'telemetry@%s' % machine
177    fullname = os.path.join(chromeos_root, 'chroot', 'tmp', filename)
178    if os.path.exists(fullname):
179      os.remove(fullname)
180
181  def Telemetry_Crosperf_Run(self, machine, label, benchmark, test_args,
182                             profiler_args):
183    if not os.path.isdir(label.chrome_src):
184      self._logger.LogFatal('Cannot find chrome src dir to'
185                            ' run telemetry: %s' % label.chrome_src)
186
187    # Check for and remove temporary file that may have been left by
188    # previous telemetry runs (and which might prevent this run from
189    # working).
190    self.RemoveTelemetryTempFile(machine, label.chromeos_root)
191
192    # For telemetry runs, we can use the autotest copy from the source
193    # location. No need to have one under /build/<board>.
194    autotest_dir_arg = '--autotest_dir ~/trunk/src/third_party/autotest/files'
195
196    profiler_args = GetProfilerArgs(profiler_args)
197    fast_arg = ''
198    if not profiler_args:
199      # --fast works unless we are doing profiling (autotest limitation).
200      # --fast avoids unnecessary copies of syslogs.
201      fast_arg = '--fast'
202    args_string = ''
203    if test_args:
204      # Strip double quotes off args (so we can wrap them in single
205      # quotes, to pass through to Telemetry).
206      if test_args[0] == '"' and test_args[-1] == '"':
207        test_args = test_args[1:-1]
208      args_string = "test_args='%s'" % test_args
209
210    cmd = ('{} {} {} --board={} --args="{} run_local={} test={} '
211           '{}" {} telemetry_Crosperf'.format(
212               TEST_THAT_PATH, autotest_dir_arg, fast_arg, label.board,
213               args_string, benchmark.run_local, benchmark.test_name,
214               profiler_args, machine))
215
216    # Use --no-ns-pid so that cros_sdk does not create a different
217    # process namespace and we can kill process created easily by their
218    # process group.
219    chrome_root_options = ('--no-ns-pid '
220                           '--chrome_root={} --chrome_root_mount={} '
221                           "FEATURES=\"-usersandbox\" "
222                           'CHROME_ROOT={}'.format(label.chrome_src,
223                                                   CHROME_MOUNT_DIR,
224                                                   CHROME_MOUNT_DIR))
225    if self.log_level != 'verbose':
226      self._logger.LogOutput('Running test.')
227      self._logger.LogOutput('CMD: %s' % cmd)
228    return self._ce.ChrootRunCommandWOutput(
229        label.chromeos_root,
230        cmd,
231        command_terminator=self._ct,
232        cros_sdk_options=chrome_root_options)
233
234  def Telemetry_Run(self, machine, label, benchmark, profiler_args):
235    telemetry_run_path = ''
236    if not os.path.isdir(label.chrome_src):
237      self._logger.LogFatal('Cannot find chrome src dir to' ' run telemetry.')
238    else:
239      telemetry_run_path = os.path.join(label.chrome_src, 'src/tools/perf')
240      if not os.path.exists(telemetry_run_path):
241        self._logger.LogFatal('Cannot find %s directory.' % telemetry_run_path)
242
243    if profiler_args:
244      self._logger.LogFatal('Telemetry does not support the perf profiler.')
245
246    # Check for and remove temporary file that may have been left by
247    # previous telemetry runs (and which might prevent this run from
248    # working).
249    if not test_flag.GetTestMode():
250      self.RemoveTelemetryTempFile(machine, label.chromeos_root)
251
252    rsa_key = os.path.join(
253        label.chromeos_root,
254        'src/scripts/mod_for_test_scripts/ssh_keys/testing_rsa')
255
256    cmd = ('cd {0} && '
257           './run_measurement '
258           '--browser=cros-chrome '
259           '--output-format=csv '
260           '--remote={1} '
261           '--identity {2} '
262           '{3} {4}'.format(telemetry_run_path, machine, rsa_key,
263                            benchmark.test_name, benchmark.test_args))
264    if self.log_level != 'verbose':
265      self._logger.LogOutput('Running test.')
266      self._logger.LogOutput('CMD: %s' % cmd)
267    return self._ce.RunCommandWOutput(cmd, print_to_console=False)
268
269  def CommandTerminator(self):
270    return self._ct
271
272  def Terminate(self):
273    self._ct.Terminate()
274
275
276class MockSuiteRunner(object):
277  """Mock suite runner for test."""
278
279  def __init__(self):
280    self._true = True
281
282  def Run(self, *_args):
283    if self._true:
284      return [0, '', '']
285    else:
286      return [0, '', '']
287