showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 1 | #!/usr/bin/python |
| 2 | |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 3 | import os, unittest |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 4 | import common |
showard | ac5b000 | 2009-10-19 18:34:00 +0000 | [diff] [blame] | 5 | from autotest_lib.client.common_lib import global_config |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 6 | from autotest_lib.client.common_lib.test_utils import mock |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 7 | from autotest_lib.scheduler import drone_manager, drone_utility, drones |
Simran Basi | 882f15b | 2013-10-29 14:59:34 -0700 | [diff] [blame^] | 8 | from autotest_lib.scheduler import scheduler_config, site_drone_manager |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 9 | |
| 10 | class MockDrone(drones._AbstractDrone): |
showard | 9bb960b | 2009-11-19 01:02:11 +0000 | [diff] [blame] | 11 | def __init__(self, name, active_processes=0, max_processes=10, |
| 12 | allowed_users=None): |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 13 | super(MockDrone, self).__init__() |
| 14 | self.name = name |
jamesren | 76fcf19 | 2010-04-21 20:39:50 +0000 | [diff] [blame] | 15 | self.hostname = name |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 16 | self.active_processes = active_processes |
| 17 | self.max_processes = max_processes |
showard | 9bb960b | 2009-11-19 01:02:11 +0000 | [diff] [blame] | 18 | self.allowed_users = allowed_users |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 19 | # maps method names list of tuples containing method arguments |
| 20 | self._recorded_calls = {'queue_call': [], |
| 21 | 'send_file_to': []} |
| 22 | |
| 23 | |
| 24 | def queue_call(self, method, *args, **kwargs): |
| 25 | self._recorded_calls['queue_call'].append((method, args, kwargs)) |
| 26 | |
| 27 | |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 28 | def call(self, method, *args, **kwargs): |
| 29 | # don't bother differentiating between call() and queue_call() |
| 30 | return self.queue_call(method, *args, **kwargs) |
| 31 | |
| 32 | |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 33 | def send_file_to(self, drone, source_path, destination_path, |
| 34 | can_fail=False): |
| 35 | self._recorded_calls['send_file_to'].append( |
| 36 | (drone, source_path, destination_path)) |
| 37 | |
| 38 | |
| 39 | # method for use by tests |
| 40 | def _check_for_recorded_call(self, method_name, arguments): |
| 41 | recorded_arg_list = self._recorded_calls[method_name] |
| 42 | was_called = arguments in recorded_arg_list |
| 43 | if not was_called: |
| 44 | print 'Recorded args:', recorded_arg_list |
| 45 | print 'Expected:', arguments |
| 46 | return was_called |
| 47 | |
| 48 | |
| 49 | def was_call_queued(self, method, *args, **kwargs): |
| 50 | return self._check_for_recorded_call('queue_call', |
| 51 | (method, args, kwargs)) |
| 52 | |
| 53 | |
| 54 | def was_file_sent(self, drone, source_path, destination_path): |
| 55 | return self._check_for_recorded_call('send_file_to', |
| 56 | (drone, source_path, |
| 57 | destination_path)) |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 58 | |
| 59 | |
| 60 | class DroneManager(unittest.TestCase): |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 61 | _DRONE_INSTALL_DIR = '/drone/install/dir' |
showard | c75fded | 2009-10-14 16:20:02 +0000 | [diff] [blame] | 62 | _DRONE_RESULTS_DIR = os.path.join(_DRONE_INSTALL_DIR, 'results') |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 63 | _RESULTS_DIR = '/results/dir' |
| 64 | _SOURCE_PATH = 'source/path' |
| 65 | _DESTINATION_PATH = 'destination/path' |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 66 | _WORKING_DIRECTORY = 'working/directory' |
showard | 9bb960b | 2009-11-19 01:02:11 +0000 | [diff] [blame] | 67 | _USERNAME = 'my_user' |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 68 | |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 69 | def setUp(self): |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 70 | self.god = mock.mock_god() |
| 71 | self.god.stub_with(drones, 'AUTOTEST_INSTALL_DIR', |
| 72 | self._DRONE_INSTALL_DIR) |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 73 | self.manager = drone_manager.DroneManager() |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 74 | self.god.stub_with(self.manager, '_results_dir', self._RESULTS_DIR) |
| 75 | |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 76 | # we don't want this to ever actually get called |
| 77 | self.god.stub_function(drones, 'get_drone') |
showard | ac5b000 | 2009-10-19 18:34:00 +0000 | [diff] [blame] | 78 | # we don't want the DroneManager to go messing with global config |
| 79 | def do_nothing(): |
| 80 | pass |
| 81 | self.god.stub_with(self.manager, 'refresh_drone_configs', do_nothing) |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 82 | |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 83 | # set up some dummy drones |
showard | 202343e | 2009-10-14 16:20:24 +0000 | [diff] [blame] | 84 | self.mock_drone = MockDrone('mock_drone') |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 85 | self.manager._drones[self.mock_drone.name] = self.mock_drone |
| 86 | self.results_drone = MockDrone('results_drone', 0, 10) |
| 87 | self.manager._results_drone = self.results_drone |
| 88 | |
| 89 | self.mock_drone_process = drone_manager.Process(self.mock_drone.name, 0) |
| 90 | |
| 91 | |
| 92 | def tearDown(self): |
| 93 | self.god.unstub_all() |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 94 | |
| 95 | |
| 96 | def _test_choose_drone_for_execution_helper(self, processes_info_list, |
| 97 | requested_processes): |
| 98 | for index, process_info in enumerate(processes_info_list): |
| 99 | active_processes, max_processes = process_info |
| 100 | self.manager._enqueue_drone(MockDrone(index, active_processes, |
| 101 | max_processes)) |
| 102 | |
showard | 9bb960b | 2009-11-19 01:02:11 +0000 | [diff] [blame] | 103 | return self.manager._choose_drone_for_execution(requested_processes, |
jamesren | 76fcf19 | 2010-04-21 20:39:50 +0000 | [diff] [blame] | 104 | self._USERNAME, None) |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 105 | |
| 106 | |
| 107 | def test_choose_drone_for_execution(self): |
| 108 | drone = self._test_choose_drone_for_execution_helper([(1, 2), (0, 2)], |
| 109 | 1) |
| 110 | self.assertEquals(drone.name, 1) |
| 111 | |
| 112 | |
| 113 | def test_choose_drone_for_execution_some_full(self): |
| 114 | drone = self._test_choose_drone_for_execution_helper([(0, 1), (1, 3)], |
| 115 | 2) |
| 116 | self.assertEquals(drone.name, 1) |
| 117 | |
| 118 | |
| 119 | def test_choose_drone_for_execution_all_full(self): |
| 120 | drone = self._test_choose_drone_for_execution_helper([(2, 1), (3, 2)], |
| 121 | 1) |
| 122 | self.assertEquals(drone.name, 1) |
| 123 | |
| 124 | |
jamesren | 37b5045 | 2010-03-25 20:38:56 +0000 | [diff] [blame] | 125 | def test_choose_drone_for_execution_all_full_same_percentage_capacity(self): |
| 126 | drone = self._test_choose_drone_for_execution_helper([(5, 3), (10, 6)], |
| 127 | 1) |
| 128 | self.assertEquals(drone.name, 1) |
| 129 | |
| 130 | |
showard | 9bb960b | 2009-11-19 01:02:11 +0000 | [diff] [blame] | 131 | def test_user_restrictions(self): |
| 132 | # this drone is restricted to a different user |
| 133 | self.manager._enqueue_drone(MockDrone(1, max_processes=10, |
| 134 | allowed_users=['fakeuser'])) |
| 135 | # this drone is allowed but has lower capacity |
| 136 | self.manager._enqueue_drone(MockDrone(2, max_processes=2, |
| 137 | allowed_users=[self._USERNAME])) |
| 138 | |
| 139 | self.assertEquals(2, |
jamesren | 76fcf19 | 2010-04-21 20:39:50 +0000 | [diff] [blame] | 140 | self.manager.max_runnable_processes(self._USERNAME, |
| 141 | None)) |
showard | 9bb960b | 2009-11-19 01:02:11 +0000 | [diff] [blame] | 142 | drone = self.manager._choose_drone_for_execution( |
jamesren | 76fcf19 | 2010-04-21 20:39:50 +0000 | [diff] [blame] | 143 | 1, username=self._USERNAME, drone_hostnames_allowed=None) |
showard | 9bb960b | 2009-11-19 01:02:11 +0000 | [diff] [blame] | 144 | self.assertEquals(drone.name, 2) |
| 145 | |
| 146 | |
jamesren | 37b5045 | 2010-03-25 20:38:56 +0000 | [diff] [blame] | 147 | def test_user_restrictions_with_full_drone(self): |
| 148 | # this drone is restricted to a different user |
| 149 | self.manager._enqueue_drone(MockDrone(1, max_processes=10, |
| 150 | allowed_users=['fakeuser'])) |
| 151 | # this drone is allowed but is full |
| 152 | self.manager._enqueue_drone(MockDrone(2, active_processes=3, |
| 153 | max_processes=2, |
| 154 | allowed_users=[self._USERNAME])) |
| 155 | |
| 156 | self.assertEquals(0, |
jamesren | 76fcf19 | 2010-04-21 20:39:50 +0000 | [diff] [blame] | 157 | self.manager.max_runnable_processes(self._USERNAME, |
| 158 | None)) |
jamesren | 37b5045 | 2010-03-25 20:38:56 +0000 | [diff] [blame] | 159 | drone = self.manager._choose_drone_for_execution( |
jamesren | 76fcf19 | 2010-04-21 20:39:50 +0000 | [diff] [blame] | 160 | 1, username=self._USERNAME, drone_hostnames_allowed=None) |
jamesren | 37b5045 | 2010-03-25 20:38:56 +0000 | [diff] [blame] | 161 | self.assertEquals(drone.name, 2) |
| 162 | |
| 163 | |
jamesren | 76fcf19 | 2010-04-21 20:39:50 +0000 | [diff] [blame] | 164 | def _setup_test_drone_restrictions(self, active_processes=0): |
| 165 | self.manager._enqueue_drone(MockDrone( |
| 166 | 1, active_processes=active_processes, max_processes=10)) |
| 167 | self.manager._enqueue_drone(MockDrone( |
| 168 | 2, active_processes=active_processes, max_processes=5)) |
| 169 | self.manager._enqueue_drone(MockDrone( |
| 170 | 3, active_processes=active_processes, max_processes=2)) |
| 171 | |
| 172 | |
| 173 | def test_drone_restrictions_allow_any(self): |
| 174 | self._setup_test_drone_restrictions() |
| 175 | self.assertEquals(10, |
| 176 | self.manager.max_runnable_processes(self._USERNAME, |
| 177 | None)) |
| 178 | drone = self.manager._choose_drone_for_execution( |
| 179 | 1, username=self._USERNAME, drone_hostnames_allowed=None) |
| 180 | self.assertEqual(drone.name, 1) |
| 181 | |
| 182 | |
| 183 | def test_drone_restrictions_under_capacity(self): |
| 184 | self._setup_test_drone_restrictions() |
| 185 | drone_hostnames_allowed = (2, 3) |
| 186 | self.assertEquals( |
| 187 | 5, self.manager.max_runnable_processes(self._USERNAME, |
| 188 | drone_hostnames_allowed)) |
| 189 | drone = self.manager._choose_drone_for_execution( |
| 190 | 1, username=self._USERNAME, |
| 191 | drone_hostnames_allowed=drone_hostnames_allowed) |
| 192 | |
| 193 | self.assertEqual(drone.name, 2) |
| 194 | |
| 195 | |
| 196 | def test_drone_restrictions_over_capacity(self): |
| 197 | self._setup_test_drone_restrictions(active_processes=6) |
| 198 | drone_hostnames_allowed = (2, 3) |
| 199 | self.assertEquals( |
| 200 | 0, self.manager.max_runnable_processes(self._USERNAME, |
| 201 | drone_hostnames_allowed)) |
| 202 | drone = self.manager._choose_drone_for_execution( |
| 203 | 7, username=self._USERNAME, |
| 204 | drone_hostnames_allowed=drone_hostnames_allowed) |
| 205 | self.assertEqual(drone.name, 2) |
| 206 | |
| 207 | |
| 208 | def test_drone_restrictions_allow_none(self): |
| 209 | self._setup_test_drone_restrictions() |
| 210 | drone_hostnames_allowed = () |
| 211 | self.assertEquals( |
| 212 | 0, self.manager.max_runnable_processes(self._USERNAME, |
| 213 | drone_hostnames_allowed)) |
| 214 | drone = self.manager._choose_drone_for_execution( |
| 215 | 1, username=self._USERNAME, |
| 216 | drone_hostnames_allowed=drone_hostnames_allowed) |
| 217 | self.assertEqual(drone, None) |
| 218 | |
| 219 | |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 220 | def test_initialize(self): |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 221 | results_hostname = 'results_repo' |
showard | ac5b000 | 2009-10-19 18:34:00 +0000 | [diff] [blame] | 222 | results_install_dir = '/results/install' |
| 223 | global_config.global_config.override_config_value( |
| 224 | scheduler_config.CONFIG_SECTION, |
| 225 | 'results_host_installation_directory', results_install_dir) |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 226 | |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 227 | (drones.get_drone.expect_call(self.mock_drone.name) |
| 228 | .and_return(self.mock_drone)) |
showard | 202343e | 2009-10-14 16:20:24 +0000 | [diff] [blame] | 229 | |
| 230 | results_drone = MockDrone('results_drone') |
| 231 | self.god.stub_function(results_drone, 'set_autotest_install_dir') |
| 232 | drones.get_drone.expect_call(results_hostname).and_return(results_drone) |
showard | ac5b000 | 2009-10-19 18:34:00 +0000 | [diff] [blame] | 233 | results_drone.set_autotest_install_dir.expect_call(results_install_dir) |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 234 | |
| 235 | self.manager.initialize(base_results_dir=self._RESULTS_DIR, |
| 236 | drone_hostnames=[self.mock_drone.name], |
| 237 | results_repository_hostname=results_hostname) |
| 238 | |
| 239 | self.assert_(self.mock_drone.was_call_queued( |
| 240 | 'initialize', self._DRONE_RESULTS_DIR + '/')) |
showard | ac5b000 | 2009-10-19 18:34:00 +0000 | [diff] [blame] | 241 | self.god.check_playback() |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 242 | |
| 243 | |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 244 | def test_execute_command(self): |
| 245 | self.manager._enqueue_drone(self.mock_drone) |
| 246 | |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 247 | pidfile_name = 'my_pidfile' |
| 248 | log_file = 'log_file' |
| 249 | |
| 250 | pidfile_id = self.manager.execute_command( |
| 251 | command=['test', drone_manager.WORKING_DIRECTORY], |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 252 | working_directory=self._WORKING_DIRECTORY, |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 253 | pidfile_name=pidfile_name, |
showard | 418785b | 2009-11-23 20:19:59 +0000 | [diff] [blame] | 254 | num_processes=1, |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 255 | log_file=log_file) |
| 256 | |
showard | c75fded | 2009-10-14 16:20:02 +0000 | [diff] [blame] | 257 | full_working_directory = os.path.join(self._DRONE_RESULTS_DIR, |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 258 | self._WORKING_DIRECTORY) |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 259 | self.assertEquals(pidfile_id.path, |
| 260 | os.path.join(full_working_directory, pidfile_name)) |
| 261 | self.assert_(self.mock_drone.was_call_queued( |
| 262 | 'execute_command', ['test', full_working_directory], |
| 263 | full_working_directory, |
showard | c75fded | 2009-10-14 16:20:02 +0000 | [diff] [blame] | 264 | os.path.join(self._DRONE_RESULTS_DIR, log_file), pidfile_name)) |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 265 | |
| 266 | |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 267 | def test_attach_file_to_execution(self): |
| 268 | self.manager._enqueue_drone(self.mock_drone) |
| 269 | |
| 270 | contents = 'my\ncontents' |
| 271 | attached_path = self.manager.attach_file_to_execution( |
| 272 | self._WORKING_DIRECTORY, contents) |
| 273 | self.manager.execute_command(command=['test'], |
| 274 | working_directory=self._WORKING_DIRECTORY, |
showard | 418785b | 2009-11-23 20:19:59 +0000 | [diff] [blame] | 275 | pidfile_name='mypidfile', |
jamesren | 76fcf19 | 2010-04-21 20:39:50 +0000 | [diff] [blame] | 276 | num_processes=1, |
| 277 | drone_hostnames_allowed=None) |
showard | 2aafd90 | 2009-10-14 16:20:14 +0000 | [diff] [blame] | 278 | |
| 279 | self.assert_(self.mock_drone.was_call_queued( |
| 280 | 'write_to_file', |
| 281 | os.path.join(self._DRONE_RESULTS_DIR, attached_path), |
| 282 | contents)) |
| 283 | |
| 284 | |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 285 | def test_copy_results_on_drone(self): |
| 286 | self.manager.copy_results_on_drone(self.mock_drone_process, |
| 287 | self._SOURCE_PATH, |
| 288 | self._DESTINATION_PATH) |
| 289 | self.assert_(self.mock_drone.was_call_queued( |
| 290 | 'copy_file_or_directory', |
showard | c75fded | 2009-10-14 16:20:02 +0000 | [diff] [blame] | 291 | os.path.join(self._DRONE_RESULTS_DIR, self._SOURCE_PATH), |
| 292 | os.path.join(self._DRONE_RESULTS_DIR, self._DESTINATION_PATH))) |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 293 | |
| 294 | |
| 295 | def test_copy_to_results_repository(self): |
Simran Basi | 882f15b | 2013-10-29 14:59:34 -0700 | [diff] [blame^] | 296 | site_drone_manager.ENABLE_ARCHIVING = True |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 297 | self.manager.copy_to_results_repository(self.mock_drone_process, |
| 298 | self._SOURCE_PATH) |
| 299 | self.assert_(self.mock_drone.was_file_sent( |
| 300 | self.results_drone, |
showard | c75fded | 2009-10-14 16:20:02 +0000 | [diff] [blame] | 301 | os.path.join(self._DRONE_RESULTS_DIR, self._SOURCE_PATH), |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 302 | os.path.join(self._RESULTS_DIR, self._SOURCE_PATH))) |
| 303 | |
| 304 | |
| 305 | def test_write_lines_to_file(self): |
| 306 | file_path = 'file/path' |
| 307 | lines = ['line1', 'line2'] |
| 308 | written_data = 'line1\nline2\n' |
| 309 | |
| 310 | # write to results repository |
| 311 | self.manager.write_lines_to_file(file_path, lines) |
| 312 | self.assert_(self.results_drone.was_call_queued( |
| 313 | 'write_to_file', os.path.join(self._RESULTS_DIR, file_path), |
| 314 | written_data)) |
| 315 | |
| 316 | # write to a drone |
| 317 | self.manager.write_lines_to_file( |
| 318 | file_path, lines, paired_with_process=self.mock_drone_process) |
| 319 | self.assert_(self.mock_drone.was_call_queued( |
| 320 | 'write_to_file', |
showard | c75fded | 2009-10-14 16:20:02 +0000 | [diff] [blame] | 321 | os.path.join(self._DRONE_RESULTS_DIR, file_path), written_data)) |
showard | 42d4498 | 2009-10-12 20:34:03 +0000 | [diff] [blame] | 322 | |
| 323 | |
showard | d349624 | 2009-12-10 21:41:43 +0000 | [diff] [blame] | 324 | def test_pidfile_expiration(self): |
| 325 | self.god.stub_with(self.manager, '_get_max_pidfile_refreshes', |
| 326 | lambda: 0) |
| 327 | pidfile_id = self.manager.get_pidfile_id_from('tag', 'name') |
| 328 | self.manager.register_pidfile(pidfile_id) |
| 329 | self.manager._drop_old_pidfiles() |
| 330 | self.manager._drop_old_pidfiles() |
| 331 | self.assertFalse(self.manager._registered_pidfile_info) |
| 332 | |
| 333 | |
showard | e39ebe9 | 2009-06-18 23:14:48 +0000 | [diff] [blame] | 334 | if __name__ == '__main__': |
| 335 | unittest.main() |