1# SPDX-License-Identifier: GPL-2.0+ 2# Copyright (c) 2012 The Chromium OS Authors. 3# 4 5import os 6import shutil 7import sys 8import tempfile 9import time 10import unittest 11 12# Bring in the patman libraries 13our_path = os.path.dirname(os.path.realpath(__file__)) 14sys.path.append(os.path.join(our_path, '../patman')) 15 16import board 17import bsettings 18import builder 19import control 20import command 21import commit 22import terminal 23import test_util 24import toolchain 25 26use_network = True 27 28settings_data = ''' 29# Buildman settings file 30 31[toolchain] 32main: /usr/sbin 33 34[toolchain-alias] 35x86: i386 x86_64 36''' 37 38errors = [ 39 '''main.c: In function 'main_loop': 40main.c:260:6: warning: unused variable 'joe' [-Wunused-variable] 41''', 42 '''main.c: In function 'main_loop2': 43main.c:295:2: error: 'fred' undeclared (first use in this function) 44main.c:295:2: note: each undeclared identifier is reported only once for each function it appears in 45make[1]: *** [main.o] Error 1 46make: *** [common/libcommon.o] Error 2 47Make failed 48''', 49 '''arch/arm/dts/socfpga_arria10_socdk_sdmmc.dtb: Warning \ 50(avoid_unnecessary_addr_size): /clocks: unnecessary #address-cells/#size-cells \ 51without "ranges" or child "reg" property 52''', 53 '''powerpc-linux-ld: warning: dot moved backwards before `.bss' 54powerpc-linux-ld: warning: dot moved backwards before `.bss' 55powerpc-linux-ld: u-boot: section .text lma 0xfffc0000 overlaps previous sections 56powerpc-linux-ld: u-boot: section .rodata lma 0xfffef3ec overlaps previous sections 57powerpc-linux-ld: u-boot: section .reloc lma 0xffffa400 overlaps previous sections 58powerpc-linux-ld: u-boot: section .data lma 0xffffcd38 overlaps previous sections 59powerpc-linux-ld: u-boot: section .u_boot_cmd lma 0xffffeb40 overlaps previous sections 60powerpc-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 68make[2]: *** [arch/sandbox/cpu/cpu.o] Error 1 69make[1]: *** [arch/sandbox/cpu] Error 2 70make[1]: *** Waiting for unfinished jobs.... 71In 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 74make: *** [sub-make] Error 2 75''' 76] 77 78 79# hash, subject, return code, list of errors/warnings 80commits = [ 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 90boards = [ 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 98BASE_DIR = 'base' 99 100OUTCOME_OK, OUTCOME_WARN, OUTCOME_ERR = range(3) 101 102class Options: 103 """Class that holds build options""" 104 pass 105 106class 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 if stage == 'build': 160 target_dir = None 161 for arg in args: 162 if arg.startswith('O='): 163 target_dir = arg[2:] 164 165 if not os.path.isdir(target_dir): 166 os.mkdir(target_dir) 167 168 result.combined = result.stdout + result.stderr 169 return result 170 171 def assertSummary(self, text, arch, plus, boards, outcome=OUTCOME_ERR): 172 col = self._col 173 expected_colour = (col.GREEN if outcome == OUTCOME_OK else 174 col.YELLOW if outcome == OUTCOME_WARN else col.RED) 175 expect = '%10s: ' % arch 176 # TODO(sjg@chromium.org): If plus is '', we shouldn't need this 177 expect += ' ' + col.Color(expected_colour, plus) 178 expect += ' ' 179 for board in boards: 180 expect += col.Color(expected_colour, ' %s' % board) 181 self.assertEqual(text, expect) 182 183 def testOutput(self): 184 """Test basic builder operation and output 185 186 This does a line-by-line verification of the summary output. 187 """ 188 global base_dir 189 190 base_dir = tempfile.mkdtemp() 191 if not os.path.isdir(base_dir): 192 os.mkdir(base_dir) 193 build = builder.Builder(self.toolchains, 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(show_errors=True); 212 build.ShowSummary(self.commits, board_selected) 213 #terminal.EchoPrintTestLines() 214 lines = terminal.GetPrintTestLines() 215 216 # Upstream commit: no errors 217 self.assertEqual(lines[0].text, '01: %s' % commits[0][1]) 218 219 # Second commit: all archs should fail with warnings 220 self.assertEqual(lines[1].text, '02: %s' % commits[1][1]) 221 222 col = terminal.Color() 223 self.assertSummary(lines[2].text, 'sandbox', 'w+', ['board4'], 224 outcome=OUTCOME_WARN) 225 self.assertSummary(lines[3].text, 'arm', 'w+', ['board1'], 226 outcome=OUTCOME_WARN) 227 self.assertSummary(lines[4].text, 'powerpc', 'w+', ['board2', 'board3'], 228 outcome=OUTCOME_WARN) 229 230 # Second commit: The warnings should be listed 231 self.assertEqual(lines[5].text, 'w+%s' % 232 errors[0].rstrip().replace('\n', '\nw+')) 233 self.assertEqual(lines[5].colour, col.MAGENTA) 234 235 # Third commit: Still fails 236 self.assertEqual(lines[6].text, '03: %s' % commits[2][1]) 237 self.assertSummary(lines[7].text, 'sandbox', '+', ['board4']) 238 self.assertSummary(lines[8].text, 'arm', '', ['board1'], 239 outcome=OUTCOME_OK) 240 self.assertSummary(lines[9].text, 'powerpc', '+', ['board2', 'board3']) 241 242 # Expect a compiler error 243 self.assertEqual(lines[10].text, '+%s' % 244 errors[1].rstrip().replace('\n', '\n+')) 245 246 # Fourth commit: Compile errors are fixed, just have warning for board3 247 self.assertEqual(lines[11].text, '04: %s' % commits[3][1]) 248 self.assertSummary(lines[12].text, 'sandbox', 'w+', ['board4'], 249 outcome=OUTCOME_WARN) 250 expect = '%10s: ' % 'powerpc' 251 expect += ' ' + col.Color(col.GREEN, '') 252 expect += ' ' 253 expect += col.Color(col.GREEN, ' %s' % 'board2') 254 expect += ' ' + col.Color(col.YELLOW, 'w+') 255 expect += ' ' 256 expect += col.Color(col.YELLOW, ' %s' % 'board3') 257 self.assertEqual(lines[13].text, expect) 258 259 # Compile error fixed 260 self.assertEqual(lines[14].text, '-%s' % 261 errors[1].rstrip().replace('\n', '\n-')) 262 self.assertEqual(lines[14].colour, col.GREEN) 263 264 self.assertEqual(lines[15].text, 'w+%s' % 265 errors[2].rstrip().replace('\n', '\nw+')) 266 self.assertEqual(lines[15].colour, col.MAGENTA) 267 268 # Fifth commit 269 self.assertEqual(lines[16].text, '05: %s' % commits[4][1]) 270 self.assertSummary(lines[17].text, 'sandbox', '+', ['board4']) 271 self.assertSummary(lines[18].text, 'powerpc', '', ['board3'], 272 outcome=OUTCOME_OK) 273 274 # The second line of errors[3] is a duplicate, so buildman will drop it 275 expect = errors[3].rstrip().split('\n') 276 expect = [expect[0]] + expect[2:] 277 self.assertEqual(lines[19].text, '+%s' % 278 '\n'.join(expect).replace('\n', '\n+')) 279 280 self.assertEqual(lines[20].text, 'w-%s' % 281 errors[2].rstrip().replace('\n', '\nw-')) 282 283 # Sixth commit 284 self.assertEqual(lines[21].text, '06: %s' % commits[5][1]) 285 self.assertSummary(lines[22].text, 'sandbox', '', ['board4'], 286 outcome=OUTCOME_OK) 287 288 # The second line of errors[3] is a duplicate, so buildman will drop it 289 expect = errors[3].rstrip().split('\n') 290 expect = [expect[0]] + expect[2:] 291 self.assertEqual(lines[23].text, '-%s' % 292 '\n'.join(expect).replace('\n', '\n-')) 293 294 self.assertEqual(lines[24].text, 'w-%s' % 295 errors[0].rstrip().replace('\n', '\nw-')) 296 297 # Seventh commit 298 self.assertEqual(lines[25].text, '07: %s' % commits[6][1]) 299 self.assertSummary(lines[26].text, 'sandbox', '+', ['board4']) 300 301 # Pick out the correct error lines 302 expect_str = errors[4].rstrip().replace('%(basedir)s', '').split('\n') 303 expect = expect_str[3:8] + [expect_str[-1]] 304 self.assertEqual(lines[27].text, '+%s' % 305 '\n'.join(expect).replace('\n', '\n+')) 306 307 # Now the warnings lines 308 expect = [expect_str[0]] + expect_str[10:12] + [expect_str[9]] 309 self.assertEqual(lines[28].text, 'w+%s' % 310 '\n'.join(expect).replace('\n', '\nw+')) 311 312 self.assertEqual(len(lines), 29) 313 shutil.rmtree(base_dir) 314 315 def _testGit(self): 316 """Test basic builder operation by building a branch""" 317 base_dir = tempfile.mkdtemp() 318 if not os.path.isdir(base_dir): 319 os.mkdir(base_dir) 320 options = Options() 321 options.git = os.getcwd() 322 options.summary = False 323 options.jobs = None 324 options.dry_run = False 325 #options.git = os.path.join(base_dir, 'repo') 326 options.branch = 'test-buildman' 327 options.force_build = False 328 options.list_tool_chains = False 329 options.count = -1 330 options.git_dir = None 331 options.threads = None 332 options.show_unknown = False 333 options.quick = False 334 options.show_errors = False 335 options.keep_outputs = False 336 args = ['tegra20'] 337 control.DoBuildman(options, args) 338 shutil.rmtree(base_dir) 339 340 def testBoardSingle(self): 341 """Test single board selection""" 342 self.assertEqual(self.boards.SelectBoards(['sandbox']), 343 ({'all': ['board4'], 'sandbox': ['board4']}, [])) 344 345 def testBoardArch(self): 346 """Test single board selection""" 347 self.assertEqual(self.boards.SelectBoards(['arm']), 348 ({'all': ['board0', 'board1'], 349 'arm': ['board0', 'board1']}, [])) 350 351 def testBoardArchSingle(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 359 def testBoardArchSingleMultiWord(self): 360 """Test single board selection""" 361 self.assertEqual(self.boards.SelectBoards(['arm', 'sandbox']), 362 ({'sandbox': ['board4'], 363 'all': ['board0', 'board1', 'board4'], 364 'arm': ['board0', 'board1']}, [])) 365 366 def testBoardSingleAnd(self): 367 """Test single board selection""" 368 self.assertEqual(self.boards.SelectBoards(['Tester & arm']), 369 ({'Tester&arm': ['board0', 'board1'], 370 'all': ['board0', 'board1']}, [])) 371 372 def testBoardTwoAnd(self): 373 """Test single board selection""" 374 self.assertEqual(self.boards.SelectBoards(['Tester', '&', 'arm', 375 'Tester' '&', 'powerpc', 376 'sandbox']), 377 ({'sandbox': ['board4'], 378 'all': ['board0', 'board1', 'board2', 'board3', 379 'board4'], 380 'Tester&powerpc': ['board2', 'board3'], 381 'Tester&arm': ['board0', 'board1']}, [])) 382 383 def testBoardAll(self): 384 """Test single board selection""" 385 self.assertEqual(self.boards.SelectBoards([]), 386 ({'all': ['board0', 'board1', 'board2', 'board3', 387 'board4']}, [])) 388 389 def testBoardRegularExpression(self): 390 """Test single board selection""" 391 self.assertEqual(self.boards.SelectBoards(['T.*r&^Po']), 392 ({'all': ['board2', 'board3'], 393 'T.*r&^Po': ['board2', 'board3']}, [])) 394 395 def testBoardDuplicate(self): 396 """Test single board selection""" 397 self.assertEqual(self.boards.SelectBoards(['sandbox sandbox', 398 'sandbox']), 399 ({'all': ['board4'], 'sandbox': ['board4']}, [])) 400 def CheckDirs(self, build, dirname): 401 self.assertEqual('base%s' % dirname, build._GetOutputDir(1)) 402 self.assertEqual('base%s/fred' % dirname, 403 build.GetBuildDir(1, 'fred')) 404 self.assertEqual('base%s/fred/done' % dirname, 405 build.GetDoneFile(1, 'fred')) 406 self.assertEqual('base%s/fred/u-boot.sizes' % dirname, 407 build.GetFuncSizesFile(1, 'fred', 'u-boot')) 408 self.assertEqual('base%s/fred/u-boot.objdump' % dirname, 409 build.GetObjdumpFile(1, 'fred', 'u-boot')) 410 self.assertEqual('base%s/fred/err' % dirname, 411 build.GetErrFile(1, 'fred')) 412 413 def testOutputDir(self): 414 build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2, 415 checkout=False, show_unknown=False) 416 build.commits = self.commits 417 build.commit_count = len(self.commits) 418 subject = self.commits[1].subject.translate(builder.trans_valid_chars) 419 dirname ='/%02d_of_%02d_g%s_%s' % (2, build.commit_count, commits[1][0], 420 subject[:20]) 421 self.CheckDirs(build, dirname) 422 423 def testOutputDirCurrent(self): 424 build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2, 425 checkout=False, show_unknown=False) 426 build.commits = None 427 build.commit_count = 0 428 self.CheckDirs(build, '/current') 429 430 def testOutputDirNoSubdirs(self): 431 build = builder.Builder(self.toolchains, BASE_DIR, None, 1, 2, 432 checkout=False, show_unknown=False, 433 no_subdirs=True) 434 build.commits = None 435 build.commit_count = 0 436 self.CheckDirs(build, '') 437 438 def testToolchainAliases(self): 439 self.assertTrue(self.toolchains.Select('arm') != None) 440 with self.assertRaises(ValueError): 441 self.toolchains.Select('no-arch') 442 with self.assertRaises(ValueError): 443 self.toolchains.Select('x86') 444 445 self.toolchains = toolchain.Toolchains() 446 self.toolchains.Add('x86_64-linux-gcc', test=False) 447 self.assertTrue(self.toolchains.Select('x86') != None) 448 449 self.toolchains = toolchain.Toolchains() 450 self.toolchains.Add('i386-linux-gcc', test=False) 451 self.assertTrue(self.toolchains.Select('x86') != None) 452 453 def testToolchainDownload(self): 454 """Test that we can download toolchains""" 455 if use_network: 456 with test_util.capture_sys_output() as (stdout, stderr): 457 url = self.toolchains.LocateArchUrl('arm') 458 self.assertRegexpMatches(url, 'https://www.kernel.org/pub/tools/' 459 'crosstool/files/bin/x86_64/.*/' 460 'x86_64-gcc-.*-nolibc_arm-.*linux-gnueabi.tar.xz') 461 462 463if __name__ == "__main__": 464 unittest.main() 465