tools/buildman/test.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2012 The Chromium OS Authors.
   3 #
   4
   5 import os
   6 import shutil
   7 import sys
   8 import tempfile
   9 import time
  10 import unittest
  11
  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'))
  15
  16 import board
  17 import bsettings
  18 import builder
  19 import control
  20 import command
  21 import commit
  22 import terminal
  23 import test_util
  24 import toolchain
  25 import tools
  26
  27 use_network = True
  28
  29 settings_data = '''
  30 # Buildman settings file
  31
  32 [toolchain]
  33 main: /usr/sbin
  34
  35 [toolchain-alias]
  36 x86: i386 x86_64
  37 '''
  38
  39 errors = [
  40     '''main.c: In function 'main_loop':
  41 main.c:260:6: warning: unused variable 'joe' [-Wunused-variable]
  42 ''',
  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
  48 Make failed
  49 ''',
  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
  53 ''',
  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
  62 ''',
  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
  76 '''
  77 ]
  78
  79
  80 # hash, subject, return code, list of errors/warnings
  81 commits = [
  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]]],
  89 ]
  90
  91 boards = [
  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', ''],
  97 ]
  98
  99 BASE_DIR = 'base'
 100
 101 OUTCOME_OK, OUTCOME_WARN, OUTCOME_ERR = range(3)
 102
 103 class Options:
 104     """Class that holds build options"""
 105     pass
 106
 107 class TestBuild(unittest.TestCase):
 108     """Test buildman
 109
 110     TODO: Write tests for the rest of the functionality
 111     """
 112     def setUp(self):
 113         # Set up commits to build
 114         self.commits = []
 115         sequence = 0
 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
 122             sequence += 1
 123             self.commits.append(comm)
 124
 125         # Set up boards to build
 126         self.boards = board.Boards()
 127         for brd in boards:
 128             self.boards.AddBoard(board.Board(*brd))
 129         self.boards.SelectBoards([])
 130
 131         # Add some test settings
 132         bsettings.Setup(None)
 133         bsettings.AddFile(settings_data)
 134
 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)
 141
 142         # Avoid sending any output
 143         terminal.SetPrintTestMode()
 144         self._col = terminal.Color()
 145
 146         self.base_dir = tempfile.mkdtemp()
 147         if not os.path.isdir(self.base_dir):
 148             os.mkdir(self.base_dir)
 149
 150     def tearDown(self):
 151         shutil.rmtree(self.base_dir)
 152
 153     def Make(self, commit, brd, stage, *args, **kwargs):
 154         result = command.CommandResult()
 155         boardnum = int(brd.target[-1])
 156         result.return_code = 0
 157         result.stderr = ''
 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/'})
 165
 166         result.combined = result.stdout + result.stderr
 167         return result
 168
 169     def assertSummary(self, text, arch, plus, boards, outcome=OUTCOME_ERR):
 170         col = self._col
 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)
 176         expect += '  '
 177         for board in boards:
 178             expect += col.Color(expected_colour, ' %s' % board)
 179         self.assertEqual(text, expect)
 180
 181     def _SetupTest(self, echo_lines=False, **kwdisplay_args):
 182         """Set up the test by running a build and summary
 183
 184         Args:
 185             echo_lines: True to echo lines to the terminal to aid test
 186                 development
 187             kwdisplay_args: Dict of arguemnts to pass to
 188                 Builder.SetDisplayOptions()
 189
 190         Returns:
 191             Iterator containing the output lines, each a PrintLine() object
 192         """
 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()
 197
 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,
 201                           verbose=False)
 202         lines = terminal.GetPrintTestLines()
 203         count = 0
 204         for line in lines:
 205             if line.text.strip():
 206                 count += 1
 207
 208         # We should get two starting messages, then an update for every commit
 209         # built.
 210         self.assertEqual(count, len(commits) * len(boards) + 2)
 211         build.SetDisplayOptions(**kwdisplay_args);
 212         build.ShowSummary(self.commits, board_selected)
 213         if echo_lines:
 214             terminal.EchoPrintTestLines()
 215         return iter(terminal.GetPrintTestLines())
 216
 217     def _CheckOutput(self, lines):
 218         """Check for expected output from the build summary
 219
 220         Args:
 221             lines: Iterator containing the lines returned from the summary
 222         """
 223         def add_line_prefix(prefix, error_str):
 224             """Add a prefix to each line of a string
 225
 226             The training \n in error_str is removed before processing
 227
 228             Args:
 229                 prefix: String prefix to add
 230                 error_str: Error string containing the lines
 231
 232             Returns:
 233                 New string where each line has the prefix added
 234             """
 235             lines = error_str.strip().splitlines()
 236             new_lines = [prefix + line for line in lines]
 237             return '\n'.join(new_lines)
 238
 239         # Upstream commit: no errors
 240         self.assertEqual(next(lines).text, '01: %s' % commits[0][1])
 241
 242         # Second commit: all archs should fail with warnings
 243         self.assertEqual(next(lines).text, '02: %s' % commits[1][1])
 244
 245         col = terminal.Color()
 246         self.assertSummary(next(lines).text, 'arm', 'w+', ['board1'],
 247                            outcome=OUTCOME_WARN)
 248         self.assertSummary(next(lines).text, 'powerpc', 'w+',
 249                            ['board2', 'board3'], outcome=OUTCOME_WARN)
 250         self.assertSummary(next(lines).text, 'sandbox', 'w+', ['board4'],
 251                            outcome=OUTCOME_WARN)
 252
 253         # Second commit: The warnings should be listed
 254         line = next(lines)
 255
 256         self.assertEqual(line.text, add_line_prefix('w+', errors[0]))
 257         self.assertEqual(line.colour, col.MAGENTA)
 258
 259         # Third commit: Still fails
 260         self.assertEqual(next(lines).text, '03: %s' % commits[2][1])
 261         self.assertSummary(next(lines).text, 'arm', '', ['board1'],
 262                            outcome=OUTCOME_OK)
 263         self.assertSummary(next(lines).text, 'powerpc', '+',
 264                            ['board2', 'board3'])
 265         self.assertSummary(next(lines).text, 'sandbox', '+', ['board4'])
 266
 267         # Expect a compiler error
 268         line = next(lines)
 269         self.assertEqual(line.text, add_line_prefix('+', errors[1]))
 270         self.assertEqual(line.colour, col.RED)
 271
 272         # Fourth commit: Compile errors are fixed, just have warning for board3
 273         self.assertEqual(next(lines).text, '04: %s' % commits[3][1])
 274         expect = '%10s: ' % 'powerpc'
 275         expect += ' ' + col.Color(col.GREEN, '')
 276         expect += '  '
 277         expect += col.Color(col.GREEN, ' %s' % 'board2')
 278         expect += ' ' + col.Color(col.YELLOW, 'w+')
 279         expect += '  '
 280         expect += col.Color(col.YELLOW, ' %s' % 'board3')
 281         self.assertEqual(next(lines).text, expect)
 282         self.assertSummary(next(lines).text, 'sandbox', 'w+', ['board4'],
 283                            outcome=OUTCOME_WARN)
 284
 285         # Compile error fixed
 286         line = next(lines)
 287         self.assertEqual(line.text, add_line_prefix('-', errors[1]))
 288         self.assertEqual(line.colour, col.GREEN)
 289
 290         line = next(lines)
 291         self.assertEqual(line.text, add_line_prefix('w+', errors[2]))
 292         self.assertEqual(line.colour, col.MAGENTA)
 293
 294         # Fifth commit
 295         self.assertEqual(next(lines).text, '05: %s' % commits[4][1])
 296         self.assertSummary(next(lines).text, 'powerpc', '', ['board3'],
 297                            outcome=OUTCOME_OK)
 298         self.assertSummary(next(lines).text, 'sandbox', '+', ['board4'])
 299
 300         # The second line of errors[3] is a duplicate, so buildman will drop it
 301         expect = errors[3].rstrip().split('\n')
 302         expect = [expect[0]] + expect[2:]
 303         expect = '\n'.join(expect)
 304         line = next(lines)
 305         self.assertEqual(line.text, add_line_prefix('+', expect))
 306         self.assertEqual(line.colour, col.RED)
 307
 308         line = next(lines)
 309         self.assertEqual(line.text, add_line_prefix('w-', errors[2]))
 310         self.assertEqual(line.colour, col.CYAN)
 311
 312         # Sixth commit
 313         self.assertEqual(next(lines).text, '06: %s' % commits[5][1])
 314         self.assertSummary(next(lines).text, 'sandbox', '', ['board4'],
 315                            outcome=OUTCOME_OK)
 316
 317         # The second line of errors[3] is a duplicate, so buildman will drop it
 318         expect = errors[3].rstrip().split('\n')
 319         expect = [expect[0]] + expect[2:]
 320         expect = '\n'.join(expect)
 321         line = next(lines)
 322         self.assertEqual(line.text, add_line_prefix('-', expect))
 323         self.assertEqual(line.colour, col.GREEN)
 324
 325         line = next(lines)
 326         self.assertEqual(line.text, add_line_prefix('w-', errors[0]))
 327         self.assertEqual(line.colour, col.CYAN)
 328
 329         # Seventh commit
 330         self.assertEqual(next(lines).text, '07: %s' % commits[6][1])
 331         self.assertSummary(next(lines).text, 'sandbox', '+', ['board4'])
 332
 333         # Pick out the correct error lines
 334         expect_str = errors[4].rstrip().replace('%(basedir)s', '').split('\n')
 335         expect = expect_str[3:8] + [expect_str[-1]]
 336         expect = '\n'.join(expect)
 337         line = next(lines)
 338         self.assertEqual(line.text, add_line_prefix('+', expect))
 339         self.assertEqual(line.colour, col.RED)
 340
 341         # Now the warnings lines
 342         expect = [expect_str[0]] + expect_str[10:12] + [expect_str[9]]
 343         expect = '\n'.join(expect)
 344         line = next(lines)
 345         self.assertEqual(line.text, add_line_prefix('w+', expect))
 346         self.assertEqual(line.colour, col.MAGENTA)
 347
 348     def testOutput(self):
 349         """Test basic builder operation and output
 350
 351         This does a line-by-line verification of the summary output.
 352         """
 353         lines = self._SetupTest(show_errors=True)
 354         self._CheckOutput(lines)
 355
 356     def _testGit(self):
 357         """Test basic builder operation by building a branch"""
 358         options = Options()
 359         options.git = os.getcwd()
 360         options.summary = False
 361         options.jobs = None
 362         options.dry_run = False
 363         #options.git = os.path.join(self.base_dir, 'repo')
 364         options.branch = 'test-buildman'
 365         options.force_build = False
 366         options.list_tool_chains = False
 367         options.count = -1
 368         options.git_dir = None
 369         options.threads = None
 370         options.show_unknown = False
 371         options.quick = False
 372         options.show_errors = False
 373         options.keep_outputs = False
 374         args = ['tegra20']
 375         control.DoBuildman(options, args)
 376
 377     def testBoardSingle(self):
 378         """Test single board selection"""
 379         self.assertEqual(self.boards.SelectBoards(['sandbox']),
 380                          ({'all': ['board4'], 'sandbox': ['board4']}, []))
 381
 382     def testBoardArch(self):
 383         """Test single board selection"""
 384         self.assertEqual(self.boards.SelectBoards(['arm']),
 385                          ({'all': ['board0', 'board1'],
 386                           'arm': ['board0', 'board1']}, []))
 387
 388     def testBoardArchSingle(self):
 389         """Test single board selection"""
 390         self.assertEqual(self.boards.SelectBoards(['arm sandbox']),
 391                          ({'sandbox': ['board4'],
 392                           'all': ['board0', 'board1', 'board4'],
 393                           'arm': ['board0', 'board1']}, []))
 394
 395
 396     def testBoardArchSingleMultiWord(self):
 397         """Test single board selection"""
 398         self.assertEqual(self.boards.SelectBoards(['arm', 'sandbox']),
 399                          ({'sandbox': ['board4'],
 400                           'all': ['board0', 'board1', 'board4'],
 401                           'arm': ['board0', 'board1']}, []))
 402
 403     def testBoardSingleAnd(self):
 404         """Test single board selection"""
 405         self.assertEqual(self.boards.SelectBoards(['Tester & arm']),
 406                          ({'Tester&arm': ['board0', 'board1'],
 407                            'all': ['board0', 'board1']}, []))
 408
 409     def testBoardTwoAnd(self):
 410         """Test single board selection"""
 411         self.assertEqual(self.boards.SelectBoards(['Tester', '&', 'arm',
 412                                                    'Tester' '&', 'powerpc',
 413                                                    'sandbox']),
 414                          ({'sandbox': ['board4'],
 415                           'all': ['board0', 'board1', 'board2', 'board3',
 416                                   'board4'],
 417                           'Tester&powerpc': ['board2', 'board3'],
 418                           'Tester&arm': ['board0', 'board1']}, []))
 419
 420     def testBoardAll(self):
 421         """Test single board selection"""
 422         self.assertEqual(self.boards.SelectBoards([]),
 423                          ({'all': ['board0', 'board1', 'board2', 'board3',
 424                                   'board4']}, []))
 425
 426     def testBoardRegularExpression(self):
 427         """Test single board selection"""
 428         self.assertEqual(self.boards.SelectBoards(['T.*r&^Po']),
 429                          ({'all': ['board2', 'board3'],
 430                           'T.*r&^Po': ['board2', 'board3']}, []))
 431
 432     def testBoardDuplicate(self):
 433         """Test single board selection"""
 434         self.assertEqual(self.boards.SelectBoards(['sandbox sandbox',
 435                                                    'sandbox']),
 436                          ({'all': ['board4'], 'sandbox': ['board4']}, []))
 437     def CheckDirs(self, build, dirname):
 438         self.assertEqual('base%s' % dirname, build._GetOutputDir(1))
 439         self.assertEqual('base%s/fred' % dirname,
 440                          build.GetBuildDir(1, 'fred'))
 441         self.assertEqual('base%s/fred/done' % dirname,
 442                          build.GetDoneFile(1, 'fred'))
 443         self.assertEqual('base%s/fred/u-boot.sizes' % dirname,
 444                          build.GetFuncSizesFile(1, 'fred', 'u-boot'))
 445         self.assertEqual('base%s/fred/u-boot.objdump' % dirname,
 446                          build.GetObjdumpFile(1, 'fred', 'u-boot'))
 447         self.assertEqual('base%s/fred/err' % dirname,
 448                          build.GetErrFile(1, 'fred'))
 449
 450     def testOutputDir(self):
 451         build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
 452                                 checkout=False, show_unknown=False)
 453         build.commits = self.commits
 454         build.commit_count = len(self.commits)
 455         subject = self.commits[1].subject.translate(builder.trans_valid_chars)
 456         dirname ='/%02d_of_%02d_g%s_%s' % (2, build.commit_count, commits[1][0],
 457                                            subject[:20])
 458         self.CheckDirs(build, dirname)
 459
 460     def testOutputDirCurrent(self):
 461         build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
 462                                 checkout=False, show_unknown=False)
 463         build.commits = None
 464         build.commit_count = 0
 465         self.CheckDirs(build, '/current')
 466
 467     def testOutputDirNoSubdirs(self):
 468         build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
 469                                 checkout=False, show_unknown=False,
 470                                 no_subdirs=True)
 471         build.commits = None
 472         build.commit_count = 0
 473         self.CheckDirs(build, '')
 474
 475     def testToolchainAliases(self):
 476         self.assertTrue(self.toolchains.Select('arm') != None)
 477         with self.assertRaises(ValueError):
 478             self.toolchains.Select('no-arch')
 479         with self.assertRaises(ValueError):
 480             self.toolchains.Select('x86')
 481
 482         self.toolchains = toolchain.Toolchains()
 483         self.toolchains.Add('x86_64-linux-gcc', test=False)
 484         self.assertTrue(self.toolchains.Select('x86') != None)
 485
 486         self.toolchains = toolchain.Toolchains()
 487         self.toolchains.Add('i386-linux-gcc', test=False)
 488         self.assertTrue(self.toolchains.Select('x86') != None)
 489
 490     def testToolchainDownload(self):
 491         """Test that we can download toolchains"""
 492         if use_network:
 493             with test_util.capture_sys_output() as (stdout, stderr):
 494                 url = self.toolchains.LocateArchUrl('arm')
 495             self.assertRegexpMatches(url, 'https://www.kernel.org/pub/tools/'
 496                     'crosstool/files/bin/x86_64/.*/'
 497                     'x86_64-gcc-.*-nolibc_arm-.*linux-gnueabi.tar.xz')
 498
 499     def testGetEnvArgs(self):
 500         """Test the GetEnvArgs() function"""
 501         tc = self.toolchains.Select('arm')
 502         self.assertEqual('arm-linux-',
 503                          tc.GetEnvArgs(toolchain.VAR_CROSS_COMPILE))
 504         self.assertEqual('', tc.GetEnvArgs(toolchain.VAR_PATH))
 505         self.assertEqual('arm',
 506                          tc.GetEnvArgs(toolchain.VAR_ARCH))
 507         self.assertEqual('', tc.GetEnvArgs(toolchain.VAR_MAKE_ARGS))
 508
 509         self.toolchains.Add('/path/to/x86_64-linux-gcc', test=False)
 510         tc = self.toolchains.Select('x86')
 511         self.assertEqual('/path/to',
 512                          tc.GetEnvArgs(toolchain.VAR_PATH))
 513         tc.override_toolchain = 'clang'
 514         self.assertEqual('HOSTCC=clang CC=clang',
 515                          tc.GetEnvArgs(toolchain.VAR_MAKE_ARGS))
 516
 517     def testPrepareOutputSpace(self):
 518         def _Touch(fname):
 519             tools.WriteFile(os.path.join(base_dir, fname), b'')
 520
 521         base_dir = tempfile.mkdtemp()
 522
 523         # Add various files that we want removed and left alone
 524         to_remove = ['01_of_22_g0982734987_title', '102_of_222_g92bf_title',
 525                      '01_of_22_g2938abd8_title']
 526         to_leave = ['something_else', '01-something.patch', '01_of_22_another']
 527         for name in to_remove + to_leave:
 528             _Touch(name)
 529
 530         build = builder.Builder(self.toolchains, base_dir, None, 1, 2)
 531         build.commits = self.commits
 532         build.commit_count = len(commits)
 533         result = set(build._GetOutputSpaceRemovals())
 534         expected = set([os.path.join(base_dir, f) for f in to_remove])
 535         self.assertEqual(expected, result)
 536
 537 if __name__ == "__main__":
 538     unittest.main()