1#!/usr/bin/env python3 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 10import argparse 11import json 12import multiprocessing 13import os 14import platform 15import re 16import shutil 17import subprocess 18import sys 19from subprocess import CalledProcessError, check_call 20from tempfile import TemporaryDirectory 21from urllib.parse import urljoin 22 23from git import Repo 24 25# interpreter is not used directly but this resolves dependency ordering 26# that would be broken if we didn't include it. 27from mesonbuild import interpreter # noqa: F401 28from mesonbuild import coredata, optinterpreter 29from mesonbuild.mesonlib import OptionKey 30from mesonbuild.mesonlib import version_compare as meson_version_compare 31 32 33class DepTree: 34 """ 35 Represents package dependency tree, where each node is a DepTree with a 36 name and DepTree children. 37 """ 38 39 def __init__(self, name): 40 """ 41 Create new DepTree. 42 43 Parameter descriptions: 44 name Name of new tree node. 45 """ 46 self.name = name 47 self.children = list() 48 49 def AddChild(self, name): 50 """ 51 Add new child node to current node. 52 53 Parameter descriptions: 54 name Name of new child 55 """ 56 new_child = DepTree(name) 57 self.children.append(new_child) 58 return new_child 59 60 def AddChildNode(self, node): 61 """ 62 Add existing child node to current node. 63 64 Parameter descriptions: 65 node Tree node to add 66 """ 67 self.children.append(node) 68 69 def RemoveChild(self, name): 70 """ 71 Remove child node. 72 73 Parameter descriptions: 74 name Name of child to remove 75 """ 76 for child in self.children: 77 if child.name == name: 78 self.children.remove(child) 79 return 80 81 def GetNode(self, name): 82 """ 83 Return node with matching name. Return None if not found. 84 85 Parameter descriptions: 86 name Name of node to return 87 """ 88 if self.name == name: 89 return self 90 for child in self.children: 91 node = child.GetNode(name) 92 if node: 93 return node 94 return None 95 96 def GetParentNode(self, name, parent_node=None): 97 """ 98 Return parent of node with matching name. Return none if not found. 99 100 Parameter descriptions: 101 name Name of node to get parent of 102 parent_node Parent of current node 103 """ 104 if self.name == name: 105 return parent_node 106 for child in self.children: 107 found_node = child.GetParentNode(name, self) 108 if found_node: 109 return found_node 110 return None 111 112 def GetPath(self, name, path=None): 113 """ 114 Return list of node names from head to matching name. 115 Return None if not found. 116 117 Parameter descriptions: 118 name Name of node 119 path List of node names from head to current node 120 """ 121 if not path: 122 path = [] 123 if self.name == name: 124 path.append(self.name) 125 return path 126 for child in self.children: 127 match = child.GetPath(name, path + [self.name]) 128 if match: 129 return match 130 return None 131 132 def GetPathRegex(self, name, regex_str, path=None): 133 """ 134 Return list of node paths that end in name, or match regex_str. 135 Return empty list if not found. 136 137 Parameter descriptions: 138 name Name of node to search for 139 regex_str Regex string to match node names 140 path Path of node names from head to current node 141 """ 142 new_paths = [] 143 if not path: 144 path = [] 145 match = re.match(regex_str, self.name) 146 if (self.name == name) or (match): 147 new_paths.append(path + [self.name]) 148 for child in self.children: 149 return_paths = None 150 full_path = path + [self.name] 151 return_paths = child.GetPathRegex(name, regex_str, full_path) 152 for i in return_paths: 153 new_paths.append(i) 154 return new_paths 155 156 def MoveNode(self, from_name, to_name): 157 """ 158 Mode existing from_name node to become child of to_name node. 159 160 Parameter descriptions: 161 from_name Name of node to make a child of to_name 162 to_name Name of node to make parent of from_name 163 """ 164 parent_from_node = self.GetParentNode(from_name) 165 from_node = self.GetNode(from_name) 166 parent_from_node.RemoveChild(from_name) 167 to_node = self.GetNode(to_name) 168 to_node.AddChildNode(from_node) 169 170 def ReorderDeps(self, name, regex_str): 171 """ 172 Reorder dependency tree. If tree contains nodes with names that 173 match 'name' and 'regex_str', move 'regex_str' nodes that are 174 to the right of 'name' node, so that they become children of the 175 'name' node. 176 177 Parameter descriptions: 178 name Name of node to look for 179 regex_str Regex string to match names to 180 """ 181 name_path = self.GetPath(name) 182 if not name_path: 183 return 184 paths = self.GetPathRegex(name, regex_str) 185 is_name_in_paths = False 186 name_index = 0 187 for i in range(len(paths)): 188 path = paths[i] 189 if path[-1] == name: 190 is_name_in_paths = True 191 name_index = i 192 break 193 if not is_name_in_paths: 194 return 195 for i in range(name_index + 1, len(paths)): 196 path = paths[i] 197 if name in path: 198 continue 199 from_name = path[-1] 200 self.MoveNode(from_name, name) 201 202 def GetInstallList(self): 203 """ 204 Return post-order list of node names. 205 206 Parameter descriptions: 207 """ 208 install_list = [] 209 for child in self.children: 210 child_install_list = child.GetInstallList() 211 install_list.extend(child_install_list) 212 install_list.append(self.name) 213 return install_list 214 215 def PrintTree(self, level=0): 216 """ 217 Print pre-order node names with indentation denoting node depth level. 218 219 Parameter descriptions: 220 level Current depth level 221 """ 222 INDENT_PER_LEVEL = 4 223 print(" " * (level * INDENT_PER_LEVEL) + self.name) 224 for child in self.children: 225 child.PrintTree(level + 1) 226 227 228def check_call_cmd(*cmd, **kwargs): 229 """ 230 Verbose prints the directory location the given command is called from and 231 the command, then executes the command using check_call. 232 233 Parameter descriptions: 234 dir Directory location command is to be called from 235 cmd List of parameters constructing the complete command 236 """ 237 printline(os.getcwd(), ">", " ".join(cmd)) 238 check_call(cmd, **kwargs) 239 240 241def clone_pkg(pkg, branch): 242 """ 243 Clone the given openbmc package's git repository from gerrit into 244 the WORKSPACE location 245 246 Parameter descriptions: 247 pkg Name of the package to clone 248 branch Branch to clone from pkg 249 """ 250 pkg_dir = os.path.join(WORKSPACE, pkg) 251 if os.path.exists(os.path.join(pkg_dir, ".git")): 252 return pkg_dir 253 pkg_repo = urljoin("https://gerrit.openbmc.org/openbmc/", pkg) 254 os.mkdir(pkg_dir) 255 printline(pkg_dir, "> git clone", pkg_repo, branch, "./") 256 try: 257 # first try the branch 258 clone = Repo.clone_from(pkg_repo, pkg_dir, branch=branch) 259 repo_inst = clone.working_dir 260 except Exception: 261 printline("Input branch not found, default to master") 262 clone = Repo.clone_from(pkg_repo, pkg_dir, branch="master") 263 repo_inst = clone.working_dir 264 return repo_inst 265 266 267def make_target_exists(target): 268 """ 269 Runs a check against the makefile in the current directory to determine 270 if the target exists so that it can be built. 271 272 Parameter descriptions: 273 target The make target we are checking 274 """ 275 try: 276 cmd = ["make", "-n", target] 277 with open(os.devnull, "w") as devnull: 278 check_call(cmd, stdout=devnull, stderr=devnull) 279 return True 280 except CalledProcessError: 281 return False 282 283 284make_parallel = [ 285 "make", 286 # Run enough jobs to saturate all the cpus 287 "-j", 288 str(multiprocessing.cpu_count()), 289 # Don't start more jobs if the load avg is too high 290 "-l", 291 str(multiprocessing.cpu_count()), 292 # Synchronize the output so logs aren't intermixed in stdout / stderr 293 "-O", 294] 295 296 297def build_and_install(name, build_for_testing=False): 298 """ 299 Builds and installs the package in the environment. Optionally 300 builds the examples and test cases for package. 301 302 Parameter description: 303 name The name of the package we are building 304 build_for_testing Enable options related to testing on the package? 305 """ 306 os.chdir(os.path.join(WORKSPACE, name)) 307 308 # Refresh dynamic linker run time bindings for dependencies 309 check_call_cmd("sudo", "-n", "--", "ldconfig") 310 311 pkg = Package() 312 if build_for_testing: 313 pkg.test() 314 else: 315 pkg.install() 316 317 318def build_dep_tree(name, pkgdir, dep_added, head, branch, dep_tree=None): 319 """ 320 For each package (name), starting with the package to be unit tested, 321 extract its dependencies. For each package dependency defined, recursively 322 apply the same strategy 323 324 Parameter descriptions: 325 name Name of the package 326 pkgdir Directory where package source is located 327 dep_added Current dict of dependencies and added status 328 head Head node of the dependency tree 329 branch Branch to clone from pkg 330 dep_tree Current dependency tree node 331 """ 332 if not dep_tree: 333 dep_tree = head 334 335 with open("/tmp/depcache", "r") as depcache: 336 cache = depcache.readline() 337 338 # Read out pkg dependencies 339 pkg = Package(name, pkgdir) 340 341 build = pkg.build_system() 342 if not build: 343 raise Exception(f"Unable to find build system for {name}.") 344 345 for dep in set(build.dependencies()): 346 if dep in cache: 347 continue 348 # Dependency package not already known 349 if dep_added.get(dep) is None: 350 print(f"Adding {dep} dependency to {name}.") 351 # Dependency package not added 352 new_child = dep_tree.AddChild(dep) 353 dep_added[dep] = False 354 dep_pkgdir = clone_pkg(dep, branch) 355 # Determine this dependency package's 356 # dependencies and add them before 357 # returning to add this package 358 dep_added = build_dep_tree( 359 dep, dep_pkgdir, dep_added, head, branch, new_child 360 ) 361 else: 362 # Dependency package known and added 363 if dep_added[dep]: 364 continue 365 else: 366 # Cyclic dependency failure 367 raise Exception("Cyclic dependencies found in " + name) 368 369 if not dep_added[name]: 370 dep_added[name] = True 371 372 return dep_added 373 374 375def run_cppcheck(): 376 if not os.path.exists(os.path.join("build", "compile_commands.json")): 377 return None 378 379 with TemporaryDirectory() as cpp_dir: 380 # http://cppcheck.sourceforge.net/manual.pdf 381 try: 382 check_call_cmd( 383 "cppcheck", 384 "-j", 385 str(multiprocessing.cpu_count()), 386 "--enable=style,performance,portability,missingInclude", 387 "--inline-suppr", 388 "--suppress=useStlAlgorithm", 389 "--suppress=unusedStructMember", 390 "--suppress=postfixOperator", 391 "--suppress=unreadVariable", 392 "--suppress=knownConditionTrueFalse", 393 "--library=googletest", 394 "--project=build/compile_commands.json", 395 f"--cppcheck-build-dir={cpp_dir}", 396 ) 397 except subprocess.CalledProcessError: 398 print("cppcheck found errors") 399 400 401def is_valgrind_safe(): 402 """ 403 Returns whether it is safe to run valgrind on our platform 404 """ 405 src = "unit-test-vg.c" 406 exe = "./unit-test-vg" 407 with open(src, "w") as h: 408 h.write("#include <errno.h>\n") 409 h.write("#include <stdio.h>\n") 410 h.write("#include <stdlib.h>\n") 411 h.write("#include <string.h>\n") 412 h.write("int main() {\n") 413 h.write("char *heap_str = malloc(16);\n") 414 h.write('strcpy(heap_str, "RandString");\n') 415 h.write('int res = strcmp("RandString", heap_str);\n') 416 h.write("free(heap_str);\n") 417 h.write("char errstr[64];\n") 418 h.write("strerror_r(EINVAL, errstr, sizeof(errstr));\n") 419 h.write('printf("%s\\n", errstr);\n') 420 h.write("return res;\n") 421 h.write("}\n") 422 try: 423 with open(os.devnull, "w") as devnull: 424 check_call( 425 ["gcc", "-O2", "-o", exe, src], stdout=devnull, stderr=devnull 426 ) 427 check_call( 428 ["valgrind", "--error-exitcode=99", exe], 429 stdout=devnull, 430 stderr=devnull, 431 ) 432 return True 433 except Exception: 434 sys.stderr.write("###### Platform is not valgrind safe ######\n") 435 return False 436 finally: 437 os.remove(src) 438 os.remove(exe) 439 440 441def is_sanitize_safe(): 442 """ 443 Returns whether it is safe to run sanitizers on our platform 444 """ 445 src = "unit-test-sanitize.c" 446 exe = "./unit-test-sanitize" 447 with open(src, "w") as h: 448 h.write("int main() { return 0; }\n") 449 try: 450 with open(os.devnull, "w") as devnull: 451 check_call( 452 [ 453 "gcc", 454 "-O2", 455 "-fsanitize=address", 456 "-fsanitize=undefined", 457 "-o", 458 exe, 459 src, 460 ], 461 stdout=devnull, 462 stderr=devnull, 463 ) 464 check_call([exe], stdout=devnull, stderr=devnull) 465 466 # TODO - Sanitizer not working on ppc64le 467 # https://github.com/openbmc/openbmc-build-scripts/issues/31 468 if platform.processor() == "ppc64le": 469 sys.stderr.write("###### ppc64le is not sanitize safe ######\n") 470 return False 471 else: 472 return True 473 except Exception: 474 sys.stderr.write("###### Platform is not sanitize safe ######\n") 475 return False 476 finally: 477 os.remove(src) 478 os.remove(exe) 479 480 481def maybe_make_valgrind(): 482 """ 483 Potentially runs the unit tests through valgrind for the package 484 via `make check-valgrind`. If the package does not have valgrind testing 485 then it just skips over this. 486 """ 487 # Valgrind testing is currently broken by an aggressive strcmp optimization 488 # that is inlined into optimized code for POWER by gcc 7+. Until we find 489 # a workaround, just don't run valgrind tests on POWER. 490 # https://github.com/openbmc/openbmc/issues/3315 491 if not is_valgrind_safe(): 492 sys.stderr.write("###### Skipping valgrind ######\n") 493 return 494 if not make_target_exists("check-valgrind"): 495 return 496 497 try: 498 cmd = make_parallel + ["check-valgrind"] 499 check_call_cmd(*cmd) 500 except CalledProcessError: 501 for root, _, files in os.walk(os.getcwd()): 502 for f in files: 503 if re.search("test-suite-[a-z]+.log", f) is None: 504 continue 505 check_call_cmd("cat", os.path.join(root, f)) 506 raise Exception("Valgrind tests failed") 507 508 509def maybe_make_coverage(): 510 """ 511 Potentially runs the unit tests through code coverage for the package 512 via `make check-code-coverage`. If the package does not have code coverage 513 testing then it just skips over this. 514 """ 515 if not make_target_exists("check-code-coverage"): 516 return 517 518 # Actually run code coverage 519 try: 520 cmd = make_parallel + ["check-code-coverage"] 521 check_call_cmd(*cmd) 522 except CalledProcessError: 523 raise Exception("Code coverage failed") 524 525 526class BuildSystem(object): 527 """ 528 Build systems generally provide the means to configure, build, install and 529 test software. The BuildSystem class defines a set of interfaces on top of 530 which Autotools, Meson, CMake and possibly other build system drivers can 531 be implemented, separating out the phases to control whether a package 532 should merely be installed or also tested and analyzed. 533 """ 534 535 def __init__(self, package, path): 536 """Initialise the driver with properties independent of the build 537 system 538 539 Keyword arguments: 540 package: The name of the package. Derived from the path if None 541 path: The path to the package. Set to the working directory if None 542 """ 543 self.path = "." if not path else path 544 realpath = os.path.realpath(self.path) 545 self.package = package if package else os.path.basename(realpath) 546 self.build_for_testing = False 547 548 def probe(self): 549 """Test if the build system driver can be applied to the package 550 551 Return True if the driver can drive the package's build system, 552 otherwise False. 553 554 Generally probe() is implemented by testing for the presence of the 555 build system's configuration file(s). 556 """ 557 raise NotImplementedError 558 559 def dependencies(self): 560 """Provide the package's dependencies 561 562 Returns a list of dependencies. If no dependencies are required then an 563 empty list must be returned. 564 565 Generally dependencies() is implemented by analysing and extracting the 566 data from the build system configuration. 567 """ 568 raise NotImplementedError 569 570 def configure(self, build_for_testing): 571 """Configure the source ready for building 572 573 Should raise an exception if configuration failed. 574 575 Keyword arguments: 576 build_for_testing: Mark the package as being built for testing rather 577 than for installation as a dependency for the 578 package under test. Setting to True generally 579 implies that the package will be configured to build 580 with debug information, at a low level of 581 optimisation and possibly with sanitizers enabled. 582 583 Generally configure() is implemented by invoking the build system 584 tooling to generate Makefiles or equivalent. 585 """ 586 raise NotImplementedError 587 588 def build(self): 589 """Build the software ready for installation and/or testing 590 591 Should raise an exception if the build fails 592 593 Generally build() is implemented by invoking `make` or `ninja`. 594 """ 595 raise NotImplementedError 596 597 def install(self): 598 """Install the software ready for use 599 600 Should raise an exception if installation fails 601 602 Like build(), install() is generally implemented by invoking `make` or 603 `ninja`. 604 """ 605 raise NotImplementedError 606 607 def test(self): 608 """Build and run the test suite associated with the package 609 610 Should raise an exception if the build or testing fails. 611 612 Like install(), test() is generally implemented by invoking `make` or 613 `ninja`. 614 """ 615 raise NotImplementedError 616 617 def analyze(self): 618 """Run any supported analysis tools over the codebase 619 620 Should raise an exception if analysis fails. 621 622 Some analysis tools such as scan-build need injection into the build 623 system. analyze() provides the necessary hook to implement such 624 behaviour. Analyzers independent of the build system can also be 625 specified here but at the cost of possible duplication of code between 626 the build system driver implementations. 627 """ 628 raise NotImplementedError 629 630 631class Autotools(BuildSystem): 632 def __init__(self, package=None, path=None): 633 super(Autotools, self).__init__(package, path) 634 635 def probe(self): 636 return os.path.isfile(os.path.join(self.path, "configure.ac")) 637 638 def dependencies(self): 639 configure_ac = os.path.join(self.path, "configure.ac") 640 641 contents = "" 642 # Prepend some special function overrides so we can parse out 643 # dependencies 644 for macro in DEPENDENCIES.keys(): 645 contents += ( 646 "m4_define([" 647 + macro 648 + "], [" 649 + macro 650 + "_START$" 651 + str(DEPENDENCIES_OFFSET[macro] + 1) 652 + macro 653 + "_END])\n" 654 ) 655 with open(configure_ac, "rt") as f: 656 contents += f.read() 657 658 autoconf_cmdline = ["autoconf", "-Wno-undefined", "-"] 659 autoconf_process = subprocess.Popen( 660 autoconf_cmdline, 661 stdin=subprocess.PIPE, 662 stdout=subprocess.PIPE, 663 stderr=subprocess.PIPE, 664 ) 665 document = contents.encode("utf-8") 666 (stdout, stderr) = autoconf_process.communicate(input=document) 667 if not stdout: 668 print(stderr) 669 raise Exception("Failed to run autoconf for parsing dependencies") 670 671 # Parse out all of the dependency text 672 matches = [] 673 for macro in DEPENDENCIES.keys(): 674 pattern = "(" + macro + ")_START(.*?)" + macro + "_END" 675 for match in re.compile(pattern).finditer(stdout.decode("utf-8")): 676 matches.append((match.group(1), match.group(2))) 677 678 # Look up dependencies from the text 679 found_deps = [] 680 for macro, deptext in matches: 681 for potential_dep in deptext.split(" "): 682 for known_dep in DEPENDENCIES[macro].keys(): 683 if potential_dep.startswith(known_dep): 684 found_deps.append(DEPENDENCIES[macro][known_dep]) 685 686 return found_deps 687 688 def _configure_feature(self, flag, enabled): 689 """ 690 Returns an configure flag as a string 691 692 Parameters: 693 flag The name of the flag 694 enabled Whether the flag is enabled or disabled 695 """ 696 return "--" + ("enable" if enabled else "disable") + "-" + flag 697 698 def configure(self, build_for_testing): 699 self.build_for_testing = build_for_testing 700 conf_flags = [ 701 self._configure_feature("silent-rules", False), 702 self._configure_feature("examples", build_for_testing), 703 self._configure_feature("tests", build_for_testing), 704 self._configure_feature("itests", INTEGRATION_TEST), 705 ] 706 conf_flags.extend( 707 [ 708 self._configure_feature("code-coverage", False), 709 self._configure_feature("valgrind", build_for_testing), 710 ] 711 ) 712 # Add any necessary configure flags for package 713 if CONFIGURE_FLAGS.get(self.package) is not None: 714 conf_flags.extend(CONFIGURE_FLAGS.get(self.package)) 715 for bootstrap in ["bootstrap.sh", "bootstrap", "autogen.sh"]: 716 if os.path.exists(bootstrap): 717 check_call_cmd("./" + bootstrap) 718 break 719 check_call_cmd("./configure", *conf_flags) 720 721 def build(self): 722 check_call_cmd(*make_parallel) 723 724 def install(self): 725 check_call_cmd("sudo", "-n", "--", *(make_parallel + ["install"])) 726 727 def test(self): 728 try: 729 cmd = make_parallel + ["check"] 730 for i in range(0, args.repeat): 731 check_call_cmd(*cmd) 732 733 maybe_make_valgrind() 734 maybe_make_coverage() 735 except CalledProcessError: 736 for root, _, files in os.walk(os.getcwd()): 737 if "test-suite.log" not in files: 738 continue 739 check_call_cmd("cat", os.path.join(root, "test-suite.log")) 740 raise Exception("Unit tests failed") 741 742 def analyze(self): 743 run_cppcheck() 744 745 746class CMake(BuildSystem): 747 def __init__(self, package=None, path=None): 748 super(CMake, self).__init__(package, path) 749 750 def probe(self): 751 return os.path.isfile(os.path.join(self.path, "CMakeLists.txt")) 752 753 def dependencies(self): 754 return [] 755 756 def configure(self, build_for_testing): 757 self.build_for_testing = build_for_testing 758 if INTEGRATION_TEST: 759 check_call_cmd( 760 "cmake", 761 "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON", 762 "-DCMAKE_CXX_FLAGS='-DBOOST_USE_VALGRIND'", 763 "-DITESTS=ON", 764 ".", 765 ) 766 else: 767 check_call_cmd( 768 "cmake", 769 "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON", 770 "-DCMAKE_CXX_FLAGS='-DBOOST_USE_VALGRIND'", 771 ".", 772 ) 773 774 def build(self): 775 check_call_cmd( 776 "cmake", 777 "--build", 778 ".", 779 "--", 780 "-j", 781 str(multiprocessing.cpu_count()), 782 ) 783 784 def install(self): 785 check_call_cmd("sudo", "cmake", "--install", ".") 786 787 def test(self): 788 if make_target_exists("test"): 789 check_call_cmd("ctest", ".") 790 791 def analyze(self): 792 if os.path.isfile(".clang-tidy"): 793 with TemporaryDirectory(prefix="build", dir=".") as build_dir: 794 # clang-tidy needs to run on a clang-specific build 795 check_call_cmd( 796 "cmake", 797 "-DCMAKE_C_COMPILER=clang", 798 "-DCMAKE_CXX_COMPILER=clang++", 799 "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON", 800 "-H.", 801 "-B" + build_dir, 802 ) 803 804 check_call_cmd( 805 "run-clang-tidy", "-header-filter=.*", "-p", build_dir 806 ) 807 808 maybe_make_valgrind() 809 maybe_make_coverage() 810 run_cppcheck() 811 812 813class Meson(BuildSystem): 814 @staticmethod 815 def _project_name(path): 816 doc = subprocess.check_output( 817 ["meson", "introspect", "--projectinfo", path], 818 stderr=subprocess.STDOUT, 819 ).decode("utf-8") 820 return json.loads(doc)["descriptive_name"] 821 822 def __init__(self, package=None, path=None): 823 super(Meson, self).__init__(package, path) 824 825 def probe(self): 826 return os.path.isfile(os.path.join(self.path, "meson.build")) 827 828 def dependencies(self): 829 meson_build = os.path.join(self.path, "meson.build") 830 if not os.path.exists(meson_build): 831 return [] 832 833 found_deps = [] 834 for root, dirs, files in os.walk(self.path): 835 if "meson.build" not in files: 836 continue 837 with open(os.path.join(root, "meson.build"), "rt") as f: 838 build_contents = f.read() 839 pattern = r"dependency\('([^']*)'.*?\),?\n" 840 for match in re.finditer(pattern, build_contents): 841 group = match.group(1) 842 maybe_dep = DEPENDENCIES["PKG_CHECK_MODULES"].get(group) 843 if maybe_dep is not None: 844 found_deps.append(maybe_dep) 845 846 return found_deps 847 848 def _parse_options(self, options_file): 849 """ 850 Returns a set of options defined in the provides meson_options.txt file 851 852 Parameters: 853 options_file The file containing options 854 """ 855 oi = optinterpreter.OptionInterpreter("") 856 oi.process(options_file) 857 return oi.options 858 859 def _configure_boolean(self, val): 860 """ 861 Returns the meson flag which signifies the value 862 863 True is true which requires the boolean. 864 False is false which disables the boolean. 865 866 Parameters: 867 val The value being converted 868 """ 869 if val is True: 870 return "true" 871 elif val is False: 872 return "false" 873 else: 874 raise Exception("Bad meson boolean value") 875 876 def _configure_feature(self, val): 877 """ 878 Returns the meson flag which signifies the value 879 880 True is enabled which requires the feature. 881 False is disabled which disables the feature. 882 None is auto which autodetects the feature. 883 884 Parameters: 885 val The value being converted 886 """ 887 if val is True: 888 return "enabled" 889 elif val is False: 890 return "disabled" 891 elif val is None: 892 return "auto" 893 else: 894 raise Exception("Bad meson feature value") 895 896 def _configure_option(self, opts, key, val): 897 """ 898 Returns the meson flag which signifies the value 899 based on the type of the opt 900 901 Parameters: 902 opt The meson option which we are setting 903 val The value being converted 904 """ 905 if isinstance(opts[key], coredata.UserBooleanOption): 906 str_val = self._configure_boolean(val) 907 elif isinstance(opts[key], coredata.UserFeatureOption): 908 str_val = self._configure_feature(val) 909 else: 910 raise Exception("Unknown meson option type") 911 return "-D{}={}".format(key, str_val) 912 913 def configure(self, build_for_testing): 914 self.build_for_testing = build_for_testing 915 meson_options = {} 916 if os.path.exists("meson.options"): 917 meson_options = self._parse_options("meson.options") 918 elif os.path.exists("meson_options.txt"): 919 meson_options = self._parse_options("meson_options.txt") 920 meson_flags = [ 921 "-Db_colorout=never", 922 "-Dwerror=true", 923 "-Dwarning_level=3", 924 "-Dcpp_args='-DBOOST_USE_VALGRIND'", 925 ] 926 if build_for_testing: 927 # -Ddebug=true -Doptimization=g is helpful for abi-dumper but isn't a combination that 928 # is supported by meson's build types. Configure it manually. 929 meson_flags.append("-Ddebug=true") 930 meson_flags.append("-Doptimization=g") 931 else: 932 meson_flags.append("--buildtype=debugoptimized") 933 if OptionKey("tests") in meson_options: 934 meson_flags.append( 935 self._configure_option( 936 meson_options, OptionKey("tests"), build_for_testing 937 ) 938 ) 939 if OptionKey("examples") in meson_options: 940 meson_flags.append( 941 self._configure_option( 942 meson_options, OptionKey("examples"), build_for_testing 943 ) 944 ) 945 if OptionKey("itests") in meson_options: 946 meson_flags.append( 947 self._configure_option( 948 meson_options, OptionKey("itests"), INTEGRATION_TEST 949 ) 950 ) 951 if MESON_FLAGS.get(self.package) is not None: 952 meson_flags.extend(MESON_FLAGS.get(self.package)) 953 try: 954 check_call_cmd( 955 "meson", "setup", "--reconfigure", "build", *meson_flags 956 ) 957 except Exception: 958 shutil.rmtree("build", ignore_errors=True) 959 check_call_cmd("meson", "setup", "build", *meson_flags) 960 961 self.package = Meson._project_name("build") 962 963 def build(self): 964 check_call_cmd("ninja", "-C", "build") 965 966 def install(self): 967 check_call_cmd("sudo", "-n", "--", "ninja", "-C", "build", "install") 968 969 def test(self): 970 # It is useful to check various settings of the meson.build file 971 # for compatibility, such as meson_version checks. We shouldn't 972 # do this in the configure path though because it affects subprojects 973 # and dependencies as well, but we only want this applied to the 974 # project-under-test (otherwise an upstream dependency could fail 975 # this check without our control). 976 self._extra_meson_checks() 977 978 try: 979 test_args = ("--repeat", str(args.repeat), "-C", "build") 980 check_call_cmd("meson", "test", "--print-errorlogs", *test_args) 981 982 except CalledProcessError: 983 raise Exception("Unit tests failed") 984 985 def _setup_exists(self, setup): 986 """ 987 Returns whether the meson build supports the named test setup. 988 989 Parameter descriptions: 990 setup The setup target to check 991 """ 992 try: 993 with open(os.devnull, "w"): 994 output = subprocess.check_output( 995 [ 996 "meson", 997 "test", 998 "-C", 999 "build", 1000 "--setup", 1001 "{}:{}".format(self.package, setup), 1002 "__likely_not_a_test__", 1003 ], 1004 stderr=subprocess.STDOUT, 1005 ) 1006 except CalledProcessError as e: 1007 output = e.output 1008 output = output.decode("utf-8") 1009 return not re.search("Unknown test setup '[^']+'[.]", output) 1010 1011 def _maybe_valgrind(self): 1012 """ 1013 Potentially runs the unit tests through valgrind for the package 1014 via `meson test`. The package can specify custom valgrind 1015 configurations by utilizing add_test_setup() in a meson.build 1016 """ 1017 if not is_valgrind_safe(): 1018 sys.stderr.write("###### Skipping valgrind ######\n") 1019 return 1020 try: 1021 if self._setup_exists("valgrind"): 1022 check_call_cmd( 1023 "meson", 1024 "test", 1025 "-t", 1026 "10", 1027 "-C", 1028 "build", 1029 "--print-errorlogs", 1030 "--setup", 1031 "{}:valgrind".format(self.package), 1032 ) 1033 else: 1034 check_call_cmd( 1035 "meson", 1036 "test", 1037 "-t", 1038 "10", 1039 "-C", 1040 "build", 1041 "--print-errorlogs", 1042 "--wrapper", 1043 "valgrind --error-exitcode=1", 1044 ) 1045 except CalledProcessError: 1046 raise Exception("Valgrind tests failed") 1047 1048 def analyze(self): 1049 self._maybe_valgrind() 1050 1051 # Run clang-tidy only if the project has a configuration 1052 if os.path.isfile(".clang-tidy"): 1053 os.environ["CXX"] = "clang++" 1054 with TemporaryDirectory(prefix="build", dir=".") as build_dir: 1055 check_call_cmd("meson", "setup", build_dir) 1056 if not os.path.isfile(".openbmc-no-clang"): 1057 check_call_cmd("meson", "compile", "-C", build_dir) 1058 try: 1059 check_call_cmd("ninja", "-C", build_dir, "clang-tidy-fix") 1060 except subprocess.CalledProcessError: 1061 check_call_cmd( 1062 "git", "-C", CODE_SCAN_DIR, "--no-pager", "diff" 1063 ) 1064 raise 1065 # Run the basic clang static analyzer otherwise 1066 else: 1067 check_call_cmd("ninja", "-C", "build", "scan-build") 1068 1069 # Run tests through sanitizers 1070 # b_lundef is needed if clang++ is CXX since it resolves the 1071 # asan symbols at runtime only. We don't want to set it earlier 1072 # in the build process to ensure we don't have undefined 1073 # runtime code. 1074 if is_sanitize_safe(): 1075 check_call_cmd( 1076 "meson", 1077 "configure", 1078 "build", 1079 "-Db_sanitize=address,undefined", 1080 "-Db_lundef=false", 1081 ) 1082 check_call_cmd( 1083 "meson", 1084 "test", 1085 "-C", 1086 "build", 1087 "--print-errorlogs", 1088 "--logbase", 1089 "testlog-ubasan", 1090 env=os.environ | {"UBSAN_OPTIONS": "halt_on_error=1"}, 1091 ) 1092 # TODO: Fix memory sanitizer 1093 # check_call_cmd('meson', 'configure', 'build', 1094 # '-Db_sanitize=memory') 1095 # check_call_cmd('meson', 'test', '-C', 'build' 1096 # '--logbase', 'testlog-msan') 1097 check_call_cmd("meson", "configure", "build", "-Db_sanitize=none") 1098 else: 1099 sys.stderr.write("###### Skipping sanitizers ######\n") 1100 1101 # Run coverage checks 1102 check_call_cmd("meson", "configure", "build", "-Db_coverage=true") 1103 self.test() 1104 # Only build coverage HTML if coverage files were produced 1105 for root, dirs, files in os.walk("build"): 1106 if any([f.endswith(".gcda") for f in files]): 1107 check_call_cmd("ninja", "-C", "build", "coverage-html") 1108 break 1109 check_call_cmd("meson", "configure", "build", "-Db_coverage=false") 1110 run_cppcheck() 1111 1112 def _extra_meson_checks(self): 1113 with open(os.path.join(self.path, "meson.build"), "rt") as f: 1114 build_contents = f.read() 1115 1116 # Find project's specified meson_version. 1117 meson_version = None 1118 pattern = r"meson_version:[^']*'([^']*)'" 1119 for match in re.finditer(pattern, build_contents): 1120 group = match.group(1) 1121 meson_version = group 1122 1123 # C++20 requires at least Meson 0.57 but Meson itself doesn't 1124 # identify this. Add to our unit-test checks so that we don't 1125 # get a meson.build missing this. 1126 pattern = r"'cpp_std=c\+\+20'" 1127 for match in re.finditer(pattern, build_contents): 1128 if not meson_version or not meson_version_compare( 1129 meson_version, ">=0.57" 1130 ): 1131 raise Exception( 1132 "C++20 support requires specifying in meson.build: " 1133 + "meson_version: '>=0.57'" 1134 ) 1135 1136 # C++23 requires at least Meson 1.1.1 but Meson itself doesn't 1137 # identify this. Add to our unit-test checks so that we don't 1138 # get a meson.build missing this. 1139 pattern = r"'cpp_std=c\+\+23'" 1140 for match in re.finditer(pattern, build_contents): 1141 if not meson_version or not meson_version_compare( 1142 meson_version, ">=1.1.1" 1143 ): 1144 raise Exception( 1145 "C++23 support requires specifying in meson.build: " 1146 + "meson_version: '>=1.1.1'" 1147 ) 1148 1149 if "get_variable(" in build_contents: 1150 if not meson_version or not meson_version_compare( 1151 meson_version, ">=0.58" 1152 ): 1153 raise Exception( 1154 "dep.get_variable() with positional argument requires " 1155 + "meson_Version: '>=0.58'" 1156 ) 1157 1158 1159class Package(object): 1160 def __init__(self, name=None, path=None): 1161 self.supported = [Meson, Autotools, CMake] 1162 self.name = name 1163 self.path = path 1164 self.test_only = False 1165 1166 def build_systems(self): 1167 instances = (system(self.name, self.path) for system in self.supported) 1168 return (instance for instance in instances if instance.probe()) 1169 1170 def build_system(self, preferred=None): 1171 systems = list(self.build_systems()) 1172 1173 if not systems: 1174 return None 1175 1176 if preferred: 1177 return {type(system): system for system in systems}[preferred] 1178 1179 return next(iter(systems)) 1180 1181 def install(self, system=None): 1182 if not system: 1183 system = self.build_system() 1184 1185 system.configure(False) 1186 system.build() 1187 system.install() 1188 1189 def _test_one(self, system): 1190 system.configure(True) 1191 system.build() 1192 system.install() 1193 system.test() 1194 if not TEST_ONLY: 1195 system.analyze() 1196 1197 def test(self): 1198 for system in self.build_systems(): 1199 self._test_one(system) 1200 1201 1202def find_file(filename, basedir): 1203 """ 1204 Finds all occurrences of a file (or list of files) in the base 1205 directory and passes them back with their relative paths. 1206 1207 Parameter descriptions: 1208 filename The name of the file (or list of files) to 1209 find 1210 basedir The base directory search in 1211 """ 1212 1213 if not isinstance(filename, list): 1214 filename = [filename] 1215 1216 filepaths = [] 1217 for root, dirs, files in os.walk(basedir): 1218 if os.path.split(root)[-1] == "subprojects": 1219 for f in files: 1220 subproject = ".".join(f.split(".")[0:-1]) 1221 if f.endswith(".wrap") and subproject in dirs: 1222 # don't find files in meson subprojects with wraps 1223 dirs.remove(subproject) 1224 for f in filename: 1225 if f in files: 1226 filepaths.append(os.path.join(root, f)) 1227 return filepaths 1228 1229 1230if __name__ == "__main__": 1231 # CONFIGURE_FLAGS = [GIT REPO]:[CONFIGURE FLAGS] 1232 CONFIGURE_FLAGS = { 1233 "phosphor-logging": [ 1234 "--enable-metadata-processing", 1235 "--enable-openpower-pel-extension", 1236 "YAML_DIR=/usr/local/share/phosphor-dbus-yaml/yaml", 1237 ] 1238 } 1239 1240 # MESON_FLAGS = [GIT REPO]:[MESON FLAGS] 1241 MESON_FLAGS = { 1242 "phosphor-dbus-interfaces": [ 1243 "-Ddata_com_ibm=true", 1244 "-Ddata_org_open_power=true", 1245 ], 1246 "phosphor-logging": ["-Dopenpower-pel-extension=enabled"], 1247 } 1248 1249 # DEPENDENCIES = [MACRO]:[library/header]:[GIT REPO] 1250 DEPENDENCIES = { 1251 "AC_CHECK_LIB": {"mapper": "phosphor-objmgr"}, 1252 "AC_CHECK_HEADER": { 1253 "host-ipmid": "phosphor-host-ipmid", 1254 "blobs-ipmid": "phosphor-ipmi-blobs", 1255 "sdbusplus": "sdbusplus", 1256 "sdeventplus": "sdeventplus", 1257 "stdplus": "stdplus", 1258 "gpioplus": "gpioplus", 1259 "phosphor-logging/log.hpp": "phosphor-logging", 1260 }, 1261 "AC_PATH_PROG": {"sdbus++": "sdbusplus"}, 1262 "PKG_CHECK_MODULES": { 1263 "phosphor-dbus-interfaces": "phosphor-dbus-interfaces", 1264 "libipmid": "phosphor-host-ipmid", 1265 "libipmid-host": "phosphor-host-ipmid", 1266 "sdbusplus": "sdbusplus", 1267 "sdeventplus": "sdeventplus", 1268 "stdplus": "stdplus", 1269 "gpioplus": "gpioplus", 1270 "phosphor-logging": "phosphor-logging", 1271 "phosphor-snmp": "phosphor-snmp", 1272 "ipmiblob": "ipmi-blob-tool", 1273 "hei": "openpower-libhei", 1274 "phosphor-ipmi-blobs": "phosphor-ipmi-blobs", 1275 "libcr51sign": "google-misc", 1276 }, 1277 } 1278 1279 # Offset into array of macro parameters MACRO(0, 1, ...N) 1280 DEPENDENCIES_OFFSET = { 1281 "AC_CHECK_LIB": 0, 1282 "AC_CHECK_HEADER": 0, 1283 "AC_PATH_PROG": 1, 1284 "PKG_CHECK_MODULES": 1, 1285 } 1286 1287 # DEPENDENCIES_REGEX = [GIT REPO]:[REGEX STRING] 1288 DEPENDENCIES_REGEX = {"phosphor-logging": r"\S+-dbus-interfaces$"} 1289 1290 # Set command line arguments 1291 parser = argparse.ArgumentParser() 1292 parser.add_argument( 1293 "-w", 1294 "--workspace", 1295 dest="WORKSPACE", 1296 required=True, 1297 help="Workspace directory location(i.e. /home)", 1298 ) 1299 parser.add_argument( 1300 "-p", 1301 "--package", 1302 dest="PACKAGE", 1303 required=True, 1304 help="OpenBMC package to be unit tested", 1305 ) 1306 parser.add_argument( 1307 "-t", 1308 "--test-only", 1309 dest="TEST_ONLY", 1310 action="store_true", 1311 required=False, 1312 default=False, 1313 help="Only run test cases, no other validation", 1314 ) 1315 arg_inttests = parser.add_mutually_exclusive_group() 1316 arg_inttests.add_argument( 1317 "--integration-tests", 1318 dest="INTEGRATION_TEST", 1319 action="store_true", 1320 required=False, 1321 default=True, 1322 help="Enable integration tests [default].", 1323 ) 1324 arg_inttests.add_argument( 1325 "--no-integration-tests", 1326 dest="INTEGRATION_TEST", 1327 action="store_false", 1328 required=False, 1329 help="Disable integration tests.", 1330 ) 1331 parser.add_argument( 1332 "-v", 1333 "--verbose", 1334 action="store_true", 1335 help="Print additional package status messages", 1336 ) 1337 parser.add_argument( 1338 "-r", "--repeat", help="Repeat tests N times", type=int, default=1 1339 ) 1340 parser.add_argument( 1341 "-b", 1342 "--branch", 1343 dest="BRANCH", 1344 required=False, 1345 help="Branch to target for dependent repositories", 1346 default="master", 1347 ) 1348 parser.add_argument( 1349 "-n", 1350 "--noformat", 1351 dest="FORMAT", 1352 action="store_false", 1353 required=False, 1354 help="Whether or not to run format code", 1355 ) 1356 args = parser.parse_args(sys.argv[1:]) 1357 WORKSPACE = args.WORKSPACE 1358 UNIT_TEST_PKG = args.PACKAGE 1359 TEST_ONLY = args.TEST_ONLY 1360 INTEGRATION_TEST = args.INTEGRATION_TEST 1361 BRANCH = args.BRANCH 1362 FORMAT_CODE = args.FORMAT 1363 if args.verbose: 1364 1365 def printline(*line): 1366 for arg in line: 1367 print(arg, end=" ") 1368 print() 1369 1370 else: 1371 1372 def printline(*line): 1373 pass 1374 1375 CODE_SCAN_DIR = os.path.join(WORKSPACE, UNIT_TEST_PKG) 1376 1377 # Run format-code.sh, which will in turn call any repo-level formatters. 1378 if FORMAT_CODE: 1379 check_call_cmd( 1380 os.path.join( 1381 WORKSPACE, "openbmc-build-scripts", "scripts", "format-code.sh" 1382 ), 1383 CODE_SCAN_DIR, 1384 ) 1385 1386 # Check to see if any files changed 1387 check_call_cmd( 1388 "git", "-C", CODE_SCAN_DIR, "--no-pager", "diff", "--exit-code" 1389 ) 1390 1391 # Check if this repo has a supported make infrastructure 1392 pkg = Package(UNIT_TEST_PKG, CODE_SCAN_DIR) 1393 if not pkg.build_system(): 1394 print("No valid build system, exit") 1395 sys.exit(0) 1396 1397 prev_umask = os.umask(000) 1398 1399 # Determine dependencies and add them 1400 dep_added = dict() 1401 dep_added[UNIT_TEST_PKG] = False 1402 1403 # Create dependency tree 1404 dep_tree = DepTree(UNIT_TEST_PKG) 1405 build_dep_tree(UNIT_TEST_PKG, CODE_SCAN_DIR, dep_added, dep_tree, BRANCH) 1406 1407 # Reorder Dependency Tree 1408 for pkg_name, regex_str in DEPENDENCIES_REGEX.items(): 1409 dep_tree.ReorderDeps(pkg_name, regex_str) 1410 if args.verbose: 1411 dep_tree.PrintTree() 1412 1413 install_list = dep_tree.GetInstallList() 1414 1415 # We don't want to treat our package as a dependency 1416 install_list.remove(UNIT_TEST_PKG) 1417 1418 # Install reordered dependencies 1419 for dep in install_list: 1420 build_and_install(dep, False) 1421 1422 # Run package unit tests 1423 build_and_install(UNIT_TEST_PKG, True) 1424 1425 os.umask(prev_umask) 1426 1427 # Run any custom CI scripts the repo has, of which there can be 1428 # multiple of and anywhere in the repository. 1429 ci_scripts = find_file(["run-ci.sh", "run-ci"], CODE_SCAN_DIR) 1430 if ci_scripts: 1431 os.chdir(CODE_SCAN_DIR) 1432 for ci_script in ci_scripts: 1433 check_call_cmd(ci_script) 1434