experiment_factory_unittest.py revision d768dc1c6dbd2cdc8f2503574e88ad88316e24f2 
1#!/usr/bin/env python2
2
3# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
4# Use of this source code is governed by a BSD-style license that can be
5# found in the LICENSE file.
6"""Unit test for experiment_factory.py"""
7
8from __future__ import print_function
9
10import StringIO
11import socket
12import mock
13import unittest
14
15from cros_utils.file_utils import FileUtils
16
17from experiment_factory import ExperimentFactory
18from experiment_file import ExperimentFile
19import test_flag
20import benchmark
21import experiment_factory
22import settings_factory
23
24EXPERIMENT_FILE_1 = """
25  board: x86-alex
26  remote: chromeos-alex3
27
28  benchmark: PageCycler {
29    iterations: 3
30  }
31
32  image1 {
33    chromeos_image: /usr/local/google/cros_image1.bin
34  }
35
36  image2 {
37    chromeos_image: /usr/local/google/cros_image2.bin
38  }
39  """
40
41# pylint: disable=too-many-function-args
42
43
44class ExperimentFactoryTest(unittest.TestCase):
45  """Class for running experiment factory unittests."""
46
47  def setUp(self):
48    self.append_benchmark_call_args = []
49
50  def testLoadExperimentFile1(self):
51    experiment_file = ExperimentFile(StringIO.StringIO(EXPERIMENT_FILE_1))
52    exp = ExperimentFactory().GetExperiment(
53        experiment_file, working_directory='', log_dir='')
54    self.assertEqual(exp.remote, ['chromeos-alex3'])
55
56    self.assertEqual(len(exp.benchmarks), 1)
57    self.assertEqual(exp.benchmarks[0].name, 'PageCycler')
58    self.assertEqual(exp.benchmarks[0].test_name, 'PageCycler')
59    self.assertEqual(exp.benchmarks[0].iterations, 3)
60
61    self.assertEqual(len(exp.labels), 2)
62    self.assertEqual(exp.labels[0].chromeos_image,
63                     '/usr/local/google/cros_image1.bin')
64    self.assertEqual(exp.labels[0].board, 'x86-alex')
65
66  def test_append_benchmark_set(self):
67    ef = ExperimentFactory()
68
69    bench_list = []
70    ef.AppendBenchmarkSet(bench_list, experiment_factory.telemetry_perfv2_tests,
71                          '', 1, False, '', 'telemetry_Crosperf', False, 0,
72                          False)
73    self.assertEqual(
74        len(bench_list), len(experiment_factory.telemetry_perfv2_tests))
75    self.assertTrue(type(bench_list[0]) is benchmark.Benchmark)
76
77    bench_list = []
78    ef.AppendBenchmarkSet(bench_list,
79                          experiment_factory.telemetry_pagecycler_tests, '', 1,
80                          False, '', 'telemetry_Crosperf', False, 0, False)
81    self.assertEqual(
82        len(bench_list), len(experiment_factory.telemetry_pagecycler_tests))
83    self.assertTrue(type(bench_list[0]) is benchmark.Benchmark)
84
85    bench_list = []
86    ef.AppendBenchmarkSet(bench_list,
87                          experiment_factory.telemetry_toolchain_perf_tests, '',
88                          1, False, '', 'telemetry_Crosperf', False, 0, False)
89    self.assertEqual(
90        len(bench_list), len(experiment_factory.telemetry_toolchain_perf_tests))
91    self.assertTrue(type(bench_list[0]) is benchmark.Benchmark)
92
93  @mock.patch.object(socket, 'gethostname')
94  def test_get_experiment(self, mock_socket):
95
96    test_flag.SetTestMode(False)
97    self.append_benchmark_call_args = []
98
99    def FakeAppendBenchmarkSet(bench_list, set_list, args, iters, rm_ch,
100                               perf_args, suite, show_all):
101      'Helper function for test_get_experiment'
102      arg_list = [
103          bench_list, set_list, args, iters, rm_ch, perf_args, suite, show_all
104      ]
105      self.append_benchmark_call_args.append(arg_list)
106
107    def FakeGetDefaultRemotes(board):
108      if not board:
109        return []
110      return ['fake_chromeos_machine1.cros', 'fake_chromeos_machine2.cros']
111
112    def FakeGetXbuddyPath(build, board, chroot, log_level):
113      if not build or not board or not chroot or not log_level:
114        return ''
115      return 'fake_image_path'
116
117    ef = ExperimentFactory()
118    ef.AppendBenchmarkSet = FakeAppendBenchmarkSet
119    ef.GetDefaultRemotes = FakeGetDefaultRemotes
120
121    label_settings = settings_factory.LabelSettings('image_label')
122    benchmark_settings = settings_factory.BenchmarkSettings('bench_test')
123    global_settings = settings_factory.GlobalSettings('test_name')
124
125    label_settings.GetXbuddyPath = FakeGetXbuddyPath
126
127    mock_experiment_file = ExperimentFile(StringIO.StringIO(''))
128    mock_experiment_file.all_settings = []
129
130    test_flag.SetTestMode(True)
131    # Basic test.
132    global_settings.SetField('name', 'unittest_test')
133    global_settings.SetField('board', 'lumpy')
134    global_settings.SetField('remote', '123.45.67.89 123.45.76.80')
135    benchmark_settings.SetField('test_name', 'kraken')
136    benchmark_settings.SetField('suite', 'telemetry_Crosperf')
137    benchmark_settings.SetField('iterations', 1)
138    label_settings.SetField(
139        'chromeos_image',
140        'chromeos/src/build/images/lumpy/latest/chromiumos_test_image.bin')
141    label_settings.SetField('chrome_src', '/usr/local/google/home/chrome-top')
142
143    mock_experiment_file.global_settings = global_settings
144    mock_experiment_file.all_settings.append(label_settings)
145    mock_experiment_file.all_settings.append(benchmark_settings)
146    mock_experiment_file.all_settings.append(global_settings)
147
148    mock_socket.return_value = ''
149
150    # First test. General test.
151    exp = ef.GetExperiment(mock_experiment_file, '', '')
152    self.assertEqual(exp.remote, ['123.45.67.89', '123.45.76.80'])
153    self.assertEqual(exp.cache_conditions, [0, 2, 1])
154    self.assertEqual(exp.log_level, 'average')
155
156    self.assertEqual(len(exp.benchmarks), 1)
157    self.assertEqual(exp.benchmarks[0].name, 'kraken')
158    self.assertEqual(exp.benchmarks[0].test_name, 'kraken')
159    self.assertEqual(exp.benchmarks[0].iterations, 1)
160    self.assertEqual(exp.benchmarks[0].suite, 'telemetry_Crosperf')
161    self.assertFalse(exp.benchmarks[0].show_all_results)
162
163    self.assertEqual(len(exp.labels), 1)
164    self.assertEqual(exp.labels[0].chromeos_image,
165                     'chromeos/src/build/images/lumpy/latest/'
166                     'chromiumos_test_image.bin')
167    self.assertEqual(exp.labels[0].board, 'lumpy')
168
169    # Second test: Remotes listed in labels.
170    test_flag.SetTestMode(True)
171    label_settings.SetField('remote', 'chromeos1.cros chromeos2.cros')
172    exp = ef.GetExperiment(mock_experiment_file, '', '')
173    self.assertEqual(
174        exp.remote,
175        ['chromeos1.cros', 'chromeos2.cros', '123.45.67.89', '123.45.76.80'])
176
177    # Third test: Automatic fixing of bad  logging_level param:
178    global_settings.SetField('logging_level', 'really loud!')
179    exp = ef.GetExperiment(mock_experiment_file, '', '')
180    self.assertEqual(exp.log_level, 'verbose')
181
182    # Fourth test: Setting cache conditions; only 1 remote with "same_machine"
183    global_settings.SetField('rerun_if_failed', 'true')
184    global_settings.SetField('rerun', 'true')
185    global_settings.SetField('same_machine', 'true')
186    global_settings.SetField('same_specs', 'true')
187
188    self.assertRaises(Exception, ef.GetExperiment, mock_experiment_file, '', '')
189    label_settings.SetField('remote', '')
190    global_settings.SetField('remote', '123.45.67.89')
191    exp = ef.GetExperiment(mock_experiment_file, '', '')
192    self.assertEqual(exp.cache_conditions, [0, 2, 3, 4, 6, 1])
193
194    # Fifth Test: Adding a second label; calling GetXbuddyPath; omitting all
195    # remotes (Call GetDefaultRemotes).
196    mock_socket.return_value = 'test.corp.google.com'
197    global_settings.SetField('remote', '')
198    global_settings.SetField('same_machine', 'false')
199
200    label_settings_2 = settings_factory.LabelSettings('official_image_label')
201    label_settings_2.SetField('chromeos_root', 'chromeos')
202    label_settings_2.SetField('build', 'official-dev')
203    label_settings_2.GetXbuddyPath = FakeGetXbuddyPath
204
205    mock_experiment_file.all_settings.append(label_settings_2)
206    exp = ef.GetExperiment(mock_experiment_file, '', '')
207    self.assertEqual(len(exp.labels), 2)
208    self.assertEqual(exp.labels[1].chromeos_image, 'fake_image_path')
209    self.assertEqual(
210        exp.remote,
211        ['fake_chromeos_machine1.cros', 'fake_chromeos_machine2.cros'])
212
213  def test_get_default_remotes(self):
214    board_list = [
215        'x86-alex', 'lumpy', 'elm', 'parrot', 'daisy', 'peach_pit', 'peppy',
216        'squawks'
217    ]
218
219    ef = ExperimentFactory()
220    self.assertRaises(Exception, ef.GetDefaultRemotes, 'bad-board')
221
222    # Verify that we have entries for every board, and that we get three
223    # machines back for each board.
224    for b in board_list:
225      remotes = ef.GetDefaultRemotes(b)
226      if b == 'elm':
227        self.assertEqual(len(remotes), 2)
228      else:
229        self.assertEqual(len(remotes), 3)
230
231
232if __name__ == '__main__':
233  FileUtils.Configure(True)
234  test_flag.SetTestMode(True)
235  unittest.main()
236