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