Mike Frysinger | d03e6b5 | 2019-08-03 12:49:01 -0400 | [diff] [blame] | 1 | #!/usr/bin/python2 |
Michael Tang | 97d188c | 2016-06-25 11:18:42 -0700 | [diff] [blame] | 2 | # Copyright 2016 The Chromium OS Authors. All rights reserved. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 3 | # Use of this source code is governed by a BSD-style license that can be |
| 4 | # found in the LICENSE file. |
| 5 | |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 6 | import __builtin__ |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 7 | import Queue |
Xinan Lin | 9eb782f | 2019-10-23 23:14:49 -0700 | [diff] [blame] | 8 | import json |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 9 | import logging |
| 10 | import os |
| 11 | import shutil |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 12 | import signal |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 13 | import stat |
Xinan Lin | 9eb782f | 2019-10-23 23:14:49 -0700 | [diff] [blame] | 14 | import subprocess |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 15 | import sys |
Rohit Makasana | c1c7e78 | 2019-04-02 18:06:00 -0700 | [diff] [blame] | 16 | import tarfile |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 17 | import tempfile |
| 18 | import time |
| 19 | import unittest |
| 20 | |
Allen Li | 9579b38 | 2017-05-05 17:07:43 -0700 | [diff] [blame] | 21 | import mock |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 22 | import mox |
| 23 | |
| 24 | import common |
Allen Li | 5ed7e63 | 2017-02-03 16:31:33 -0800 | [diff] [blame] | 25 | from autotest_lib.client.common_lib import global_config |
Dan Shi | 1b4c7c3 | 2015-10-05 10:38:57 -0700 | [diff] [blame] | 26 | from autotest_lib.client.common_lib import utils |
Michael Tang | e8bc959 | 2017-07-06 10:59:32 -0700 | [diff] [blame] | 27 | #For unittest without cloud_client.proto compiled. |
| 28 | try: |
| 29 | from autotest_lib.site_utils import cloud_console_client |
| 30 | except ImportError: |
| 31 | cloud_console_client = None |
Prathmesh Prabhu | beb9e01 | 2017-01-30 16:18:39 -0800 | [diff] [blame] | 32 | from autotest_lib.site_utils import gs_offloader |
| 33 | from autotest_lib.site_utils import job_directories |
Prathmesh Prabhu | d47e9d3 | 2019-03-13 13:04:05 -0700 | [diff] [blame] | 34 | from autotest_lib.site_utils import job_directories_unittest as jd_test |
Ningning Xia | 2d981ee | 2016-07-06 17:59:54 -0700 | [diff] [blame] | 35 | from autotest_lib.tko import models |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 36 | from autotest_lib.utils import gslib |
Michael Tang | 0f553bd | 2017-06-16 17:38:45 -0700 | [diff] [blame] | 37 | from autotest_lib.site_utils import pubsub_utils |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 38 | from chromite.lib import timeout_util |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 39 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 40 | # Test value to use for `days_old`, if nothing else is required. |
| 41 | _TEST_EXPIRATION_AGE = 7 |
| 42 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 43 | |
| 44 | def _get_options(argv): |
| 45 | """Helper function to exercise command line parsing. |
| 46 | |
| 47 | @param argv Value of sys.argv to be parsed. |
| 48 | |
| 49 | """ |
| 50 | sys.argv = ['bogus.py'] + argv |
| 51 | return gs_offloader.parse_options() |
| 52 | |
| 53 | |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 54 | def is_fifo(path): |
Allen Li | 9358538 | 2017-05-05 14:24:53 -0700 | [diff] [blame] | 55 | """Determines whether a path is a fifo. |
| 56 | |
| 57 | @param path: fifo path string. |
| 58 | """ |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 59 | return stat.S_ISFIFO(os.lstat(path).st_mode) |
| 60 | |
| 61 | |
Xinan Lin | 9eb782f | 2019-10-23 23:14:49 -0700 | [diff] [blame] | 62 | def _get_fake_process(): |
| 63 | return FakeProcess() |
| 64 | |
| 65 | |
| 66 | class FakeProcess(object): |
| 67 | """Fake process object.""" |
| 68 | |
| 69 | def __init__(self): |
| 70 | self.returncode = 0 |
| 71 | |
| 72 | |
| 73 | def wait(self): |
| 74 | return True |
| 75 | |
| 76 | |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 77 | class OffloaderOptionsTests(mox.MoxTestBase): |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 78 | """Tests for the `Offloader` constructor. |
| 79 | |
| 80 | Tests that offloader instance fields are set as expected |
| 81 | for given command line options. |
| 82 | |
| 83 | """ |
| 84 | |
Allen Li | 7402f09 | 2018-06-26 15:42:21 -0700 | [diff] [blame] | 85 | _REGULAR_ONLY = {job_directories.SwarmingJobDirectory, |
| 86 | job_directories.RegularJobDirectory} |
| 87 | _SPECIAL_ONLY = {job_directories.SwarmingJobDirectory, |
| 88 | job_directories.SpecialJobDirectory} |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 89 | _BOTH = _REGULAR_ONLY | _SPECIAL_ONLY |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 90 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 91 | |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 92 | def setUp(self): |
| 93 | super(OffloaderOptionsTests, self).setUp() |
| 94 | self.mox.StubOutWithMock(utils, 'get_offload_gsuri') |
Simran Basi | f3e305f | 2014-10-03 14:43:53 -0700 | [diff] [blame] | 95 | gs_offloader.GS_OFFLOADING_ENABLED = True |
Michael Tang | 0df2eb4 | 2016-05-13 19:06:54 -0700 | [diff] [blame] | 96 | gs_offloader.GS_OFFLOADER_MULTIPROCESSING = False |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 97 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 98 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 99 | def _mock_get_sub_offloader(self, is_moblab, multiprocessing=False, |
Michael Tang | 0f553bd | 2017-06-16 17:38:45 -0700 | [diff] [blame] | 100 | console_client=None, delete_age=0): |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 101 | """Mock the process of getting the offload_dir function.""" |
| 102 | if is_moblab: |
| 103 | expected_gsuri = '%sresults/%s/%s/' % ( |
| 104 | global_config.global_config.get_config_value( |
| 105 | 'CROS', 'image_storage_server'), |
| 106 | 'Fa:ke:ma:c0:12:34', 'rand0m-uu1d') |
| 107 | else: |
| 108 | expected_gsuri = utils.DEFAULT_OFFLOAD_GSURI |
| 109 | utils.get_offload_gsuri().AndReturn(expected_gsuri) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 110 | sub_offloader = gs_offloader.GSOffloader(expected_gsuri, |
Michael Tang | 0f553bd | 2017-06-16 17:38:45 -0700 | [diff] [blame] | 111 | multiprocessing, delete_age, console_client) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 112 | self.mox.StubOutWithMock(gs_offloader, 'GSOffloader') |
Michael Tang | e8bc959 | 2017-07-06 10:59:32 -0700 | [diff] [blame] | 113 | if cloud_console_client: |
| 114 | self.mox.StubOutWithMock(cloud_console_client, |
| 115 | 'is_cloud_notification_enabled') |
Michael Tang | 0f553bd | 2017-06-16 17:38:45 -0700 | [diff] [blame] | 116 | if console_client: |
| 117 | cloud_console_client.is_cloud_notification_enabled().AndReturn(True) |
| 118 | gs_offloader.GSOffloader( |
| 119 | expected_gsuri, multiprocessing, delete_age, |
| 120 | mox.IsA(cloud_console_client.PubSubBasedClient)).AndReturn( |
| 121 | sub_offloader) |
| 122 | else: |
Michael Tang | e8bc959 | 2017-07-06 10:59:32 -0700 | [diff] [blame] | 123 | if cloud_console_client: |
| 124 | cloud_console_client.is_cloud_notification_enabled().AndReturn( |
| 125 | False) |
Michael Tang | 0f553bd | 2017-06-16 17:38:45 -0700 | [diff] [blame] | 126 | gs_offloader.GSOffloader( |
| 127 | expected_gsuri, multiprocessing, delete_age, None).AndReturn( |
| 128 | sub_offloader) |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 129 | self.mox.ReplayAll() |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 130 | return sub_offloader |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 131 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 132 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 133 | def test_process_no_options(self): |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 134 | """Test default offloader options.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 135 | sub_offloader = self._mock_get_sub_offloader(False) |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 136 | offloader = gs_offloader.Offloader(_get_options([])) |
| 137 | self.assertEqual(set(offloader._jobdir_classes), |
| 138 | self._REGULAR_ONLY) |
| 139 | self.assertEqual(offloader._processes, 1) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 140 | self.assertEqual(offloader._gs_offloader, |
| 141 | sub_offloader) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 142 | self.assertEqual(offloader._upload_age_limit, 0) |
| 143 | self.assertEqual(offloader._delete_age_limit, 0) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 144 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 145 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 146 | def test_process_all_option(self): |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 147 | """Test offloader handling for the --all option.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 148 | sub_offloader = self._mock_get_sub_offloader(False) |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 149 | offloader = gs_offloader.Offloader(_get_options(['--all'])) |
| 150 | self.assertEqual(set(offloader._jobdir_classes), self._BOTH) |
| 151 | self.assertEqual(offloader._processes, 1) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 152 | self.assertEqual(offloader._gs_offloader, |
| 153 | sub_offloader) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 154 | self.assertEqual(offloader._upload_age_limit, 0) |
| 155 | self.assertEqual(offloader._delete_age_limit, 0) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 156 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 157 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 158 | def test_process_hosts_option(self): |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 159 | """Test offloader handling for the --hosts option.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 160 | sub_offloader = self._mock_get_sub_offloader(False) |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 161 | offloader = gs_offloader.Offloader( |
| 162 | _get_options(['--hosts'])) |
| 163 | self.assertEqual(set(offloader._jobdir_classes), |
| 164 | self._SPECIAL_ONLY) |
| 165 | self.assertEqual(offloader._processes, 1) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 166 | self.assertEqual(offloader._gs_offloader, |
| 167 | sub_offloader) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 168 | self.assertEqual(offloader._upload_age_limit, 0) |
| 169 | self.assertEqual(offloader._delete_age_limit, 0) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 170 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 171 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 172 | def test_parallelism_option(self): |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 173 | """Test offloader handling for the --parallelism option.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 174 | sub_offloader = self._mock_get_sub_offloader(False) |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 175 | offloader = gs_offloader.Offloader( |
| 176 | _get_options(['--parallelism', '2'])) |
| 177 | self.assertEqual(set(offloader._jobdir_classes), |
| 178 | self._REGULAR_ONLY) |
| 179 | self.assertEqual(offloader._processes, 2) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 180 | self.assertEqual(offloader._gs_offloader, |
| 181 | sub_offloader) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 182 | self.assertEqual(offloader._upload_age_limit, 0) |
| 183 | self.assertEqual(offloader._delete_age_limit, 0) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 184 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 185 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 186 | def test_delete_only_option(self): |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 187 | """Test offloader handling for the --delete_only option.""" |
| 188 | offloader = gs_offloader.Offloader( |
| 189 | _get_options(['--delete_only'])) |
| 190 | self.assertEqual(set(offloader._jobdir_classes), |
| 191 | self._REGULAR_ONLY) |
| 192 | self.assertEqual(offloader._processes, 1) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 193 | self.assertIsInstance(offloader._gs_offloader, |
| 194 | gs_offloader.FakeGSOffloader) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 195 | self.assertEqual(offloader._upload_age_limit, 0) |
| 196 | self.assertEqual(offloader._delete_age_limit, 0) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 197 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 198 | |
Simran Basi | df4751e | 2014-10-10 14:19:22 -0700 | [diff] [blame] | 199 | def test_days_old_option(self): |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 200 | """Test offloader handling for the --days_old option.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 201 | sub_offloader = self._mock_get_sub_offloader(False, delete_age=7) |
J. Richard Barnette | ef4b47d | 2014-05-19 07:52:08 -0700 | [diff] [blame] | 202 | offloader = gs_offloader.Offloader( |
| 203 | _get_options(['--days_old', '7'])) |
| 204 | self.assertEqual(set(offloader._jobdir_classes), |
| 205 | self._REGULAR_ONLY) |
| 206 | self.assertEqual(offloader._processes, 1) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 207 | self.assertEqual(offloader._gs_offloader, |
| 208 | sub_offloader) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 209 | self.assertEqual(offloader._upload_age_limit, 7) |
| 210 | self.assertEqual(offloader._delete_age_limit, 7) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 211 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 212 | |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 213 | def test_moblab_gsuri_generation(self): |
| 214 | """Test offloader construction for Moblab.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 215 | sub_offloader = self._mock_get_sub_offloader(True) |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 216 | offloader = gs_offloader.Offloader(_get_options([])) |
| 217 | self.assertEqual(set(offloader._jobdir_classes), |
| 218 | self._REGULAR_ONLY) |
| 219 | self.assertEqual(offloader._processes, 1) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 220 | self.assertEqual(offloader._gs_offloader, |
| 221 | sub_offloader) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 222 | self.assertEqual(offloader._upload_age_limit, 0) |
| 223 | self.assertEqual(offloader._delete_age_limit, 0) |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 224 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 225 | |
Simran Basi | f3e305f | 2014-10-03 14:43:53 -0700 | [diff] [blame] | 226 | def test_globalconfig_offloading_flag(self): |
| 227 | """Test enabling of --delete_only via global_config.""" |
| 228 | gs_offloader.GS_OFFLOADING_ENABLED = False |
| 229 | offloader = gs_offloader.Offloader( |
| 230 | _get_options([])) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 231 | self.assertIsInstance(offloader._gs_offloader, |
| 232 | gs_offloader.FakeGSOffloader) |
Simran Basi | f3e305f | 2014-10-03 14:43:53 -0700 | [diff] [blame] | 233 | |
Michael Tang | 0df2eb4 | 2016-05-13 19:06:54 -0700 | [diff] [blame] | 234 | def test_offloader_multiprocessing_flag_set(self): |
| 235 | """Test multiprocessing is set.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 236 | sub_offloader = self._mock_get_sub_offloader(True, True) |
Michael Tang | 0df2eb4 | 2016-05-13 19:06:54 -0700 | [diff] [blame] | 237 | offloader = gs_offloader.Offloader(_get_options(['-m'])) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 238 | self.assertEqual(offloader._gs_offloader, |
| 239 | sub_offloader) |
Michael Tang | 0df2eb4 | 2016-05-13 19:06:54 -0700 | [diff] [blame] | 240 | self.mox.VerifyAll() |
| 241 | |
| 242 | def test_offloader_multiprocessing_flag_not_set_default_false(self): |
| 243 | """Test multiprocessing is set.""" |
| 244 | gs_offloader.GS_OFFLOADER_MULTIPROCESSING = False |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 245 | sub_offloader = self._mock_get_sub_offloader(True, False) |
Michael Tang | 0df2eb4 | 2016-05-13 19:06:54 -0700 | [diff] [blame] | 246 | offloader = gs_offloader.Offloader(_get_options([])) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 247 | self.assertEqual(offloader._gs_offloader, |
| 248 | sub_offloader) |
Michael Tang | 0df2eb4 | 2016-05-13 19:06:54 -0700 | [diff] [blame] | 249 | self.mox.VerifyAll() |
| 250 | |
| 251 | def test_offloader_multiprocessing_flag_not_set_default_true(self): |
| 252 | """Test multiprocessing is set.""" |
| 253 | gs_offloader.GS_OFFLOADER_MULTIPROCESSING = True |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 254 | sub_offloader = self._mock_get_sub_offloader(True, True) |
Michael Tang | 0df2eb4 | 2016-05-13 19:06:54 -0700 | [diff] [blame] | 255 | offloader = gs_offloader.Offloader(_get_options([])) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 256 | self.assertEqual(offloader._gs_offloader, |
| 257 | sub_offloader) |
Michael Tang | 0df2eb4 | 2016-05-13 19:06:54 -0700 | [diff] [blame] | 258 | self.mox.VerifyAll() |
| 259 | |
Michael Tang | 97d188c | 2016-06-25 11:18:42 -0700 | [diff] [blame] | 260 | |
Michael Tang | 0f553bd | 2017-06-16 17:38:45 -0700 | [diff] [blame] | 261 | def test_offloader_pubsub_enabled(self): |
Michael Tang | 97d188c | 2016-06-25 11:18:42 -0700 | [diff] [blame] | 262 | """Test multiprocessing is set.""" |
Michael Tang | e8bc959 | 2017-07-06 10:59:32 -0700 | [diff] [blame] | 263 | if not cloud_console_client: |
| 264 | return |
Michael Tang | 0f553bd | 2017-06-16 17:38:45 -0700 | [diff] [blame] | 265 | self.mox.StubOutWithMock(pubsub_utils, "PubSubClient") |
| 266 | sub_offloader = self._mock_get_sub_offloader(True, False, |
| 267 | cloud_console_client.PubSubBasedClient()) |
| 268 | offloader = gs_offloader.Offloader(_get_options([])) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 269 | self.assertEqual(offloader._gs_offloader, |
| 270 | sub_offloader) |
Michael Tang | 97d188c | 2016-06-25 11:18:42 -0700 | [diff] [blame] | 271 | self.mox.VerifyAll() |
| 272 | |
Simran Basi | f3e305f | 2014-10-03 14:43:53 -0700 | [diff] [blame] | 273 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 274 | class _MockJobDirectory(job_directories._JobDirectory): |
| 275 | """Subclass of `_JobDirectory` used as a helper for tests.""" |
| 276 | |
| 277 | GLOB_PATTERN = '[0-9]*-*' |
| 278 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 279 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 280 | def __init__(self, resultsdir): |
| 281 | """Create new job in initial state.""" |
| 282 | super(_MockJobDirectory, self).__init__(resultsdir) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 283 | self._timestamp = None |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 284 | self.queue_args = [resultsdir, os.path.dirname(resultsdir), self._timestamp] |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 285 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 286 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 287 | def get_timestamp_if_finished(self): |
| 288 | return self._timestamp |
| 289 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 290 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 291 | def set_finished(self, days_old): |
| 292 | """Make this job appear to be finished. |
| 293 | |
| 294 | After calling this function, calls to `enqueue_offload()` |
| 295 | will find this job as finished, but not expired and ready |
| 296 | for offload. Note that when `days_old` is 0, |
| 297 | `enqueue_offload()` will treat a finished job as eligible |
| 298 | for offload. |
| 299 | |
| 300 | @param days_old The value of the `days_old` parameter that |
| 301 | will be passed to `enqueue_offload()` for |
| 302 | testing. |
| 303 | |
| 304 | """ |
Prathmesh Prabhu | d47e9d3 | 2019-03-13 13:04:05 -0700 | [diff] [blame] | 305 | self._timestamp = jd_test.make_timestamp(days_old, False) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 306 | self.queue_args[2] = self._timestamp |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 307 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 308 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 309 | def set_expired(self, days_old): |
| 310 | """Make this job eligible to be offloaded. |
| 311 | |
| 312 | After calling this function, calls to `offload` will attempt |
| 313 | to offload this job. |
| 314 | |
| 315 | @param days_old The value of the `days_old` parameter that |
| 316 | will be passed to `enqueue_offload()` for |
| 317 | testing. |
| 318 | |
| 319 | """ |
Prathmesh Prabhu | d47e9d3 | 2019-03-13 13:04:05 -0700 | [diff] [blame] | 320 | self._timestamp = jd_test.make_timestamp(days_old, True) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 321 | self.queue_args[2] = self._timestamp |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 322 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 323 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 324 | def set_incomplete(self): |
| 325 | """Make this job appear to have failed offload just once.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 326 | self.offload_count += 1 |
| 327 | self.first_offload_start = time.time() |
| 328 | if not os.path.isdir(self.dirname): |
| 329 | os.mkdir(self.dirname) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 330 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 331 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 332 | def set_reportable(self): |
| 333 | """Make this job be reportable.""" |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 334 | self.set_incomplete() |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 335 | self.offload_count += 1 |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 336 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 337 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 338 | def set_complete(self): |
| 339 | """Make this job be completed.""" |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 340 | self.offload_count += 1 |
| 341 | if os.path.isdir(self.dirname): |
| 342 | os.rmdir(self.dirname) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 343 | |
| 344 | |
Simran Basi | 1e10e92 | 2015-04-16 15:09:56 -0700 | [diff] [blame] | 345 | def process_gs_instructions(self): |
| 346 | """Always still offload the job directory.""" |
| 347 | return True |
| 348 | |
| 349 | |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 350 | class CommandListTests(unittest.TestCase): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 351 | """Tests for `_get_cmd_list()`.""" |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 352 | |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 353 | def _command_list_assertions(self, job, use_rsync=True, multi=False): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 354 | """Call `_get_cmd_list()` and check the return value. |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 355 | |
| 356 | Check the following assertions: |
| 357 | * The command name (argv[0]) is 'gsutil'. |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 358 | * '-m' option (argv[1]) is on when the argument, multi, is True. |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 359 | * The arguments contain the 'cp' subcommand. |
| 360 | * The next-to-last argument (the source directory) is the |
| 361 | job's `queue_args[0]`. |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 362 | * The last argument (the destination URL) is the job's |
| 363 | 'queue_args[1]'. |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 364 | |
| 365 | @param job A job with properly calculated arguments to |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 366 | `_get_cmd_list()` |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 367 | @param use_rsync True when using 'rsync'. False when using 'cp'. |
| 368 | @param multi True when using '-m' option for gsutil. |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 369 | |
| 370 | """ |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 371 | test_bucket_uri = 'gs://a-test-bucket' |
| 372 | |
| 373 | gs_offloader.USE_RSYNC_ENABLED = use_rsync |
| 374 | |
Aviv Keshet | acef00e | 2019-11-13 16:35:29 -0800 | [diff] [blame] | 375 | gs_path = os.path.join(test_bucket_uri, job.queue_args[1]) |
| 376 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 377 | command = gs_offloader._get_cmd_list( |
Aviv Keshet | acef00e | 2019-11-13 16:35:29 -0800 | [diff] [blame] | 378 | multi, job.queue_args[0], gs_path) |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 379 | |
Dan Shi | 365049f | 2017-05-28 08:00:02 +0000 | [diff] [blame] | 380 | self.assertEqual(command[0], 'gsutil') |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 381 | if multi: |
| 382 | self.assertEqual(command[1], '-m') |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 383 | self.assertEqual(command[-2], job.queue_args[0]) |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 384 | |
| 385 | if use_rsync: |
| 386 | self.assertTrue('rsync' in command) |
| 387 | self.assertEqual(command[-1], |
| 388 | os.path.join(test_bucket_uri, job.queue_args[0])) |
| 389 | else: |
| 390 | self.assertTrue('cp' in command) |
| 391 | self.assertEqual(command[-1], |
| 392 | os.path.join(test_bucket_uri, job.queue_args[1])) |
| 393 | |
Aviv Keshet | acef00e | 2019-11-13 16:35:29 -0800 | [diff] [blame] | 394 | finish_command = gs_offloader._get_finish_cmd_list(gs_path) |
| 395 | self.assertEqual(finish_command[0], 'gsutil') |
| 396 | self.assertEqual(finish_command[1], 'cp') |
| 397 | self.assertEqual(finish_command[2], '/dev/null') |
| 398 | self.assertEqual(finish_command[3], |
| 399 | os.path.join(gs_path, '.finished_offload')) |
| 400 | |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 401 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 402 | def test__get_cmd_list_regular(self): |
| 403 | """Test `_get_cmd_list()` as for a regular job.""" |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 404 | job = _MockJobDirectory('118-debug') |
| 405 | self._command_list_assertions(job) |
| 406 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 407 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 408 | def test__get_cmd_list_special(self): |
| 409 | """Test `_get_cmd_list()` as for a special job.""" |
J. Richard Barnette | 9f4be0d | 2014-05-20 12:28:31 -0700 | [diff] [blame] | 410 | job = _MockJobDirectory('hosts/host1/118-reset') |
| 411 | self._command_list_assertions(job) |
| 412 | |
| 413 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 414 | def test_get_cmd_list_regular_no_rsync(self): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 415 | """Test `_get_cmd_list()` as for a regular job.""" |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 416 | job = _MockJobDirectory('118-debug') |
| 417 | self._command_list_assertions(job, use_rsync=False) |
| 418 | |
| 419 | |
| 420 | def test_get_cmd_list_special_no_rsync(self): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 421 | """Test `_get_cmd_list()` as for a special job.""" |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 422 | job = _MockJobDirectory('hosts/host1/118-reset') |
| 423 | self._command_list_assertions(job, use_rsync=False) |
| 424 | |
| 425 | |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 426 | def test_get_cmd_list_regular_multi(self): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 427 | """Test `_get_cmd_list()` as for a regular job with True multi.""" |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 428 | job = _MockJobDirectory('118-debug') |
| 429 | self._command_list_assertions(job, multi=True) |
| 430 | |
| 431 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 432 | def test__get_cmd_list_special_multi(self): |
| 433 | """Test `_get_cmd_list()` as for a special job with True multi.""" |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 434 | job = _MockJobDirectory('hosts/host1/118-reset') |
| 435 | self._command_list_assertions(job, multi=True) |
| 436 | |
| 437 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 438 | class _TempResultsDirTestCase(unittest.TestCase): |
| 439 | """Mixin class for tests using a temporary results directory.""" |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 440 | |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 441 | REGULAR_JOBLIST = [ |
| 442 | '111-fubar', '112-fubar', '113-fubar', '114-snafu'] |
| 443 | HOST_LIST = ['host1', 'host2', 'host3'] |
| 444 | SPECIAL_JOBLIST = [ |
| 445 | 'hosts/host1/333-reset', 'hosts/host1/334-reset', |
| 446 | 'hosts/host2/444-reset', 'hosts/host3/555-reset'] |
| 447 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 448 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 449 | def setUp(self): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 450 | super(_TempResultsDirTestCase, self).setUp() |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 451 | self._resultsroot = tempfile.mkdtemp() |
| 452 | self._cwd = os.getcwd() |
| 453 | os.chdir(self._resultsroot) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 454 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 455 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 456 | def tearDown(self): |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 457 | os.chdir(self._cwd) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 458 | shutil.rmtree(self._resultsroot) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 459 | super(_TempResultsDirTestCase, self).tearDown() |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 460 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 461 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 462 | def make_job(self, jobdir): |
| 463 | """Create a job with results in `self._resultsroot`. |
| 464 | |
| 465 | @param jobdir Name of the subdirectory to be created in |
| 466 | `self._resultsroot`. |
| 467 | |
| 468 | """ |
Xinan Lin | e1dc696 | 2019-09-20 15:43:52 -0700 | [diff] [blame] | 469 | os.makedirs(jobdir) |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 470 | return _MockJobDirectory(jobdir) |
| 471 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 472 | |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 473 | def make_job_hierarchy(self): |
| 474 | """Create a sample hierarchy of job directories. |
| 475 | |
| 476 | `self.REGULAR_JOBLIST` is a list of directories for regular |
| 477 | jobs to be created; `self.SPECIAL_JOBLIST` is a list of |
| 478 | directories for special jobs to be created. |
| 479 | |
| 480 | """ |
| 481 | for d in self.REGULAR_JOBLIST: |
| 482 | os.mkdir(d) |
| 483 | hostsdir = 'hosts' |
| 484 | os.mkdir(hostsdir) |
| 485 | for host in self.HOST_LIST: |
| 486 | os.mkdir(os.path.join(hostsdir, host)) |
| 487 | for d in self.SPECIAL_JOBLIST: |
| 488 | os.mkdir(d) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 489 | |
| 490 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 491 | class _TempResultsDirTestBase(_TempResultsDirTestCase, mox.MoxTestBase): |
| 492 | """Base Mox test class for tests using a temporary results directory.""" |
| 493 | |
| 494 | |
Prathmesh Prabhu | 80dfb1e | 2017-01-30 18:01:29 -0800 | [diff] [blame] | 495 | class FailedOffloadsLogTest(_TempResultsDirTestBase): |
| 496 | """Test the formatting of failed offloads log file.""" |
| 497 | # Below is partial sample of a failed offload log file. This text is |
| 498 | # deliberately hard-coded and then parsed to create the test data; the idea |
| 499 | # is to make sure the actual text format will be reviewed by a human being. |
| 500 | # |
| 501 | # first offload count directory |
| 502 | # --+----1----+---- ----+ ----+----1----+----2----+----3 |
| 503 | _SAMPLE_DIRECTORIES_REPORT = '''\ |
| 504 | =================== ====== ============================== |
| 505 | 2014-03-14 15:09:26 1 118-fubar |
| 506 | 2014-03-14 15:19:23 2 117-fubar |
| 507 | 2014-03-14 15:29:20 6 116-fubar |
| 508 | 2014-03-14 15:39:17 24 115-fubar |
| 509 | 2014-03-14 15:49:14 120 114-fubar |
| 510 | 2014-03-14 15:59:11 720 113-fubar |
| 511 | 2014-03-14 16:09:08 5040 112-fubar |
| 512 | 2014-03-14 16:19:05 40320 111-fubar |
| 513 | ''' |
| 514 | |
| 515 | def setUp(self): |
| 516 | super(FailedOffloadsLogTest, self).setUp() |
| 517 | self._offloader = gs_offloader.Offloader(_get_options([])) |
| 518 | self._joblist = [] |
| 519 | for line in self._SAMPLE_DIRECTORIES_REPORT.split('\n')[1 : -1]: |
| 520 | date_, time_, count, dir_ = line.split() |
| 521 | job = _MockJobDirectory(dir_) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 522 | job.offload_count = int(count) |
Prathmesh Prabhu | 80dfb1e | 2017-01-30 18:01:29 -0800 | [diff] [blame] | 523 | timestruct = time.strptime("%s %s" % (date_, time_), |
| 524 | gs_offloader.FAILED_OFFLOADS_TIME_FORMAT) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 525 | job.first_offload_start = time.mktime(timestruct) |
Prathmesh Prabhu | 80dfb1e | 2017-01-30 18:01:29 -0800 | [diff] [blame] | 526 | # enter the jobs in reverse order, to make sure we |
| 527 | # test that the output will be sorted. |
| 528 | self._joblist.insert(0, job) |
| 529 | |
| 530 | |
| 531 | def assert_report_well_formatted(self, report_file): |
Allen Li | 9358538 | 2017-05-05 14:24:53 -0700 | [diff] [blame] | 532 | """Assert that report file is well formatted. |
| 533 | |
| 534 | @param report_file: Path to report file |
| 535 | """ |
Prathmesh Prabhu | 80dfb1e | 2017-01-30 18:01:29 -0800 | [diff] [blame] | 536 | with open(report_file, 'r') as f: |
| 537 | report_lines = f.read().split() |
| 538 | |
| 539 | for end_of_header_index in range(len(report_lines)): |
| 540 | if report_lines[end_of_header_index].startswith('=='): |
| 541 | break |
| 542 | self.assertLess(end_of_header_index, len(report_lines), |
| 543 | 'Failed to find end-of-header marker in the report') |
| 544 | |
| 545 | relevant_lines = report_lines[end_of_header_index:] |
| 546 | expected_lines = self._SAMPLE_DIRECTORIES_REPORT.split() |
| 547 | self.assertListEqual(relevant_lines, expected_lines) |
| 548 | |
| 549 | |
| 550 | def test_failed_offload_log_format(self): |
| 551 | """Trigger an e-mail report and check its contents.""" |
| 552 | log_file = os.path.join(self._resultsroot, 'failed_log') |
| 553 | report = self._offloader._log_failed_jobs_locally(self._joblist, |
| 554 | log_file=log_file) |
| 555 | self.assert_report_well_formatted(log_file) |
| 556 | |
| 557 | |
| 558 | def test_failed_offload_file_overwrite(self): |
| 559 | """Verify that we can saefly overwrite the log file.""" |
| 560 | log_file = os.path.join(self._resultsroot, 'failed_log') |
| 561 | with open(log_file, 'w') as f: |
| 562 | f.write('boohoohoo') |
| 563 | report = self._offloader._log_failed_jobs_locally(self._joblist, |
| 564 | log_file=log_file) |
| 565 | self.assert_report_well_formatted(log_file) |
| 566 | |
| 567 | |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 568 | class OffloadDirectoryTests(_TempResultsDirTestBase): |
| 569 | """Tests for `offload_dir()`.""" |
| 570 | |
| 571 | def setUp(self): |
| 572 | super(OffloadDirectoryTests, self).setUp() |
| 573 | # offload_dir() logs messages; silence them. |
| 574 | self._saved_loglevel = logging.getLogger().getEffectiveLevel() |
| 575 | logging.getLogger().setLevel(logging.CRITICAL+1) |
| 576 | self._job = self.make_job(self.REGULAR_JOBLIST[0]) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 577 | self.mox.StubOutWithMock(gs_offloader, '_get_cmd_list') |
| 578 | alarm = mock.patch('signal.alarm', return_value=0) |
| 579 | alarm.start() |
| 580 | self.addCleanup(alarm.stop) |
Ningning Xia | 2d981ee | 2016-07-06 17:59:54 -0700 | [diff] [blame] | 581 | self.mox.StubOutWithMock(models.test, 'parse_job_keyval') |
Xinan Lin | e1dc696 | 2019-09-20 15:43:52 -0700 | [diff] [blame] | 582 | self.should_remove_sarming_req_dir = False |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 583 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 584 | |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 585 | def tearDown(self): |
| 586 | logging.getLogger().setLevel(self._saved_loglevel) |
| 587 | super(OffloadDirectoryTests, self).tearDown() |
| 588 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 589 | def _mock__upload_cts_testresult(self): |
| 590 | self.mox.StubOutWithMock(gs_offloader, '_upload_cts_testresult') |
| 591 | gs_offloader._upload_cts_testresult( |
Ningning Xia | 4211124 | 2016-06-15 14:35:58 -0700 | [diff] [blame] | 592 | mox.IgnoreArg(),mox.IgnoreArg()).AndReturn(None) |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 593 | |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 594 | def _mock_create_marker_file(self): |
| 595 | self.mox.StubOutWithMock(__builtin__, 'open') |
Allen Li | 9579b38 | 2017-05-05 17:07:43 -0700 | [diff] [blame] | 596 | open(mox.IgnoreArg(), 'a').AndReturn(mock.MagicMock()) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 597 | |
| 598 | |
| 599 | def _mock_offload_dir_calls(self, command, queue_args, |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 600 | marker_initially_exists=False): |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 601 | """Mock out the calls needed by `offload_dir()`. |
| 602 | |
| 603 | This covers only the calls made when there is no timeout. |
| 604 | |
| 605 | @param command Command list to be returned by the mocked |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 606 | call to `_get_cmd_list()`. |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 607 | |
| 608 | """ |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 609 | self.mox.StubOutWithMock(os.path, 'isfile') |
| 610 | os.path.isfile(mox.IgnoreArg()).AndReturn(marker_initially_exists) |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 611 | command.append(queue_args[0]) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 612 | gs_offloader._get_cmd_list( |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 613 | False, queue_args[0], |
| 614 | '%s%s' % (utils.DEFAULT_OFFLOAD_GSURI, |
| 615 | queue_args[1])).AndReturn(command) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 616 | self._mock__upload_cts_testresult() |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 617 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 618 | |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 619 | def _run_offload_dir(self, should_succeed, delete_age): |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 620 | """Make one call to `offload_dir()`. |
| 621 | |
| 622 | The caller ensures all mocks are set up already. |
| 623 | |
| 624 | @param should_succeed True iff the call to `offload_dir()` |
| 625 | is expected to succeed and remove the |
| 626 | offloaded job directory. |
| 627 | |
| 628 | """ |
| 629 | self.mox.ReplayAll() |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 630 | gs_offloader.GSOffloader( |
| 631 | utils.DEFAULT_OFFLOAD_GSURI, False, delete_age).offload( |
MK Ryu | e93c857 | 2015-08-11 11:53:00 -0700 | [diff] [blame] | 632 | self._job.queue_args[0], |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 633 | self._job.queue_args[1], |
| 634 | self._job.queue_args[2]) |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 635 | self.mox.VerifyAll() |
| 636 | self.assertEqual(not should_succeed, |
| 637 | os.path.isdir(self._job.queue_args[0])) |
Xinan Lin | e1dc696 | 2019-09-20 15:43:52 -0700 | [diff] [blame] | 638 | swarming_req_dir = gs_offloader._get_swarming_req_dir( |
| 639 | self._job.queue_args[0]) |
| 640 | if swarming_req_dir: |
| 641 | self.assertEqual(not self.should_remove_sarming_req_dir, |
| 642 | os.path.exists(swarming_req_dir)) |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 643 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 644 | |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 645 | def test_offload_success(self): |
| 646 | """Test that `offload_dir()` can succeed correctly.""" |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 647 | self._mock_offload_dir_calls(['test', '-d'], |
| 648 | self._job.queue_args) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 649 | os.path.isfile(mox.IgnoreArg()).AndReturn(True) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 650 | self._mock_create_marker_file() |
| 651 | self._run_offload_dir(True, 0) |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 652 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 653 | |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 654 | def test_offload_failure(self): |
| 655 | """Test that `offload_dir()` can fail correctly.""" |
Simran Basi | dd12997 | 2014-09-11 14:34:49 -0700 | [diff] [blame] | 656 | self._mock_offload_dir_calls(['test', '!', '-d'], |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 657 | self._job.queue_args) |
Keith Haddow | 5ba5fb8 | 2016-11-09 11:39:36 -0800 | [diff] [blame] | 658 | self._run_offload_dir(False, 0) |
J. Richard Barnette | 2e443ef | 2014-05-20 12:31:35 -0700 | [diff] [blame] | 659 | |
| 660 | |
Xinan Lin | e1dc696 | 2019-09-20 15:43:52 -0700 | [diff] [blame] | 661 | def test_offload_swarming_req_dir_remove(self): |
| 662 | """Test that `offload_dir()` can prune the empty swarming task dir.""" |
| 663 | should_remove = os.path.join('results', 'swarming-123abc0') |
| 664 | self._job = self.make_job(os.path.join(should_remove, '1')) |
| 665 | self._mock_offload_dir_calls(['test', '-d'], |
| 666 | self._job.queue_args) |
| 667 | |
| 668 | os.path.isfile(mox.IgnoreArg()).AndReturn(True) |
| 669 | self.should_remove_sarming_req_dir = True |
| 670 | self._mock_create_marker_file() |
| 671 | self._run_offload_dir(True, 0) |
| 672 | |
| 673 | |
| 674 | def test_offload_swarming_req_dir_exist(self): |
| 675 | """Test that `offload_dir()` keeps the non-empty swarming task dir.""" |
| 676 | should_not_remove = os.path.join('results', 'swarming-456edf0') |
| 677 | self._job = self.make_job(os.path.join(should_not_remove, '1')) |
| 678 | self.make_job(os.path.join(should_not_remove, '2')) |
| 679 | self._mock_offload_dir_calls(['test', '-d'], |
| 680 | self._job.queue_args) |
| 681 | |
| 682 | os.path.isfile(mox.IgnoreArg()).AndReturn(True) |
| 683 | self.should_remove_sarming_req_dir = False |
| 684 | self._mock_create_marker_file() |
| 685 | self._run_offload_dir(True, 0) |
| 686 | |
| 687 | |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 688 | def test_sanitize_dir(self): |
| 689 | """Test that folder/file name with invalid character can be corrected. |
| 690 | """ |
| 691 | results_folder = tempfile.mkdtemp() |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 692 | invalid_chars = '_'.join(['[', ']', '*', '?', '#']) |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 693 | invalid_files = [] |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 694 | invalid_folder_name = 'invalid_name_folder_%s' % invalid_chars |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 695 | invalid_folder = os.path.join( |
| 696 | results_folder, |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 697 | invalid_folder_name) |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 698 | invalid_files.append(os.path.join( |
| 699 | invalid_folder, |
| 700 | 'invalid_name_file_%s' % invalid_chars)) |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 701 | good_folder = os.path.join(results_folder, 'valid_name_folder') |
| 702 | good_file = os.path.join(good_folder, 'valid_name_file') |
| 703 | for folder in [invalid_folder, good_folder]: |
| 704 | os.makedirs(folder) |
| 705 | for f in invalid_files + [good_file]: |
| 706 | with open(f, 'w'): |
| 707 | pass |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 708 | # check that broken symlinks don't break sanitization |
| 709 | symlink = os.path.join(invalid_folder, 'broken-link') |
| 710 | os.symlink(os.path.join(results_folder, 'no-such-file'), |
| 711 | symlink) |
| 712 | fifo1 = os.path.join(results_folder, 'test_fifo1') |
| 713 | fifo2 = os.path.join(good_folder, 'test_fifo2') |
| 714 | fifo3 = os.path.join(invalid_folder, 'test_fifo3') |
| 715 | invalid_fifo4_name = 'test_fifo4_%s' % invalid_chars |
| 716 | fifo4 = os.path.join(invalid_folder, invalid_fifo4_name) |
| 717 | os.mkfifo(fifo1) |
| 718 | os.mkfifo(fifo2) |
| 719 | os.mkfifo(fifo3) |
| 720 | os.mkfifo(fifo4) |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 721 | gs_offloader.sanitize_dir(results_folder) |
| 722 | for _, dirs, files in os.walk(results_folder): |
| 723 | for name in dirs + files: |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 724 | self.assertEqual(name, gslib.escape(name)) |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 725 | for c in name: |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 726 | self.assertFalse(c in ['[', ']', '*', '?', '#']) |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 727 | self.assertTrue(os.path.exists(good_file)) |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 728 | |
| 729 | self.assertTrue(os.path.exists(fifo1)) |
| 730 | self.assertFalse(is_fifo(fifo1)) |
| 731 | self.assertTrue(os.path.exists(fifo2)) |
| 732 | self.assertFalse(is_fifo(fifo2)) |
| 733 | corrected_folder = os.path.join( |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 734 | results_folder, gslib.escape(invalid_folder_name)) |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 735 | corrected_fifo3 = os.path.join( |
| 736 | corrected_folder, |
| 737 | 'test_fifo3') |
| 738 | self.assertFalse(os.path.exists(fifo3)) |
| 739 | self.assertTrue(os.path.exists(corrected_fifo3)) |
| 740 | self.assertFalse(is_fifo(corrected_fifo3)) |
| 741 | corrected_fifo4 = os.path.join( |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 742 | corrected_folder, gslib.escape(invalid_fifo4_name)) |
Laurence Goodby | ca7726d | 2017-02-14 17:09:07 -0800 | [diff] [blame] | 743 | self.assertFalse(os.path.exists(fifo4)) |
| 744 | self.assertTrue(os.path.exists(corrected_fifo4)) |
| 745 | self.assertFalse(is_fifo(corrected_fifo4)) |
| 746 | |
| 747 | corrected_symlink = os.path.join( |
| 748 | corrected_folder, |
| 749 | 'broken-link') |
| 750 | self.assertFalse(os.path.lexists(symlink)) |
| 751 | self.assertTrue(os.path.exists(corrected_symlink)) |
| 752 | self.assertFalse(os.path.islink(corrected_symlink)) |
Dan Shi | affb922 | 2015-04-15 17:05:47 -0700 | [diff] [blame] | 753 | shutil.rmtree(results_folder) |
| 754 | |
| 755 | |
Dan Shi | 1b4c7c3 | 2015-10-05 10:38:57 -0700 | [diff] [blame] | 756 | def check_limit_file_count(self, is_test_job=True): |
| 757 | """Test that folder with too many files can be compressed. |
| 758 | |
| 759 | @param is_test_job: True to check the method with test job result |
| 760 | folder. Set to False for special task folder. |
| 761 | """ |
| 762 | results_folder = tempfile.mkdtemp() |
| 763 | host_folder = os.path.join( |
| 764 | results_folder, |
| 765 | 'lab1-host1' if is_test_job else 'hosts/lab1-host1/1-repair') |
| 766 | debug_folder = os.path.join(host_folder, 'debug') |
| 767 | sysinfo_folder = os.path.join(host_folder, 'sysinfo') |
| 768 | for folder in [debug_folder, sysinfo_folder]: |
| 769 | os.makedirs(folder) |
| 770 | for i in range(10): |
| 771 | with open(os.path.join(folder, str(i)), 'w') as f: |
| 772 | f.write('test') |
| 773 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 774 | gs_offloader._MAX_FILE_COUNT = 100 |
Dan Shi | 1b4c7c3 | 2015-10-05 10:38:57 -0700 | [diff] [blame] | 775 | gs_offloader.limit_file_count( |
| 776 | results_folder if is_test_job else host_folder) |
| 777 | self.assertTrue(os.path.exists(sysinfo_folder)) |
| 778 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 779 | gs_offloader._MAX_FILE_COUNT = 10 |
Dan Shi | 1b4c7c3 | 2015-10-05 10:38:57 -0700 | [diff] [blame] | 780 | gs_offloader.limit_file_count( |
| 781 | results_folder if is_test_job else host_folder) |
| 782 | self.assertFalse(os.path.exists(sysinfo_folder)) |
| 783 | self.assertTrue(os.path.exists(sysinfo_folder + '.tgz')) |
| 784 | self.assertTrue(os.path.exists(debug_folder)) |
| 785 | |
| 786 | shutil.rmtree(results_folder) |
| 787 | |
| 788 | |
| 789 | def test_limit_file_count(self): |
| 790 | """Test that folder with too many files can be compressed. |
| 791 | """ |
| 792 | self.check_limit_file_count(is_test_job=True) |
| 793 | self.check_limit_file_count(is_test_job=False) |
| 794 | |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 795 | |
Ningning Xia | 8db632f | 2016-08-19 11:01:35 -0700 | [diff] [blame] | 796 | def test_is_valid_result(self): |
| 797 | """Test _is_valid_result.""" |
Ningning Xia | 21922c8 | 2016-07-29 11:03:15 -0700 | [diff] [blame] | 798 | release_build = 'veyron_minnie-cheets-release/R52-8248.0.0' |
| 799 | pfq_build = 'cyan-cheets-android-pfq/R54-8623.0.0-rc1' |
| 800 | trybot_build = 'trybot-samus-release/R54-8640.0.0-b5092' |
| 801 | trybot_2_build = 'trybot-samus-pfq/R54-8640.0.0-b5092' |
| 802 | release_2_build = 'test-trybot-release/R54-8640.0.0-b5092' |
Ningning Xia | 8db632f | 2016-08-19 11:01:35 -0700 | [diff] [blame] | 803 | self.assertTrue(gs_offloader._is_valid_result( |
| 804 | release_build, gs_offloader.CTS_RESULT_PATTERN, 'arc-cts')) |
Rohit Makasana | 6384c10 | 2016-10-21 17:09:47 -0700 | [diff] [blame] | 805 | self.assertTrue(gs_offloader._is_valid_result( |
| 806 | release_build, gs_offloader.CTS_RESULT_PATTERN, 'test_that_wrapper')) |
Rohit Makasana | 8d868c9 | 2018-06-08 11:29:50 -0700 | [diff] [blame] | 807 | self.assertTrue(gs_offloader._is_valid_result( |
Rohit Makasana | 54c78f7 | 2019-09-17 17:20:03 -0700 | [diff] [blame] | 808 | release_build, gs_offloader.CTS_RESULT_PATTERN, 'cros_test_platform')) |
| 809 | self.assertTrue(gs_offloader._is_valid_result( |
Richard Barnette | 33e1289 | 2017-05-26 09:25:34 -0700 | [diff] [blame] | 810 | release_build, gs_offloader.CTS_RESULT_PATTERN, 'bvt-arc')) |
Rohit Makasana | 8d868c9 | 2018-06-08 11:29:50 -0700 | [diff] [blame] | 811 | self.assertFalse(gs_offloader._is_valid_result( |
| 812 | release_build, gs_offloader.CTS_RESULT_PATTERN, 'bvt-cq')) |
Ningning Xia | 8db632f | 2016-08-19 11:01:35 -0700 | [diff] [blame] | 813 | self.assertTrue(gs_offloader._is_valid_result( |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 814 | release_build, gs_offloader.CTS_V2_RESULT_PATTERN, 'arc-gts')) |
Ningning Xia | 8db632f | 2016-08-19 11:01:35 -0700 | [diff] [blame] | 815 | self.assertFalse(gs_offloader._is_valid_result( |
| 816 | None, gs_offloader.CTS_RESULT_PATTERN, 'arc-cts')) |
| 817 | self.assertFalse(gs_offloader._is_valid_result( |
| 818 | release_build, gs_offloader.CTS_RESULT_PATTERN, None)) |
| 819 | self.assertFalse(gs_offloader._is_valid_result( |
| 820 | pfq_build, gs_offloader.CTS_RESULT_PATTERN, 'arc-cts')) |
| 821 | self.assertFalse(gs_offloader._is_valid_result( |
| 822 | trybot_build, gs_offloader.CTS_RESULT_PATTERN, 'arc-cts')) |
| 823 | self.assertFalse(gs_offloader._is_valid_result( |
| 824 | trybot_2_build, gs_offloader.CTS_RESULT_PATTERN, 'arc-cts')) |
| 825 | self.assertTrue(gs_offloader._is_valid_result( |
| 826 | release_2_build, gs_offloader.CTS_RESULT_PATTERN, 'arc-cts')) |
Ningning Xia | 21922c8 | 2016-07-29 11:03:15 -0700 | [diff] [blame] | 827 | |
| 828 | |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 829 | def create_results_folder(self): |
| 830 | """Create CTS/GTS results folders.""" |
Ningning Xia | 4211124 | 2016-06-15 14:35:58 -0700 | [diff] [blame] | 831 | results_folder = tempfile.mkdtemp() |
| 832 | host_folder = os.path.join(results_folder, 'chromeos4-row9-rack11-host22') |
| 833 | debug_folder = os.path.join(host_folder, 'debug') |
| 834 | sysinfo_folder = os.path.join(host_folder, 'sysinfo') |
| 835 | cts_result_folder = os.path.join( |
| 836 | host_folder, 'cheets_CTS.android.dpi', 'results', 'cts-results') |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 837 | cts_v2_result_folder = os.path.join(host_folder, |
| 838 | 'cheets_CTS_N.CtsGraphicsTestCases', 'results', 'android-cts') |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 839 | gts_result_folder = os.path.join( |
Ilja H. Friedel | bfa6314 | 2017-01-26 00:56:29 -0800 | [diff] [blame] | 840 | host_folder, 'cheets_GTS.google.admin', 'results', 'android-gts') |
Ningning Xia | 4211124 | 2016-06-15 14:35:58 -0700 | [diff] [blame] | 841 | timestamp_str = '2016.04.28_01.41.44' |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 842 | timestamp_cts_folder = os.path.join(cts_result_folder, timestamp_str) |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 843 | timestamp_cts_v2_folder = os.path.join(cts_v2_result_folder, timestamp_str) |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 844 | timestamp_gts_folder = os.path.join(gts_result_folder, timestamp_str) |
| 845 | |
Rohit Makasana | 2030dde | 2019-04-05 04:18:52 -0700 | [diff] [blame] | 846 | # Build host keyvals set to parse model info. |
| 847 | host_info_path = os.path.join(host_folder, 'host_keyvals') |
| 848 | dir_to_create = '/' |
| 849 | for tdir in host_info_path.split('/'): |
| 850 | dir_to_create = os.path.join(dir_to_create, tdir) |
| 851 | if not os.path.exists(dir_to_create): |
| 852 | os.mkdir(dir_to_create) |
| 853 | with open(os.path.join(host_info_path, 'chromeos4-row9-rack11-host22'), 'w') as store_file: |
| 854 | store_file.write('labels=board%3Acoral,hw_video_acc_vp9,cros,'+ |
| 855 | 'hw_jpeg_acc_dec,bluetooth,model%3Arobo360,'+ |
| 856 | 'accel%3Acros-ec,'+ |
| 857 | 'sku%3Arobo360_IntelR_CeleronR_CPU_N3450_1_10GHz_4Gb') |
| 858 | |
| 859 | # .autoserv_execute file is needed for the test results package to look |
| 860 | # legit. |
| 861 | autoserve_path = os.path.join(host_folder, '.autoserv_execute') |
| 862 | with open(autoserve_path, 'w') as temp_file: |
| 863 | temp_file.write(' ') |
| 864 | |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 865 | # Test results in cts_result_folder with a different time-stamp. |
| 866 | timestamp_str_2 = '2016.04.28_10.41.44' |
| 867 | timestamp_cts_folder_2 = os.path.join(cts_result_folder, timestamp_str_2) |
| 868 | |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 869 | for folder in [debug_folder, sysinfo_folder, cts_result_folder, |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 870 | timestamp_cts_folder, timestamp_cts_folder_2, |
| 871 | timestamp_cts_v2_folder, timestamp_gts_folder]: |
Ningning Xia | 4211124 | 2016-06-15 14:35:58 -0700 | [diff] [blame] | 872 | os.makedirs(folder) |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 873 | |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 874 | path_pattern_pair = [(timestamp_cts_folder, gs_offloader.CTS_RESULT_PATTERN), |
| 875 | (timestamp_cts_folder_2, gs_offloader.CTS_RESULT_PATTERN), |
Rohit Makasana | c1c7e78 | 2019-04-02 18:06:00 -0700 | [diff] [blame] | 876 | (timestamp_cts_folder_2, gs_offloader.CTS_COMPRESSED_RESULT_PATTERN), |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 877 | (timestamp_cts_v2_folder, gs_offloader.CTS_V2_RESULT_PATTERN), |
Rohit Makasana | c1c7e78 | 2019-04-02 18:06:00 -0700 | [diff] [blame] | 878 | (timestamp_cts_v2_folder, gs_offloader.CTS_V2_COMPRESSED_RESULT_PATTERN), |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 879 | (timestamp_gts_folder, gs_offloader.CTS_V2_RESULT_PATTERN)] |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 880 | |
| 881 | # Create timestamp.zip file_path. |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 882 | cts_zip_file = os.path.join(cts_result_folder, timestamp_str + '.zip') |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 883 | cts_zip_file_2 = os.path.join(cts_result_folder, timestamp_str_2 + '.zip') |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 884 | cts_v2_zip_file = os.path.join(cts_v2_result_folder, timestamp_str + '.zip') |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 885 | gts_zip_file = os.path.join(gts_result_folder, timestamp_str + '.zip') |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 886 | |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 887 | # Create xml file_path. |
| 888 | cts_result_file = os.path.join(timestamp_cts_folder, 'testResult.xml') |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 889 | cts_result_file_2 = os.path.join(timestamp_cts_folder_2, |
| 890 | 'testResult.xml') |
Rohit Makasana | c1c7e78 | 2019-04-02 18:06:00 -0700 | [diff] [blame] | 891 | cts_result_compressed_file_2 = os.path.join(timestamp_cts_folder_2, |
| 892 | 'testResult.xml.tgz') |
Ilja H. Friedel | bfa6314 | 2017-01-26 00:56:29 -0800 | [diff] [blame] | 893 | gts_result_file = os.path.join(timestamp_gts_folder, 'test_result.xml') |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 894 | cts_v2_result_file = os.path.join(timestamp_cts_v2_folder, |
| 895 | 'test_result.xml') |
Rohit Makasana | c1c7e78 | 2019-04-02 18:06:00 -0700 | [diff] [blame] | 896 | cts_v2_result_compressed_file = os.path.join(timestamp_cts_v2_folder, |
| 897 | 'test_result.xml.tgz') |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 898 | |
Ilja H. Friedel | 73cf6cd | 2017-03-01 12:23:00 -0800 | [diff] [blame] | 899 | for file_path in [cts_zip_file, cts_zip_file_2, cts_v2_zip_file, |
| 900 | gts_zip_file, cts_result_file, cts_result_file_2, |
Rohit Makasana | c1c7e78 | 2019-04-02 18:06:00 -0700 | [diff] [blame] | 901 | cts_result_compressed_file_2, gts_result_file, |
| 902 | cts_v2_result_file, cts_v2_result_compressed_file]: |
| 903 | if file_path.endswith('tgz'): |
| 904 | test_result_file = gs_offloader.CTS_COMPRESSED_RESULT_TYPES[ |
| 905 | os.path.basename(file_path)] |
| 906 | with open(test_result_file, 'w') as f: |
| 907 | f.write('test') |
| 908 | with tarfile.open(file_path, 'w:gz') as tar_file: |
| 909 | tar_file.add(test_result_file) |
| 910 | os.remove(test_result_file) |
| 911 | else: |
| 912 | with open(file_path, 'w') as f: |
| 913 | f.write('test') |
Ningning Xia | 4211124 | 2016-06-15 14:35:58 -0700 | [diff] [blame] | 914 | |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 915 | return (results_folder, host_folder, path_pattern_pair) |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 916 | |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 917 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 918 | def test__upload_cts_testresult(self): |
| 919 | """Test _upload_cts_testresult.""" |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 920 | results_folder, host_folder, path_pattern_pair = self.create_results_folder() |
| 921 | |
| 922 | self.mox.StubOutWithMock(gs_offloader, '_upload_files') |
| 923 | gs_offloader._upload_files( |
Rohit Makasana | ea337c5 | 2018-04-11 18:03:41 -0700 | [diff] [blame] | 924 | mox.IgnoreArg(), mox.IgnoreArg(), mox.IgnoreArg(), False, |
| 925 | mox.IgnoreArg(), mox.IgnoreArg()).AndReturn( |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 926 | ['test', '-d', host_folder]) |
| 927 | gs_offloader._upload_files( |
Rohit Makasana | ea337c5 | 2018-04-11 18:03:41 -0700 | [diff] [blame] | 928 | mox.IgnoreArg(), mox.IgnoreArg(), mox.IgnoreArg(), False, |
| 929 | mox.IgnoreArg(), mox.IgnoreArg()).AndReturn( |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 930 | ['test', '-d', host_folder]) |
| 931 | gs_offloader._upload_files( |
Rohit Makasana | ea337c5 | 2018-04-11 18:03:41 -0700 | [diff] [blame] | 932 | mox.IgnoreArg(), mox.IgnoreArg(), mox.IgnoreArg(), False, |
| 933 | mox.IgnoreArg(), mox.IgnoreArg()).AndReturn( |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 934 | ['test', '-d', host_folder]) |
Ningning Xia | 2d88eec | 2016-07-25 23:18:46 -0700 | [diff] [blame] | 935 | |
Ningning Xia | 4211124 | 2016-06-15 14:35:58 -0700 | [diff] [blame] | 936 | self.mox.ReplayAll() |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 937 | gs_offloader._upload_cts_testresult(results_folder, False) |
Ningning Xia | 4211124 | 2016-06-15 14:35:58 -0700 | [diff] [blame] | 938 | self.mox.VerifyAll() |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 939 | shutil.rmtree(results_folder) |
| 940 | |
| 941 | |
Keith Haddow | 295a54e | 2019-07-10 15:27:17 -0700 | [diff] [blame] | 942 | def test_parse_cts_job_results_file_path(self): |
| 943 | # A autotest path |
| 944 | path = ('/317739475-chromeos-test/chromeos4-row9-rack11-host22/' |
| 945 | 'cheets_CTS.android.dpi/results/cts-results/' |
| 946 | '2016.04.28_01.41.44') |
| 947 | job_id, package, timestamp = \ |
| 948 | gs_offloader._parse_cts_job_results_file_path(path) |
| 949 | self.assertEqual('317739475-chromeos-test', job_id) |
| 950 | self.assertEqual('cheets_CTS.android.dpi', package) |
| 951 | self.assertEqual('2016.04.28_01.41.44', timestamp) |
| 952 | |
| 953 | |
| 954 | # A skylab path |
Prathmesh Prabhu | 174640b | 2019-10-17 21:30:07 +0000 | [diff] [blame] | 955 | path = ('/swarming-458e3a3a7fc6f210/1/autoserv_test/' |
Keith Haddow | 295a54e | 2019-07-10 15:27:17 -0700 | [diff] [blame] | 956 | 'cheets_CTS.android.dpi/results/cts-results/' |
| 957 | '2016.04.28_01.41.44') |
| 958 | job_id, package, timestamp = \ |
| 959 | gs_offloader._parse_cts_job_results_file_path(path) |
Prathmesh Prabhu | 174640b | 2019-10-17 21:30:07 +0000 | [diff] [blame] | 960 | self.assertEqual('swarming-458e3a3a7fc6f210-1', job_id) |
Keith Haddow | 295a54e | 2019-07-10 15:27:17 -0700 | [diff] [blame] | 961 | self.assertEqual('cheets_CTS.android.dpi', package) |
| 962 | self.assertEqual('2016.04.28_01.41.44', timestamp) |
| 963 | |
| 964 | |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 965 | def test_upload_files(self): |
| 966 | """Test upload_files""" |
| 967 | results_folder, host_folder, path_pattern_pair = self.create_results_folder() |
| 968 | |
| 969 | for path, pattern in path_pattern_pair: |
| 970 | models.test.parse_job_keyval(mox.IgnoreArg()).AndReturn({ |
| 971 | 'build': 'veyron_minnie-cheets-release/R52-8248.0.0', |
Rohit Makasana | 2030dde | 2019-04-05 04:18:52 -0700 | [diff] [blame] | 972 | 'hostname': 'chromeos4-row9-rack11-host22', |
Ningning Xia | 8db632f | 2016-08-19 11:01:35 -0700 | [diff] [blame] | 973 | 'parent_job_id': 'p_id', |
| 974 | 'suite': 'arc-cts' |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 975 | }) |
| 976 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 977 | gs_offloader._get_cmd_list( |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 978 | False, mox.IgnoreArg(), mox.IgnoreArg()).AndReturn( |
| 979 | ['test', '-d', path]) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 980 | gs_offloader._get_cmd_list( |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 981 | False, mox.IgnoreArg(), mox.IgnoreArg()).AndReturn( |
| 982 | ['test', '-d', path]) |
| 983 | |
| 984 | self.mox.ReplayAll() |
Rohit Makasana | ea337c5 | 2018-04-11 18:03:41 -0700 | [diff] [blame] | 985 | gs_offloader._upload_files(host_folder, path, pattern, False, |
| 986 | 'gs://a-test-bucket/', |
| 987 | 'gs://a-test-apfe-bucket/') |
Ningning Xia | 0c27d9b | 2016-08-04 14:02:39 -0700 | [diff] [blame] | 988 | self.mox.VerifyAll() |
| 989 | self.mox.ResetAll() |
Ningning Xia | 4211124 | 2016-06-15 14:35:58 -0700 | [diff] [blame] | 990 | |
| 991 | shutil.rmtree(results_folder) |
Dan Shi | 1b4c7c3 | 2015-10-05 10:38:57 -0700 | [diff] [blame] | 992 | |
Michael Tang | 97d188c | 2016-06-25 11:18:42 -0700 | [diff] [blame] | 993 | |
Dan Shi | 02dd066 | 2017-05-23 11:24:32 -0700 | [diff] [blame] | 994 | def test_get_metrics_fields(self): |
| 995 | """Test method _get_metrics_fields.""" |
| 996 | results_folder, host_folder, _ = self.create_results_folder() |
| 997 | models.test.parse_job_keyval(mox.IgnoreArg()).AndReturn({ |
| 998 | 'build': 'veyron_minnie-cheets-release/R52-8248.0.0', |
| 999 | 'parent_job_id': 'p_id', |
| 1000 | 'suite': 'arc-cts' |
| 1001 | }) |
| 1002 | try: |
| 1003 | self.mox.ReplayAll() |
| 1004 | self.assertEqual({'board': 'veyron_minnie-cheets', |
| 1005 | 'milestone': 'R52'}, |
| 1006 | gs_offloader._get_metrics_fields(host_folder)) |
| 1007 | self.mox.VerifyAll() |
| 1008 | finally: |
| 1009 | shutil.rmtree(results_folder) |
| 1010 | |
| 1011 | |
Xinan Lin | 9eb782f | 2019-10-23 23:14:49 -0700 | [diff] [blame] | 1012 | class OffladerConfigTests(_TempResultsDirTestBase): |
| 1013 | """Tests for the `Offloader` to follow side_effect config.""" |
| 1014 | |
| 1015 | def setUp(self): |
| 1016 | super(OffladerConfigTests, self).setUp() |
| 1017 | gs_offloader.GS_OFFLOADING_ENABLED = True |
| 1018 | gs_offloader.GS_OFFLOADER_MULTIPROCESSING = True |
| 1019 | self.dest_path = '/results' |
| 1020 | self.mox.StubOutWithMock(gs_offloader, '_get_metrics_fields') |
| 1021 | self.mox.StubOutWithMock(gs_offloader, '_OffloadError') |
| 1022 | self.mox.StubOutWithMock(gs_offloader, '_upload_cts_testresult') |
| 1023 | self.mox.StubOutWithMock(gs_offloader, '_emit_offload_metrics') |
| 1024 | self.mox.StubOutWithMock(gs_offloader, '_get_cmd_list') |
| 1025 | self.mox.StubOutWithMock(subprocess, 'Popen') |
| 1026 | self.mox.StubOutWithMock(gs_offloader, '_emit_gs_returncode_metric') |
| 1027 | |
| 1028 | |
| 1029 | def _run(self, results_dir, gs_bucket, expect_dest, cts_enabled): |
| 1030 | stdout = os.path.join(results_dir, 'std.log') |
| 1031 | stderr = os.path.join(results_dir, 'std.err') |
| 1032 | config = { |
| 1033 | 'tko': { |
| 1034 | 'proxy_socket': '/file-system/foo-socket', |
| 1035 | 'mysql_user': 'foo-user', |
| 1036 | 'mysql_password_file': '/file-system/foo-password-file' |
| 1037 | }, |
| 1038 | 'google_storage': { |
| 1039 | 'bucket': gs_bucket, |
| 1040 | 'credentials_file': '/foo-creds' |
| 1041 | }, |
| 1042 | 'cts': { |
| 1043 | 'enabled': cts_enabled, |
| 1044 | }, |
| 1045 | 'this_field_is_ignored': True |
| 1046 | } |
| 1047 | path = os.path.join(results_dir, 'side_effects_config.json') |
| 1048 | with open(path, 'w') as f: |
| 1049 | f.write(json.dumps(config)) |
| 1050 | gs_offloader._get_metrics_fields(results_dir) |
| 1051 | if cts_enabled: |
| 1052 | gs_offloader._upload_cts_testresult(results_dir, True) |
| 1053 | gs_offloader._get_cmd_list( |
| 1054 | True, |
| 1055 | mox.IgnoreArg(), |
| 1056 | expect_dest).AndReturn(['test', '-d', expect_dest]) |
| 1057 | subprocess.Popen(mox.IgnoreArg(), |
| 1058 | stdout=stdout, |
| 1059 | stderr=stderr).AndReturn(_get_fake_process()) |
| 1060 | gs_offloader._OffloadError(mox.IgnoreArg()) |
| 1061 | gs_offloader._emit_gs_returncode_metric(mox.IgnoreArg()).AndReturn(True) |
| 1062 | gs_offloader._emit_offload_metrics(mox.IgnoreArg()).AndReturn(True) |
| 1063 | sub_offloader = gs_offloader.GSOffloader(results_dir, True, 0, None) |
Aviv Keshet | acef00e | 2019-11-13 16:35:29 -0800 | [diff] [blame] | 1064 | subprocess.Popen(mox.IgnoreArg(), |
| 1065 | stdout=stdout, |
| 1066 | stderr=stderr).AndReturn(_get_fake_process()) |
Xinan Lin | 9eb782f | 2019-10-23 23:14:49 -0700 | [diff] [blame] | 1067 | self.mox.ReplayAll() |
| 1068 | sub_offloader._try_offload(results_dir, self.dest_path, stdout, stderr) |
| 1069 | self.mox.VerifyAll() |
| 1070 | self.mox.ResetAll() |
| 1071 | shutil.rmtree(results_dir) |
| 1072 | |
| 1073 | |
| 1074 | def test_upload_files_to_dev(self): |
| 1075 | """Test upload results to dev gs bucket and skip cts uploading.""" |
| 1076 | res = tempfile.mkdtemp() |
| 1077 | gs_bucket = 'dev-bucket' |
| 1078 | expect_dest = 'gs://' + gs_bucket + self.dest_path |
| 1079 | self._run(res, gs_bucket, expect_dest, False) |
| 1080 | |
| 1081 | |
| 1082 | def test_upload_files_prod(self): |
| 1083 | """Test upload results to the prod gs bucket and also upload to cts.""" |
| 1084 | res = tempfile.mkdtemp() |
| 1085 | gs_bucket = 'prod-bucket' |
| 1086 | expect_dest = 'gs://' + gs_bucket + self.dest_path |
| 1087 | self._run(res, gs_bucket, expect_dest, True) |
| 1088 | |
| 1089 | |
| 1090 | def test_skip_gs_prefix(self): |
| 1091 | """Test skip the 'gs://' prefix if already presented.""" |
| 1092 | res = tempfile.mkdtemp() |
| 1093 | gs_bucket = 'gs://prod-bucket' |
| 1094 | expect_dest = gs_bucket + self.dest_path |
| 1095 | self._run(res, gs_bucket, expect_dest, True) |
| 1096 | |
| 1097 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1098 | class JobDirectoryOffloadTests(_TempResultsDirTestBase): |
| 1099 | """Tests for `_JobDirectory.enqueue_offload()`. |
| 1100 | |
| 1101 | When testing with a `days_old` parameter of 0, we use |
| 1102 | `set_finished()` instead of `set_expired()`. This causes the |
| 1103 | job's timestamp to be set in the future. This is done so as |
| 1104 | to test that when `days_old` is 0, the job is always treated |
| 1105 | as eligible for offload, regardless of the timestamp's value. |
| 1106 | |
| 1107 | Testing covers the following assertions: |
| 1108 | A. Each time `enqueue_offload()` is called, a message that |
| 1109 | includes the job's directory name will be logged using |
| 1110 | `logging.debug()`, regardless of whether the job was |
| 1111 | enqueued. Nothing else is allowed to be logged. |
| 1112 | B. If the job is not eligible to be offloaded, |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1113 | `first_offload_start` and `offload_count` are 0. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1114 | C. If the job is not eligible for offload, nothing is |
| 1115 | enqueued in `queue`. |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1116 | D. When the job is offloaded, `offload_count` increments |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1117 | each time. |
| 1118 | E. When the job is offloaded, the appropriate parameters are |
| 1119 | enqueued exactly once. |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1120 | F. The first time a job is offloaded, `first_offload_start` is |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1121 | set to the current time. |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1122 | G. `first_offload_start` only changes the first time that the |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1123 | job is offloaded. |
| 1124 | |
| 1125 | The test cases below are designed to exercise all of the |
| 1126 | meaningful state transitions at least once. |
| 1127 | |
| 1128 | """ |
| 1129 | |
| 1130 | def setUp(self): |
| 1131 | super(JobDirectoryOffloadTests, self).setUp() |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1132 | self._job = self.make_job(self.REGULAR_JOBLIST[0]) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1133 | self._queue = Queue.Queue() |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1134 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1135 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1136 | def _offload_unexpired_job(self, days_old): |
| 1137 | """Make calls to `enqueue_offload()` for an unexpired job. |
| 1138 | |
| 1139 | This method tests assertions B and C that calling |
| 1140 | `enqueue_offload()` has no effect. |
| 1141 | |
| 1142 | """ |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1143 | self.assertEqual(self._job.offload_count, 0) |
| 1144 | self.assertEqual(self._job.first_offload_start, 0) |
| 1145 | gs_offloader._enqueue_offload(self._job, self._queue, days_old) |
| 1146 | gs_offloader._enqueue_offload(self._job, self._queue, days_old) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1147 | self.assertTrue(self._queue.empty()) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1148 | self.assertEqual(self._job.offload_count, 0) |
| 1149 | self.assertEqual(self._job.first_offload_start, 0) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1150 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1151 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1152 | def _offload_expired_once(self, days_old, count): |
| 1153 | """Make one call to `enqueue_offload()` for an expired job. |
| 1154 | |
| 1155 | This method tests assertions D and E regarding side-effects |
| 1156 | expected when a job is offloaded. |
| 1157 | |
| 1158 | """ |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1159 | gs_offloader._enqueue_offload(self._job, self._queue, days_old) |
| 1160 | self.assertEqual(self._job.offload_count, count) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1161 | self.assertFalse(self._queue.empty()) |
| 1162 | v = self._queue.get_nowait() |
| 1163 | self.assertTrue(self._queue.empty()) |
J. Richard Barnette | 2c72ddd | 2014-05-20 12:17:37 -0700 | [diff] [blame] | 1164 | self.assertEqual(v, self._job.queue_args) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1165 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1166 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1167 | def _offload_expired_job(self, days_old): |
| 1168 | """Make calls to `enqueue_offload()` for a just-expired job. |
| 1169 | |
| 1170 | This method directly tests assertions F and G regarding |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1171 | side-effects on `first_offload_start`. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1172 | |
| 1173 | """ |
| 1174 | t0 = time.time() |
| 1175 | self._offload_expired_once(days_old, 1) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1176 | t1 = self._job.first_offload_start |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1177 | self.assertLessEqual(t1, time.time()) |
| 1178 | self.assertGreaterEqual(t1, t0) |
| 1179 | self._offload_expired_once(days_old, 2) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1180 | self.assertEqual(self._job.first_offload_start, t1) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1181 | self._offload_expired_once(days_old, 3) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1182 | self.assertEqual(self._job.first_offload_start, t1) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1183 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1184 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1185 | def test_case_1_no_expiration(self): |
| 1186 | """Test a series of `enqueue_offload()` calls with `days_old` of 0. |
| 1187 | |
| 1188 | This tests that offload works as expected if calls are |
| 1189 | made both before and after the job becomes expired. |
| 1190 | |
| 1191 | """ |
| 1192 | self._offload_unexpired_job(0) |
| 1193 | self._job.set_finished(0) |
| 1194 | self._offload_expired_job(0) |
| 1195 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1196 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1197 | def test_case_2_no_expiration(self): |
| 1198 | """Test a series of `enqueue_offload()` calls with `days_old` of 0. |
| 1199 | |
| 1200 | This tests that offload works as expected if calls are made |
| 1201 | only after the job becomes expired. |
| 1202 | |
| 1203 | """ |
| 1204 | self._job.set_finished(0) |
| 1205 | self._offload_expired_job(0) |
| 1206 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1207 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1208 | def test_case_1_with_expiration(self): |
| 1209 | """Test a series of `enqueue_offload()` calls with `days_old` non-zero. |
| 1210 | |
| 1211 | This tests that offload works as expected if calls are made |
| 1212 | before the job finishes, before the job expires, and after |
| 1213 | the job expires. |
| 1214 | |
| 1215 | """ |
| 1216 | self._offload_unexpired_job(_TEST_EXPIRATION_AGE) |
| 1217 | self._job.set_finished(_TEST_EXPIRATION_AGE) |
| 1218 | self._offload_unexpired_job(_TEST_EXPIRATION_AGE) |
| 1219 | self._job.set_expired(_TEST_EXPIRATION_AGE) |
| 1220 | self._offload_expired_job(_TEST_EXPIRATION_AGE) |
| 1221 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1222 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1223 | def test_case_2_with_expiration(self): |
| 1224 | """Test a series of `enqueue_offload()` calls with `days_old` non-zero. |
| 1225 | |
| 1226 | This tests that offload works as expected if calls are made |
| 1227 | between finishing and expiration, and after the job expires. |
| 1228 | |
| 1229 | """ |
| 1230 | self._job.set_finished(_TEST_EXPIRATION_AGE) |
| 1231 | self._offload_unexpired_job(_TEST_EXPIRATION_AGE) |
| 1232 | self._job.set_expired(_TEST_EXPIRATION_AGE) |
| 1233 | self._offload_expired_job(_TEST_EXPIRATION_AGE) |
| 1234 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1235 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1236 | def test_case_3_with_expiration(self): |
| 1237 | """Test a series of `enqueue_offload()` calls with `days_old` non-zero. |
| 1238 | |
| 1239 | This tests that offload works as expected if calls are made |
| 1240 | only before finishing and after expiration. |
| 1241 | |
| 1242 | """ |
| 1243 | self._offload_unexpired_job(_TEST_EXPIRATION_AGE) |
| 1244 | self._job.set_expired(_TEST_EXPIRATION_AGE) |
| 1245 | self._offload_expired_job(_TEST_EXPIRATION_AGE) |
| 1246 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1247 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1248 | def test_case_4_with_expiration(self): |
| 1249 | """Test a series of `enqueue_offload()` calls with `days_old` non-zero. |
| 1250 | |
| 1251 | This tests that offload works as expected if calls are made |
| 1252 | only after expiration. |
| 1253 | |
| 1254 | """ |
| 1255 | self._job.set_expired(_TEST_EXPIRATION_AGE) |
| 1256 | self._offload_expired_job(_TEST_EXPIRATION_AGE) |
| 1257 | |
| 1258 | |
| 1259 | class GetJobDirectoriesTests(_TempResultsDirTestBase): |
| 1260 | """Tests for `_JobDirectory.get_job_directories()`.""" |
| 1261 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1262 | def setUp(self): |
| 1263 | super(GetJobDirectoriesTests, self).setUp() |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1264 | self.make_job_hierarchy() |
| 1265 | os.mkdir('not-a-job') |
| 1266 | open('not-a-dir', 'w').close() |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1267 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1268 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1269 | def _run_get_directories(self, cls, expected_list): |
| 1270 | """Test `get_job_directories()` for the given class. |
| 1271 | |
| 1272 | Calls the method, and asserts that the returned list of |
| 1273 | directories matches the expected return value. |
| 1274 | |
| 1275 | @param expected_list Expected return value from the call. |
| 1276 | """ |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1277 | dirlist = cls.get_job_directories() |
| 1278 | self.assertEqual(set(dirlist), set(expected_list)) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1279 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1280 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1281 | def test_get_regular_jobs(self): |
| 1282 | """Test `RegularJobDirectory.get_job_directories()`.""" |
| 1283 | self._run_get_directories(job_directories.RegularJobDirectory, |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1284 | self.REGULAR_JOBLIST) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1285 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1286 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1287 | def test_get_special_jobs(self): |
| 1288 | """Test `SpecialJobDirectory.get_job_directories()`.""" |
| 1289 | self._run_get_directories(job_directories.SpecialJobDirectory, |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1290 | self.SPECIAL_JOBLIST) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1291 | |
| 1292 | |
| 1293 | class AddJobsTests(_TempResultsDirTestBase): |
| 1294 | """Tests for `Offloader._add_new_jobs()`.""" |
| 1295 | |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1296 | MOREJOBS = ['115-fubar', '116-fubar', '117-fubar', '118-snafu'] |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1297 | |
| 1298 | def setUp(self): |
| 1299 | super(AddJobsTests, self).setUp() |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1300 | self._initial_job_names = ( |
| 1301 | set(self.REGULAR_JOBLIST) | set(self.SPECIAL_JOBLIST)) |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1302 | self.make_job_hierarchy() |
| 1303 | self._offloader = gs_offloader.Offloader(_get_options(['-a'])) |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1304 | self.mox.StubOutWithMock(logging, 'debug') |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1305 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1306 | |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1307 | def _run_add_new_jobs(self, expected_key_set): |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1308 | """Basic test assertions for `_add_new_jobs()`. |
| 1309 | |
| 1310 | Asserts the following: |
| 1311 | * The keys in the offloader's `_open_jobs` dictionary |
| 1312 | matches the expected set of keys. |
| 1313 | * For every job in `_open_jobs`, the job has the expected |
| 1314 | directory name. |
| 1315 | |
| 1316 | """ |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1317 | count = len(expected_key_set) - len(self._offloader._open_jobs) |
| 1318 | logging.debug(mox.IgnoreArg(), count) |
| 1319 | self.mox.ReplayAll() |
| 1320 | self._offloader._add_new_jobs() |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1321 | self.assertEqual(expected_key_set, |
| 1322 | set(self._offloader._open_jobs.keys())) |
| 1323 | for jobkey, job in self._offloader._open_jobs.items(): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1324 | self.assertEqual(jobkey, job.dirname) |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1325 | self.mox.VerifyAll() |
| 1326 | self.mox.ResetAll() |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1327 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1328 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1329 | def test_add_jobs_empty(self): |
| 1330 | """Test adding jobs to an empty dictionary. |
| 1331 | |
| 1332 | Calls the offloader's `_add_new_jobs()`, then perform |
| 1333 | the assertions of `self._check_open_jobs()`. |
| 1334 | |
| 1335 | """ |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1336 | self._run_add_new_jobs(self._initial_job_names) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1337 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1338 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1339 | def test_add_jobs_non_empty(self): |
| 1340 | """Test adding jobs to a non-empty dictionary. |
| 1341 | |
| 1342 | Calls the offloader's `_add_new_jobs()` twice; once from |
| 1343 | initial conditions, and then again after adding more |
| 1344 | directories. After the second call, perform the assertions |
| 1345 | of `self._check_open_jobs()`. Additionally, assert that |
| 1346 | keys added by the first call still map to their original |
| 1347 | job object after the second call. |
| 1348 | |
| 1349 | """ |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1350 | self._run_add_new_jobs(self._initial_job_names) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1351 | jobs_copy = self._offloader._open_jobs.copy() |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1352 | for d in self.MOREJOBS: |
| 1353 | os.mkdir(d) |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1354 | self._run_add_new_jobs(self._initial_job_names | |
| 1355 | set(self.MOREJOBS)) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1356 | for key in jobs_copy.keys(): |
| 1357 | self.assertIs(jobs_copy[key], |
| 1358 | self._offloader._open_jobs[key]) |
| 1359 | |
| 1360 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1361 | class ReportingTests(_TempResultsDirTestBase): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1362 | """Tests for `Offloader._report_failed_jobs()`.""" |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1363 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1364 | def setUp(self): |
| 1365 | super(ReportingTests, self).setUp() |
| 1366 | self._offloader = gs_offloader.Offloader(_get_options([])) |
Prathmesh Prabhu | 16f9e5c | 2017-01-30 17:54:40 -0800 | [diff] [blame] | 1367 | self.mox.StubOutWithMock(self._offloader, '_log_failed_jobs_locally') |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1368 | self.mox.StubOutWithMock(logging, 'debug') |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1369 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1370 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1371 | def _add_job(self, jobdir): |
| 1372 | """Add a job to the dictionary of unfinished jobs.""" |
| 1373 | j = self.make_job(jobdir) |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1374 | self._offloader._open_jobs[j.dirname] = j |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1375 | return j |
| 1376 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1377 | |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1378 | def _expect_log_message(self, new_open_jobs, with_failures): |
| 1379 | """Mock expected logging calls. |
| 1380 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1381 | `_report_failed_jobs()` logs one message with the number |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1382 | of jobs removed from the open job set and the number of jobs |
| 1383 | still remaining. Additionally, if there are reportable |
| 1384 | jobs, then it logs the number of jobs that haven't yet |
| 1385 | offloaded. |
| 1386 | |
| 1387 | This sets up the logging calls using `new_open_jobs` to |
| 1388 | figure the job counts. If `with_failures` is true, then |
| 1389 | the log message is set up assuming that all jobs in |
| 1390 | `new_open_jobs` have offload failures. |
| 1391 | |
| 1392 | @param new_open_jobs New job set for calculating counts |
| 1393 | in the messages. |
| 1394 | @param with_failures Whether the log message with a |
| 1395 | failure count is expected. |
| 1396 | |
| 1397 | """ |
| 1398 | count = len(self._offloader._open_jobs) - len(new_open_jobs) |
| 1399 | logging.debug(mox.IgnoreArg(), count, len(new_open_jobs)) |
| 1400 | if with_failures: |
| 1401 | logging.debug(mox.IgnoreArg(), len(new_open_jobs)) |
| 1402 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1403 | |
Prathmesh Prabhu | 33e3e1a | 2017-01-30 18:03:34 -0800 | [diff] [blame] | 1404 | def _run_update(self, new_open_jobs): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1405 | """Call `_report_failed_jobs()`. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1406 | |
| 1407 | Initial conditions are set up by the caller. This calls |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1408 | `_report_failed_jobs()` once, and then checks these |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1409 | assertions: |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1410 | * The offloader's new `_open_jobs` field contains only |
| 1411 | the entries in `new_open_jobs`. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1412 | |
| 1413 | @param new_open_jobs A dictionary representing the expected |
| 1414 | new value of the offloader's |
| 1415 | `_open_jobs` field. |
| 1416 | """ |
| 1417 | self.mox.ReplayAll() |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1418 | self._offloader._report_failed_jobs() |
| 1419 | self._offloader._remove_offloaded_jobs() |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1420 | self.assertEqual(self._offloader._open_jobs, new_open_jobs) |
| 1421 | self.mox.VerifyAll() |
| 1422 | self.mox.ResetAll() |
| 1423 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1424 | |
Prathmesh Prabhu | 16f9e5c | 2017-01-30 17:54:40 -0800 | [diff] [blame] | 1425 | def _expect_failed_jobs(self, failed_jobs): |
| 1426 | """Mock expected call to log the failed jobs on local disk. |
| 1427 | |
| 1428 | TODO(crbug.com/686904): The fact that we have to mock an internal |
| 1429 | function for this test is evidence that we need to pull out the local |
| 1430 | file formatter in its own object in a future CL. |
| 1431 | |
| 1432 | @param failed_jobs: The list of jobs being logged as failed. |
| 1433 | """ |
| 1434 | self._offloader._log_failed_jobs_locally(failed_jobs) |
| 1435 | |
| 1436 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1437 | def test_no_jobs(self): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1438 | """Test `_report_failed_jobs()` with no open jobs. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1439 | |
Prathmesh Prabhu | 33e3e1a | 2017-01-30 18:03:34 -0800 | [diff] [blame] | 1440 | Initial conditions are an empty `_open_jobs` list. |
| 1441 | Expected result is an empty `_open_jobs` list. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1442 | |
| 1443 | """ |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1444 | self._expect_log_message({}, False) |
Prathmesh Prabhu | 16f9e5c | 2017-01-30 17:54:40 -0800 | [diff] [blame] | 1445 | self._expect_failed_jobs([]) |
Prathmesh Prabhu | 33e3e1a | 2017-01-30 18:03:34 -0800 | [diff] [blame] | 1446 | self._run_update({}) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1447 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1448 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1449 | def test_all_completed(self): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1450 | """Test `_report_failed_jobs()` with only complete jobs. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1451 | |
Prathmesh Prabhu | 33e3e1a | 2017-01-30 18:03:34 -0800 | [diff] [blame] | 1452 | Initial conditions are an `_open_jobs` list consisting of only completed |
| 1453 | jobs. |
| 1454 | Expected result is an empty `_open_jobs` list. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1455 | |
| 1456 | """ |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1457 | for d in self.REGULAR_JOBLIST: |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1458 | self._add_job(d).set_complete() |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1459 | self._expect_log_message({}, False) |
Prathmesh Prabhu | 16f9e5c | 2017-01-30 17:54:40 -0800 | [diff] [blame] | 1460 | self._expect_failed_jobs([]) |
Prathmesh Prabhu | 33e3e1a | 2017-01-30 18:03:34 -0800 | [diff] [blame] | 1461 | self._run_update({}) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1462 | |
Jakob Juelich | 24f22c2 | 2014-09-26 11:46:11 -0700 | [diff] [blame] | 1463 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1464 | def test_none_finished(self): |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1465 | """Test `_report_failed_jobs()` with only unfinished jobs. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1466 | |
Prathmesh Prabhu | 33e3e1a | 2017-01-30 18:03:34 -0800 | [diff] [blame] | 1467 | Initial conditions are an `_open_jobs` list consisting of only |
| 1468 | unfinished jobs. |
| 1469 | Expected result is no change to the `_open_jobs` list. |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1470 | |
| 1471 | """ |
J. Richard Barnette | 0880032 | 2014-05-16 14:49:46 -0700 | [diff] [blame] | 1472 | for d in self.REGULAR_JOBLIST: |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1473 | self._add_job(d) |
J. Richard Barnette | 22dd748 | 2014-06-23 12:25:02 -0700 | [diff] [blame] | 1474 | new_jobs = self._offloader._open_jobs.copy() |
| 1475 | self._expect_log_message(new_jobs, False) |
Prathmesh Prabhu | 16f9e5c | 2017-01-30 17:54:40 -0800 | [diff] [blame] | 1476 | self._expect_failed_jobs([]) |
Prathmesh Prabhu | 33e3e1a | 2017-01-30 18:03:34 -0800 | [diff] [blame] | 1477 | self._run_update(new_jobs) |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1478 | |
| 1479 | |
Allen Li | b41527d | 2017-06-22 17:28:00 -0700 | [diff] [blame] | 1480 | class GsOffloaderMockTests(_TempResultsDirTestCase): |
| 1481 | """Tests using mock instead of mox.""" |
| 1482 | |
| 1483 | def setUp(self): |
| 1484 | super(GsOffloaderMockTests, self).setUp() |
| 1485 | alarm = mock.patch('signal.alarm', return_value=0) |
| 1486 | alarm.start() |
| 1487 | self.addCleanup(alarm.stop) |
| 1488 | |
| 1489 | self._saved_loglevel = logging.getLogger().getEffectiveLevel() |
| 1490 | logging.getLogger().setLevel(logging.CRITICAL + 1) |
| 1491 | |
| 1492 | self._job = self.make_job(self.REGULAR_JOBLIST[0]) |
| 1493 | |
| 1494 | |
| 1495 | def test_offload_timeout_early(self): |
| 1496 | """Test that `offload_dir()` times out correctly. |
| 1497 | |
| 1498 | This test triggers timeout at the earliest possible moment, |
| 1499 | at the first call to set the timeout alarm. |
| 1500 | |
| 1501 | """ |
| 1502 | signal.alarm.side_effect = [0, timeout_util.TimeoutError('fubar')] |
| 1503 | with mock.patch.object(gs_offloader, '_upload_cts_testresult', |
| 1504 | autospec=True) as upload: |
| 1505 | upload.return_value = None |
| 1506 | gs_offloader.GSOffloader( |
| 1507 | utils.DEFAULT_OFFLOAD_GSURI, False, 0).offload( |
| 1508 | self._job.queue_args[0], |
| 1509 | self._job.queue_args[1], |
| 1510 | self._job.queue_args[2]) |
| 1511 | self.assertTrue(os.path.isdir(self._job.queue_args[0])) |
| 1512 | |
| 1513 | |
| 1514 | # TODO(ayatane): This tests passes when run locally, but it fails |
| 1515 | # when run on trybot. I have no idea why, but the assert isdir |
| 1516 | # fails. |
| 1517 | # |
| 1518 | # This test is also kind of redundant since we are using the timeout |
| 1519 | # from chromite which has its own tests. |
| 1520 | @unittest.skip('This fails on trybot') |
| 1521 | def test_offload_timeout_late(self): |
| 1522 | """Test that `offload_dir()` times out correctly. |
| 1523 | |
| 1524 | This test triggers timeout at the latest possible moment, at |
| 1525 | the call to clear the timeout alarm. |
| 1526 | |
| 1527 | """ |
| 1528 | signal.alarm.side_effect = [0, 0, timeout_util.TimeoutError('fubar')] |
| 1529 | with mock.patch.object(gs_offloader, '_upload_cts_testresult', |
| 1530 | autospec=True) as upload, \ |
| 1531 | mock.patch.object(gs_offloader, '_get_cmd_list', |
| 1532 | autospec=True) as get_cmd_list: |
| 1533 | upload.return_value = None |
| 1534 | get_cmd_list.return_value = ['test', '-d', self._job.queue_args[0]] |
| 1535 | gs_offloader.GSOffloader( |
| 1536 | utils.DEFAULT_OFFLOAD_GSURI, False, 0).offload( |
| 1537 | self._job.queue_args[0], |
| 1538 | self._job.queue_args[1], |
| 1539 | self._job.queue_args[2]) |
| 1540 | self.assertTrue(os.path.isdir(self._job.queue_args[0])) |
| 1541 | |
| 1542 | |
| 1543 | |
J. Richard Barnette | ea78536 | 2014-03-17 16:00:53 -0700 | [diff] [blame] | 1544 | if __name__ == '__main__': |
| 1545 | unittest.main() |