1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2014 Google, Inc
11 from buildman import board
12 from buildman import bsettings
13 from buildman import cmdline
14 from buildman import control
15 from buildman import toolchain
16 from patman import command
17 from patman import gitutil
18 from patman import terminal
19 from patman import test_util
20 from patman import tools
23 # Buildman settings file
31 chroot=/home/sjg/c/chroot
32 vboot=VBOOT_DEBUG=1 MAKEFLAGS_VBOOT=DEBUG=1 CFLAGS_EXTRA_VBOOT=-DUNROLL_LOOPS VBOOT_SOURCE=${src}/platform/vboot_reference
33 chromeos_coreboot=VBOOT=${chroot}/build/link/usr ${vboot}
34 chromeos_daisy=VBOOT=${chroot}/build/daisy/usr ${vboot}
35 chromeos_peach=VBOOT=${chroot}/build/peach_pit/usr ${vboot}
39 ['Active', 'arm', 'armv7', '', 'Tester', 'ARM Board 1', 'board0', ''],
40 ['Active', 'arm', 'armv7', '', 'Tester', 'ARM Board 2', 'board1', ''],
41 ['Active', 'powerpc', 'powerpc', '', 'Tester', 'PowerPC board 1', 'board2', ''],
42 ['Active', 'sandbox', 'sandbox', '', 'Tester', 'Sandbox board', 'board4', ''],
45 commit_shortlog = """4aca821 patman: Avoid changing the order of tags
46 39403bb patman: Use --no-pager' to stop git from forking a pager
47 db6e6f2 patman: Remove the -a option
48 f2ccf03 patman: Correct unit tests to run correctly
49 1d097f9 patman: Fix indentation in terminal.py
50 d073747 patman: Support the 'reverse' option for 'git log
53 commit_log = ["""commit 7f6b8315d18f683c5181d0c3694818c1b2a20dcd
54 Author: Masahiro Yamada <yamada.m@jp.panasonic.com>
55 Date: Fri Aug 22 19:12:41 2014 +0900
57 buildman: refactor help message
59 "buildman [options]" is displayed by default.
61 Append the rest of help messages to parser.usage
62 instead of replacing it.
64 Besides, "-b <branch>" is not mandatory since commit fea5858e.
65 Drop it from the usage.
67 Signed-off-by: Masahiro Yamada <yamada.m@jp.panasonic.com>
69 """commit d0737479be6baf4db5e2cdbee123e96bc5ed0ba8
70 Author: Simon Glass <sjg@chromium.org>
71 Date: Thu Aug 14 16:48:25 2014 -0600
73 patman: Support the 'reverse' option for 'git log'
75 This option is currently not supported, but needs to be, for buildman to
79 - Add new patch to fix the 'reverse' bug
83 Change-Id: I79078f792e8b390b8a1272a8023537821d45feda
84 Reported-by: York Sun <yorksun@freescale.com>
85 Signed-off-by: Simon Glass <sjg@chromium.org>
88 """commit 1d097f9ab487c5019152fd47bda126839f3bf9fc
89 Author: Simon Glass <sjg@chromium.org>
90 Date: Sat Aug 9 11:44:32 2014 -0600
92 patman: Fix indentation in terminal.py
94 This code came from a different project with 2-character indentation. Fix
98 - Add new patch to fix indentation in teminal.py
100 Change-Id: I5a74d2ebbb3cc12a665f5c725064009ac96e8a34
101 Signed-off-by: Simon Glass <sjg@chromium.org>
104 """commit f2ccf03869d1e152c836515a3ceb83cdfe04a105
105 Author: Simon Glass <sjg@chromium.org>
106 Date: Sat Aug 9 11:08:24 2014 -0600
108 patman: Correct unit tests to run correctly
110 It seems that doctest behaves differently now, and some of the unit tests
111 do not run. Adjust the tests to work correctly.
113 ./tools/patman/patman --test
114 <unittest.result.TestResult run=10 errors=0 failures=0>
117 - Add new patch to fix patman unit tests
119 Change-Id: I3d2ca588f4933e1f9d6b1665a00e4ae58269ff3b
122 """commit db6e6f2f9331c5a37647d6668768d4a40b8b0d1c
123 Author: Simon Glass <sjg@chromium.org>
124 Date: Sat Aug 9 12:06:02 2014 -0600
126 patman: Remove the -a option
128 It seems that this is no longer needed, since checkpatch.pl will catch
129 whitespace problems in patches. Also the option is not widely used, so
130 it seems safe to just remove it.
133 - Add new patch to remove patman's -a option
135 Suggested-by: Masahiro Yamada <yamada.m@jp.panasonic.com>
136 Change-Id: I5821a1c75154e532c46513486ca40b808de7e2cc
139 """commit 39403bb4f838153028a6f21ca30bf100f3791133
140 Author: Simon Glass <sjg@chromium.org>
141 Date: Thu Aug 14 21:50:52 2014 -0600
143 patman: Use --no-pager' to stop git from forking a pager
146 """commit 4aca821e27e97925c039e69fd37375b09c6f129c
147 Author: Simon Glass <sjg@chromium.org>
148 Date: Fri Aug 22 15:57:39 2014 -0600
150 patman: Avoid changing the order of tags
152 patman collects tags that it sees in the commit and places them nicely
153 sorted at the end of the patch. However, this is not really necessary and
154 in fact is apparently not desirable.
157 - Add new patch to avoid changing the order of tags
161 Suggested-by: Masahiro Yamada <yamada.m@jp.panasonic.com>
162 Change-Id: Ib1518588c1a189ad5c3198aae76f8654aed8d0db
165 TEST_BRANCH = '__testbranch'
167 class TestFunctional(unittest.TestCase):
168 """Functional test for buildman.
170 This aims to test from just below the invocation of buildman (parsing
171 of arguments) to 'make' and 'git' invocation. It is not a true
172 emd-to-end test, as it mocks git, make and the tool chain. But this
173 makes it easier to detect when the builder is doing the wrong thing,
174 since in many cases this test code will fail. For example, only a
175 very limited subset of 'git' arguments is supported - anything
176 unexpected will fail.
179 self._base_dir = tempfile.mkdtemp()
180 self._output_dir = tempfile.mkdtemp()
181 self._git_dir = os.path.join(self._base_dir, 'src')
182 self._buildman_pathname = sys.argv[0]
183 self._buildman_dir = os.path.dirname(os.path.realpath(sys.argv[0]))
184 command.test_result = self._HandleCommand
185 bsettings.Setup(None)
186 bsettings.AddFile(settings_data)
187 self.setupToolchains()
188 self._toolchains.Add('arm-gcc', test=False)
189 self._toolchains.Add('powerpc-gcc', test=False)
190 self._boards = board.Boards()
192 self._boards.AddBoard(board.Board(*brd))
194 # Directories where the source been cloned
195 self._clone_dirs = []
196 self._commits = len(commit_shortlog.splitlines()) + 1
197 self._total_builds = self._commits * len(boards)
199 # Number of calls to make
202 # Map of [board, commit] to error messages
205 self._test_branch = TEST_BRANCH
207 # Avoid sending any output and clear all terminal output
208 terminal.SetPrintTestMode()
209 terminal.GetPrintTestLines()
212 shutil.rmtree(self._base_dir)
213 #shutil.rmtree(self._output_dir)
215 def setupToolchains(self):
216 self._toolchains = toolchain.Toolchains()
217 self._toolchains.Add('gcc', test=False)
219 def _RunBuildman(self, *args):
220 return command.run_pipe([[self._buildman_pathname] + list(args)],
221 capture=True, capture_stderr=True)
223 def _RunControl(self, *args, boards=None, clean_dir=False,
224 test_thread_exceptions=False):
228 args: List of arguments to pass
230 clean_dir: Used for tests only, indicates that the existing output_dir
231 should be removed before starting the build
232 test_thread_exceptions: Uses for tests only, True to make the threads
233 raise an exception instead of reporting their result. This simulates
234 a failure in the code somewhere
237 result code from buildman
239 sys.argv = [sys.argv[0]] + list(args)
240 options, args = cmdline.ParseArgs()
241 result = control.DoBuildman(options, args, toolchains=self._toolchains,
242 make_func=self._HandleMake, boards=boards or self._boards,
244 test_thread_exceptions=test_thread_exceptions)
245 self._builder = control.builder
248 def testFullHelp(self):
249 command.test_result = None
250 result = self._RunBuildman('-H')
251 help_file = os.path.join(self._buildman_dir, 'README')
252 # Remove possible extraneous strings
253 extra = '::::::::::::::\n' + help_file + '\n::::::::::::::\n'
254 gothelp = result.stdout.replace(extra, '')
255 self.assertEqual(len(gothelp), os.path.getsize(help_file))
256 self.assertEqual(0, len(result.stderr))
257 self.assertEqual(0, result.return_code)
260 command.test_result = None
261 result = self._RunBuildman('-h')
262 help_file = os.path.join(self._buildman_dir, 'README')
263 self.assertTrue(len(result.stdout) > 1000)
264 self.assertEqual(0, len(result.stderr))
265 self.assertEqual(0, result.return_code)
267 def testGitSetup(self):
268 """Test gitutils.Setup(), from outside the module itself"""
269 command.test_result = command.CommandResult(return_code=1)
271 self.assertEqual(gitutil.use_no_decorate, False)
273 command.test_result = command.CommandResult(return_code=0)
275 self.assertEqual(gitutil.use_no_decorate, True)
277 def _HandleCommandGitLog(self, args):
281 return command.CommandResult(return_code=0)
282 elif args[-1] == 'upstream/master..%s' % self._test_branch:
283 return command.CommandResult(return_code=0, stdout=commit_shortlog)
284 elif args[:3] == ['--no-color', '--no-decorate', '--reverse']:
285 if args[-1] == self._test_branch:
286 count = int(args[3][2:])
287 return command.CommandResult(return_code=0,
288 stdout=''.join(commit_log[:count]))
290 # Not handled, so abort
291 print('git log', args)
294 def _HandleCommandGitConfig(self, args):
296 if config == 'sendemail.aliasesfile':
297 return command.CommandResult(return_code=0)
298 elif config.startswith('branch.badbranch'):
299 return command.CommandResult(return_code=1)
300 elif config == 'branch.%s.remote' % self._test_branch:
301 return command.CommandResult(return_code=0, stdout='upstream\n')
302 elif config == 'branch.%s.merge' % self._test_branch:
303 return command.CommandResult(return_code=0,
304 stdout='refs/heads/master\n')
306 # Not handled, so abort
307 print('git config', args)
310 def _HandleCommandGit(self, in_args):
311 """Handle execution of a git command
313 This uses a hacked-up parser.
316 in_args: Arguments after 'git' from the command line
318 git_args = [] # Top-level arguments to git itself
319 sub_cmd = None # Git sub-command selected
320 args = [] # Arguments to the git sub-command
327 if git_args and git_args[-1] in ['--git-dir', '--work-tree']:
331 if sub_cmd == 'config':
332 return self._HandleCommandGitConfig(args)
333 elif sub_cmd == 'log':
334 return self._HandleCommandGitLog(args)
335 elif sub_cmd == 'clone':
336 return command.CommandResult(return_code=0)
337 elif sub_cmd == 'checkout':
338 return command.CommandResult(return_code=0)
339 elif sub_cmd == 'worktree':
340 return command.CommandResult(return_code=0)
342 # Not handled, so abort
343 print('git', git_args, sub_cmd, args)
346 def _HandleCommandNm(self, args):
347 return command.CommandResult(return_code=0)
349 def _HandleCommandObjdump(self, args):
350 return command.CommandResult(return_code=0)
352 def _HandleCommandObjcopy(self, args):
353 return command.CommandResult(return_code=0)
355 def _HandleCommandSize(self, args):
356 return command.CommandResult(return_code=0)
358 def _HandleCommand(self, **kwargs):
359 """Handle a command execution.
361 The command is in kwargs['pipe-list'], as a list of pipes, each a
362 list of commands. The command should be emulated as required for
366 A CommandResult object
368 pipe_list = kwargs['pipe_list']
370 if len(pipe_list) != 1:
371 if pipe_list[1] == ['wc', '-l']:
374 print('invalid pipe', kwargs)
376 cmd = pipe_list[0][0]
377 args = pipe_list[0][1:]
380 result = self._HandleCommandGit(args)
381 elif cmd == './scripts/show-gnu-make':
382 return command.CommandResult(return_code=0, stdout='make')
383 elif cmd.endswith('nm'):
384 return self._HandleCommandNm(args)
385 elif cmd.endswith('objdump'):
386 return self._HandleCommandObjdump(args)
387 elif cmd.endswith('objcopy'):
388 return self._HandleCommandObjcopy(args)
389 elif cmd.endswith( 'size'):
390 return self._HandleCommandSize(args)
393 # Not handled, so abort
394 print('unknown command', kwargs)
398 result.stdout = len(result.stdout.splitlines())
401 def _HandleMake(self, commit, brd, stage, cwd, *args, **kwargs):
402 """Handle execution of 'make'
405 commit: Commit object that is being built
406 brd: Board object that is being built
407 stage: Stage that we are at (mrproper, config, build)
408 cwd: Directory where make should be run
409 args: Arguments to pass to make
410 kwargs: Arguments to pass to command.run_pipe()
412 self._make_calls += 1
413 if stage == 'mrproper':
414 return command.CommandResult(return_code=0)
415 elif stage == 'config':
416 return command.CommandResult(return_code=0,
417 combined='Test configuration complete')
418 elif stage == 'build':
422 if arg.startswith('O='):
424 fname = os.path.join(cwd or '', out_dir, 'u-boot')
425 tools.write_file(fname, b'U-Boot')
426 if type(commit) is not str:
427 stderr = self._error.get((brd.target, commit.sequence))
429 return command.CommandResult(return_code=1, stderr=stderr)
430 return command.CommandResult(return_code=0)
432 # Not handled, so abort
436 # Example function to print output lines
437 def print_lines(self, lines):
441 #self.print_lines(terminal.GetPrintTestLines())
443 def testNoBoards(self):
444 """Test that buildman aborts when there are no boards"""
445 self._boards = board.Boards()
446 with self.assertRaises(SystemExit):
449 def testCurrentSource(self):
450 """Very simple test to invoke buildman on the current source"""
451 self.setupToolchains();
452 self._RunControl('-o', self._output_dir)
453 lines = terminal.GetPrintTestLines()
454 self.assertIn('Building current source for %d boards' % len(boards),
457 def testBadBranch(self):
458 """Test that we can detect an invalid branch"""
459 with self.assertRaises(ValueError):
460 self._RunControl('-b', 'badbranch')
462 def testBadToolchain(self):
463 """Test that missing toolchains are detected"""
464 self.setupToolchains();
465 ret_code = self._RunControl('-b', TEST_BRANCH, '-o', self._output_dir)
466 lines = terminal.GetPrintTestLines()
468 # Buildman always builds the upstream commit as well
469 self.assertIn('Building %d commits for %d boards' %
470 (self._commits, len(boards)), lines[0].text)
471 self.assertEqual(self._builder.count, self._total_builds)
473 # Only sandbox should succeed, the others don't have toolchains
474 self.assertEqual(self._builder.fail,
475 self._total_builds - self._commits)
476 self.assertEqual(ret_code, 100)
478 for commit in range(self._commits):
479 for board in self._boards.GetList():
480 if board.arch != 'sandbox':
481 errfile = self._builder.GetErrFile(commit, board.target)
483 self.assertEqual(fd.readlines(),
484 ['No tool chain for %s\n' % board.arch])
487 def testBranch(self):
488 """Test building a branch with all toolchains present"""
489 self._RunControl('-b', TEST_BRANCH, '-o', self._output_dir)
490 self.assertEqual(self._builder.count, self._total_builds)
491 self.assertEqual(self._builder.fail, 0)
494 """Test building a specific number of commitst"""
495 self._RunControl('-b', TEST_BRANCH, '-c2', '-o', self._output_dir)
496 self.assertEqual(self._builder.count, 2 * len(boards))
497 self.assertEqual(self._builder.fail, 0)
498 # Each board has a config, and then one make per commit
499 self.assertEqual(self._make_calls, len(boards) * (1 + 2))
501 def testIncremental(self):
502 """Test building a branch twice - the second time should do nothing"""
503 self._RunControl('-b', TEST_BRANCH, '-o', self._output_dir)
505 # Each board has a mrproper, config, and then one make per commit
506 self.assertEqual(self._make_calls, len(boards) * (self._commits + 1))
508 self._RunControl('-b', TEST_BRANCH, '-o', self._output_dir, clean_dir=False)
509 self.assertEqual(self._make_calls, 0)
510 self.assertEqual(self._builder.count, self._total_builds)
511 self.assertEqual(self._builder.fail, 0)
513 def testForceBuild(self):
514 """The -f flag should force a rebuild"""
515 self._RunControl('-b', TEST_BRANCH, '-o', self._output_dir)
517 self._RunControl('-b', TEST_BRANCH, '-f', '-o', self._output_dir, clean_dir=False)
518 # Each board has a config and one make per commit
519 self.assertEqual(self._make_calls, len(boards) * (self._commits + 1))
521 def testForceReconfigure(self):
522 """The -f flag should force a rebuild"""
523 self._RunControl('-b', TEST_BRANCH, '-C', '-o', self._output_dir)
524 # Each commit has a config and make
525 self.assertEqual(self._make_calls, len(boards) * self._commits * 2)
527 def testForceReconfigure(self):
528 """The -f flag should force a rebuild"""
529 self._RunControl('-b', TEST_BRANCH, '-C', '-o', self._output_dir)
530 # Each commit has a config and make
531 self.assertEqual(self._make_calls, len(boards) * self._commits * 2)
533 def testMrproper(self):
534 """The -f flag should force a rebuild"""
535 self._RunControl('-b', TEST_BRANCH, '-m', '-o', self._output_dir)
536 # Each board has a mkproper, config and then one make per commit
537 self.assertEqual(self._make_calls, len(boards) * (self._commits + 2))
539 def testErrors(self):
540 """Test handling of build errors"""
541 self._error['board2', 1] = 'fred\n'
542 self._RunControl('-b', TEST_BRANCH, '-o', self._output_dir)
543 self.assertEqual(self._builder.count, self._total_builds)
544 self.assertEqual(self._builder.fail, 1)
546 # Remove the error. This should have no effect since the commit will
548 del self._error['board2', 1]
550 self._RunControl('-b', TEST_BRANCH, '-o', self._output_dir, clean_dir=False)
551 self.assertEqual(self._builder.count, self._total_builds)
552 self.assertEqual(self._make_calls, 0)
553 self.assertEqual(self._builder.fail, 1)
555 # Now use the -F flag to force rebuild of the bad commit
556 self._RunControl('-b', TEST_BRANCH, '-o', self._output_dir, '-F', clean_dir=False)
557 self.assertEqual(self._builder.count, self._total_builds)
558 self.assertEqual(self._builder.fail, 0)
559 self.assertEqual(self._make_calls, 2)
561 def testBranchWithSlash(self):
562 """Test building a branch with a '/' in the name"""
563 self._test_branch = '/__dev/__testbranch'
564 self._RunControl('-b', self._test_branch, clean_dir=False)
565 self.assertEqual(self._builder.count, self._total_builds)
566 self.assertEqual(self._builder.fail, 0)
568 def testEnvironment(self):
569 """Test that the done and environment files are written to out-env"""
570 self._RunControl('-o', self._output_dir)
571 board0_dir = os.path.join(self._output_dir, 'current', 'board0')
572 self.assertTrue(os.path.exists(os.path.join(board0_dir, 'done')))
573 self.assertTrue(os.path.exists(os.path.join(board0_dir, 'out-env')))
575 def testEnvironmentUnicode(self):
576 """Test there are no unicode errors when the env has non-ASCII chars"""
578 varname = b'buildman_test_var'
579 os.environb[varname] = b'strange\x80chars'
580 self.assertEqual(0, self._RunControl('-o', self._output_dir))
581 board0_dir = os.path.join(self._output_dir, 'current', 'board0')
582 self.assertTrue(os.path.exists(os.path.join(board0_dir, 'done')))
583 self.assertTrue(os.path.exists(os.path.join(board0_dir, 'out-env')))
585 del os.environb[varname]
587 def testWorkInOutput(self):
588 """Test the -w option which should write directly to the output dir"""
589 board_list = board.Boards()
590 board_list.AddBoard(board.Board(*boards[0]))
591 self._RunControl('-o', self._output_dir, '-w', clean_dir=False,
594 os.path.exists(os.path.join(self._output_dir, 'u-boot')))
596 os.path.exists(os.path.join(self._output_dir, 'done')))
598 os.path.exists(os.path.join(self._output_dir, 'out-env')))
600 def testWorkInOutputFail(self):
601 """Test the -w option failures"""
602 with self.assertRaises(SystemExit) as e:
603 self._RunControl('-o', self._output_dir, '-w', clean_dir=False)
604 self.assertIn("single board", str(e.exception))
606 os.path.exists(os.path.join(self._output_dir, 'u-boot')))
608 board_list = board.Boards()
609 board_list.AddBoard(board.Board(*boards[0]))
610 with self.assertRaises(SystemExit) as e:
611 self._RunControl('-b', self._test_branch, '-o', self._output_dir,
612 '-w', clean_dir=False, boards=board_list)
613 self.assertIn("single commit", str(e.exception))
615 board_list = board.Boards()
616 board_list.AddBoard(board.Board(*boards[0]))
617 with self.assertRaises(SystemExit) as e:
618 self._RunControl('-w', clean_dir=False)
619 self.assertIn("specify -o", str(e.exception))
621 def testThreadExceptions(self):
622 """Test that exceptions in threads are reported"""
623 with test_util.capture_sys_output() as (stdout, stderr):
624 self.assertEqual(102, self._RunControl('-o', self._output_dir,
625 test_thread_exceptions=True))
627 'Thread exception (use -T0 to run without threads): test exception',