• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/env python3
2# -*- coding: utf-8 -*-
3
4# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
5# Use of this source code is governed by a BSD-style license that can be
6# found in the LICENSE file.
7
8"""Unit test for experiment_factory.py"""
9
10from __future__ import print_function
11
12import io
13import os
14import socket
15import unittest
16import unittest.mock as mock
17
18from cros_utils import command_executer
19from cros_utils.file_utils import FileUtils
20
21from experiment_file import ExperimentFile
22import test_flag
23import benchmark
24import experiment_factory
25from experiment_factory import ExperimentFactory
26import settings_factory
27
28EXPERIMENT_FILE_1 = """
29  board: x86-alex
30  remote: chromeos-alex3
31  locks_dir: /tmp
32
33  benchmark: PageCycler {
34    iterations: 3
35  }
36
37  benchmark: webrtc {
38    iterations: 1
39    test_args: --story-filter=datachannel
40  }
41
42  image1 {
43    chromeos_image: /usr/local/google/cros_image1.bin
44  }
45
46  image2 {
47    chromeos_image: /usr/local/google/cros_image2.bin
48  }
49  """
50
51EXPERIMENT_FILE_2 = """
52  board: x86-alex
53  remote: chromeos-alex3
54  locks_dir: /tmp
55
56  cwp_dso: kallsyms
57
58  benchmark: Octane {
59    iterations: 1
60    suite: telemetry_Crosperf
61    run_local: False
62    weight: 0.8
63  }
64
65  benchmark: Kraken {
66    iterations: 1
67    suite: telemetry_Crosperf
68    run_local: False
69    weight: 0.2
70  }
71
72  image1 {
73    chromeos_image: /usr/local/google/cros_image1.bin
74  }
75  """
76
77# pylint: disable=too-many-function-args
78
79
80class ExperimentFactoryTest(unittest.TestCase):
81  """Class for running experiment factory unittests."""
82  def setUp(self):
83    self.append_benchmark_call_args = []
84
85  def testLoadExperimentFile1(self):
86    experiment_file = ExperimentFile(io.StringIO(EXPERIMENT_FILE_1))
87    exp = ExperimentFactory().GetExperiment(experiment_file,
88                                            working_directory='',
89                                            log_dir='')
90    self.assertEqual(exp.remote, ['chromeos-alex3'])
91
92    self.assertEqual(len(exp.benchmarks), 2)
93    self.assertEqual(exp.benchmarks[0].name, 'PageCycler')
94    self.assertEqual(exp.benchmarks[0].test_name, 'PageCycler')
95    self.assertEqual(exp.benchmarks[0].iterations, 3)
96    self.assertEqual(exp.benchmarks[1].name, 'webrtc@@datachannel')
97    self.assertEqual(exp.benchmarks[1].test_name, 'webrtc')
98    self.assertEqual(exp.benchmarks[1].iterations, 1)
99
100    self.assertEqual(len(exp.labels), 2)
101    self.assertEqual(exp.labels[0].chromeos_image,
102                     '/usr/local/google/cros_image1.bin')
103    self.assertEqual(exp.labels[0].board, 'x86-alex')
104
105  def testLoadExperimentFile2CWP(self):
106    experiment_file = ExperimentFile(io.StringIO(EXPERIMENT_FILE_2))
107    exp = ExperimentFactory().GetExperiment(experiment_file,
108                                            working_directory='',
109                                            log_dir='')
110    self.assertEqual(exp.cwp_dso, 'kallsyms')
111    self.assertEqual(len(exp.benchmarks), 2)
112    self.assertEqual(exp.benchmarks[0].weight, 0.8)
113    self.assertEqual(exp.benchmarks[1].weight, 0.2)
114
115  def testDuplecateBenchmark(self):
116    mock_experiment_file = ExperimentFile(io.StringIO(EXPERIMENT_FILE_1))
117    mock_experiment_file.all_settings = []
118    benchmark_settings1 = settings_factory.BenchmarkSettings('name')
119    mock_experiment_file.all_settings.append(benchmark_settings1)
120    benchmark_settings2 = settings_factory.BenchmarkSettings('name')
121    mock_experiment_file.all_settings.append(benchmark_settings2)
122
123    with self.assertRaises(SyntaxError):
124      ef = ExperimentFactory()
125      ef.GetExperiment(mock_experiment_file, '', '')
126
127  def testCWPExceptions(self):
128    mock_experiment_file = ExperimentFile(io.StringIO(''))
129    mock_experiment_file.all_settings = []
130    global_settings = settings_factory.GlobalSettings('test_name')
131    global_settings.SetField('locks_dir', '/tmp')
132
133    # Test 1: DSO type not supported
134    global_settings.SetField('cwp_dso', 'test')
135    self.assertEqual(global_settings.GetField('cwp_dso'), 'test')
136    mock_experiment_file.global_settings = global_settings
137    with self.assertRaises(RuntimeError) as msg:
138      ef = ExperimentFactory()
139      ef.GetExperiment(mock_experiment_file, '', '')
140    self.assertEqual('The DSO specified is not supported', str(msg.exception))
141
142    # Test 2: No weight after DSO specified
143    global_settings.SetField('cwp_dso', 'kallsyms')
144    mock_experiment_file.global_settings = global_settings
145    benchmark_settings = settings_factory.BenchmarkSettings('name')
146    mock_experiment_file.all_settings.append(benchmark_settings)
147    with self.assertRaises(RuntimeError) as msg:
148      ef = ExperimentFactory()
149      ef.GetExperiment(mock_experiment_file, '', '')
150    self.assertEqual('With DSO specified, each benchmark should have a weight',
151                     str(msg.exception))
152
153    # Test 3: Weight is set, but no dso specified
154    global_settings.SetField('cwp_dso', '')
155    mock_experiment_file.global_settings = global_settings
156    benchmark_settings = settings_factory.BenchmarkSettings('name')
157    benchmark_settings.SetField('weight', '0.8')
158    mock_experiment_file.all_settings = []
159    mock_experiment_file.all_settings.append(benchmark_settings)
160    with self.assertRaises(RuntimeError) as msg:
161      ef = ExperimentFactory()
162      ef.GetExperiment(mock_experiment_file, '', '')
163    self.assertEqual('Weight can only be set when DSO specified',
164                     str(msg.exception))
165
166    # Test 4: cwp_dso only works for telemetry_Crosperf benchmarks
167    global_settings.SetField('cwp_dso', 'kallsyms')
168    mock_experiment_file.global_settings = global_settings
169    benchmark_settings = settings_factory.BenchmarkSettings('name')
170    benchmark_settings.SetField('weight', '0.8')
171    mock_experiment_file.all_settings = []
172    mock_experiment_file.all_settings.append(benchmark_settings)
173    with self.assertRaises(RuntimeError) as msg:
174      ef = ExperimentFactory()
175      ef.GetExperiment(mock_experiment_file, '', '')
176    self.assertEqual(
177        'CWP approximation weight only works with '
178        'telemetry_Crosperf suite', str(msg.exception))
179
180    # Test 5: cwp_dso does not work for local run
181    benchmark_settings = settings_factory.BenchmarkSettings('name')
182    benchmark_settings.SetField('weight', '0.8')
183    benchmark_settings.SetField('suite', 'telemetry_Crosperf')
184    benchmark_settings.SetField('run_local', 'True')
185    mock_experiment_file.all_settings = []
186    mock_experiment_file.all_settings.append(benchmark_settings)
187    with self.assertRaises(RuntimeError) as msg:
188      ef = ExperimentFactory()
189      ef.GetExperiment(mock_experiment_file, '', '')
190    self.assertEqual('run_local must be set to False to use CWP approximation',
191                     str(msg.exception))
192
193    # Test 6: weight should be float >=0
194    benchmark_settings = settings_factory.BenchmarkSettings('name')
195    benchmark_settings.SetField('weight', '-1.2')
196    benchmark_settings.SetField('suite', 'telemetry_Crosperf')
197    benchmark_settings.SetField('run_local', 'False')
198    mock_experiment_file.all_settings = []
199    mock_experiment_file.all_settings.append(benchmark_settings)
200    with self.assertRaises(RuntimeError) as msg:
201      ef = ExperimentFactory()
202      ef.GetExperiment(mock_experiment_file, '', '')
203    self.assertEqual('Weight should be a float >=0', str(msg.exception))
204
205    # Test 7: more than one story tag in test_args
206    benchmark_settings = settings_factory.BenchmarkSettings('name')
207    benchmark_settings.SetField('test_args',
208                                '--story-filter=a --story-tag-filter=b')
209    benchmark_settings.SetField('weight', '1.2')
210    benchmark_settings.SetField('suite', 'telemetry_Crosperf')
211    mock_experiment_file.all_settings = []
212    mock_experiment_file.all_settings.append(benchmark_settings)
213    with self.assertRaises(RuntimeError) as msg:
214      ef = ExperimentFactory()
215      ef.GetExperiment(mock_experiment_file, '', '')
216    self.assertEqual(
217        'Only one story or story-tag filter allowed in a single '
218        'benchmark run', str(msg.exception))
219
220    # Test 8: Iterations of each benchmark run are not same in cwp mode
221    mock_experiment_file.all_settings = []
222    benchmark_settings = settings_factory.BenchmarkSettings('name1')
223    benchmark_settings.SetField('iterations', '4')
224    benchmark_settings.SetField('weight', '1.2')
225    benchmark_settings.SetField('suite', 'telemetry_Crosperf')
226    benchmark_settings.SetField('run_local', 'False')
227    mock_experiment_file.all_settings.append(benchmark_settings)
228    benchmark_settings = settings_factory.BenchmarkSettings('name2')
229    benchmark_settings.SetField('iterations', '3')
230    benchmark_settings.SetField('weight', '1.2')
231    benchmark_settings.SetField('suite', 'telemetry_Crosperf')
232    benchmark_settings.SetField('run_local', 'False')
233    mock_experiment_file.all_settings.append(benchmark_settings)
234    with self.assertRaises(RuntimeError) as msg:
235      ef = ExperimentFactory()
236      ef.GetExperiment(mock_experiment_file, '', '')
237    self.assertEqual('Iterations of each benchmark run are not the same',
238                     str(msg.exception))
239
240  def test_append_benchmark_set(self):
241    ef = ExperimentFactory()
242
243    bench_list = []
244    ef.AppendBenchmarkSet(bench_list,
245                          experiment_factory.telemetry_perfv2_tests, '', 1,
246                          False, '', 'telemetry_Crosperf', False, 0, False, '',
247                          0)
248    self.assertEqual(len(bench_list),
249                     len(experiment_factory.telemetry_perfv2_tests))
250    self.assertTrue(isinstance(bench_list[0], benchmark.Benchmark))
251
252    bench_list = []
253    ef.AppendBenchmarkSet(bench_list,
254                          experiment_factory.telemetry_pagecycler_tests, '', 1,
255                          False, '', 'telemetry_Crosperf', False, 0, False, '',
256                          0)
257    self.assertEqual(len(bench_list),
258                     len(experiment_factory.telemetry_pagecycler_tests))
259    self.assertTrue(isinstance(bench_list[0], benchmark.Benchmark))
260
261    bench_list = []
262    ef.AppendBenchmarkSet(bench_list,
263                          experiment_factory.telemetry_toolchain_perf_tests,
264                          '', 1, False, '', 'telemetry_Crosperf', False, 0,
265                          False, '', 0)
266    self.assertEqual(len(bench_list),
267                     len(experiment_factory.telemetry_toolchain_perf_tests))
268    self.assertTrue(isinstance(bench_list[0], benchmark.Benchmark))
269
270  @mock.patch.object(socket, 'gethostname')
271  def test_get_experiment(self, mock_socket):
272
273    test_flag.SetTestMode(False)
274    self.append_benchmark_call_args = []
275
276    def FakeAppendBenchmarkSet(bench_list, set_list, args, iters, rm_ch,
277                               perf_args, suite, show_all):
278      'Helper function for test_get_experiment'
279      arg_list = [
280          bench_list, set_list, args, iters, rm_ch, perf_args, suite, show_all
281      ]
282      self.append_benchmark_call_args.append(arg_list)
283
284    def FakeGetDefaultRemotes(board):
285      if not board:
286        return []
287      return ['fake_chromeos_machine1.cros', 'fake_chromeos_machine2.cros']
288
289    def FakeGetXbuddyPath(build, autotest_dir, debug_dir, board, chroot,
290                          log_level, perf_args):
291      autotest_path = autotest_dir
292      if not autotest_path:
293        autotest_path = 'fake_autotest_path'
294      debug_path = debug_dir
295      if not debug_path and perf_args:
296        debug_path = 'fake_debug_path'
297      if not build or not board or not chroot or not log_level:
298        return '', autotest_path, debug_path
299      return 'fake_image_path', autotest_path, debug_path
300
301    ef = ExperimentFactory()
302    ef.AppendBenchmarkSet = FakeAppendBenchmarkSet
303    ef.GetDefaultRemotes = FakeGetDefaultRemotes
304
305    label_settings = settings_factory.LabelSettings('image_label')
306    benchmark_settings = settings_factory.BenchmarkSettings('bench_test')
307    global_settings = settings_factory.GlobalSettings('test_name')
308
309    label_settings.GetXbuddyPath = FakeGetXbuddyPath
310
311    mock_experiment_file = ExperimentFile(io.StringIO(''))
312    mock_experiment_file.all_settings = []
313
314    test_flag.SetTestMode(True)
315    # Basic test.
316    global_settings.SetField('name', 'unittest_test')
317    global_settings.SetField('board', 'lumpy')
318    global_settings.SetField('locks_dir', '/tmp')
319    global_settings.SetField('remote', '123.45.67.89 123.45.76.80')
320    benchmark_settings.SetField('test_name', 'kraken')
321    benchmark_settings.SetField('suite', 'telemetry_Crosperf')
322    benchmark_settings.SetField('iterations', 1)
323    label_settings.SetField(
324        'chromeos_image',
325        'chromeos/src/build/images/lumpy/latest/chromiumos_test_image.bin')
326    label_settings.SetField('chrome_src', '/usr/local/google/home/chrome-top')
327    label_settings.SetField('autotest_path', '/tmp/autotest')
328
329    mock_experiment_file.global_settings = global_settings
330    mock_experiment_file.all_settings.append(label_settings)
331    mock_experiment_file.all_settings.append(benchmark_settings)
332    mock_experiment_file.all_settings.append(global_settings)
333
334    mock_socket.return_value = ''
335
336    # First test. General test.
337    exp = ef.GetExperiment(mock_experiment_file, '', '')
338    self.assertCountEqual(exp.remote, ['123.45.67.89', '123.45.76.80'])
339    self.assertEqual(exp.cache_conditions, [0, 2, 1])
340    self.assertEqual(exp.log_level, 'average')
341
342    self.assertEqual(len(exp.benchmarks), 1)
343    self.assertEqual(exp.benchmarks[0].name, 'bench_test')
344    self.assertEqual(exp.benchmarks[0].test_name, 'kraken')
345    self.assertEqual(exp.benchmarks[0].iterations, 1)
346    self.assertEqual(exp.benchmarks[0].suite, 'telemetry_Crosperf')
347    self.assertFalse(exp.benchmarks[0].show_all_results)
348
349    self.assertEqual(len(exp.labels), 1)
350    self.assertEqual(
351        exp.labels[0].chromeos_image, 'chromeos/src/build/images/lumpy/latest/'
352        'chromiumos_test_image.bin')
353    self.assertEqual(exp.labels[0].autotest_path, '/tmp/autotest')
354    self.assertEqual(exp.labels[0].board, 'lumpy')
355
356    # Second test: Remotes listed in labels.
357    test_flag.SetTestMode(True)
358    label_settings.SetField('remote', 'chromeos1.cros chromeos2.cros')
359    exp = ef.GetExperiment(mock_experiment_file, '', '')
360    self.assertCountEqual(
361        exp.remote,
362        ['123.45.67.89', '123.45.76.80', 'chromeos1.cros', 'chromeos2.cros'])
363
364    # Third test: Automatic fixing of bad  logging_level param:
365    global_settings.SetField('logging_level', 'really loud!')
366    exp = ef.GetExperiment(mock_experiment_file, '', '')
367    self.assertEqual(exp.log_level, 'verbose')
368
369    # Fourth test: Setting cache conditions; only 1 remote with "same_machine"
370    global_settings.SetField('rerun_if_failed', 'true')
371    global_settings.SetField('rerun', 'true')
372    global_settings.SetField('same_machine', 'true')
373    global_settings.SetField('same_specs', 'true')
374
375    self.assertRaises(Exception, ef.GetExperiment, mock_experiment_file, '',
376                      '')
377    label_settings.SetField('remote', '')
378    global_settings.SetField('remote', '123.45.67.89')
379    exp = ef.GetExperiment(mock_experiment_file, '', '')
380    self.assertEqual(exp.cache_conditions, [0, 2, 3, 4, 6, 1])
381
382    # Fifth Test: Adding a second label; calling GetXbuddyPath; omitting all
383    # remotes (Call GetDefaultRemotes).
384    mock_socket.return_value = 'test.corp.google.com'
385    global_settings.SetField('remote', '')
386    global_settings.SetField('same_machine', 'false')
387
388    label_settings_2 = settings_factory.LabelSettings('official_image_label')
389    label_settings_2.SetField('chromeos_root', 'chromeos')
390    label_settings_2.SetField('build', 'official-dev')
391    label_settings_2.SetField('autotest_path', '')
392    label_settings_2.GetXbuddyPath = FakeGetXbuddyPath
393
394    mock_experiment_file.all_settings.append(label_settings_2)
395    exp = ef.GetExperiment(mock_experiment_file, '', '')
396    self.assertEqual(len(exp.labels), 2)
397    self.assertEqual(exp.labels[1].chromeos_image, 'fake_image_path')
398    self.assertEqual(exp.labels[1].autotest_path, 'fake_autotest_path')
399    self.assertCountEqual(
400        exp.remote,
401        ['fake_chromeos_machine1.cros', 'fake_chromeos_machine2.cros'])
402
403  def test_get_default_remotes(self):
404    board_list = [
405        'bob', 'chell', 'coral', 'elm', 'kefka', 'nautilus', 'snappy',
406        'veyron_tiger'
407    ]
408
409    ef = ExperimentFactory()
410    self.assertRaises(Exception, ef.GetDefaultRemotes, 'bad-board')
411
412    # Verify that we have entries for every board
413    for b in board_list:
414      remotes = ef.GetDefaultRemotes(b)
415      self.assertGreaterEqual(len(remotes), 1)
416
417  @mock.patch.object(command_executer.CommandExecuter, 'RunCommand')
418  @mock.patch.object(os.path, 'exists')
419  def test_check_crosfleet_tool(self, mock_exists, mock_runcmd):
420    ef = ExperimentFactory()
421    chromeos_root = '/tmp/chromeos'
422    log_level = 'average'
423
424    mock_exists.return_value = True
425    ret = ef.CheckCrosfleetTool(chromeos_root, log_level)
426    self.assertTrue(ret)
427
428    mock_exists.return_value = False
429    mock_runcmd.return_value = 1
430    with self.assertRaises(RuntimeError) as err:
431      ef.CheckCrosfleetTool(chromeos_root, log_level)
432    self.assertEqual(mock_runcmd.call_count, 1)
433    self.assertEqual(
434        str(err.exception), 'Crosfleet tool not installed '
435        'correctly, please try to manually install it from '
436        '/tmp/chromeos/chromeos-admin/lab-tools/setup_lab_tools')
437
438    mock_runcmd.return_value = 0
439    mock_runcmd.call_count = 0
440    ret = ef.CheckCrosfleetTool(chromeos_root, log_level)
441    self.assertEqual(mock_runcmd.call_count, 1)
442    self.assertFalse(ret)
443
444
445if __name__ == '__main__':
446  FileUtils.Configure(True)
447  test_flag.SetTestMode(True)
448  unittest.main()
449