1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2012 The Chromium OS Authors.
12 # Bring in the patman libraries
13 our_path = os.path.dirname(os.path.realpath(__file__))
14 sys.path.append(os.path.join(our_path, '../patman'))
30 # Buildman settings file
40 '''main.c: In function 'main_loop':
41 main.c:260:6: warning: unused variable 'joe' [-Wunused-variable]
43 '''main.c: In function 'main_loop2':
44 main.c:295:2: error: 'fred' undeclared (first use in this function)
45 main.c:295:2: note: each undeclared identifier is reported only once for each function it appears in
46 make[1]: *** [main.o] Error 1
47 make: *** [common/libcommon.o] Error 2
50 '''arch/arm/dts/socfpga_arria10_socdk_sdmmc.dtb: Warning \
51 (avoid_unnecessary_addr_size): /clocks: unnecessary #address-cells/#size-cells \
52 without "ranges" or child "reg" property
54 '''powerpc-linux-ld: warning: dot moved backwards before `.bss'
55 powerpc-linux-ld: warning: dot moved backwards before `.bss'
56 powerpc-linux-ld: u-boot: section .text lma 0xfffc0000 overlaps previous sections
57 powerpc-linux-ld: u-boot: section .rodata lma 0xfffef3ec overlaps previous sections
58 powerpc-linux-ld: u-boot: section .reloc lma 0xffffa400 overlaps previous sections
59 powerpc-linux-ld: u-boot: section .data lma 0xffffcd38 overlaps previous sections
60 powerpc-linux-ld: u-boot: section .u_boot_cmd lma 0xffffeb40 overlaps previous sections
61 powerpc-linux-ld: u-boot: section .bootpg lma 0xfffff198 overlaps previous sections
63 '''In file included from %(basedir)sarch/sandbox/cpu/cpu.c:9:0:
64 %(basedir)sarch/sandbox/include/asm/state.h:44:0: warning: "xxxx" redefined [enabled by default]
65 %(basedir)sarch/sandbox/include/asm/state.h:43:0: note: this is the location of the previous definition
66 %(basedir)sarch/sandbox/cpu/cpu.c: In function 'do_reset':
67 %(basedir)sarch/sandbox/cpu/cpu.c:27:1: error: unknown type name 'blah'
68 %(basedir)sarch/sandbox/cpu/cpu.c:28:12: error: expected declaration specifiers or '...' before numeric constant
69 make[2]: *** [arch/sandbox/cpu/cpu.o] Error 1
70 make[1]: *** [arch/sandbox/cpu] Error 2
71 make[1]: *** Waiting for unfinished jobs....
72 In file included from %(basedir)scommon/board_f.c:55:0:
73 %(basedir)sarch/sandbox/include/asm/state.h:44:0: warning: "xxxx" redefined [enabled by default]
74 %(basedir)sarch/sandbox/include/asm/state.h:43:0: note: this is the location of the previous definition
75 make: *** [sub-make] Error 2
80 # hash, subject, return code, list of errors/warnings
82 ['1234', 'upstream/master, ok', 0, []],
83 ['5678', 'Second commit, a warning', 0, errors[0:1]],
84 ['9012', 'Third commit, error', 1, errors[0:2]],
85 ['3456', 'Fourth commit, warning', 0, [errors[0], errors[2]]],
86 ['7890', 'Fifth commit, link errors', 1, [errors[0], errors[3]]],
87 ['abcd', 'Sixth commit, fixes all errors', 0, []],
88 ['ef01', 'Seventh commit, check directory suppression', 1, [errors[4]]],
92 ['Active', 'arm', 'armv7', '', 'Tester', 'ARM Board 1', 'board0', ''],
93 ['Active', 'arm', 'armv7', '', 'Tester', 'ARM Board 2', 'board1', ''],
94 ['Active', 'powerpc', 'powerpc', '', 'Tester', 'PowerPC board 1', 'board2', ''],
95 ['Active', 'powerpc', 'mpc83xx', '', 'Tester', 'PowerPC board 2', 'board3', ''],
96 ['Active', 'sandbox', 'sandbox', '', 'Tester', 'Sandbox board', 'board4', ''],
101 OUTCOME_OK, OUTCOME_WARN, OUTCOME_ERR = range(3)
104 """Class that holds build options"""
107 class TestBuild(unittest.TestCase):
110 TODO: Write tests for the rest of the functionality
113 # Set up commits to build
116 for commit_info in commits:
117 comm = commit.Commit(commit_info[0])
118 comm.subject = commit_info[1]
119 comm.return_code = commit_info[2]
120 comm.error_list = commit_info[3]
121 comm.sequence = sequence
123 self.commits.append(comm)
125 # Set up boards to build
126 self.boards = board.Boards()
128 self.boards.AddBoard(board.Board(*brd))
129 self.boards.SelectBoards([])
131 # Add some test settings
132 bsettings.Setup(None)
133 bsettings.AddFile(settings_data)
135 # Set up the toolchains
136 self.toolchains = toolchain.Toolchains()
137 self.toolchains.Add('arm-linux-gcc', test=False)
138 self.toolchains.Add('sparc-linux-gcc', test=False)
139 self.toolchains.Add('powerpc-linux-gcc', test=False)
140 self.toolchains.Add('gcc', test=False)
142 # Avoid sending any output
143 terminal.SetPrintTestMode()
144 self._col = terminal.Color()
146 self.base_dir = tempfile.mkdtemp()
147 if not os.path.isdir(self.base_dir):
148 os.mkdir(self.base_dir)
151 shutil.rmtree(self.base_dir)
153 def Make(self, commit, brd, stage, *args, **kwargs):
154 result = command.CommandResult()
155 boardnum = int(brd.target[-1])
156 result.return_code = 0
158 result.stdout = ('This is the test output for board %s, commit %s' %
159 (brd.target, commit.hash))
160 if ((boardnum >= 1 and boardnum >= commit.sequence) or
161 boardnum == 4 and commit.sequence == 6):
162 result.return_code = commit.return_code
163 result.stderr = (''.join(commit.error_list)
164 % {'basedir' : self.base_dir + '/.bm-work/00/'})
166 result.combined = result.stdout + result.stderr
169 def assertSummary(self, text, arch, plus, boards, outcome=OUTCOME_ERR):
171 expected_colour = (col.GREEN if outcome == OUTCOME_OK else
172 col.YELLOW if outcome == OUTCOME_WARN else col.RED)
173 expect = '%10s: ' % arch
174 # TODO(sjg@chromium.org): If plus is '', we shouldn't need this
175 expect += ' ' + col.Color(expected_colour, plus)
178 expect += col.Color(expected_colour, ' %s' % board)
179 self.assertEqual(text, expect)
181 def _SetupTest(self, echo_lines=False, **kwdisplay_args):
182 """Set up the test by running a build and summary
185 echo_lines: True to echo lines to the terminal to aid test
187 kwdisplay_args: Dict of arguemnts to pass to
188 Builder.SetDisplayOptions()
191 Iterator containing the output lines, each a PrintLine() object
193 build = builder.Builder(self.toolchains, self.base_dir, None, 1, 2,
194 checkout=False, show_unknown=False)
195 build.do_make = self.Make
196 board_selected = self.boards.GetSelectedDict()
198 # Build the boards for the pre-defined commits and warnings/errors
199 # associated with each. This calls our Make() to inject the fake output.
200 build.BuildBoards(self.commits, board_selected, keep_outputs=False,
202 lines = terminal.GetPrintTestLines()
205 if line.text.strip():
208 # We should get two starting messages, then an update for every commit
210 self.assertEqual(count, len(commits) * len(boards) + 2)
211 build.SetDisplayOptions(**kwdisplay_args);
212 build.ShowSummary(self.commits, board_selected)
214 terminal.EchoPrintTestLines()
215 return iter(terminal.GetPrintTestLines())
217 def _CheckOutput(self, lines, list_error_boards):
218 """Check for expected output from the build summary
221 lines: Iterator containing the lines returned from the summary
222 list_error_boards: Adjust the check for output produced with the
223 --list-error-boards flag
225 def add_line_prefix(prefix, boards, error_str):
226 """Add a prefix to each line of a string
228 The training \n in error_str is removed before processing
231 prefix: String prefix to add
232 error_str: Error string containing the lines
235 New string where each line has the prefix added
238 boards = '(%s) ' % boards
239 lines = error_str.strip().splitlines()
240 new_lines = [prefix + boards + line for line in lines]
241 return '\n'.join(new_lines)
243 boards1234 = 'board1,board2,board3,board4' if list_error_boards else ''
244 boards234 = 'board2,board3,board4' if list_error_boards else ''
245 boards34 = 'board3,board4' if list_error_boards else ''
246 boards4 = 'board4' if list_error_boards else ''
248 # Upstream commit: no errors
249 self.assertEqual(next(lines).text, '01: %s' % commits[0][1])
251 # Second commit: all archs should fail with warnings
252 self.assertEqual(next(lines).text, '02: %s' % commits[1][1])
254 col = terminal.Color()
255 self.assertSummary(next(lines).text, 'arm', 'w+', ['board1'],
256 outcome=OUTCOME_WARN)
257 self.assertSummary(next(lines).text, 'powerpc', 'w+',
258 ['board2', 'board3'], outcome=OUTCOME_WARN)
259 self.assertSummary(next(lines).text, 'sandbox', 'w+', ['board4'],
260 outcome=OUTCOME_WARN)
262 # Second commit: The warnings should be listed
265 self.assertEqual(line.text,
266 add_line_prefix('w+', boards1234, errors[0]))
267 self.assertEqual(line.colour, col.MAGENTA)
269 # Third commit: Still fails
270 self.assertEqual(next(lines).text, '03: %s' % commits[2][1])
271 self.assertSummary(next(lines).text, 'arm', '', ['board1'],
273 self.assertSummary(next(lines).text, 'powerpc', '+',
274 ['board2', 'board3'])
275 self.assertSummary(next(lines).text, 'sandbox', '+', ['board4'])
277 # Expect a compiler error
279 self.assertEqual(line.text, add_line_prefix('+', boards234, errors[1]))
280 self.assertEqual(line.colour, col.RED)
282 # Fourth commit: Compile errors are fixed, just have warning for board3
283 self.assertEqual(next(lines).text, '04: %s' % commits[3][1])
284 expect = '%10s: ' % 'powerpc'
285 expect += ' ' + col.Color(col.GREEN, '')
287 expect += col.Color(col.GREEN, ' %s' % 'board2')
288 expect += ' ' + col.Color(col.YELLOW, 'w+')
290 expect += col.Color(col.YELLOW, ' %s' % 'board3')
291 self.assertEqual(next(lines).text, expect)
292 self.assertSummary(next(lines).text, 'sandbox', 'w+', ['board4'],
293 outcome=OUTCOME_WARN)
295 # Compile error fixed
297 self.assertEqual(line.text, add_line_prefix('-', boards234, errors[1]))
298 self.assertEqual(line.colour, col.GREEN)
301 self.assertEqual(line.text, add_line_prefix('w+', boards34, errors[2]))
302 self.assertEqual(line.colour, col.MAGENTA)
305 self.assertEqual(next(lines).text, '05: %s' % commits[4][1])
306 self.assertSummary(next(lines).text, 'powerpc', '', ['board3'],
308 self.assertSummary(next(lines).text, 'sandbox', '+', ['board4'])
310 # The second line of errors[3] is a duplicate, so buildman will drop it
311 expect = errors[3].rstrip().split('\n')
312 expect = [expect[0]] + expect[2:]
313 expect = '\n'.join(expect)
315 self.assertEqual(line.text, add_line_prefix('+', boards4, expect))
316 self.assertEqual(line.colour, col.RED)
319 self.assertEqual(line.text, add_line_prefix('w-', boards34, errors[2]))
320 self.assertEqual(line.colour, col.CYAN)
323 self.assertEqual(next(lines).text, '06: %s' % commits[5][1])
324 self.assertSummary(next(lines).text, 'sandbox', '', ['board4'],
327 # The second line of errors[3] is a duplicate, so buildman will drop it
328 expect = errors[3].rstrip().split('\n')
329 expect = [expect[0]] + expect[2:]
330 expect = '\n'.join(expect)
332 self.assertEqual(line.text, add_line_prefix('-', boards4, expect))
333 self.assertEqual(line.colour, col.GREEN)
336 self.assertEqual(line.text, add_line_prefix('w-', boards4, errors[0]))
337 self.assertEqual(line.colour, col.CYAN)
340 self.assertEqual(next(lines).text, '07: %s' % commits[6][1])
341 self.assertSummary(next(lines).text, 'sandbox', '+', ['board4'])
343 # Pick out the correct error lines
344 expect_str = errors[4].rstrip().replace('%(basedir)s', '').split('\n')
345 expect = expect_str[3:8] + [expect_str[-1]]
346 expect = '\n'.join(expect)
348 self.assertEqual(line.text, add_line_prefix('+', boards4, expect))
349 self.assertEqual(line.colour, col.RED)
351 # Now the warnings lines
352 expect = [expect_str[0]] + expect_str[10:12] + [expect_str[9]]
353 expect = '\n'.join(expect)
355 self.assertEqual(line.text, add_line_prefix('w+', boards4, expect))
356 self.assertEqual(line.colour, col.MAGENTA)
358 def testOutput(self):
359 """Test basic builder operation and output
361 This does a line-by-line verification of the summary output.
363 lines = self._SetupTest(show_errors=True)
364 self._CheckOutput(lines, list_error_boards=False)
366 def testErrorBoards(self):
367 """Test output with --list-error-boards
369 This does a line-by-line verification of the summary output.
371 lines = self._SetupTest(show_errors=True, list_error_boards=True)
372 self._CheckOutput(lines, list_error_boards=True)
375 """Test basic builder operation by building a branch"""
377 options.git = os.getcwd()
378 options.summary = False
380 options.dry_run = False
381 #options.git = os.path.join(self.base_dir, 'repo')
382 options.branch = 'test-buildman'
383 options.force_build = False
384 options.list_tool_chains = False
386 options.git_dir = None
387 options.threads = None
388 options.show_unknown = False
389 options.quick = False
390 options.show_errors = False
391 options.keep_outputs = False
393 control.DoBuildman(options, args)
395 def testBoardSingle(self):
396 """Test single board selection"""
397 self.assertEqual(self.boards.SelectBoards(['sandbox']),
398 ({'all': ['board4'], 'sandbox': ['board4']}, []))
400 def testBoardArch(self):
401 """Test single board selection"""
402 self.assertEqual(self.boards.SelectBoards(['arm']),
403 ({'all': ['board0', 'board1'],
404 'arm': ['board0', 'board1']}, []))
406 def testBoardArchSingle(self):
407 """Test single board selection"""
408 self.assertEqual(self.boards.SelectBoards(['arm sandbox']),
409 ({'sandbox': ['board4'],
410 'all': ['board0', 'board1', 'board4'],
411 'arm': ['board0', 'board1']}, []))
414 def testBoardArchSingleMultiWord(self):
415 """Test single board selection"""
416 self.assertEqual(self.boards.SelectBoards(['arm', 'sandbox']),
417 ({'sandbox': ['board4'],
418 'all': ['board0', 'board1', 'board4'],
419 'arm': ['board0', 'board1']}, []))
421 def testBoardSingleAnd(self):
422 """Test single board selection"""
423 self.assertEqual(self.boards.SelectBoards(['Tester & arm']),
424 ({'Tester&arm': ['board0', 'board1'],
425 'all': ['board0', 'board1']}, []))
427 def testBoardTwoAnd(self):
428 """Test single board selection"""
429 self.assertEqual(self.boards.SelectBoards(['Tester', '&', 'arm',
430 'Tester' '&', 'powerpc',
432 ({'sandbox': ['board4'],
433 'all': ['board0', 'board1', 'board2', 'board3',
435 'Tester&powerpc': ['board2', 'board3'],
436 'Tester&arm': ['board0', 'board1']}, []))
438 def testBoardAll(self):
439 """Test single board selection"""
440 self.assertEqual(self.boards.SelectBoards([]),
441 ({'all': ['board0', 'board1', 'board2', 'board3',
444 def testBoardRegularExpression(self):
445 """Test single board selection"""
446 self.assertEqual(self.boards.SelectBoards(['T.*r&^Po']),
447 ({'all': ['board2', 'board3'],
448 'T.*r&^Po': ['board2', 'board3']}, []))
450 def testBoardDuplicate(self):
451 """Test single board selection"""
452 self.assertEqual(self.boards.SelectBoards(['sandbox sandbox',
454 ({'all': ['board4'], 'sandbox': ['board4']}, []))
455 def CheckDirs(self, build, dirname):
456 self.assertEqual('base%s' % dirname, build._GetOutputDir(1))
457 self.assertEqual('base%s/fred' % dirname,
458 build.GetBuildDir(1, 'fred'))
459 self.assertEqual('base%s/fred/done' % dirname,
460 build.GetDoneFile(1, 'fred'))
461 self.assertEqual('base%s/fred/u-boot.sizes' % dirname,
462 build.GetFuncSizesFile(1, 'fred', 'u-boot'))
463 self.assertEqual('base%s/fred/u-boot.objdump' % dirname,
464 build.GetObjdumpFile(1, 'fred', 'u-boot'))
465 self.assertEqual('base%s/fred/err' % dirname,
466 build.GetErrFile(1, 'fred'))
468 def testOutputDir(self):
469 build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
470 checkout=False, show_unknown=False)
471 build.commits = self.commits
472 build.commit_count = len(self.commits)
473 subject = self.commits[1].subject.translate(builder.trans_valid_chars)
474 dirname ='/%02d_of_%02d_g%s_%s' % (2, build.commit_count, commits[1][0],
476 self.CheckDirs(build, dirname)
478 def testOutputDirCurrent(self):
479 build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
480 checkout=False, show_unknown=False)
482 build.commit_count = 0
483 self.CheckDirs(build, '/current')
485 def testOutputDirNoSubdirs(self):
486 build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
487 checkout=False, show_unknown=False,
490 build.commit_count = 0
491 self.CheckDirs(build, '')
493 def testToolchainAliases(self):
494 self.assertTrue(self.toolchains.Select('arm') != None)
495 with self.assertRaises(ValueError):
496 self.toolchains.Select('no-arch')
497 with self.assertRaises(ValueError):
498 self.toolchains.Select('x86')
500 self.toolchains = toolchain.Toolchains()
501 self.toolchains.Add('x86_64-linux-gcc', test=False)
502 self.assertTrue(self.toolchains.Select('x86') != None)
504 self.toolchains = toolchain.Toolchains()
505 self.toolchains.Add('i386-linux-gcc', test=False)
506 self.assertTrue(self.toolchains.Select('x86') != None)
508 def testToolchainDownload(self):
509 """Test that we can download toolchains"""
511 with test_util.capture_sys_output() as (stdout, stderr):
512 url = self.toolchains.LocateArchUrl('arm')
513 self.assertRegexpMatches(url, 'https://www.kernel.org/pub/tools/'
514 'crosstool/files/bin/x86_64/.*/'
515 'x86_64-gcc-.*-nolibc_arm-.*linux-gnueabi.tar.xz')
517 def testGetEnvArgs(self):
518 """Test the GetEnvArgs() function"""
519 tc = self.toolchains.Select('arm')
520 self.assertEqual('arm-linux-',
521 tc.GetEnvArgs(toolchain.VAR_CROSS_COMPILE))
522 self.assertEqual('', tc.GetEnvArgs(toolchain.VAR_PATH))
523 self.assertEqual('arm',
524 tc.GetEnvArgs(toolchain.VAR_ARCH))
525 self.assertEqual('', tc.GetEnvArgs(toolchain.VAR_MAKE_ARGS))
527 self.toolchains.Add('/path/to/x86_64-linux-gcc', test=False)
528 tc = self.toolchains.Select('x86')
529 self.assertEqual('/path/to',
530 tc.GetEnvArgs(toolchain.VAR_PATH))
531 tc.override_toolchain = 'clang'
532 self.assertEqual('HOSTCC=clang CC=clang',
533 tc.GetEnvArgs(toolchain.VAR_MAKE_ARGS))
535 def testPrepareOutputSpace(self):
537 tools.WriteFile(os.path.join(base_dir, fname), b'')
539 base_dir = tempfile.mkdtemp()
541 # Add various files that we want removed and left alone
542 to_remove = ['01_of_22_g0982734987_title', '102_of_222_g92bf_title',
543 '01_of_22_g2938abd8_title']
544 to_leave = ['something_else', '01-something.patch', '01_of_22_another']
545 for name in to_remove + to_leave:
548 build = builder.Builder(self.toolchains, base_dir, None, 1, 2)
549 build.commits = self.commits
550 build.commit_count = len(commits)
551 result = set(build._GetOutputSpaceRemovals())
552 expected = set([os.path.join(base_dir, f) for f in to_remove])
553 self.assertEqual(expected, result)
555 if __name__ == "__main__":