1#!/usr/bin/env python 2 3""" 4This script determines the given package's openbmc dependencies from its 5configure.ac file where it downloads, configures, builds, and installs each of 6these dependencies. Then the given package is configured, built, and installed 7prior to executing its unit tests. 8""" 9 10from git import Repo 11from urlparse import urljoin 12from subprocess import check_call, call, CalledProcessError 13import os 14import sys 15import argparse 16import multiprocessing 17import re 18import sets 19import subprocess 20import shutil 21import platform 22 23 24class DepTree(): 25 """ 26 Represents package dependency tree, where each node is a DepTree with a 27 name and DepTree children. 28 """ 29 30 def __init__(self, name): 31 """ 32 Create new DepTree. 33 34 Parameter descriptions: 35 name Name of new tree node. 36 """ 37 self.name = name 38 self.children = list() 39 40 def AddChild(self, name): 41 """ 42 Add new child node to current node. 43 44 Parameter descriptions: 45 name Name of new child 46 """ 47 new_child = DepTree(name) 48 self.children.append(new_child) 49 return new_child 50 51 def AddChildNode(self, node): 52 """ 53 Add existing child node to current node. 54 55 Parameter descriptions: 56 node Tree node to add 57 """ 58 self.children.append(node) 59 60 def RemoveChild(self, name): 61 """ 62 Remove child node. 63 64 Parameter descriptions: 65 name Name of child to remove 66 """ 67 for child in self.children: 68 if child.name == name: 69 self.children.remove(child) 70 return 71 72 def GetNode(self, name): 73 """ 74 Return node with matching name. Return None if not found. 75 76 Parameter descriptions: 77 name Name of node to return 78 """ 79 if self.name == name: 80 return self 81 for child in self.children: 82 node = child.GetNode(name) 83 if node: 84 return node 85 return None 86 87 def GetParentNode(self, name, parent_node=None): 88 """ 89 Return parent of node with matching name. Return none if not found. 90 91 Parameter descriptions: 92 name Name of node to get parent of 93 parent_node Parent of current node 94 """ 95 if self.name == name: 96 return parent_node 97 for child in self.children: 98 found_node = child.GetParentNode(name, self) 99 if found_node: 100 return found_node 101 return None 102 103 def GetPath(self, name, path=None): 104 """ 105 Return list of node names from head to matching name. 106 Return None if not found. 107 108 Parameter descriptions: 109 name Name of node 110 path List of node names from head to current node 111 """ 112 if not path: 113 path = [] 114 if self.name == name: 115 path.append(self.name) 116 return path 117 for child in self.children: 118 match = child.GetPath(name, path + [self.name]) 119 if match: 120 return match 121 return None 122 123 def GetPathRegex(self, name, regex_str, path=None): 124 """ 125 Return list of node paths that end in name, or match regex_str. 126 Return empty list if not found. 127 128 Parameter descriptions: 129 name Name of node to search for 130 regex_str Regex string to match node names 131 path Path of node names from head to current node 132 """ 133 new_paths = [] 134 if not path: 135 path = [] 136 match = re.match(regex_str, self.name) 137 if (self.name == name) or (match): 138 new_paths.append(path + [self.name]) 139 for child in self.children: 140 return_paths = None 141 full_path = path + [self.name] 142 return_paths = child.GetPathRegex(name, regex_str, full_path) 143 for i in return_paths: 144 new_paths.append(i) 145 return new_paths 146 147 def MoveNode(self, from_name, to_name): 148 """ 149 Mode existing from_name node to become child of to_name node. 150 151 Parameter descriptions: 152 from_name Name of node to make a child of to_name 153 to_name Name of node to make parent of from_name 154 """ 155 parent_from_node = self.GetParentNode(from_name) 156 from_node = self.GetNode(from_name) 157 parent_from_node.RemoveChild(from_name) 158 to_node = self.GetNode(to_name) 159 to_node.AddChildNode(from_node) 160 161 def ReorderDeps(self, name, regex_str): 162 """ 163 Reorder dependency tree. If tree contains nodes with names that 164 match 'name' and 'regex_str', move 'regex_str' nodes that are 165 to the right of 'name' node, so that they become children of the 166 'name' node. 167 168 Parameter descriptions: 169 name Name of node to look for 170 regex_str Regex string to match names to 171 """ 172 name_path = self.GetPath(name) 173 if not name_path: 174 return 175 paths = self.GetPathRegex(name, regex_str) 176 is_name_in_paths = False 177 name_index = 0 178 for i in range(len(paths)): 179 path = paths[i] 180 if path[-1] == name: 181 is_name_in_paths = True 182 name_index = i 183 break 184 if not is_name_in_paths: 185 return 186 for i in range(name_index + 1, len(paths)): 187 path = paths[i] 188 if name in path: 189 continue 190 from_name = path[-1] 191 self.MoveNode(from_name, name) 192 193 def GetInstallList(self): 194 """ 195 Return post-order list of node names. 196 197 Parameter descriptions: 198 """ 199 install_list = [] 200 for child in self.children: 201 child_install_list = child.GetInstallList() 202 install_list.extend(child_install_list) 203 install_list.append(self.name) 204 return install_list 205 206 def PrintTree(self, level=0): 207 """ 208 Print pre-order node names with indentation denoting node depth level. 209 210 Parameter descriptions: 211 level Current depth level 212 """ 213 INDENT_PER_LEVEL = 4 214 print ' ' * (level * INDENT_PER_LEVEL) + self.name 215 for child in self.children: 216 child.PrintTree(level + 1) 217 218 219def check_call_cmd(*cmd): 220 """ 221 Verbose prints the directory location the given command is called from and 222 the command, then executes the command using check_call. 223 224 Parameter descriptions: 225 dir Directory location command is to be called from 226 cmd List of parameters constructing the complete command 227 """ 228 printline(os.getcwd(), ">", " ".join(cmd)) 229 check_call(cmd) 230 231 232def clone_pkg(pkg, branch): 233 """ 234 Clone the given openbmc package's git repository from gerrit into 235 the WORKSPACE location 236 237 Parameter descriptions: 238 pkg Name of the package to clone 239 branch Branch to clone from pkg 240 """ 241 pkg_dir = os.path.join(WORKSPACE, pkg) 242 if os.path.exists(os.path.join(pkg_dir, '.git')): 243 return pkg_dir 244 pkg_repo = urljoin('https://gerrit.openbmc-project.xyz/openbmc/', pkg) 245 os.mkdir(pkg_dir) 246 printline(pkg_dir, "> git clone", pkg_repo, branch, "./") 247 try: 248 # first try the branch 249 clone = Repo.clone_from(pkg_repo, pkg_dir, branch=branch) 250 repo_inst = clone.working_dir 251 except: 252 printline("Input branch not found, default to master") 253 clone = Repo.clone_from(pkg_repo, pkg_dir, branch="master") 254 repo_inst = clone.working_dir 255 return repo_inst 256 257 258def make_target_exists(target): 259 """ 260 Runs a check against the makefile in the current directory to determine 261 if the target exists so that it can be built. 262 263 Parameter descriptions: 264 target The make target we are checking 265 """ 266 try: 267 cmd = ['make', '-n', target] 268 with open(os.devnull, 'w') as devnull: 269 check_call(cmd, stdout=devnull, stderr=devnull) 270 return True 271 except CalledProcessError: 272 return False 273 274 275make_parallel = [ 276 'make', 277 # Run enough jobs to saturate all the cpus 278 '-j', str(multiprocessing.cpu_count()), 279 # Don't start more jobs if the load avg is too high 280 '-l', str(multiprocessing.cpu_count()), 281 # Synchronize the output so logs aren't intermixed in stdout / stderr 282 '-O', 283] 284 285 286def build_and_install(name, build_for_testing=False): 287 """ 288 Builds and installs the package in the environment. Optionally 289 builds the examples and test cases for package. 290 291 Parameter description: 292 name The name of the package we are building 293 build_for_testing Enable options related to testing on the package? 294 """ 295 os.chdir(os.path.join(WORKSPACE, name)) 296 297 # Refresh dynamic linker run time bindings for dependencies 298 check_call_cmd('sudo', '-n', '--', 'ldconfig') 299 300 pkg = Package() 301 if build_for_testing: 302 pkg.test() 303 else: 304 pkg.install() 305 306 307def build_dep_tree(name, pkgdir, dep_added, head, branch, dep_tree=None): 308 """ 309 For each package (name), starting with the package to be unit tested, 310 extract its dependencies. For each package dependency defined, recursively 311 apply the same strategy 312 313 Parameter descriptions: 314 name Name of the package 315 pkgdir Directory where package source is located 316 dep_added Current dict of dependencies and added status 317 head Head node of the dependency tree 318 branch Branch to clone from pkg 319 dep_tree Current dependency tree node 320 """ 321 if not dep_tree: 322 dep_tree = head 323 324 with open("/tmp/depcache", "r") as depcache: 325 cache = depcache.readline() 326 327 # Read out pkg dependencies 328 pkg = Package(name, pkgdir) 329 330 for dep in sets.Set(pkg.build_system().dependencies()): 331 if dep in cache: 332 continue 333 # Dependency package not already known 334 if dep_added.get(dep) is None: 335 # Dependency package not added 336 new_child = dep_tree.AddChild(dep) 337 dep_added[dep] = False 338 dep_pkgdir = clone_pkg(dep, branch) 339 # Determine this dependency package's 340 # dependencies and add them before 341 # returning to add this package 342 dep_added = build_dep_tree(dep, 343 dep_pkgdir, 344 dep_added, 345 head, 346 branch, 347 new_child) 348 else: 349 # Dependency package known and added 350 if dep_added[dep]: 351 continue 352 else: 353 # Cyclic dependency failure 354 raise Exception("Cyclic dependencies found in "+name) 355 356 if not dep_added[name]: 357 dep_added[name] = True 358 359 return dep_added 360 361 362def run_cppcheck(): 363 match_re = re.compile('((?!\.mako\.).)*\.[ch](?:pp)?$', re.I) 364 cppcheck_files = [] 365 stdout = subprocess.check_output(['git', 'ls-files']) 366 367 for f in stdout.decode('utf-8').split(): 368 if match_re.match(f): 369 cppcheck_files.append(f) 370 371 if not cppcheck_files: 372 # skip cppcheck if there arent' any c or cpp sources. 373 print("no files") 374 return None 375 376 # http://cppcheck.sourceforge.net/manual.pdf 377 params = ['cppcheck', '-j', str(multiprocessing.cpu_count()), 378 '--enable=all', '--file-list=-'] 379 380 cppcheck_process = subprocess.Popen( 381 params, 382 stdout=subprocess.PIPE, 383 stderr=subprocess.PIPE, 384 stdin=subprocess.PIPE) 385 (stdout, stderr) = cppcheck_process.communicate( 386 input='\n'.join(cppcheck_files)) 387 388 if cppcheck_process.wait(): 389 raise Exception('Cppcheck failed') 390 print(stdout) 391 print(stderr) 392 393 394def is_valgrind_safe(): 395 """ 396 Returns whether it is safe to run valgrind on our platform 397 """ 398 src = 'unit-test-vg.c' 399 exe = './unit-test-vg' 400 with open(src, 'w') as h: 401 h.write('#include <errno.h>\n') 402 h.write('#include <stdio.h>\n') 403 h.write('#include <stdlib.h>\n') 404 h.write('#include <string.h>\n') 405 h.write('int main() {\n') 406 h.write('char *heap_str = malloc(16);\n') 407 h.write('strcpy(heap_str, "RandString");\n') 408 h.write('int res = strcmp("RandString", heap_str);\n') 409 h.write('free(heap_str);\n') 410 h.write('char errstr[64];\n') 411 h.write('strerror_r(EINVAL, errstr, sizeof(errstr));\n') 412 h.write('printf("%s\\n", errstr);\n') 413 h.write('return res;\n') 414 h.write('}\n') 415 try: 416 with open(os.devnull, 'w') as devnull: 417 check_call(['gcc', '-O2', '-o', exe, src], 418 stdout=devnull, stderr=devnull) 419 check_call(['valgrind', '--error-exitcode=99', exe], 420 stdout=devnull, stderr=devnull) 421 return True 422 except: 423 sys.stderr.write("###### Platform is not valgrind safe ######\n") 424 return False 425 finally: 426 os.remove(src) 427 os.remove(exe) 428 429 430def is_sanitize_safe(): 431 """ 432 Returns whether it is safe to run sanitizers on our platform 433 """ 434 src = 'unit-test-sanitize.c' 435 exe = './unit-test-sanitize' 436 with open(src, 'w') as h: 437 h.write('int main() { return 0; }\n') 438 try: 439 with open(os.devnull, 'w') as devnull: 440 check_call(['gcc', '-O2', '-fsanitize=address', 441 '-fsanitize=undefined', '-o', exe, src], 442 stdout=devnull, stderr=devnull) 443 check_call([exe], stdout=devnull, stderr=devnull) 444 return True 445 except: 446 sys.stderr.write("###### Platform is not sanitize safe ######\n") 447 return False 448 finally: 449 os.remove(src) 450 os.remove(exe) 451 452 453def maybe_make_valgrind(): 454 """ 455 Potentially runs the unit tests through valgrind for the package 456 via `make check-valgrind`. If the package does not have valgrind testing 457 then it just skips over this. 458 """ 459 # Valgrind testing is currently broken by an aggressive strcmp optimization 460 # that is inlined into optimized code for POWER by gcc 7+. Until we find 461 # a workaround, just don't run valgrind tests on POWER. 462 # https://github.com/openbmc/openbmc/issues/3315 463 if not is_valgrind_safe(): 464 sys.stderr.write("###### Skipping valgrind ######\n") 465 return 466 if not make_target_exists('check-valgrind'): 467 return 468 469 try: 470 cmd = make_parallel + ['check-valgrind'] 471 check_call_cmd(*cmd) 472 except CalledProcessError: 473 for root, _, files in os.walk(os.getcwd()): 474 for f in files: 475 if re.search('test-suite-[a-z]+.log', f) is None: 476 continue 477 check_call_cmd('cat', os.path.join(root, f)) 478 raise Exception('Valgrind tests failed') 479 480 481def maybe_make_coverage(): 482 """ 483 Potentially runs the unit tests through code coverage for the package 484 via `make check-code-coverage`. If the package does not have code coverage 485 testing then it just skips over this. 486 """ 487 if not make_target_exists('check-code-coverage'): 488 return 489 490 # Actually run code coverage 491 try: 492 cmd = make_parallel + ['check-code-coverage'] 493 check_call_cmd(*cmd) 494 except CalledProcessError: 495 raise Exception('Code coverage failed') 496 497 498class BuildSystem(object): 499 """ 500 Build systems generally provide the means to configure, build, install and 501 test software. The BuildSystem class defines a set of interfaces on top of 502 which Autotools, Meson, CMake and possibly other build system drivers can 503 be implemented, separating out the phases to control whether a package 504 should merely be installed or also tested and analyzed. 505 """ 506 def __init__(self, package, path): 507 """Initialise the driver with properties independent of the build system 508 509 Keyword arguments: 510 package: The name of the package. Derived from the path if None 511 path: The path to the package. Set to the working directory if None 512 """ 513 self.path = "." if not path else path 514 realpath = os.path.realpath(self.path) 515 self.package = package if package else os.path.basename(realpath) 516 self.build_for_testing = False 517 518 def probe(self): 519 """Test if the build system driver can be applied to the package 520 521 Return True if the driver can drive the package's build system, 522 otherwise False. 523 524 Generally probe() is implemented by testing for the presence of the 525 build system's configuration file(s). 526 """ 527 raise NotImplemented 528 529 def dependencies(self): 530 """Provide the package's dependencies 531 532 Returns a list of dependencies. If no dependencies are required then an 533 empty list must be returned. 534 535 Generally dependencies() is implemented by analysing and extracting the 536 data from the build system configuration. 537 """ 538 raise NotImplemented 539 540 def configure(self, build_for_testing): 541 """Configure the source ready for building 542 543 Should raise an exception if configuration failed. 544 545 Keyword arguments: 546 build_for_testing: Mark the package as being built for testing rather 547 than for installation as a dependency for the 548 package under test. Setting to True generally 549 implies that the package will be configured to build 550 with debug information, at a low level of 551 optimisation and possibly with sanitizers enabled. 552 553 Generally configure() is implemented by invoking the build system 554 tooling to generate Makefiles or equivalent. 555 """ 556 raise NotImplemented 557 558 def build(self): 559 """Build the software ready for installation and/or testing 560 561 Should raise an exception if the build fails 562 563 Generally build() is implemented by invoking `make` or `ninja`. 564 """ 565 raise NotImplemented 566 567 def install(self): 568 """Install the software ready for use 569 570 Should raise an exception if installation fails 571 572 Like build(), install() is generally implemented by invoking `make` or 573 `ninja`. 574 """ 575 raise NotImplemented 576 577 def test(self): 578 """Build and run the test suite associated with the package 579 580 Should raise an exception if the build or testing fails. 581 582 Like install(), test() is generally implemented by invoking `make` or 583 `ninja`. 584 """ 585 raise NotImplemented 586 587 def analyze(self): 588 """Run any supported analysis tools over the codebase 589 590 Should raise an exception if analysis fails. 591 592 Some analysis tools such as scan-build need injection into the build 593 system. analyze() provides the necessary hook to implement such 594 behaviour. Analyzers independent of the build system can also be 595 specified here but at the cost of possible duplication of code between 596 the build system driver implementations. 597 """ 598 raise NotImplemented 599 600 601class Autotools(BuildSystem): 602 def __init__(self, package=None, path=None): 603 super(Autotools, self).__init__(package, path) 604 605 def probe(self): 606 return os.path.isfile(os.path.join(self.path, 'configure.ac')) 607 608 def dependencies(self): 609 configure_ac = os.path.join(self.path, 'configure.ac') 610 611 contents = '' 612 # Prepend some special function overrides so we can parse out 613 # dependencies 614 for macro in DEPENDENCIES.iterkeys(): 615 contents += ('m4_define([' + macro + '], [' + macro + '_START$' + 616 str(DEPENDENCIES_OFFSET[macro] + 1) + 617 macro + '_END])\n') 618 with open(configure_ac, "rt") as f: 619 contents += f.read() 620 621 autoconf_cmdline = ['autoconf', '-Wno-undefined', '-'] 622 autoconf_process = subprocess.Popen(autoconf_cmdline, 623 stdin=subprocess.PIPE, 624 stdout=subprocess.PIPE, 625 stderr=subprocess.PIPE) 626 (stdout, stderr) = autoconf_process.communicate(input=contents) 627 if not stdout: 628 print(stderr) 629 raise Exception("Failed to run autoconf for parsing dependencies") 630 631 # Parse out all of the dependency text 632 matches = [] 633 for macro in DEPENDENCIES.iterkeys(): 634 pattern = '(' + macro + ')_START(.*?)' + macro + '_END' 635 for match in re.compile(pattern).finditer(stdout): 636 matches.append((match.group(1), match.group(2))) 637 638 # Look up dependencies from the text 639 found_deps = [] 640 for macro, deptext in matches: 641 for potential_dep in deptext.split(' '): 642 for known_dep in DEPENDENCIES[macro].iterkeys(): 643 if potential_dep.startswith(known_dep): 644 found_deps.append(DEPENDENCIES[macro][known_dep]) 645 646 return found_deps 647 648 def _configure_feature(self, flag, enabled): 649 """ 650 Returns an configure flag as a string 651 652 Parameters: 653 flag The name of the flag 654 enabled Whether the flag is enabled or disabled 655 """ 656 return '--' + ('enable' if enabled else 'disable') + '-' + flag 657 658 def configure(self, build_for_testing): 659 self.build_for_testing = build_for_testing 660 conf_flags = [ 661 self._configure_feature('silent-rules', False), 662 self._configure_feature('examples', build_for_testing), 663 self._configure_feature('tests', build_for_testing), 664 ] 665 if not TEST_ONLY: 666 conf_flags.extend([ 667 self._configure_feature('code-coverage', build_for_testing), 668 self._configure_feature('valgrind', build_for_testing), 669 ]) 670 # Add any necessary configure flags for package 671 if CONFIGURE_FLAGS.get(self.package) is not None: 672 conf_flags.extend(CONFIGURE_FLAGS.get(self.package)) 673 for bootstrap in ['bootstrap.sh', 'bootstrap', 'autogen.sh']: 674 if os.path.exists(bootstrap): 675 check_call_cmd('./' + bootstrap) 676 break 677 check_call_cmd('./configure', *conf_flags) 678 679 def build(self): 680 check_call_cmd(*make_parallel) 681 682 def install(self): 683 check_call_cmd('sudo', '-n', '--', *(make_parallel + ['install'])) 684 685 def test(self): 686 try: 687 cmd = make_parallel + ['check'] 688 for i in range(0, args.repeat): 689 check_call_cmd(*cmd) 690 except CalledProcessError: 691 for root, _, files in os.walk(os.getcwd()): 692 if 'test-suite.log' not in files: 693 continue 694 check_call_cmd('cat', os.path.join(root, 'test-suite.log')) 695 raise Exception('Unit tests failed') 696 697 def analyze(self): 698 maybe_make_valgrind() 699 maybe_make_coverage() 700 run_cppcheck() 701 702 703class CMake(BuildSystem): 704 def __init__(self, package=None, path=None): 705 super(CMake, self).__init__(package, path) 706 707 def probe(self): 708 return os.path.isfile(os.path.join(self.path, 'CMakeLists.txt')) 709 710 def dependencies(self): 711 return [] 712 713 def configure(self, build_for_testing): 714 self.build_for_testing = build_for_testing 715 check_call_cmd('cmake', '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON', '.') 716 717 def build(self): 718 check_call_cmd('cmake', '--build', '.', '--', '-j', 719 str(multiprocessing.cpu_count())) 720 721 def install(self): 722 pass 723 724 def test(self): 725 if make_target_exists('test'): 726 check_call_cmd('ctest', '.') 727 728 def analyze(self): 729 if os.path.isfile('.clang-tidy'): 730 check_call_cmd('run-clang-tidy-8.py', '-p', '.') 731 maybe_make_valgrind() 732 maybe_make_coverage() 733 run_cppcheck() 734 735 736class Meson(BuildSystem): 737 def __init__(self, package=None, path=None): 738 super(Meson, self).__init__(package, path) 739 740 def probe(self): 741 return os.path.isfile(os.path.join(self.path, 'meson.build')) 742 743 def dependencies(self): 744 meson_build = os.path.join(self.path, 'meson.build') 745 if not os.path.exists(meson_build): 746 return [] 747 748 found_deps = [] 749 for root, dirs, files in os.walk(self.path): 750 if 'meson.build' not in files: 751 continue 752 with open(os.path.join(root, 'meson.build'), 'rt') as f: 753 build_contents = f.read() 754 pattern = r"dependency\('([^']*)'.*?\)\n" 755 for match in re.finditer(pattern, build_contents): 756 group = match.group(1) 757 maybe_dep = DEPENDENCIES['PKG_CHECK_MODULES'].get(group) 758 if maybe_dep is not None: 759 found_deps.append(maybe_dep) 760 761 return found_deps 762 763 def _parse_options(self, options_file): 764 """ 765 Returns a set of options defined in the provides meson_options.txt file 766 767 Parameters: 768 options_file The file containing options 769 """ 770 options_contents = '' 771 with open(options_file, "rt") as f: 772 options_contents += f.read() 773 options = sets.Set() 774 pattern = 'option\\(\\s*\'([^\']*)\'' 775 for match in re.compile(pattern).finditer(options_contents): 776 options.add(match.group(1)) 777 return options 778 779 def _configure_feature(self, val): 780 """ 781 Returns the meson flag which signifies the value 782 783 True is enabled which requires the feature. 784 False is disabled which disables the feature. 785 None is auto which autodetects the feature. 786 787 Parameters: 788 val The value being converted 789 """ 790 if val is True: 791 return "enabled" 792 elif val is False: 793 return "disabled" 794 elif val is None: 795 return "auto" 796 else: 797 raise Exception("Bad meson feature value") 798 799 def configure(self, build_for_testing): 800 self.build_for_testing = build_for_testing 801 meson_options = sets.Set() 802 if os.path.exists("meson_options.txt"): 803 meson_options = self._parse_options("meson_options.txt") 804 meson_flags = [ 805 '-Db_colorout=never', 806 '-Dwerror=true', 807 '-Dwarning_level=3', 808 ] 809 if build_for_testing: 810 meson_flags.append('--buildtype=debug') 811 else: 812 meson_flags.append('--buildtype=debugoptimized') 813 if 'tests' in meson_options: 814 flag_args = self._configure_feature(build_for_testing) 815 meson_flags.append('-Dtests=' + flag_args) 816 if 'examples' in meson_options: 817 meson_flags.append('-Dexamples=' + str(build_for_testing).lower()) 818 if MESON_FLAGS.get(self.package) is not None: 819 meson_flags.extend(MESON_FLAGS.get(self.package)) 820 try: 821 check_call_cmd('meson', 'setup', '--reconfigure', 'build', 822 *meson_flags) 823 except: 824 shutil.rmtree('build') 825 check_call_cmd('meson', 'setup', 'build', *meson_flags) 826 827 def build(self): 828 check_call_cmd('ninja', '-C', 'build') 829 830 def install(self): 831 check_call_cmd('sudo', '-n', '--', 'ninja', '-C', 'build', 'install') 832 833 def test(self): 834 try: 835 check_call_cmd('meson', 'test', '-C', 'build') 836 except CalledProcessError: 837 for root, _, files in os.walk(os.getcwd()): 838 if 'testlog.txt' not in files: 839 continue 840 check_call_cmd('cat', os.path.join(root, 'testlog.txt')) 841 raise Exception('Unit tests failed') 842 843 def _setup_exists(self, setup): 844 """ 845 Returns whether the meson build supports the named test setup. 846 847 Parameter descriptions: 848 setup The setup target to check 849 """ 850 try: 851 with open(os.devnull, 'w') as devnull: 852 output = subprocess.check_output( 853 ['meson', 'test', '-C', 'build', 854 '--setup', setup, '-t', '0'], 855 stderr=subprocess.STDOUT) 856 except CalledProcessError as e: 857 output = e.output 858 return not re.search('Test setup .* not found from project', output) 859 860 def _maybe_valgrind(self): 861 """ 862 Potentially runs the unit tests through valgrind for the package 863 via `meson test`. The package can specify custom valgrind 864 configurations by utilizing add_test_setup() in a meson.build 865 """ 866 if not is_valgrind_safe(): 867 sys.stderr.write("###### Skipping valgrind ######\n") 868 return 869 try: 870 if self._setup_exists('valgrind'): 871 check_call_cmd('meson', 'test', '-C', 'build', 872 '--setup', 'valgrind') 873 else: 874 check_call_cmd('meson', 'test', '-C', 'build', 875 '--wrapper', 'valgrind') 876 except CalledProcessError: 877 for root, _, files in os.walk(os.getcwd()): 878 if 'testlog-valgrind.txt' not in files: 879 continue 880 cat_args = os.path.join(root, 'testlog-valgrind.txt') 881 check_call_cmd('cat', cat_args) 882 raise Exception('Valgrind tests failed') 883 884 def analyze(self): 885 self._maybe_valgrind() 886 887 # Run clang-tidy only if the project has a configuration 888 if os.path.isfile('.clang-tidy'): 889 check_call_cmd('run-clang-tidy-8.py', '-p', 890 'build') 891 # Run the basic clang static analyzer otherwise 892 else: 893 check_call_cmd('ninja', '-C', 'build', 894 'scan-build') 895 896 # Run tests through sanitizers 897 # b_lundef is needed if clang++ is CXX since it resolves the 898 # asan symbols at runtime only. We don't want to set it earlier 899 # in the build process to ensure we don't have undefined 900 # runtime code. 901 if is_sanitize_safe(): 902 check_call_cmd('meson', 'configure', 'build', 903 '-Db_sanitize=address,undefined', 904 '-Db_lundef=false') 905 check_call_cmd('meson', 'test', '-C', 'build', 906 '--logbase', 'testlog-ubasan') 907 # TODO: Fix memory sanitizer 908 # check_call_cmd('meson', 'configure', 'build', 909 # '-Db_sanitize=memory') 910 # check_call_cmd('meson', 'test', '-C', 'build' 911 # '--logbase', 'testlog-msan') 912 check_call_cmd('meson', 'configure', 'build', 913 '-Db_sanitize=none', '-Db_lundef=true') 914 else: 915 sys.stderr.write("###### Skipping sanitizers ######\n") 916 917 # Run coverage checks 918 check_call_cmd('meson', 'configure', 'build', 919 '-Db_coverage=true') 920 self.test() 921 # Only build coverage HTML if coverage files were produced 922 for root, dirs, files in os.walk('build'): 923 if any([f.endswith('.gcda') for f in files]): 924 check_call_cmd('ninja', '-C', 'build', 925 'coverage-html') 926 break 927 check_call_cmd('meson', 'configure', 'build', 928 '-Db_coverage=false') 929 run_cppcheck() 930 931 932class Package(object): 933 def __init__(self, name=None, path=None): 934 self.supported = [Autotools, Meson, CMake] 935 self.name = name 936 self.path = path 937 self.test_only = False 938 939 def build_systems(self): 940 instances = (system(self.name, self.path) for system in self.supported) 941 return (instance for instance in instances if instance.probe()) 942 943 def build_system(self, preferred=None): 944 systems = self.build_systems() 945 946 if preferred: 947 return {type(system): system for system in systems}[preferred] 948 949 return next(iter(systems)) 950 951 def install(self, system=None): 952 if not system: 953 system = self.build_system() 954 955 system.configure(False) 956 system.build() 957 system.install() 958 959 def _test_one(self, system): 960 system.configure(True) 961 system.build() 962 system.install() 963 system.test() 964 system.analyze() 965 966 def test(self): 967 for system in self.build_systems(): 968 self._test_one(system) 969 970 971def find_file(filename, basedir): 972 """ 973 Finds all occurrences of a file in the base directory 974 and passes them back with their relative paths. 975 976 Parameter descriptions: 977 filename The name of the file to find 978 basedir The base directory search in 979 """ 980 981 filepaths = [] 982 for root, dirs, files in os.walk(basedir): 983 if filename in files: 984 filepaths.append(os.path.join(root, filename)) 985 return filepaths 986 987 988if __name__ == '__main__': 989 # CONFIGURE_FLAGS = [GIT REPO]:[CONFIGURE FLAGS] 990 CONFIGURE_FLAGS = { 991 'sdbusplus': ['--enable-transaction'], 992 'phosphor-logging': 993 ['--enable-metadata-processing', '--enable-openpower-pel-extension', 994 'YAML_DIR=/usr/local/share/phosphor-dbus-yaml/yaml'] 995 } 996 997 # MESON_FLAGS = [GIT REPO]:[MESON FLAGS] 998 MESON_FLAGS = { 999 } 1000 1001 # DEPENDENCIES = [MACRO]:[library/header]:[GIT REPO] 1002 DEPENDENCIES = { 1003 'AC_CHECK_LIB': {'mapper': 'phosphor-objmgr'}, 1004 'AC_CHECK_HEADER': { 1005 'host-ipmid': 'phosphor-host-ipmid', 1006 'blobs-ipmid': 'phosphor-ipmi-blobs', 1007 'sdbusplus': 'sdbusplus', 1008 'sdeventplus': 'sdeventplus', 1009 'stdplus': 'stdplus', 1010 'gpioplus': 'gpioplus', 1011 'phosphor-logging/log.hpp': 'phosphor-logging', 1012 }, 1013 'AC_PATH_PROG': {'sdbus++': 'sdbusplus'}, 1014 'PKG_CHECK_MODULES': { 1015 'phosphor-dbus-interfaces': 'phosphor-dbus-interfaces', 1016 'openpower-dbus-interfaces': 'openpower-dbus-interfaces', 1017 'ibm-dbus-interfaces': 'ibm-dbus-interfaces', 1018 'libipmid': 'phosphor-host-ipmid', 1019 'libipmid-host': 'phosphor-host-ipmid', 1020 'sdbusplus': 'sdbusplus', 1021 'sdeventplus': 'sdeventplus', 1022 'stdplus': 'stdplus', 1023 'gpioplus': 'gpioplus', 1024 'phosphor-logging': 'phosphor-logging', 1025 'phosphor-snmp': 'phosphor-snmp', 1026 'ipmiblob': 'ipmi-blob-tool', 1027 }, 1028 } 1029 1030 # Offset into array of macro parameters MACRO(0, 1, ...N) 1031 DEPENDENCIES_OFFSET = { 1032 'AC_CHECK_LIB': 0, 1033 'AC_CHECK_HEADER': 0, 1034 'AC_PATH_PROG': 1, 1035 'PKG_CHECK_MODULES': 1, 1036 } 1037 1038 # DEPENDENCIES_REGEX = [GIT REPO]:[REGEX STRING] 1039 DEPENDENCIES_REGEX = { 1040 'phosphor-logging': r'\S+-dbus-interfaces$' 1041 } 1042 1043 # Set command line arguments 1044 parser = argparse.ArgumentParser() 1045 parser.add_argument("-w", "--workspace", dest="WORKSPACE", required=True, 1046 help="Workspace directory location(i.e. /home)") 1047 parser.add_argument("-p", "--package", dest="PACKAGE", required=True, 1048 help="OpenBMC package to be unit tested") 1049 parser.add_argument("-t", "--test-only", dest="TEST_ONLY", 1050 action="store_true", required=False, default=False, 1051 help="Only run test cases, no other validation") 1052 parser.add_argument("-v", "--verbose", action="store_true", 1053 help="Print additional package status messages") 1054 parser.add_argument("-r", "--repeat", help="Repeat tests N times", 1055 type=int, default=1) 1056 parser.add_argument("-b", "--branch", dest="BRANCH", required=False, 1057 help="Branch to target for dependent repositories", 1058 default="master") 1059 parser.add_argument("-n", "--noformat", dest="FORMAT", 1060 action="store_false", required=False, 1061 help="Whether or not to run format code") 1062 args = parser.parse_args(sys.argv[1:]) 1063 WORKSPACE = args.WORKSPACE 1064 UNIT_TEST_PKG = args.PACKAGE 1065 TEST_ONLY = args.TEST_ONLY 1066 BRANCH = args.BRANCH 1067 FORMAT_CODE = args.FORMAT 1068 if args.verbose: 1069 def printline(*line): 1070 for arg in line: 1071 print arg, 1072 print 1073 else: 1074 def printline(*line): 1075 pass 1076 1077 CODE_SCAN_DIR = WORKSPACE + "/" + UNIT_TEST_PKG 1078 1079 # First validate code formatting if repo has style formatting files. 1080 # The format-code.sh checks for these files. 1081 if FORMAT_CODE: 1082 check_call_cmd("./format-code.sh", CODE_SCAN_DIR) 1083 1084 prev_umask = os.umask(000) 1085 1086 # Determine dependencies and add them 1087 dep_added = dict() 1088 dep_added[UNIT_TEST_PKG] = False 1089 1090 # Create dependency tree 1091 dep_tree = DepTree(UNIT_TEST_PKG) 1092 build_dep_tree(UNIT_TEST_PKG, 1093 os.path.join(WORKSPACE, UNIT_TEST_PKG), 1094 dep_added, 1095 dep_tree, 1096 BRANCH) 1097 1098 # Reorder Dependency Tree 1099 for pkg_name, regex_str in DEPENDENCIES_REGEX.iteritems(): 1100 dep_tree.ReorderDeps(pkg_name, regex_str) 1101 if args.verbose: 1102 dep_tree.PrintTree() 1103 1104 install_list = dep_tree.GetInstallList() 1105 1106 # We don't want to treat our package as a dependency 1107 install_list.remove(UNIT_TEST_PKG) 1108 1109 # Install reordered dependencies 1110 for dep in install_list: 1111 build_and_install(dep, False) 1112 1113 # Run package unit tests 1114 build_and_install(UNIT_TEST_PKG, True) 1115 1116 os.umask(prev_umask) 1117 1118 # Run any custom CI scripts the repo has, of which there can be 1119 # multiple of and anywhere in the repository. 1120 ci_scripts = find_file('run-ci.sh', os.path.join(WORKSPACE, UNIT_TEST_PKG)) 1121 if ci_scripts: 1122 os.chdir(os.path.join(WORKSPACE, UNIT_TEST_PKG)) 1123 for ci_script in ci_scripts: 1124 check_call_cmd('sh', ci_script) 1125