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
  26 use_network = True
  27
  28 settings_data = '''
  29 # Buildman settings file
  30
  31 [toolchain]
  32 main: /usr/sbin
  33
  34 [toolchain-alias]
  35 x86: i386 x86_64
  36 '''
  37
  38 errors = [
  39     '''main.c: In function 'main_loop':
  40 main.c:260:6: warning: unused variable 'joe' [-Wunused-variable]
  41 ''',
  42     '''main.c: In function 'main_loop2':
  43 main.c:295:2: error: 'fred' undeclared (first use in this function)
  44 main.c:295:2: note: each undeclared identifier is reported only once for each function it appears in
  45 make[1]: *** [main.o] Error 1
  46 make: *** [common/libcommon.o] Error 2
  47 Make failed
  48 ''',
  49     '''arch/arm/dts/socfpga_arria10_socdk_sdmmc.dtb: Warning \
  50 (avoid_unnecessary_addr_size): /clocks: unnecessary #address-cells/#size-cells \
  51 without "ranges" or child "reg" property
  52 ''',
  53     '''powerpc-linux-ld: warning: dot moved backwards before `.bss'
  54 powerpc-linux-ld: warning: dot moved backwards before `.bss'
  55 powerpc-linux-ld: u-boot: section .text lma 0xfffc0000 overlaps previous sections
  56 powerpc-linux-ld: u-boot: section .rodata lma 0xfffef3ec overlaps previous sections
  57 powerpc-linux-ld: u-boot: section .reloc lma 0xffffa400 overlaps previous sections
  58 powerpc-linux-ld: u-boot: section .data lma 0xffffcd38 overlaps previous sections
  59 powerpc-linux-ld: u-boot: section .u_boot_cmd lma 0xffffeb40 overlaps previous sections
  60 powerpc-linux-ld: u-boot: section .bootpg lma 0xfffff198 overlaps previous sections
  61 ''',
  62    '''In file included from %(basedir)sarch/sandbox/cpu/cpu.c:9:0:
  63 %(basedir)sarch/sandbox/include/asm/state.h:44:0: warning: "xxxx" redefined [enabled by default]
  64 %(basedir)sarch/sandbox/include/asm/state.h:43:0: note: this is the location of the previous definition
  65 %(basedir)sarch/sandbox/cpu/cpu.c: In function 'do_reset':
  66 %(basedir)sarch/sandbox/cpu/cpu.c:27:1: error: unknown type name 'blah'
  67 %(basedir)sarch/sandbox/cpu/cpu.c:28:12: error: expected declaration specifiers or '...' before numeric constant
  68 make[2]: *** [arch/sandbox/cpu/cpu.o] Error 1
  69 make[1]: *** [arch/sandbox/cpu] Error 2
  70 make[1]: *** Waiting for unfinished jobs....
  71 In file included from %(basedir)scommon/board_f.c:55:0:
  72 %(basedir)sarch/sandbox/include/asm/state.h:44:0: warning: "xxxx" redefined [enabled by default]
  73 %(basedir)sarch/sandbox/include/asm/state.h:43:0: note: this is the location of the previous definition
  74 make: *** [sub-make] Error 2
  75 '''
  76 ]
  77
  78
  79 # hash, subject, return code, list of errors/warnings
  80 commits = [
  81     ['1234', 'upstream/master, ok', 0, []],
  82     ['5678', 'Second commit, a warning', 0, errors[0:1]],
  83     ['9012', 'Third commit, error', 1, errors[0:2]],
  84     ['3456', 'Fourth commit, warning', 0, [errors[0], errors[2]]],
  85     ['7890', 'Fifth commit, link errors', 1, [errors[0], errors[3]]],
  86     ['abcd', 'Sixth commit, fixes all errors', 0, []],
  87     ['ef01', 'Seventh commit, check directory suppression', 1, [errors[4]]],
  88 ]
  89
  90 boards = [
  91     ['Active', 'arm', 'armv7', '', 'Tester', 'ARM Board 1', 'board0',  ''],
  92     ['Active', 'arm', 'armv7', '', 'Tester', 'ARM Board 2', 'board1', ''],
  93     ['Active', 'powerpc', 'powerpc', '', 'Tester', 'PowerPC board 1', 'board2', ''],
  94     ['Active', 'powerpc', 'mpc83xx', '', 'Tester', 'PowerPC board 2', 'board3', ''],
  95     ['Active', 'sandbox', 'sandbox', '', 'Tester', 'Sandbox board', 'board4', ''],
  96 ]
  97
  98 BASE_DIR = 'base'
  99
 100 OUTCOME_OK, OUTCOME_WARN, OUTCOME_ERR = range(3)
 101
 102 class Options:
 103     """Class that holds build options"""
 104     pass
 105
 106 class TestBuild(unittest.TestCase):
 107     """Test buildman
 108
 109     TODO: Write tests for the rest of the functionality
 110     """
 111     def setUp(self):
 112         # Set up commits to build
 113         self.commits = []
 114         sequence = 0
 115         for commit_info in commits:
 116             comm = commit.Commit(commit_info[0])
 117             comm.subject = commit_info[1]
 118             comm.return_code = commit_info[2]
 119             comm.error_list = commit_info[3]
 120             comm.sequence = sequence
 121             sequence += 1
 122             self.commits.append(comm)
 123
 124         # Set up boards to build
 125         self.boards = board.Boards()
 126         for brd in boards:
 127             self.boards.AddBoard(board.Board(*brd))
 128         self.boards.SelectBoards([])
 129
 130         # Add some test settings
 131         bsettings.Setup(None)
 132         bsettings.AddFile(settings_data)
 133
 134         # Set up the toolchains
 135         self.toolchains = toolchain.Toolchains()
 136         self.toolchains.Add('arm-linux-gcc', test=False)
 137         self.toolchains.Add('sparc-linux-gcc', test=False)
 138         self.toolchains.Add('powerpc-linux-gcc', test=False)
 139         self.toolchains.Add('gcc', test=False)
 140
 141         # Avoid sending any output
 142         terminal.SetPrintTestMode()
 143         self._col = terminal.Color()
 144
 145     def Make(self, commit, brd, stage, *args, **kwargs):
 146         global base_dir
 147
 148         result = command.CommandResult()
 149         boardnum = int(brd.target[-1])
 150         result.return_code = 0
 151         result.stderr = ''
 152         result.stdout = ('This is the test output for board %s, commit %s' %
 153                 (brd.target, commit.hash))
 154         if ((boardnum >= 1 and boardnum >= commit.sequence) or
 155                 boardnum == 4 and commit.sequence == 6):
 156             result.return_code = commit.return_code
 157             result.stderr = (''.join(commit.error_list)
 158                 % {'basedir' : base_dir + '/.bm-work/00/'})
 159
 160         result.combined = result.stdout + result.stderr
 161         return result
 162
 163     def assertSummary(self, text, arch, plus, boards, outcome=OUTCOME_ERR):
 164         col = self._col
 165         expected_colour = (col.GREEN if outcome == OUTCOME_OK else
 166                            col.YELLOW if outcome == OUTCOME_WARN else col.RED)
 167         expect = '%10s: ' % arch
 168         # TODO(sjg@chromium.org): If plus is '', we shouldn't need this
 169         expect += ' ' + col.Color(expected_colour, plus)
 170         expect += '  '
 171         for board in boards:
 172             expect += col.Color(expected_colour, ' %s' % board)
 173         self.assertEqual(text, expect)
 174
 175     def testOutput(self):
 176         """Test basic builder operation and output
 177
 178         This does a line-by-line verification of the summary output.
 179         """
 180         global base_dir
 181
 182         base_dir = tempfile.mkdtemp()
 183         if not os.path.isdir(base_dir):
 184             os.mkdir(base_dir)
 185         build = builder.Builder(self.toolchains, base_dir, None, 1, 2,
 186                                 checkout=False, show_unknown=False)
 187         build.do_make = self.Make
 188         board_selected = self.boards.GetSelectedDict()
 189
 190         # Build the boards for the pre-defined commits and warnings/errors
 191         # associated with each. This calls our Make() to inject the fake output.
 192         build.BuildBoards(self.commits, board_selected, keep_outputs=False,
 193                           verbose=False)
 194         lines = terminal.GetPrintTestLines()
 195         count = 0
 196         for line in lines:
 197             if line.text.strip():
 198                 count += 1
 199
 200         # We should get two starting messages, then an update for every commit
 201         # built.
 202         self.assertEqual(count, len(commits) * len(boards) + 2)
 203         build.SetDisplayOptions(show_errors=True);
 204         build.ShowSummary(self.commits, board_selected)
 205         #terminal.EchoPrintTestLines()
 206         lines = terminal.GetPrintTestLines()
 207
 208         # Upstream commit: no errors
 209         self.assertEqual(lines[0].text, '01: %s' % commits[0][1])
 210
 211         # Second commit: all archs should fail with warnings
 212         self.assertEqual(lines[1].text, '02: %s' % commits[1][1])
 213
 214         col = terminal.Color()
 215         self.assertSummary(lines[2].text, 'sandbox', 'w+', ['board4'],
 216                            outcome=OUTCOME_WARN)
 217         self.assertSummary(lines[3].text, 'arm', 'w+', ['board1'],
 218                            outcome=OUTCOME_WARN)
 219         self.assertSummary(lines[4].text, 'powerpc', 'w+', ['board2', 'board3'],
 220                            outcome=OUTCOME_WARN)
 221
 222         # Second commit: The warnings should be listed
 223         self.assertEqual(lines[5].text, 'w+%s' %
 224                 errors[0].rstrip().replace('\n', '\nw+'))
 225         self.assertEqual(lines[5].colour, col.MAGENTA)
 226
 227         # Third commit: Still fails
 228         self.assertEqual(lines[6].text, '03: %s' % commits[2][1])
 229         self.assertSummary(lines[7].text, 'sandbox', '+', ['board4'])
 230         self.assertSummary(lines[8].text, 'arm', '', ['board1'],
 231                            outcome=OUTCOME_OK)
 232         self.assertSummary(lines[9].text, 'powerpc', '+', ['board2', 'board3'])
 233
 234         # Expect a compiler error
 235         self.assertEqual(lines[10].text, '+%s' %
 236                 errors[1].rstrip().replace('\n', '\n+'))
 237
 238         # Fourth commit: Compile errors are fixed, just have warning for board3
 239         self.assertEqual(lines[11].text, '04: %s' % commits[3][1])
 240         self.assertSummary(lines[12].text, 'sandbox', 'w+', ['board4'],
 241                            outcome=OUTCOME_WARN)
 242         expect = '%10s: ' % 'powerpc'
 243         expect += ' ' + col.Color(col.GREEN, '')
 244         expect += '  '
 245         expect += col.Color(col.GREEN, ' %s' % 'board2')
 246         expect += ' ' + col.Color(col.YELLOW, 'w+')
 247         expect += '  '
 248         expect += col.Color(col.YELLOW, ' %s' % 'board3')
 249         self.assertEqual(lines[13].text, expect)
 250
 251         # Compile error fixed
 252         self.assertEqual(lines[14].text, '-%s' %
 253                 errors[1].rstrip().replace('\n', '\n-'))
 254         self.assertEqual(lines[14].colour, col.GREEN)
 255
 256         self.assertEqual(lines[15].text, 'w+%s' %
 257                 errors[2].rstrip().replace('\n', '\nw+'))
 258         self.assertEqual(lines[15].colour, col.MAGENTA)
 259
 260         # Fifth commit
 261         self.assertEqual(lines[16].text, '05: %s' % commits[4][1])
 262         self.assertSummary(lines[17].text, 'sandbox', '+', ['board4'])
 263         self.assertSummary(lines[18].text, 'powerpc', '', ['board3'],
 264                            outcome=OUTCOME_OK)
 265
 266         # The second line of errors[3] is a duplicate, so buildman will drop it
 267         expect = errors[3].rstrip().split('\n')
 268         expect = [expect[0]] + expect[2:]
 269         self.assertEqual(lines[19].text, '+%s' %
 270                 '\n'.join(expect).replace('\n', '\n+'))
 271
 272         self.assertEqual(lines[20].text, 'w-%s' %
 273                 errors[2].rstrip().replace('\n', '\nw-'))
 274
 275         # Sixth commit
 276         self.assertEqual(lines[21].text, '06: %s' % commits[5][1])
 277         self.assertSummary(lines[22].text, 'sandbox', '', ['board4'],
 278                            outcome=OUTCOME_OK)
 279
 280         # The second line of errors[3] is a duplicate, so buildman will drop it
 281         expect = errors[3].rstrip().split('\n')
 282         expect = [expect[0]] + expect[2:]
 283         self.assertEqual(lines[23].text, '-%s' %
 284                 '\n'.join(expect).replace('\n', '\n-'))
 285
 286         self.assertEqual(lines[24].text, 'w-%s' %
 287                 errors[0].rstrip().replace('\n', '\nw-'))
 288
 289         # Seventh commit
 290         self.assertEqual(lines[25].text, '07: %s' % commits[6][1])
 291         self.assertSummary(lines[26].text, 'sandbox', '+', ['board4'])
 292
 293         # Pick out the correct error lines
 294         expect_str = errors[4].rstrip().replace('%(basedir)s', '').split('\n')
 295         expect = expect_str[3:8] + [expect_str[-1]]
 296         self.assertEqual(lines[27].text, '+%s' %
 297                 '\n'.join(expect).replace('\n', '\n+'))
 298
 299         # Now the warnings lines
 300         expect = [expect_str[0]] + expect_str[10:12] + [expect_str[9]]
 301         self.assertEqual(lines[28].text, 'w+%s' %
 302                 '\n'.join(expect).replace('\n', '\nw+'))
 303
 304         self.assertEqual(len(lines), 29)
 305         shutil.rmtree(base_dir)
 306
 307     def _testGit(self):
 308         """Test basic builder operation by building a branch"""
 309         base_dir = tempfile.mkdtemp()
 310         if not os.path.isdir(base_dir):
 311             os.mkdir(base_dir)
 312         options = Options()
 313         options.git = os.getcwd()
 314         options.summary = False
 315         options.jobs = None
 316         options.dry_run = False
 317         #options.git = os.path.join(base_dir, 'repo')
 318         options.branch = 'test-buildman'
 319         options.force_build = False
 320         options.list_tool_chains = False
 321         options.count = -1
 322         options.git_dir = None
 323         options.threads = None
 324         options.show_unknown = False
 325         options.quick = False
 326         options.show_errors = False
 327         options.keep_outputs = False
 328         args = ['tegra20']
 329         control.DoBuildman(options, args)
 330         shutil.rmtree(base_dir)
 331
 332     def testBoardSingle(self):
 333         """Test single board selection"""
 334         self.assertEqual(self.boards.SelectBoards(['sandbox']),
 335                          ({'all': ['board4'], 'sandbox': ['board4']}, []))
 336
 337     def testBoardArch(self):
 338         """Test single board selection"""
 339         self.assertEqual(self.boards.SelectBoards(['arm']),
 340                          ({'all': ['board0', 'board1'],
 341                           'arm': ['board0', 'board1']}, []))
 342
 343     def testBoardArchSingle(self):
 344         """Test single board selection"""
 345         self.assertEqual(self.boards.SelectBoards(['arm sandbox']),
 346                          ({'sandbox': ['board4'],
 347                           'all': ['board0', 'board1', 'board4'],
 348                           'arm': ['board0', 'board1']}, []))
 349
 350
 351     def testBoardArchSingleMultiWord(self):
 352         """Test single board selection"""
 353         self.assertEqual(self.boards.SelectBoards(['arm', 'sandbox']),
 354                          ({'sandbox': ['board4'],
 355                           'all': ['board0', 'board1', 'board4'],
 356                           'arm': ['board0', 'board1']}, []))
 357
 358     def testBoardSingleAnd(self):
 359         """Test single board selection"""
 360         self.assertEqual(self.boards.SelectBoards(['Tester & arm']),
 361                          ({'Tester&arm': ['board0', 'board1'],
 362                            'all': ['board0', 'board1']}, []))
 363
 364     def testBoardTwoAnd(self):
 365         """Test single board selection"""
 366         self.assertEqual(self.boards.SelectBoards(['Tester', '&', 'arm',
 367                                                    'Tester' '&', 'powerpc',
 368                                                    'sandbox']),
 369                          ({'sandbox': ['board4'],
 370                           'all': ['board0', 'board1', 'board2', 'board3',
 371                                   'board4'],
 372                           'Tester&powerpc': ['board2', 'board3'],
 373                           'Tester&arm': ['board0', 'board1']}, []))
 374
 375     def testBoardAll(self):
 376         """Test single board selection"""
 377         self.assertEqual(self.boards.SelectBoards([]),
 378                          ({'all': ['board0', 'board1', 'board2', 'board3',
 379                                   'board4']}, []))
 380
 381     def testBoardRegularExpression(self):
 382         """Test single board selection"""
 383         self.assertEqual(self.boards.SelectBoards(['T.*r&^Po']),
 384                          ({'all': ['board2', 'board3'],
 385                           'T.*r&^Po': ['board2', 'board3']}, []))
 386
 387     def testBoardDuplicate(self):
 388         """Test single board selection"""
 389         self.assertEqual(self.boards.SelectBoards(['sandbox sandbox',
 390                                                    'sandbox']),
 391                          ({'all': ['board4'], 'sandbox': ['board4']}, []))
 392     def CheckDirs(self, build, dirname):
 393         self.assertEqual('base%s' % dirname, build._GetOutputDir(1))
 394         self.assertEqual('base%s/fred' % dirname,
 395                          build.GetBuildDir(1, 'fred'))
 396         self.assertEqual('base%s/fred/done' % dirname,
 397                          build.GetDoneFile(1, 'fred'))
 398         self.assertEqual('base%s/fred/u-boot.sizes' % dirname,
 399                          build.GetFuncSizesFile(1, 'fred', 'u-boot'))
 400         self.assertEqual('base%s/fred/u-boot.objdump' % dirname,
 401                          build.GetObjdumpFile(1, 'fred', 'u-boot'))
 402         self.assertEqual('base%s/fred/err' % dirname,
 403                          build.GetErrFile(1, 'fred'))
 404
 405     def testOutputDir(self):
 406         build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
 407                                 checkout=False, show_unknown=False)
 408         build.commits = self.commits
 409         build.commit_count = len(self.commits)
 410         subject = self.commits[1].subject.translate(builder.trans_valid_chars)
 411         dirname ='/%02d_of_%02d_g%s_%s' % (2, build.commit_count, commits[1][0],
 412                                            subject[:20])
 413         self.CheckDirs(build, dirname)
 414
 415     def testOutputDirCurrent(self):
 416         build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
 417                                 checkout=False, show_unknown=False)
 418         build.commits = None
 419         build.commit_count = 0
 420         self.CheckDirs(build, '/current')
 421
 422     def testOutputDirNoSubdirs(self):
 423         build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2,
 424                                 checkout=False, show_unknown=False,
 425                                 no_subdirs=True)
 426         build.commits = None
 427         build.commit_count = 0
 428         self.CheckDirs(build, '')
 429
 430     def testToolchainAliases(self):
 431         self.assertTrue(self.toolchains.Select('arm') != None)
 432         with self.assertRaises(ValueError):
 433             self.toolchains.Select('no-arch')
 434         with self.assertRaises(ValueError):
 435             self.toolchains.Select('x86')
 436
 437         self.toolchains = toolchain.Toolchains()
 438         self.toolchains.Add('x86_64-linux-gcc', test=False)
 439         self.assertTrue(self.toolchains.Select('x86') != None)
 440
 441         self.toolchains = toolchain.Toolchains()
 442         self.toolchains.Add('i386-linux-gcc', test=False)
 443         self.assertTrue(self.toolchains.Select('x86') != None)
 444
 445     def testToolchainDownload(self):
 446         """Test that we can download toolchains"""
 447         if use_network:
 448             with test_util.capture_sys_output() as (stdout, stderr):
 449                 url = self.toolchains.LocateArchUrl('arm')
 450             self.assertRegexpMatches(url, 'https://www.kernel.org/pub/tools/'
 451                     'crosstool/files/bin/x86_64/.*/'
 452                     'x86_64-gcc-.*-nolibc_arm-.*linux-gnueabi.tar.xz')
 453
 454
 455 if __name__ == "__main__":
 456     unittest.main()