blob: 6aef65d71d4c8d81568b5084c8df024af9a9bea1 [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
Don Garrettc4114cc2016-11-01 20:04:06 -070018from chromite.lib import cros_build_lib_unittest
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
Don Garrett066e6f52017-09-28 19:14:01 -070093class RunDepotToolsEnsureBootstrap(cros_build_lib_unittest.RunCommandTestCase,
94 cros_test_lib.TempDirTestCase):
95 """Test the helper function DepotToolsEnsureBootstrap."""
96
97 def testEnsureBootstrap(self):
98 """Verify that the script is run if present."""
99 script = os.path.join(self.tempdir, 'ensure_bootstrap')
100 osutils.Touch(script, makedirs=True)
101
102 cbuildbot_launch.DepotToolsEnsureBootstrap(self.tempdir)
103 self.assertCommandCalled(
104 [script], extra_env={'PATH': mock.ANY}, cwd=self.tempdir)
105
106 def testEnsureBootstrapMissing(self):
107 """Verify that the script is NOT run if not present."""
108 cbuildbot_launch.DepotToolsEnsureBootstrap(self.tempdir)
109 self.assertEqual(self.rc.call_count, 0)
110
111
Don Garrett597ddff2017-02-17 18:29:37 -0800112class RunTests(cros_build_lib_unittest.RunCommandTestCase):
Don Garrett0c54ed72017-03-03 11:18:57 -0800113 """Tests for cbuildbot_launch script."""
Don Garrett597ddff2017-02-17 18:29:37 -0800114
115 ARGS_BASE = ['--buildroot', '/buildroot']
Don Garrett5cd946b2017-07-20 13:42:20 -0700116 EXPECTED_ARGS_BASE = ['--buildroot', '/cbuildbot_buildroot']
Don Garrett597ddff2017-02-17 18:29:37 -0800117 ARGS_GIT_CACHE = ['--git-cache-dir', '/git-cache']
118 ARGS_CONFIG = ['config']
Don Garrettbf90cdf2017-05-19 15:54:02 -0700119 CMD = ['/cbuildbot_buildroot/chromite/bin/cbuildbot']
Don Garrett597ddff2017-02-17 18:29:37 -0800120
Don Garrett6e5c6b92018-04-06 17:58:49 -0700121 def verifyCbuildbot(self, args, expected_cmd, version):
Don Garrett86881cb2017-02-15 15:41:55 -0800122 """Ensure we invoke cbuildbot correctly."""
Don Garrett597ddff2017-02-17 18:29:37 -0800123 self.PatchObject(
124 cros_build_lib, 'GetTargetChromiteApiVersion', autospec=True,
125 return_value=version)
126
Don Garrett6e5c6b92018-04-06 17:58:49 -0700127 cbuildbot_launch.Cbuildbot('/cbuildbot_buildroot', '/depot_tools', args)
Don Garrett597ddff2017-02-17 18:29:37 -0800128
129 self.assertCommandCalled(
Don Garretta50bf492017-09-28 18:33:02 -0700130 expected_cmd, extra_env={'PATH': mock.ANY},
131 cwd='/cbuildbot_buildroot', error_code_ok=True)
Don Garrett597ddff2017-02-17 18:29:37 -0800132
Don Garrett6e5c6b92018-04-06 17:58:49 -0700133 def testCbuildbotSimple(self):
Don Garrett597ddff2017-02-17 18:29:37 -0800134 """Ensure we invoke cbuildbot correctly."""
Don Garrett6e5c6b92018-04-06 17:58:49 -0700135 self.verifyCbuildbot(
Don Garrett597ddff2017-02-17 18:29:37 -0800136 self.ARGS_BASE + self.ARGS_CONFIG,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700137 self.CMD + self.ARGS_CONFIG + self.EXPECTED_ARGS_BASE,
Don Garrett597ddff2017-02-17 18:29:37 -0800138 (0, 4))
139
Don Garrett6e5c6b92018-04-06 17:58:49 -0700140 def testCbuildbotNotFiltered(self):
Don Garrett597ddff2017-02-17 18:29:37 -0800141 """Ensure we invoke cbuildbot correctly."""
Don Garrett6e5c6b92018-04-06 17:58:49 -0700142 self.verifyCbuildbot(
Don Garrett597ddff2017-02-17 18:29:37 -0800143 self.ARGS_BASE + self.ARGS_CONFIG + self.ARGS_GIT_CACHE,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700144 (self.CMD + self.ARGS_CONFIG + self.EXPECTED_ARGS_BASE +
145 self.ARGS_GIT_CACHE),
Don Garrett597ddff2017-02-17 18:29:37 -0800146 (0, 4))
147
Don Garrett6e5c6b92018-04-06 17:58:49 -0700148 def testCbuildbotFiltered(self):
Don Garrett597ddff2017-02-17 18:29:37 -0800149 """Ensure we invoke cbuildbot correctly."""
Don Garrett6e5c6b92018-04-06 17:58:49 -0700150 self.verifyCbuildbot(
Don Garrett597ddff2017-02-17 18:29:37 -0800151 self.ARGS_BASE + self.ARGS_CONFIG + self.ARGS_GIT_CACHE,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700152 self.CMD + self.ARGS_CONFIG + self.EXPECTED_ARGS_BASE,
Don Garrett597ddff2017-02-17 18:29:37 -0800153 (0, 2))
Don Garrettc4114cc2016-11-01 20:04:06 -0700154
Don Garrett86881cb2017-02-15 15:41:55 -0800155 def testMainMin(self):
156 """Test a minimal set of command line options."""
Don Garrett597ddff2017-02-17 18:29:37 -0800157 self.PatchObject(osutils, 'SafeMakedirs', autospec=True)
158 self.PatchObject(cros_build_lib, 'GetTargetChromiteApiVersion',
Don Garrett861e9182017-05-15 15:30:23 -0700159 autospec=True, return_value=(constants.REEXEC_API_MAJOR,
160 constants.REEXEC_API_MINOR))
Don Garrettf324bc32017-05-23 14:00:53 -0700161 mock_repo = mock.MagicMock()
162 mock_repo.branch = 'master'
Don Garrettbf90cdf2017-05-19 15:54:02 -0700163 mock_repo.directory = '/root/repository'
164
Don Garrettf324bc32017-05-23 14:00:53 -0700165 mock_repo_create = self.PatchObject(repository, 'RepoRepository',
166 autospec=True, return_value=mock_repo)
Don Garrettbf90cdf2017-05-19 15:54:02 -0700167 mock_clean = self.PatchObject(cbuildbot_launch, 'CleanBuildRoot',
Don Garrett0c54ed72017-03-03 11:18:57 -0800168 autospec=True)
169 mock_checkout = self.PatchObject(cbuildbot_launch, 'InitialCheckout',
Don Garrett86881cb2017-02-15 15:41:55 -0800170 autospec=True)
Benjamin Gordonaee36b82018-02-05 14:25:26 -0700171 mock_cleanup_chroot = self.PatchObject(cbuildbot_launch, 'CleanupChroot',
172 autospec=True)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600173 mock_set_last_build_state = self.PatchObject(
174 cbuildbot_launch, 'SetLastBuildState', autospec=True)
175
176 expected_build_state = build_summary.BuildSummary(
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600177 build_number=0, master_build_id=0, status=mock.ANY,
178 buildroot_layout=2, branch='master')
Don Garrett7ade05a2017-02-17 13:31:47 -0800179
Don Garrettbf90cdf2017-05-19 15:54:02 -0700180 cbuildbot_launch._main(['-r', '/root', 'config'])
Don Garrettc4114cc2016-11-01 20:04:06 -0700181
Don Garrettf324bc32017-05-23 14:00:53 -0700182 # Did we create the repo instance correctly?
183 self.assertEqual(mock_repo_create.mock_calls,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700184 [mock.call(EXPECTED_MANIFEST_URL, '/root/repository',
Don Garrettf324bc32017-05-23 14:00:53 -0700185 git_cache_dir=None, branch='master')])
186
Don Garrett7ade05a2017-02-17 13:31:47 -0800187 # Ensure we clean, as expected.
Don Garrettbf90cdf2017-05-19 15:54:02 -0700188 self.assertEqual(mock_clean.mock_calls, [
Don Garrettd1d90dd2017-06-13 17:35:52 -0700189 mock.call('/root', mock_repo,
190 {
191 'branch_name': 'master',
192 'tryjob': False,
193 'build_config': 'config',
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600194 },
195 expected_build_state)])
Don Garrett7ade05a2017-02-17 13:31:47 -0800196
Don Garrett86881cb2017-02-15 15:41:55 -0800197 # Ensure we checkout, as expected.
198 self.assertEqual(mock_checkout.mock_calls,
Don Garrettf324bc32017-05-23 14:00:53 -0700199 [mock.call(mock_repo)])
Don Garrettc4114cc2016-11-01 20:04:06 -0700200
Don Garrett86881cb2017-02-15 15:41:55 -0800201 # Ensure we invoke cbuildbot, as expected.
202 self.assertCommandCalled(
Don Garrett5cd946b2017-07-20 13:42:20 -0700203 [
204 '/root/repository/chromite/bin/cbuildbot',
205 'config',
206 '-r', '/root/repository',
207 '--ts-mon-task-num', '1',
208 ],
Don Garretta50bf492017-09-28 18:33:02 -0700209 extra_env={'PATH': mock.ANY},
Don Garrettbf90cdf2017-05-19 15:54:02 -0700210 cwd='/root/repository',
Don Garrettacbb2392017-05-11 18:27:41 -0700211 error_code_ok=True)
Don Garrettc4114cc2016-11-01 20:04:06 -0700212
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600213 # Ensure we saved the final state, as expected.
214 self.assertEqual(expected_build_state.status,
215 constants.BUILDER_STATUS_PASSED)
216 self.assertEqual(mock_set_last_build_state.mock_calls, [
217 mock.call('/root', expected_build_state)])
218
Benjamin Gordonaee36b82018-02-05 14:25:26 -0700219 # Ensure we clean the chroot, as expected.
220 self.assertEqual(mock_cleanup_chroot.mock_calls, [
221 mock.call('/root/repository')])
222
Don Garrett86881cb2017-02-15 15:41:55 -0800223 def testMainMax(self):
Don Garrett597ddff2017-02-17 18:29:37 -0800224 """Test a larger set of command line options."""
225 self.PatchObject(osutils, 'SafeMakedirs', autospec=True)
226 self.PatchObject(cros_build_lib, 'GetTargetChromiteApiVersion',
Don Garrett861e9182017-05-15 15:30:23 -0700227 autospec=True, return_value=(constants.REEXEC_API_MAJOR,
228 constants.REEXEC_API_MINOR))
Don Garrettf324bc32017-05-23 14:00:53 -0700229 mock_repo = mock.MagicMock()
230 mock_repo.branch = 'branch'
Don Garrettbf90cdf2017-05-19 15:54:02 -0700231 mock_repo.directory = '/root/repository'
232
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600233 mock_summary = build_summary.BuildSummary(
234 build_number=313,
235 master_build_id=123123123,
236 status=constants.BUILDER_STATUS_FAILED,
237 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
238 branch='branch')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600239
240 mock_get_last_build_state = self.PatchObject(
241 cbuildbot_launch, 'GetLastBuildState', autospec=True,
242 return_value=mock_summary)
Don Garrettf324bc32017-05-23 14:00:53 -0700243 mock_repo_create = self.PatchObject(repository, 'RepoRepository',
244 autospec=True, return_value=mock_repo)
Don Garrettbf90cdf2017-05-19 15:54:02 -0700245 mock_clean = self.PatchObject(cbuildbot_launch, 'CleanBuildRoot',
Don Garrett0c54ed72017-03-03 11:18:57 -0800246 autospec=True)
247 mock_checkout = self.PatchObject(cbuildbot_launch, 'InitialCheckout',
Don Garrett86881cb2017-02-15 15:41:55 -0800248 autospec=True)
Benjamin Gordonaee36b82018-02-05 14:25:26 -0700249 mock_cleanup_chroot = self.PatchObject(cbuildbot_launch, 'CleanupChroot',
250 autospec=True)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600251 mock_set_last_build_state = self.PatchObject(
252 cbuildbot_launch, 'SetLastBuildState', autospec=True)
Don Garrettc4114cc2016-11-01 20:04:06 -0700253
Don Garrettbf90cdf2017-05-19 15:54:02 -0700254 cbuildbot_launch._main(['--buildroot', '/root',
Don Garrettacbb2392017-05-11 18:27:41 -0700255 '--branch', 'branch',
256 '--git-cache-dir', '/git-cache',
Don Garrettd1d90dd2017-06-13 17:35:52 -0700257 '--remote-trybot',
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600258 '--master-build-id', '123456789',
259 '--buildnumber', '314',
Don Garrettacbb2392017-05-11 18:27:41 -0700260 'config'])
Don Garrettc4114cc2016-11-01 20:04:06 -0700261
Don Garrettf324bc32017-05-23 14:00:53 -0700262 # Did we create the repo instance correctly?
263 self.assertEqual(mock_repo_create.mock_calls,
Don Garrettbf90cdf2017-05-19 15:54:02 -0700264 [mock.call(EXPECTED_MANIFEST_URL, '/root/repository',
Don Garrettf324bc32017-05-23 14:00:53 -0700265 git_cache_dir='/git-cache', branch='branch')])
266
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600267 # Ensure we look up the previous status.
268 self.assertEqual(mock_get_last_build_state.mock_calls, [
269 mock.call('/root')])
270
Don Garrett7ade05a2017-02-17 13:31:47 -0800271 # Ensure we clean, as expected.
Don Garrettbf90cdf2017-05-19 15:54:02 -0700272 self.assertEqual(mock_clean.mock_calls, [
Don Garrettd1d90dd2017-06-13 17:35:52 -0700273 mock.call('/root',
274 mock_repo,
275 {
276 'branch_name': 'branch',
277 'tryjob': True,
278 'build_config': 'config',
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600279 },
280 build_summary.BuildSummary(
281 build_number=314,
282 master_build_id=123456789,
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600283 status=mock.ANY,
284 branch='branch',
285 buildroot_layout=2
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600286 ))])
Don Garrett7ade05a2017-02-17 13:31:47 -0800287
Don Garrett86881cb2017-02-15 15:41:55 -0800288 # Ensure we checkout, as expected.
289 self.assertEqual(mock_checkout.mock_calls,
Don Garrettf324bc32017-05-23 14:00:53 -0700290 [mock.call(mock_repo)])
Don Garrett86881cb2017-02-15 15:41:55 -0800291
292 # Ensure we invoke cbuildbot, as expected.
293 self.assertCommandCalled(
Don Garrett5cd946b2017-07-20 13:42:20 -0700294 [
295 '/root/repository/chromite/bin/cbuildbot',
296 'config',
297 '--buildroot', '/root/repository',
298 '--branch', 'branch',
299 '--git-cache-dir', '/git-cache',
300 '--remote-trybot',
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600301 '--master-build-id', '123456789',
302 '--buildnumber', '314',
303 '--previous-build-state',
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600304 'eyJzdGF0dXMiOiAiZmFpbCIsICJtYXN0ZXJfYnVpbGRfaWQiOiAxMjMxMjMxMj'
305 'MsICJidWlsZF9udW1iZXIiOiAzMTMsICJidWlsZHJvb3RfbGF5b3V0IjogMiwg'
306 'ImJyYW5jaCI6ICJicmFuY2gifQ==',
Don Garrett5cd946b2017-07-20 13:42:20 -0700307 '--ts-mon-task-num', '1',
308 ],
Don Garretta50bf492017-09-28 18:33:02 -0700309 extra_env={'PATH': mock.ANY},
Don Garrettbf90cdf2017-05-19 15:54:02 -0700310 cwd='/root/repository',
Don Garrettacbb2392017-05-11 18:27:41 -0700311 error_code_ok=True)
Don Garrett7ade05a2017-02-17 13:31:47 -0800312
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600313 # Ensure we write the final build state, as expected.
314 final_state = build_summary.BuildSummary(
315 build_number=314,
316 master_build_id=123456789,
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600317 status=constants.BUILDER_STATUS_PASSED,
318 buildroot_layout=2,
319 branch='branch')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600320 self.assertEqual(mock_set_last_build_state.mock_calls, [
321 mock.call('/root', final_state)])
322
Benjamin Gordonaee36b82018-02-05 14:25:26 -0700323 # Ensure we clean the chroot, as expected.
324 self.assertEqual(mock_cleanup_chroot.mock_calls, [
325 mock.call('/root/repository')])
326
Don Garrett7ade05a2017-02-17 13:31:47 -0800327
Don Garrettbf90cdf2017-05-19 15:54:02 -0700328class CleanBuildRootTest(cros_test_lib.MockTempDirTestCase):
329 """Tests for CleanBuildRoot method."""
Don Garrett7ade05a2017-02-17 13:31:47 -0800330
331 def setUp(self):
332 """Create standard buildroot contents for cleanup."""
Don Garrettbf90cdf2017-05-19 15:54:02 -0700333 self.root = os.path.join(self.tempdir)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600334 self.previous_build_state = os.path.join(
335 self.root, '.cbuildbot_build_state.json')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700336 self.buildroot = os.path.join(self.root, 'buildroot')
337 self.repo = os.path.join(self.buildroot, '.repo/repo')
338 self.chroot = os.path.join(self.buildroot, 'chroot/chroot')
339 self.general = os.path.join(self.buildroot, 'general/general')
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700340 self.cache = os.path.join(self.buildroot, '.cache')
341 self.distfiles = os.path.join(self.cache, 'distfiles')
Don Garrett7ade05a2017-02-17 13:31:47 -0800342
Don Garrettf324bc32017-05-23 14:00:53 -0700343 self.mock_repo = mock.MagicMock()
Don Garrettbf90cdf2017-05-19 15:54:02 -0700344 self.mock_repo.directory = self.buildroot
Don Garrettf324bc32017-05-23 14:00:53 -0700345
Don Garrettacbb2392017-05-11 18:27:41 -0700346 self.metrics = {}
347
Benjamin Gordon8642bcc2018-05-01 13:49:56 -0600348 def populateBuildroot(self, previous_build_state=None):
Don Garrett7ade05a2017-02-17 13:31:47 -0800349 """Create standard buildroot contents for cleanup."""
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600350 if previous_build_state:
351 osutils.SafeMakedirs(self.root)
352 osutils.WriteFile(self.previous_build_state, previous_build_state)
353
Don Garrett7ade05a2017-02-17 13:31:47 -0800354 # Create files.
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700355 for f in (self.repo, self.chroot, self.general, self.distfiles):
Don Garrette17e1d92017-04-12 15:28:19 -0700356 osutils.Touch(f, makedirs=True)
Don Garrett7ade05a2017-02-17 13:31:47 -0800357
Don Garrette17e1d92017-04-12 15:28:19 -0700358 def testNoBuildroot(self):
Don Garrettbf90cdf2017-05-19 15:54:02 -0700359 """Test CleanBuildRoot with no history."""
Don Garrettf324bc32017-05-23 14:00:53 -0700360 self.mock_repo.branch = 'master'
361
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600362 build_state = build_summary.BuildSummary(
363 status=constants.BUILDER_STATUS_INFLIGHT,
364 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
365 branch='master')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700366 cbuildbot_launch.CleanBuildRoot(
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600367 self.root, self.mock_repo, self.metrics, build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800368
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600369 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600370 self.assertEqual(new_summary.buildroot_layout, 2)
371 self.assertEqual(new_summary.branch, 'master')
372 self.assertIsNotNone(new_summary.distfiles_ts)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600373 self.assertEqual(new_summary, build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800374
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600375 self.assertExists(self.previous_build_state)
376
Don Garrett7ade05a2017-02-17 13:31:47 -0800377 def testBuildrootNoState(self):
Don Garrettbf90cdf2017-05-19 15:54:02 -0700378 """Test CleanBuildRoot with no state information."""
Don Garrett7ade05a2017-02-17 13:31:47 -0800379 self.populateBuildroot()
Don Garrettf324bc32017-05-23 14:00:53 -0700380 self.mock_repo.branch = 'master'
Don Garrett7ade05a2017-02-17 13:31:47 -0800381
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600382 build_state = build_summary.BuildSummary(
383 status=constants.BUILDER_STATUS_INFLIGHT,
384 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
385 branch='master')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700386 cbuildbot_launch.CleanBuildRoot(
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600387 self.root, self.mock_repo, self.metrics, build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800388
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600389 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600390 self.assertEqual(new_summary.buildroot_layout, 2)
391 self.assertEqual(new_summary.branch, 'master')
392 self.assertIsNotNone(new_summary.distfiles_ts)
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600393 self.assertEqual(new_summary, build_state)
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700394
Don Garrett60967922017-04-12 18:51:44 -0700395 self.assertNotExists(self.repo)
Don Garrett7ade05a2017-02-17 13:31:47 -0800396 self.assertNotExists(self.chroot)
Don Garrett60967922017-04-12 18:51:44 -0700397 self.assertNotExists(self.general)
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700398 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600399 self.assertExists(self.previous_build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800400
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600401 def testBuildrootFormatMismatch(self):
402 """Test CleanBuildRoot with buildroot layout mismatch."""
403 old_build_state = build_summary.BuildSummary(
404 status=constants.BUILDER_STATUS_PASSED,
405 buildroot_layout=1,
406 branch='master')
407 self.populateBuildroot(previous_build_state=old_build_state.to_json())
408 self.mock_repo.branch = 'master'
409
410 build_state = build_summary.BuildSummary(
411 status=constants.BUILDER_STATUS_INFLIGHT,
412 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
413 branch='master')
414 cbuildbot_launch.CleanBuildRoot(
415 self.root, self.mock_repo, self.metrics, build_state)
416
417 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
418 self.assertEqual(new_summary.buildroot_layout, 2)
419 self.assertEqual(new_summary.branch, 'master')
420 self.assertIsNotNone(new_summary.distfiles_ts)
421 self.assertEqual(new_summary, build_state)
422
423 self.assertNotExists(self.repo)
424 self.assertNotExists(self.chroot)
425 self.assertNotExists(self.general)
426 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600427 self.assertExists(self.previous_build_state)
428
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600429 def testBuildrootBranchChange(self):
430 """Test CleanBuildRoot with a change in branches."""
431 old_build_state = build_summary.BuildSummary(
432 status=constants.BUILDER_STATUS_PASSED,
433 buildroot_layout=2,
434 branch='branchA')
435 self.populateBuildroot(previous_build_state=old_build_state.to_json())
436 self.mock_repo.branch = 'branchB'
437 m = self.PatchObject(cros_build_lib, 'CleanupChrootMount')
Don Garrett7ade05a2017-02-17 13:31:47 -0800438
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600439 build_state = build_summary.BuildSummary(
440 status=constants.BUILDER_STATUS_INFLIGHT,
441 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
442 branch='branchB')
Don Garrettbf90cdf2017-05-19 15:54:02 -0700443 cbuildbot_launch.CleanBuildRoot(
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600444 self.root, self.mock_repo, self.metrics, build_state)
Don Garrett7ade05a2017-02-17 13:31:47 -0800445
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600446 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600447 self.assertEqual(new_summary.buildroot_layout, 2)
448 self.assertEqual(new_summary.branch, 'branchB')
449 self.assertIsNotNone(new_summary.distfiles_ts)
450 self.assertEqual(new_summary, build_state)
451
452 self.assertExists(self.repo)
453 self.assertNotExists(self.chroot)
454 self.assertExists(self.general)
455 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600456 self.assertExists(self.previous_build_state)
457 m.assert_called()
458
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600459 def testBuildrootBranchMatch(self):
460 """Test CleanBuildRoot with no change in branch."""
461 old_build_state = build_summary.BuildSummary(
462 status=constants.BUILDER_STATUS_PASSED,
463 buildroot_layout=2,
464 branch='branchA')
465 self.populateBuildroot(previous_build_state=old_build_state.to_json())
466 self.mock_repo.branch = 'branchA'
467
468 build_state = build_summary.BuildSummary(
469 status=constants.BUILDER_STATUS_INFLIGHT,
470 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
471 branch='branchA')
472 cbuildbot_launch.CleanBuildRoot(
473 self.root, self.mock_repo, self.metrics, build_state)
474
475 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
476 self.assertEqual(new_summary.buildroot_layout, 2)
477 self.assertEqual(new_summary.branch, 'branchA')
478 self.assertIsNotNone(new_summary.distfiles_ts)
479 self.assertEqual(new_summary, build_state)
480
481 self.assertExists(self.repo)
482 self.assertExists(self.chroot)
483 self.assertExists(self.general)
484 self.assertExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600485 self.assertExists(self.previous_build_state)
Prathmesh Prabhuc41a0f52018-04-03 13:26:52 -0700486
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600487 def testBuildrootDistfilesRecentCache(self):
488 """Test CleanBuildRoot does not delete distfiles when cache is recent."""
489 seed_distfiles_ts = time.time() - 60
490 old_build_state = build_summary.BuildSummary(
491 status=constants.BUILDER_STATUS_PASSED,
492 buildroot_layout=2,
493 branch='branchA',
494 distfiles_ts=seed_distfiles_ts)
495 self.populateBuildroot(previous_build_state=old_build_state.to_json())
496 self.mock_repo.branch = 'branchA'
497
498 build_state = build_summary.BuildSummary(
499 status=constants.BUILDER_STATUS_INFLIGHT,
500 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
501 branch='branchA')
502 cbuildbot_launch.CleanBuildRoot(
503 self.root, self.mock_repo, self.metrics, build_state)
504
505 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
506 self.assertEqual(new_summary.buildroot_layout, 2)
507 self.assertEqual(new_summary.branch, 'branchA')
508 # Same cache creation timestamp is rewritten to state.
509 self.assertEqual(new_summary.distfiles_ts, seed_distfiles_ts)
510 self.assertEqual(new_summary, build_state)
511
512 self.assertExists(self.repo)
513 self.assertExists(self.chroot)
514 self.assertExists(self.general)
515 self.assertExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600516 self.assertExists(self.previous_build_state)
Don Garrette17e1d92017-04-12 15:28:19 -0700517
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600518 def testBuildrootDistfilesCacheExpired(self):
519 """Test CleanBuildRoot when the distfiles cache is too old."""
520 old_build_state = build_summary.BuildSummary(
521 status=constants.BUILDER_STATUS_PASSED,
522 buildroot_layout=2,
523 branch='branchA',
524 distfiles_ts=100.0)
525 self.populateBuildroot(previous_build_state=old_build_state.to_json())
526 self.mock_repo.branch = 'branchA'
527
528 build_state = build_summary.BuildSummary(
529 status=constants.BUILDER_STATUS_INFLIGHT,
530 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
531 branch='branchA')
532 cbuildbot_launch.CleanBuildRoot(
533 self.root, self.mock_repo, self.metrics, build_state)
534
535 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
536 self.assertEqual(new_summary.buildroot_layout, 2)
537 self.assertEqual(new_summary.branch, 'branchA')
538 self.assertIsNotNone(new_summary.distfiles_ts)
539 self.assertEqual(new_summary, build_state)
540
541 self.assertExists(self.repo)
542 self.assertExists(self.chroot)
543 self.assertExists(self.general)
544 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600545 self.assertExists(self.previous_build_state)
546
547 def testBuildrootRepoCleanFailure(self):
548 """Test CleanBuildRoot with repo checkout failure."""
549 old_build_state = build_summary.BuildSummary(
550 status=constants.BUILDER_STATUS_PASSED,
551 buildroot_layout=1,
552 branch='branchA')
553 self.populateBuildroot(previous_build_state=old_build_state.to_json())
554 self.mock_repo.branch = 'branchA'
555 self.mock_repo.BuildRootGitCleanup.side_effect = Exception
556
557 build_state = build_summary.BuildSummary(
558 status=constants.BUILDER_STATUS_INFLIGHT,
559 buildroot_layout=cbuildbot_launch.BUILDROOT_BUILDROOT_LAYOUT,
560 branch='branchA')
561 cbuildbot_launch.CleanBuildRoot(
562 self.root, self.mock_repo, self.metrics, build_state)
563
564 new_summary = cbuildbot_launch.GetLastBuildState(self.root)
565 self.assertEqual(new_summary.buildroot_layout, 2)
566 self.assertEqual(new_summary.branch, 'branchA')
567 self.assertIsNotNone(new_summary.distfiles_ts)
568 self.assertEqual(new_summary, build_state)
569
570 self.assertNotExists(self.repo)
571 self.assertNotExists(self.chroot)
572 self.assertNotExists(self.general)
573 self.assertNotExists(self.distfiles)
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600574 self.assertExists(self.previous_build_state)
Don Garrettf324bc32017-05-23 14:00:53 -0700575
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600576 def testGetCurrentBuildStateNoArgs(self):
577 """Tests GetCurrentBuildState without arguments."""
578 options = cbuildbot_launch.PreParseArguments([
579 '--buildroot', self.root, 'config'
580 ])
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600581 state = cbuildbot_launch.GetCurrentBuildState(options, 'master')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600582
583 expected_state = build_summary.BuildSummary(
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600584 status=constants.BUILDER_STATUS_INFLIGHT,
585 buildroot_layout=2,
586 branch='master')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600587 self.assertEqual(state, expected_state)
588
589 def testGetCurrentBuildStateHasArgs(self):
590 """Tests GetCurrentBuildState with arguments."""
591 options = cbuildbot_launch.PreParseArguments([
592 '--buildroot', self.root,
593 '--buildnumber', '20',
594 '--master-build-id', '50',
595 'config'
596 ])
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600597 state = cbuildbot_launch.GetCurrentBuildState(options, 'branchA')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600598
599 expected_state = build_summary.BuildSummary(
600 build_number=20,
601 master_build_id=50,
Benjamin Gordon8b6d4122018-04-26 13:38:39 -0600602 status=constants.BUILDER_STATUS_INFLIGHT,
603 buildroot_layout=2,
604 branch='branchA')
605 self.assertEqual(state, expected_state)
606
607 def testGetCurrentBuildStateLayout(self):
608 """Test that GetCurrentBuildState uses the current buildroot layout."""
609 # Change to a future version.
610 self.PatchObject(cbuildbot_launch, 'BUILDROOT_BUILDROOT_LAYOUT', 22)
611
612 options = cbuildbot_launch.PreParseArguments([
613 '--buildroot', self.root, 'config'
614 ])
615 state = cbuildbot_launch.GetCurrentBuildState(options, 'branchA')
616
617 expected_state = build_summary.BuildSummary(
618 status=constants.BUILDER_STATUS_INFLIGHT,
619 buildroot_layout=22,
620 branch='branchA')
Benjamin Gordon90b2dd92018-04-12 14:04:21 -0600621 self.assertEqual(state, expected_state)
622
623 def testGetLastBuildStateNoFile(self):
624 """Tests GetLastBuildState if the file is missing."""
625 osutils.SafeMakedirs(self.root)
626 state = cbuildbot_launch.GetLastBuildState(self.root)
627 self.assertEqual(state, build_summary.BuildSummary())
628
629 def testGetLastBuildStateBadFile(self):
630 """Tests GetLastBuildState if the file contains invalid JSON."""
631 osutils.SafeMakedirs(self.root)
632 osutils.WriteFile(self.previous_build_state, '}}')
633 state = cbuildbot_launch.GetLastBuildState(self.root)
634 self.assertEqual(state, build_summary.BuildSummary())
635
636 def testGetLastBuildStateMissingBuildStatus(self):
637 """Tests GetLastBuildState if the file doesn't have a valid status."""
638 osutils.SafeMakedirs(self.root)
639 osutils.WriteFile(self.previous_build_state, '{"build_number": "3"}')
640 state = cbuildbot_launch.GetLastBuildState(self.root)
641 self.assertEqual(state, build_summary.BuildSummary())
642
643 def testGetLastBuildStateGoodFile(self):
644 """Tests GetLastBuildState on a good file."""
645 osutils.SafeMakedirs(self.root)
646 osutils.WriteFile(
647 self.previous_build_state,
648 '{"build_number": 1, "master_build_id": 3, "status": "pass"}')
649 state = cbuildbot_launch.GetLastBuildState(self.root)
650 self.assertEqual(
651 state,
652 build_summary.BuildSummary(
653 build_number=1, master_build_id=3, status='pass'))
654
655 def testSetLastBuildState(self):
656 """Verifies that SetLastBuildState writes to the expected file."""
657 osutils.SafeMakedirs(self.root)
658 old_state = build_summary.BuildSummary(
659 build_number=314,
660 master_build_id=2178,
661 status=constants.BUILDER_STATUS_PASSED)
662 cbuildbot_launch.SetLastBuildState(self.root, old_state)
663
664 saved_state = osutils.ReadFile(self.previous_build_state)
665 new_state = build_summary.BuildSummary()
666 new_state.from_json(saved_state)
667
668 self.assertEqual(old_state, new_state)