blob: 947fef1201024903bbfae3646c5a8d245da5789f [file] [log] [blame]
Mike Frysingere58c0e22017-10-04 15:43:30 -04001# -*- coding: utf-8 -*-
Don Garrettc4114cc2016-11-01 20:04:06 -07002# Copyright 2016 The Chromium OS Authors. All rights reserved.
3# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -07006"""Unit tests for chromite.scripts.cbuildbot_launch."""
Don Garrettc4114cc2016-11-01 20:04:06 -07007
8from __future__ import print_function
9
Don Garrett86881cb2017-02-15 15:41:55 -080010import mock
Don Garrett7ade05a2017-02-17 13:31:47 -080011import os
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -070012import time
Don Garrett86881cb2017-02-15 15:41:55 -080013
14from chromite.cbuildbot import repository
Benjamin Gordon90b2dd92018-04-12 14:04:21 -060015from chromite.lib import build_summary
Don Garrett861e9182017-05-15 15:30:23 -070016from chromite.lib import constants
Don Garrett597ddff2017-02-17 18:29:37 -080017from chromite.lib import cros_build_lib
Benjamin Gordon74645232018-05-04 17:40:42 -060018from chromite.lib import cros_sdk_lib
Don Garrett7ade05a2017-02-17 13:31:47 -080019from chromite.lib import cros_test_lib
Don Garrett86881cb2017-02-15 15:41:55 -080020from chromite.lib import osutils
Don Garrett0c54ed72017-03-03 11:18:57 -080021from chromite.scripts import cbuildbot_launch
Don Garrett86881cb2017-02-15 15:41:55 -080022
Don Garrett86881cb2017-02-15 15:41:55 -080023EXPECTED_MANIFEST_URL = 'https://chrome-internal-review.googlesource.com/chromeos/manifest-internal' # pylint: disable=line-too-long
Don Garrettc4114cc2016-11-01 20:04:06 -070024
25
Don Garrettacbb2392017-05-11 18:27:41 -070026# It's reasonable for unittests to look at internals.
27# pylint: disable=protected-access
28
29
Don Garrett8d314792017-05-18 13:11:42 -070030class FakeException(Exception):
31 """Test exception to raise during tests."""
32
33
Don Garrett0c54ed72017-03-03 11:18:57 -080034class CbuildbotLaunchTest(cros_test_lib.MockTestCase):
35 """Tests for cbuildbot_launch script."""
Don Garrettc4114cc2016-11-01 20:04:06 -070036
Don Garrett86881cb2017-02-15 15:41:55 -080037 def testPreParseArguments(self):
Don Garrettc4114cc2016-11-01 20:04:06 -070038 """Test that we can correctly extract branch values from cbuildbot args."""
Don Garrett597ddff2017-02-17 18:29:37 -080039 CASES = (
40 (['--buildroot', '/buildroot', 'daisy-incremental'],
41 (None, '/buildroot', None)),
42
43 (['--buildbot', '--buildroot', '/buildroot',
44 '--git-cache-dir', '/git-cache',
45 '-b', 'release-R57-9202.B',
46 'daisy-incremental'],
47 ('release-R57-9202.B', '/buildroot', '/git-cache')),
48
49 (['--debug', '--buildbot', '--notests',
50 '--buildroot', '/buildroot',
51 '--git-cache-dir', '/git-cache',
52 '--branch', 'release-R57-9202.B',
53 'daisy-incremental'],
54 ('release-R57-9202.B', '/buildroot', '/git-cache')),
Don Garrettc4114cc2016-11-01 20:04:06 -070055 )
56
Don Garrett597ddff2017-02-17 18:29:37 -080057 for cmd_args, expected in CASES:
58 expected_branch, expected_buildroot, expected_cache_dir = expected
59
Don Garrett0c54ed72017-03-03 11:18:57 -080060 options = cbuildbot_launch.PreParseArguments(cmd_args)
Don Garrett597ddff2017-02-17 18:29:37 -080061
62 self.assertEqual(options.branch, expected_branch)
63 self.assertEqual(options.buildroot, expected_buildroot)
64 self.assertEqual(options.git_cache_dir, expected_cache_dir)
Don Garrett86881cb2017-02-15 15:41:55 -080065
Don Garrettf324bc32017-05-23 14:00:53 -070066 def testInitialCheckout(self):
Don Garrett86881cb2017-02-15 15:41:55 -080067 """Test InitialCheckout with minimum settings."""
Don Garrettf324bc32017-05-23 14:00:53 -070068 mock_repo = mock.MagicMock()
69 mock_repo.branch = 'branch'
Don Garrett86881cb2017-02-15 15:41:55 -080070
Don Garrettf324bc32017-05-23 14:00:53 -070071 cbuildbot_launch.InitialCheckout(mock_repo)
Don Garrett86881cb2017-02-15 15:41:55 -080072
73 self.assertEqual(mock_repo.mock_calls, [
Don Garrettf324bc32017-05-23 14:00:53 -070074 mock.call.Sync(detach=True),
Don Garrett8d314792017-05-18 13:11:42 -070075 ])
76
Don Garrettf15d65b2017-04-12 12:39:55 -070077 def testConfigureGlobalEnvironment(self):
Don Garrett60967922017-04-12 18:51:44 -070078 """Ensure that we can setup our global runtime environment correctly."""
Don Garrett86fec482017-05-17 18:13:33 -070079
80 os.environ.pop('LANG', None)
81 os.environ['LC_MONETARY'] = 'bad'
82
Don Garrettf15d65b2017-04-12 12:39:55 -070083 cbuildbot_launch.ConfigureGlobalEnvironment()
84
Don Garrett86fec482017-05-17 18:13:33 -070085 # Verify umask is updated.
Don Garrettf15d65b2017-04-12 12:39:55 -070086 self.assertEqual(os.umask(0), 0o22)
87
Don Garrett86fec482017-05-17 18:13:33 -070088 # Verify ENVs are cleaned up.
89 self.assertEqual(os.environ['LANG'], 'en_US.UTF-8')
90 self.assertNotIn('LC_MONETARY', os.environ)
91
Don Garrettf15d65b2017-04-12 12:39:55 -070092
Benjamin Gordon121a2aa2018-05-04 16:24:45 -060093class RunTests(cros_test_lib.RunCommandTestCase):
Don Garrett0c54ed72017-03-03 11:18:57 -080094 """Tests for cbuildbot_launch script."""
Don Garrett597ddff2017-02-17 18:29:37 -080095
96 ARGS_BASE = ['--buildroot', '/buildroot']
Don Garrett5cd946b2017-07-20 13:42:20 -070097 EXPECTED_ARGS_BASE = ['--buildroot', '/cbuildbot_buildroot']
Don Garrett597ddff2017-02-17 18:29:37 -080098 ARGS_GIT_CACHE = ['--git-cache-dir', '/git-cache']
99 ARGS_CONFIG = ['config']
Don Garrettbf90cdf2017-05-19 15:54:02 -0700100 CMD = ['/cbuildbot_buildroot/chromite/bin/cbuildbot']
Don Garrett597ddff2017-02-17 18:29:37 -0800101
Don Garrett6e5c6b92018-04-06 17:58:49 -0700102 def verifyCbuildbot(self, args, expected_cmd, version):
Don Garrett86881cb2017-02-15 15:41:55 -0800103 """Ensure we invoke cbuildbot correctly."""
Don Garrett597ddff2017-02-17 18:29:37 -0800104 self.PatchObject(
105 cros_build_lib, 'GetTargetChromiteApiVersion', autospec=True,
106 return_value=version)
107
Don Garrett6e5c6b92018-04-06 17:58:49 -0700108 cbuildbot_launch.Cbuildbot('/cbuildbot_buildroot', '/depot_tools', args)
Don Garrett597ddff2017-02-17 18:29:37 -0800109
110 self.assertCommandCalled(
Don Garretta50bf492017-09-28 18:33:02 -0700111 expected_cmd, extra_env={'PATH': mock.ANY},
112 cwd='/cbuildbot_buildroot', error_code_ok=True)
Don Garrett597ddff2017-02-17 18:29:37 -0800113
Don Garrett6e5c6b92018-04-06 17:58:49 -0700114 def testCbuildbotSimple(self):
Don Garrett597ddff2017-02-17 18:29:37 -0800115 """Ensure we invoke cbuildbot correctly."""
Don Garrett6e5c6b92018-04-06 17:58:49 -0700116 self.verifyCbuildbot(
Don Garrett597ddff2017-02-17 18:29:37 -0800117 self.ARGS_BASE + self.ARGS_CONFIG,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700118 self.CMD + self.ARGS_CONFIG + self.EXPECTED_ARGS_BASE,
Don Garrett597ddff2017-02-17 18:29:37 -0800119 (0, 4))
120
Don Garrett6e5c6b92018-04-06 17:58:49 -0700121 def testCbuildbotNotFiltered(self):
Don Garrett597ddff2017-02-17 18:29:37 -0800122 """Ensure we invoke cbuildbot correctly."""
Don Garrett6e5c6b92018-04-06 17:58:49 -0700123 self.verifyCbuildbot(
Don Garrett597ddff2017-02-17 18:29:37 -0800124 self.ARGS_BASE + self.ARGS_CONFIG + self.ARGS_GIT_CACHE,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700125 (self.CMD + self.ARGS_CONFIG + self.EXPECTED_ARGS_BASE +
126 self.ARGS_GIT_CACHE),
Don Garrett597ddff2017-02-17 18:29:37 -0800127 (0, 4))
128
Don Garrett6e5c6b92018-04-06 17:58:49 -0700129 def testCbuildbotFiltered(self):
Don Garrett597ddff2017-02-17 18:29:37 -0800130 """Ensure we invoke cbuildbot correctly."""
Don Garrett6e5c6b92018-04-06 17:58:49 -0700131 self.verifyCbuildbot(
Don Garrett597ddff2017-02-17 18:29:37 -0800132 self.ARGS_BASE + self.ARGS_CONFIG + self.ARGS_GIT_CACHE,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700133 self.CMD + self.ARGS_CONFIG + self.EXPECTED_ARGS_BASE,
Don Garrett597ddff2017-02-17 18:29:37 -0800134 (0, 2))
Don Garrettc4114cc2016-11-01 20:04:06 -0700135
Don Garrett86881cb2017-02-15 15:41:55 -0800136 def testMainMin(self):
137 """Test a minimal set of command line options."""
Don Garrett597ddff2017-02-17 18:29:37 -0800138 self.PatchObject(osutils, 'SafeMakedirs', autospec=True)
139 self.PatchObject(cros_build_lib, 'GetTargetChromiteApiVersion',
Don Garrett861e9182017-05-15 15:30:23 -0700140 autospec=True, return_value=(constants.REEXEC_API_MAJOR,
141 constants.REEXEC_API_MINOR))
Don Garrettf324bc32017-05-23 14:00:53 -0700142 mock_repo = mock.MagicMock()
143 mock_repo.branch = 'master'
Don Garrettbf90cdf2017-05-19 15:54:02 -0700144 mock_repo.directory = '/root/repository'
145
Don Garrettf324bc32017-05-23 14:00:53 -0700146 mock_repo_create = self.PatchObject(repository, 'RepoRepository',
147 autospec=True, return_value=mock_repo)
Don Garrettbf90cdf2017-05-19 15:54:02 -0700148 mock_clean = self.PatchObject(cbuildbot_launch, 'CleanBuildRoot',
Don Garrett0c54ed72017-03-03 11:18:57 -0800149 autospec=True)
150 mock_checkout = self.PatchObject(cbuildbot_launch, 'InitialCheckout',
Don Garrett86881cb2017-02-15 15:41:55 -0800151 autospec=True)
Benjamin Gordonaee36b82018-02-05 14:25:26 -0700152 mock_cleanup_chroot = self.PatchObject(cbuildbot_launch, 'CleanupChroot',
153 autospec=True)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600154 mock_set_last_build_state = self.PatchObject(
155 cbuildbot_launch, 'SetLastBuildState', autospec=True)
156
157 expected_build_state = build_summary.BuildSummary(
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600158 build_number=0, master_build_id=0, status=mock.ANY,
159 buildroot_layout=2, branch='master')
Don Garrett7ade05a2017-02-17 13:31:47 -0800160
Don Garrettbf90cdf2017-05-19 15:54:02 -0700161 cbuildbot_launch._main(['-r', '/root', 'config'])
Don Garrettc4114cc2016-11-01 20:04:06 -0700162
Don Garrettf324bc32017-05-23 14:00:53 -0700163 # Did we create the repo instance correctly?
164 self.assertEqual(mock_repo_create.mock_calls,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700165 [mock.call(EXPECTED_MANIFEST_URL, '/root/repository',
Don Garrett33872502018-08-03 22:30:40 +0000166 git_cache_dir=None, branch='master')])
Don Garrettf324bc32017-05-23 14:00:53 -0700167
Don Garrett7ade05a2017-02-17 13:31:47 -0800168 # Ensure we clean, as expected.
Don Garrettbf90cdf2017-05-19 15:54:02 -0700169 self.assertEqual(mock_clean.mock_calls, [
Don Garrettd1d90dd2017-06-13 17:35:52 -0700170 mock.call('/root', mock_repo,
171 {
172 'branch_name': 'master',
173 'tryjob': False,
174 'build_config': 'config',
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600175 },
176 expected_build_state)])
Don Garrett7ade05a2017-02-17 13:31:47 -0800177
Don Garrett86881cb2017-02-15 15:41:55 -0800178 # Ensure we checkout, as expected.
179 self.assertEqual(mock_checkout.mock_calls,
Don Garrettf324bc32017-05-23 14:00:53 -0700180 [mock.call(mock_repo)])
Don Garrettc4114cc2016-11-01 20:04:06 -0700181
Don Garrett86881cb2017-02-15 15:41:55 -0800182 # Ensure we invoke cbuildbot, as expected.
183 self.assertCommandCalled(
Don Garrett5cd946b2017-07-20 13:42:20 -0700184 [
185 '/root/repository/chromite/bin/cbuildbot',
186 'config',
187 '-r', '/root/repository',
Don Garrettb497f552018-07-09 16:01:13 -0700188 '--workspace', '/root/workspace',
Don Garrett5cd946b2017-07-20 13:42:20 -0700189 '--ts-mon-task-num', '1',
190 ],
Don Garretta50bf492017-09-28 18:33:02 -0700191 extra_env={'PATH': mock.ANY},
Don Garrettbf90cdf2017-05-19 15:54:02 -0700192 cwd='/root/repository',
Don Garrettacbb2392017-05-11 18:27:41 -0700193 error_code_ok=True)
Don Garrettc4114cc2016-11-01 20:04:06 -0700194
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600195 # Ensure we saved the final state, as expected.
196 self.assertEqual(expected_build_state.status,
197 constants.BUILDER_STATUS_PASSED)
198 self.assertEqual(mock_set_last_build_state.mock_calls, [
199 mock.call('/root', expected_build_state)])
200
Benjamin Gordonaee36b82018-02-05 14:25:26 -0700201 # Ensure we clean the chroot, as expected.
202 self.assertEqual(mock_cleanup_chroot.mock_calls, [
203 mock.call('/root/repository')])
204
Don Garrett86881cb2017-02-15 15:41:55 -0800205 def testMainMax(self):
Don Garrett597ddff2017-02-17 18:29:37 -0800206 """Test a larger set of command line options."""
207 self.PatchObject(osutils, 'SafeMakedirs', autospec=True)
208 self.PatchObject(cros_build_lib, 'GetTargetChromiteApiVersion',
Don Garrett861e9182017-05-15 15:30:23 -0700209 autospec=True, return_value=(constants.REEXEC_API_MAJOR,
210 constants.REEXEC_API_MINOR))
Don Garrettf324bc32017-05-23 14:00:53 -0700211 mock_repo = mock.MagicMock()
212 mock_repo.branch = 'branch'
Don Garrettbf90cdf2017-05-19 15:54:02 -0700213 mock_repo.directory = '/root/repository'
214
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600215 mock_summary = build_summary.BuildSummary(
216 build_number=313,
217 master_build_id=123123123,
218 status=constants.BUILDER_STATUS_FAILED,
219 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
220 branch='branch')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600221
222 mock_get_last_build_state = self.PatchObject(
223 cbuildbot_launch, 'GetLastBuildState', autospec=True,
224 return_value=mock_summary)
Don Garrettf324bc32017-05-23 14:00:53 -0700225 mock_repo_create = self.PatchObject(repository, 'RepoRepository',
226 autospec=True, return_value=mock_repo)
Don Garrettbf90cdf2017-05-19 15:54:02 -0700227 mock_clean = self.PatchObject(cbuildbot_launch, 'CleanBuildRoot',
Don Garrett0c54ed72017-03-03 11:18:57 -0800228 autospec=True)
229 mock_checkout = self.PatchObject(cbuildbot_launch, 'InitialCheckout',
Don Garrett86881cb2017-02-15 15:41:55 -0800230 autospec=True)
Benjamin Gordonaee36b82018-02-05 14:25:26 -0700231 mock_cleanup_chroot = self.PatchObject(cbuildbot_launch, 'CleanupChroot',
232 autospec=True)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600233 mock_set_last_build_state = self.PatchObject(
234 cbuildbot_launch, 'SetLastBuildState', autospec=True)
Don Garrettc4114cc2016-11-01 20:04:06 -0700235
Don Garrettbf90cdf2017-05-19 15:54:02 -0700236 cbuildbot_launch._main(['--buildroot', '/root',
Don Garrettacbb2392017-05-11 18:27:41 -0700237 '--branch', 'branch',
238 '--git-cache-dir', '/git-cache',
Don Garrettd1d90dd2017-06-13 17:35:52 -0700239 '--remote-trybot',
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600240 '--master-build-id', '123456789',
241 '--buildnumber', '314',
Don Garrettacbb2392017-05-11 18:27:41 -0700242 'config'])
Don Garrettc4114cc2016-11-01 20:04:06 -0700243
Don Garrettf324bc32017-05-23 14:00:53 -0700244 # Did we create the repo instance correctly?
245 self.assertEqual(mock_repo_create.mock_calls,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700246 [mock.call(EXPECTED_MANIFEST_URL, '/root/repository',
Don Garrett33872502018-08-03 22:30:40 +0000247 git_cache_dir='/git-cache', branch='branch')])
Don Garrettf324bc32017-05-23 14:00:53 -0700248
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600249 # Ensure we look up the previous status.
250 self.assertEqual(mock_get_last_build_state.mock_calls, [
251 mock.call('/root')])
252
Don Garrett7ade05a2017-02-17 13:31:47 -0800253 # Ensure we clean, as expected.
Don Garrettbf90cdf2017-05-19 15:54:02 -0700254 self.assertEqual(mock_clean.mock_calls, [
Don Garrettd1d90dd2017-06-13 17:35:52 -0700255 mock.call('/root',
256 mock_repo,
257 {
258 'branch_name': 'branch',
259 'tryjob': True,
260 'build_config': 'config',
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600261 },
262 build_summary.BuildSummary(
263 build_number=314,
264 master_build_id=123456789,
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600265 status=mock.ANY,
266 branch='branch',
267 buildroot_layout=2
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600268 ))])
Don Garrett7ade05a2017-02-17 13:31:47 -0800269
Don Garrett86881cb2017-02-15 15:41:55 -0800270 # Ensure we checkout, as expected.
271 self.assertEqual(mock_checkout.mock_calls,
Don Garrettf324bc32017-05-23 14:00:53 -0700272 [mock.call(mock_repo)])
Don Garrett86881cb2017-02-15 15:41:55 -0800273
274 # Ensure we invoke cbuildbot, as expected.
275 self.assertCommandCalled(
Don Garrett5cd946b2017-07-20 13:42:20 -0700276 [
277 '/root/repository/chromite/bin/cbuildbot',
278 'config',
279 '--buildroot', '/root/repository',
280 '--branch', 'branch',
281 '--git-cache-dir', '/git-cache',
282 '--remote-trybot',
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600283 '--master-build-id', '123456789',
284 '--buildnumber', '314',
285 '--previous-build-state',
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600286 'eyJzdGF0dXMiOiAiZmFpbCIsICJtYXN0ZXJfYnVpbGRfaWQiOiAxMjMxMjMxMj'
287 'MsICJidWlsZF9udW1iZXIiOiAzMTMsICJidWlsZHJvb3RfbGF5b3V0IjogMiwg'
288 'ImJyYW5jaCI6ICJicmFuY2gifQ==',
Don Garrettb497f552018-07-09 16:01:13 -0700289 '--workspace', '/root/workspace',
Don Garrett5cd946b2017-07-20 13:42:20 -0700290 '--ts-mon-task-num', '1',
291 ],
Don Garretta50bf492017-09-28 18:33:02 -0700292 extra_env={'PATH': mock.ANY},
Don Garrettbf90cdf2017-05-19 15:54:02 -0700293 cwd='/root/repository',
Don Garrettacbb2392017-05-11 18:27:41 -0700294 error_code_ok=True)
Don Garrett7ade05a2017-02-17 13:31:47 -0800295
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600296 # Ensure we write the final build state, as expected.
297 final_state = build_summary.BuildSummary(
298 build_number=314,
299 master_build_id=123456789,
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600300 status=constants.BUILDER_STATUS_PASSED,
301 buildroot_layout=2,
302 branch='branch')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600303 self.assertEqual(mock_set_last_build_state.mock_calls, [
304 mock.call('/root', final_state)])
305
Benjamin Gordonaee36b82018-02-05 14:25:26 -0700306 # Ensure we clean the chroot, as expected.
307 self.assertEqual(mock_cleanup_chroot.mock_calls, [
308 mock.call('/root/repository')])
309
Don Garrett7ade05a2017-02-17 13:31:47 -0800310
Don Garrettbf90cdf2017-05-19 15:54:02 -0700311class CleanBuildRootTest(cros_test_lib.MockTempDirTestCase):
312 """Tests for CleanBuildRoot method."""
Don Garrett7ade05a2017-02-17 13:31:47 -0800313
314 def setUp(self):
315 """Create standard buildroot contents for cleanup."""
Don Garrettbf90cdf2017-05-19 15:54:02 -0700316 self.root = os.path.join(self.tempdir)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600317 self.previous_build_state = os.path.join(
318 self.root, '.cbuildbot_build_state.json')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700319 self.buildroot = os.path.join(self.root, 'buildroot')
320 self.repo = os.path.join(self.buildroot, '.repo/repo')
Don Garrett36650112018-06-28 15:54:34 -0700321 self.chroot = os.path.join(self.buildroot, 'chroot')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700322 self.general = os.path.join(self.buildroot, 'general/general')
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700323 self.cache = os.path.join(self.buildroot, '.cache')
324 self.distfiles = os.path.join(self.cache, 'distfiles')
Don Garrett7ade05a2017-02-17 13:31:47 -0800325
Don Garrettf324bc32017-05-23 14:00:53 -0700326 self.mock_repo = mock.MagicMock()
Don Garrettbf90cdf2017-05-19 15:54:02 -0700327 self.mock_repo.directory = self.buildroot
Don Garrettf324bc32017-05-23 14:00:53 -0700328
Don Garrettacbb2392017-05-11 18:27:41 -0700329 self.metrics = {}
330
Benjamin Gordon8642bcc2018-05-01 13:49:56 -0600331 def populateBuildroot(self, previous_build_state=None):
Don Garrett7ade05a2017-02-17 13:31:47 -0800332 """Create standard buildroot contents for cleanup."""
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600333 if previous_build_state:
334 osutils.SafeMakedirs(self.root)
335 osutils.WriteFile(self.previous_build_state, previous_build_state)
336
Don Garrett7ade05a2017-02-17 13:31:47 -0800337 # Create files.
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700338 for f in (self.repo, self.chroot, self.general, self.distfiles):
Don Garrette17e1d92017-04-12 15:28:19 -0700339 osutils.Touch(f, makedirs=True)
Don Garrett7ade05a2017-02-17 13:31:47 -0800340
Don Garrette17e1d92017-04-12 15:28:19 -0700341 def testNoBuildroot(self):
Don Garrettbf90cdf2017-05-19 15:54:02 -0700342 """Test CleanBuildRoot with no history."""
Don Garrettf324bc32017-05-23 14:00:53 -0700343 self.mock_repo.branch = 'master'
344
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600345 build_state = build_summary.BuildSummary(
346 status=constants.BUILDER_STATUS_INFLIGHT,
347 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
348 branch='master')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700349 cbuildbot_launch.CleanBuildRoot(
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600350 self.root, self.mock_repo, self.metrics, build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800351
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600352 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600353 self.assertEqual(new_summary.buildroot_layout, 2)
354 self.assertEqual(new_summary.branch, 'master')
355 self.assertIsNotNone(new_summary.distfiles_ts)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600356 self.assertEqual(new_summary, build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800357
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600358 self.assertExists(self.previous_build_state)
359
Don Garrett7ade05a2017-02-17 13:31:47 -0800360 def testBuildrootNoState(self):
Don Garrettbf90cdf2017-05-19 15:54:02 -0700361 """Test CleanBuildRoot with no state information."""
Don Garrett7ade05a2017-02-17 13:31:47 -0800362 self.populateBuildroot()
Don Garrettf324bc32017-05-23 14:00:53 -0700363 self.mock_repo.branch = 'master'
Don Garrett7ade05a2017-02-17 13:31:47 -0800364
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600365 build_state = build_summary.BuildSummary(
366 status=constants.BUILDER_STATUS_INFLIGHT,
367 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
368 branch='master')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700369 cbuildbot_launch.CleanBuildRoot(
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600370 self.root, self.mock_repo, self.metrics, build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800371
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600372 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600373 self.assertEqual(new_summary.buildroot_layout, 2)
374 self.assertEqual(new_summary.branch, 'master')
375 self.assertIsNotNone(new_summary.distfiles_ts)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600376 self.assertEqual(new_summary, build_state)
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700377
Don Garrett60967922017-04-12 18:51:44 -0700378 self.assertNotExists(self.repo)
Don Garrett7ade05a2017-02-17 13:31:47 -0800379 self.assertNotExists(self.chroot)
Don Garrett60967922017-04-12 18:51:44 -0700380 self.assertNotExists(self.general)
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700381 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600382 self.assertExists(self.previous_build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800383
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600384 def testBuildrootFormatMismatch(self):
385 """Test CleanBuildRoot with buildroot layout mismatch."""
386 old_build_state = build_summary.BuildSummary(
387 status=constants.BUILDER_STATUS_PASSED,
388 buildroot_layout=1,
389 branch='master')
390 self.populateBuildroot(previous_build_state=old_build_state.to_json())
391 self.mock_repo.branch = 'master'
392
393 build_state = build_summary.BuildSummary(
394 status=constants.BUILDER_STATUS_INFLIGHT,
395 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
396 branch='master')
397 cbuildbot_launch.CleanBuildRoot(
398 self.root, self.mock_repo, self.metrics, build_state)
399
400 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
401 self.assertEqual(new_summary.buildroot_layout, 2)
402 self.assertEqual(new_summary.branch, 'master')
403 self.assertIsNotNone(new_summary.distfiles_ts)
404 self.assertEqual(new_summary, build_state)
405
406 self.assertNotExists(self.repo)
407 self.assertNotExists(self.chroot)
408 self.assertNotExists(self.general)
409 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600410 self.assertExists(self.previous_build_state)
411
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600412 def testBuildrootBranchChange(self):
413 """Test CleanBuildRoot with a change in branches."""
414 old_build_state = build_summary.BuildSummary(
415 status=constants.BUILDER_STATUS_PASSED,
416 buildroot_layout=2,
417 branch='branchA')
418 self.populateBuildroot(previous_build_state=old_build_state.to_json())
419 self.mock_repo.branch = 'branchB'
Benjamin Gordon74645232018-05-04 17:40:42 -0600420 m = self.PatchObject(cros_sdk_lib, 'CleanupChrootMount')
Don Garrett7ade05a2017-02-17 13:31:47 -0800421
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600422 build_state = build_summary.BuildSummary(
423 status=constants.BUILDER_STATUS_INFLIGHT,
424 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
425 branch='branchB')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700426 cbuildbot_launch.CleanBuildRoot(
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600427 self.root, self.mock_repo, self.metrics, build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800428
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600429 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600430 self.assertEqual(new_summary.buildroot_layout, 2)
431 self.assertEqual(new_summary.branch, 'branchB')
432 self.assertIsNotNone(new_summary.distfiles_ts)
433 self.assertEqual(new_summary, build_state)
434
435 self.assertExists(self.repo)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600436 self.assertExists(self.general)
437 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600438 self.assertExists(self.previous_build_state)
Don Garrett36650112018-06-28 15:54:34 -0700439 m.assert_called_with(self.chroot, delete=True)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600440
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600441 def testBuildrootBranchMatch(self):
442 """Test CleanBuildRoot with no change in branch."""
443 old_build_state = build_summary.BuildSummary(
444 status=constants.BUILDER_STATUS_PASSED,
445 buildroot_layout=2,
446 branch='branchA')
447 self.populateBuildroot(previous_build_state=old_build_state.to_json())
448 self.mock_repo.branch = 'branchA'
449
450 build_state = build_summary.BuildSummary(
451 status=constants.BUILDER_STATUS_INFLIGHT,
452 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
453 branch='branchA')
454 cbuildbot_launch.CleanBuildRoot(
455 self.root, self.mock_repo, self.metrics, build_state)
456
457 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
458 self.assertEqual(new_summary.buildroot_layout, 2)
459 self.assertEqual(new_summary.branch, 'branchA')
460 self.assertIsNotNone(new_summary.distfiles_ts)
461 self.assertEqual(new_summary, build_state)
462
463 self.assertExists(self.repo)
464 self.assertExists(self.chroot)
465 self.assertExists(self.general)
466 self.assertExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600467 self.assertExists(self.previous_build_state)
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700468
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600469 def testBuildrootDistfilesRecentCache(self):
470 """Test CleanBuildRoot does not delete distfiles when cache is recent."""
471 seed_distfiles_ts = time.time() - 60
472 old_build_state = build_summary.BuildSummary(
473 status=constants.BUILDER_STATUS_PASSED,
474 buildroot_layout=2,
475 branch='branchA',
476 distfiles_ts=seed_distfiles_ts)
477 self.populateBuildroot(previous_build_state=old_build_state.to_json())
478 self.mock_repo.branch = 'branchA'
479
480 build_state = build_summary.BuildSummary(
481 status=constants.BUILDER_STATUS_INFLIGHT,
482 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
483 branch='branchA')
484 cbuildbot_launch.CleanBuildRoot(
485 self.root, self.mock_repo, self.metrics, build_state)
486
487 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
488 self.assertEqual(new_summary.buildroot_layout, 2)
489 self.assertEqual(new_summary.branch, 'branchA')
490 # Same cache creation timestamp is rewritten to state.
491 self.assertEqual(new_summary.distfiles_ts, seed_distfiles_ts)
492 self.assertEqual(new_summary, build_state)
493
494 self.assertExists(self.repo)
495 self.assertExists(self.chroot)
496 self.assertExists(self.general)
497 self.assertExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600498 self.assertExists(self.previous_build_state)
Don Garrette17e1d92017-04-12 15:28:19 -0700499
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600500 def testBuildrootDistfilesCacheExpired(self):
501 """Test CleanBuildRoot when the distfiles cache is too old."""
502 old_build_state = build_summary.BuildSummary(
503 status=constants.BUILDER_STATUS_PASSED,
504 buildroot_layout=2,
505 branch='branchA',
506 distfiles_ts=100.0)
507 self.populateBuildroot(previous_build_state=old_build_state.to_json())
508 self.mock_repo.branch = 'branchA'
509
510 build_state = build_summary.BuildSummary(
511 status=constants.BUILDER_STATUS_INFLIGHT,
512 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
513 branch='branchA')
514 cbuildbot_launch.CleanBuildRoot(
515 self.root, self.mock_repo, self.metrics, build_state)
516
517 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
518 self.assertEqual(new_summary.buildroot_layout, 2)
519 self.assertEqual(new_summary.branch, 'branchA')
520 self.assertIsNotNone(new_summary.distfiles_ts)
521 self.assertEqual(new_summary, build_state)
522
523 self.assertExists(self.repo)
524 self.assertExists(self.chroot)
525 self.assertExists(self.general)
526 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600527 self.assertExists(self.previous_build_state)
528
529 def testBuildrootRepoCleanFailure(self):
530 """Test CleanBuildRoot with repo checkout failure."""
531 old_build_state = build_summary.BuildSummary(
532 status=constants.BUILDER_STATUS_PASSED,
533 buildroot_layout=1,
534 branch='branchA')
535 self.populateBuildroot(previous_build_state=old_build_state.to_json())
536 self.mock_repo.branch = 'branchA'
537 self.mock_repo.BuildRootGitCleanup.side_effect = Exception
538
539 build_state = build_summary.BuildSummary(
540 status=constants.BUILDER_STATUS_INFLIGHT,
541 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
542 branch='branchA')
543 cbuildbot_launch.CleanBuildRoot(
544 self.root, self.mock_repo, self.metrics, build_state)
545
546 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
547 self.assertEqual(new_summary.buildroot_layout, 2)
548 self.assertEqual(new_summary.branch, 'branchA')
549 self.assertIsNotNone(new_summary.distfiles_ts)
550 self.assertEqual(new_summary, build_state)
551
552 self.assertNotExists(self.repo)
553 self.assertNotExists(self.chroot)
554 self.assertNotExists(self.general)
555 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600556 self.assertExists(self.previous_build_state)
Don Garrettf324bc32017-05-23 14:00:53 -0700557
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600558 def testGetCurrentBuildStateNoArgs(self):
559 """Tests GetCurrentBuildState without arguments."""
560 options = cbuildbot_launch.PreParseArguments([
561 '--buildroot', self.root, 'config'
562 ])
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600563 state = cbuildbot_launch.GetCurrentBuildState(options, 'master')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600564
565 expected_state = build_summary.BuildSummary(
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600566 status=constants.BUILDER_STATUS_INFLIGHT,
567 buildroot_layout=2,
568 branch='master')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600569 self.assertEqual(state, expected_state)
570
571 def testGetCurrentBuildStateHasArgs(self):
572 """Tests GetCurrentBuildState with arguments."""
573 options = cbuildbot_launch.PreParseArguments([
574 '--buildroot', self.root,
575 '--buildnumber', '20',
576 '--master-build-id', '50',
577 'config'
578 ])
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600579 state = cbuildbot_launch.GetCurrentBuildState(options, 'branchA')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600580
581 expected_state = build_summary.BuildSummary(
582 build_number=20,
583 master_build_id=50,
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600584 status=constants.BUILDER_STATUS_INFLIGHT,
585 buildroot_layout=2,
586 branch='branchA')
587 self.assertEqual(state, expected_state)
588
589 def testGetCurrentBuildStateLayout(self):
590 """Test that GetCurrentBuildState uses the current buildroot layout."""
591 # Change to a future version.
592 self.PatchObject(cbuildbot_launch, 'BUILDROOT_BUILDROOT_LAYOUT', 22)
593
594 options = cbuildbot_launch.PreParseArguments([
595 '--buildroot', self.root, 'config'
596 ])
597 state = cbuildbot_launch.GetCurrentBuildState(options, 'branchA')
598
599 expected_state = build_summary.BuildSummary(
600 status=constants.BUILDER_STATUS_INFLIGHT,
601 buildroot_layout=22,
602 branch='branchA')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600603 self.assertEqual(state, expected_state)
604
605 def testGetLastBuildStateNoFile(self):
606 """Tests GetLastBuildState if the file is missing."""
607 osutils.SafeMakedirs(self.root)
608 state = cbuildbot_launch.GetLastBuildState(self.root)
609 self.assertEqual(state, build_summary.BuildSummary())
610
611 def testGetLastBuildStateBadFile(self):
612 """Tests GetLastBuildState if the file contains invalid JSON."""
613 osutils.SafeMakedirs(self.root)
614 osutils.WriteFile(self.previous_build_state, '}}')
615 state = cbuildbot_launch.GetLastBuildState(self.root)
616 self.assertEqual(state, build_summary.BuildSummary())
617
618 def testGetLastBuildStateMissingBuildStatus(self):
619 """Tests GetLastBuildState if the file doesn't have a valid status."""
620 osutils.SafeMakedirs(self.root)
621 osutils.WriteFile(self.previous_build_state, '{"build_number": "3"}')
622 state = cbuildbot_launch.GetLastBuildState(self.root)
623 self.assertEqual(state, build_summary.BuildSummary())
624
625 def testGetLastBuildStateGoodFile(self):
626 """Tests GetLastBuildState on a good file."""
627 osutils.SafeMakedirs(self.root)
628 osutils.WriteFile(
629 self.previous_build_state,
630 '{"build_number": 1, "master_build_id": 3, "status": "pass"}')
631 state = cbuildbot_launch.GetLastBuildState(self.root)
632 self.assertEqual(
633 state,
634 build_summary.BuildSummary(
635 build_number=1, master_build_id=3, status='pass'))
636
637 def testSetLastBuildState(self):
638 """Verifies that SetLastBuildState writes to the expected file."""
639 osutils.SafeMakedirs(self.root)
640 old_state = build_summary.BuildSummary(
641 build_number=314,
642 master_build_id=2178,
643 status=constants.BUILDER_STATUS_PASSED)
644 cbuildbot_launch.SetLastBuildState(self.root, old_state)
645
646 saved_state = osutils.ReadFile(self.previous_build_state)
647 new_state = build_summary.BuildSummary()
648 new_state.from_json(saved_state)
649
650 self.assertEqual(old_state, new_state)