blob: 1a845f71d08a173504c3c9f2862281a033511aa8 [file] [log] [blame]
Matthew Barthccb7f852016-11-23 17:43:02 -06001#!/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
Matthew Barthd1810372016-12-19 16:57:21 -060010from git import Repo
Matthew Barthccb7f852016-11-23 17:43:02 -060011from urlparse import urljoin
Andrew Jefferya4e31c62018-03-08 13:45:28 +103012from subprocess import check_call, call, CalledProcessError
Matthew Barthccb7f852016-11-23 17:43:02 -060013import os
14import sys
Matthew Barth33df8792016-12-19 14:30:17 -060015import argparse
William A. Kennington IIIa2156732018-06-30 18:38:09 -070016import multiprocessing
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -050017import re
William A. Kennington III9a32d5e2018-12-06 17:38:53 -080018import sets
William A. Kennington IIIe67f5fc2018-12-06 17:40:30 -080019import subprocess
William A. Kennington III3f1d1202018-12-06 18:02:07 -080020import shutil
William A. Kennington III4e1d0a12018-07-16 12:04:03 -070021import platform
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -050022
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)
Matthew Barth33df8792016-12-19 14:30:17 -0600217
218
219def check_call_cmd(dir, *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(dir, ">", " ".join(cmd))
229 check_call(cmd)
Matthew Barthccb7f852016-11-23 17:43:02 -0600230
231
Andrew Geisslera61acb52019-01-03 16:32:44 -0600232def clone_pkg(pkg, branch):
Matthew Barth33df8792016-12-19 14:30:17 -0600233 """
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
Andrew Geisslera61acb52019-01-03 16:32:44 -0600239 branch Branch to clone from pkg
Matthew Barth33df8792016-12-19 14:30:17 -0600240 """
Andrew Jeffery7be94ca2018-03-08 13:15:33 +1030241 pkg_dir = os.path.join(WORKSPACE, pkg)
242 if os.path.exists(os.path.join(pkg_dir, '.git')):
243 return pkg_dir
Matthew Barthccb7f852016-11-23 17:43:02 -0600244 pkg_repo = urljoin('https://gerrit.openbmc-project.xyz/openbmc/', pkg)
Andrew Jeffery7be94ca2018-03-08 13:15:33 +1030245 os.mkdir(pkg_dir)
Andrew Geisslera61acb52019-01-03 16:32:44 -0600246 printline(pkg_dir, "> git clone", pkg_repo, branch, "./")
247 try:
248 # first try the branch
249 repo_inst = Repo.clone_from(pkg_repo, pkg_dir,
250 branch=branch).working_dir
251 except:
252 printline("Input branch not found, default to master")
253 repo_inst = Repo.clone_from(pkg_repo, pkg_dir,
254 branch="master").working_dir
255 return repo_inst
Matthew Barth33df8792016-12-19 14:30:17 -0600256
257
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800258def get_autoconf_deps(pkgdir):
259 """
260 Parse the given 'configure.ac' file for package dependencies and return
261 a list of the dependencies found. If the package is not autoconf it is just
262 ignored.
263
264 Parameter descriptions:
265 pkgdir Directory where package source is located
266 """
267 configure_ac = os.path.join(pkgdir, 'configure.ac')
268 if not os.path.exists(configure_ac):
269 return []
270
William A. Kennington IIIe67f5fc2018-12-06 17:40:30 -0800271 configure_ac_contents = ''
272 # Prepend some special function overrides so we can parse out dependencies
273 for macro in DEPENDENCIES.iterkeys():
274 configure_ac_contents += ('m4_define([' + macro + '], [' +
275 macro + '_START$' + str(DEPENDENCIES_OFFSET[macro] + 1) +
276 macro + '_END])\n')
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800277 with open(configure_ac, "rt") as f:
William A. Kennington IIIe67f5fc2018-12-06 17:40:30 -0800278 configure_ac_contents += f.read()
279
280 autoconf_process = subprocess.Popen(['autoconf', '-Wno-undefined', '-'],
281 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
282 stderr=subprocess.PIPE)
283 (stdout, stderr) = autoconf_process.communicate(input=configure_ac_contents)
284 if not stdout:
285 print(stderr)
286 raise Exception("Failed to run autoconf for parsing dependencies")
287
288 # Parse out all of the dependency text
289 matches = []
290 for macro in DEPENDENCIES.iterkeys():
291 pattern = '(' + macro + ')_START(.*?)' + macro + '_END'
292 for match in re.compile(pattern).finditer(stdout):
293 matches.append((match.group(1), match.group(2)))
294
295 # Look up dependencies from the text
296 found_deps = []
297 for macro, deptext in matches:
298 for potential_dep in deptext.split(' '):
299 for known_dep in DEPENDENCIES[macro].iterkeys():
300 if potential_dep.startswith(known_dep):
301 found_deps.append(DEPENDENCIES[macro][known_dep])
302
303 return found_deps
Matthew Barthccb7f852016-11-23 17:43:02 -0600304
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800305def get_meson_deps(pkgdir):
306 """
307 Parse the given 'meson.build' file for package dependencies and return
308 a list of the dependencies found. If the package is not meson compatible
309 it is just ignored.
310
311 Parameter descriptions:
312 pkgdir Directory where package source is located
313 """
314 meson_build = os.path.join(pkgdir, 'meson.build')
315 if not os.path.exists(meson_build):
316 return []
317
318 found_deps = []
319 for root, dirs, files in os.walk(pkgdir):
320 if 'meson.build' not in files:
321 continue
322 with open(os.path.join(root, 'meson.build'), 'rt') as f:
323 build_contents = f.read()
324 for match in re.finditer(r"dependency\('([^']*)'.*?\)\n", build_contents):
325 maybe_dep = DEPENDENCIES['PKG_CHECK_MODULES'].get(match.group(1))
326 if maybe_dep is not None:
327 found_deps.append(maybe_dep)
328
329 return found_deps
330
William A. Kennington IIIa2156732018-06-30 18:38:09 -0700331make_parallel = [
332 'make',
333 # Run enough jobs to saturate all the cpus
334 '-j', str(multiprocessing.cpu_count()),
335 # Don't start more jobs if the load avg is too high
336 '-l', str(multiprocessing.cpu_count()),
337 # Synchronize the output so logs aren't intermixed in stdout / stderr
338 '-O',
339]
340
William A. Kennington IIIa0454912018-12-06 14:47:16 -0800341def enFlag(flag, enabled):
342 """
343 Returns an configure flag as a string
344
345 Parameters:
346 flag The name of the flag
347 enabled Whether the flag is enabled or disabled
348 """
349 return '--' + ('enable' if enabled else 'disable') + '-' + flag
350
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800351def mesonFeature(val):
352 """
353 Returns the meson flag which signifies the value
354
355 True is enabled which requires the feature.
356 False is disabled which disables the feature.
357 None is auto which autodetects the feature.
358
359 Parameters:
360 val The value being converted
361 """
362 if val is True:
363 return "enabled"
364 elif val is False:
365 return "disabled"
366 elif val is None:
367 return "auto"
368 else:
369 raise Exception("Bad meson feature value")
370
William A. Kennington III6764d5f2018-12-13 12:27:03 -0800371def parse_meson_options(options_file):
372 """
373 Returns a set of options defined in the provides meson_options.txt file
374
375 Parameters:
376 options_file The file containing options
377 """
378 options_contents = ''
379 with open(options_file, "rt") as f:
380 options_contents += f.read()
381 options = sets.Set()
382 pattern = 'option\\(\\s*\'([^\']*)\''
383 for match in re.compile(pattern).finditer(options_contents):
384 options.add(match.group(1))
385 return options
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800386
William A. Kennington IIIa0454912018-12-06 14:47:16 -0800387def build_and_install(pkg, build_for_testing=False):
William A. Kennington III780ec092018-12-06 14:46:50 -0800388 """
389 Builds and installs the package in the environment. Optionally
390 builds the examples and test cases for package.
391
392 Parameter description:
393 pkg The package we are building
William A. Kennington IIIa0454912018-12-06 14:47:16 -0800394 build_for_testing Enable options related to testing on the package?
William A. Kennington III780ec092018-12-06 14:46:50 -0800395 """
396 pkgdir = os.path.join(WORKSPACE, pkg)
William A. Kennington III54d4faf2018-12-06 17:46:24 -0800397 os.chdir(pkgdir)
398
399 # Refresh dynamic linker run time bindings for dependencies
400 check_call_cmd(pkgdir, 'sudo', '-n', '--', 'ldconfig')
401
William A. Kennington III780ec092018-12-06 14:46:50 -0800402 # Build & install this package
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800403 # Always try using meson first
404 if os.path.exists('meson.build'):
William A. Kennington III6764d5f2018-12-13 12:27:03 -0800405 meson_options = parse_meson_options("meson_options.txt")
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800406 meson_flags = [
407 '-Db_colorout=never',
William A. Kennington III73b0d6e2019-01-17 14:35:41 -0800408 '-Dwerror=true',
409 '-Dwarning_level=3',
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800410 ]
William A. Kennington III25e58142018-12-13 14:30:43 -0800411 if build_for_testing:
412 meson_flags.append('--buildtype=debug')
413 else:
414 meson_flags.append('--buildtype=debugoptimized')
William A. Kennington III6764d5f2018-12-13 12:27:03 -0800415 if 'tests' in meson_options:
416 meson_flags.append('-Dtests=' + mesonFeature(build_for_testing))
417 if 'examples' in meson_options:
418 meson_flags.append('-Dexamples=' + str(build_for_testing).lower())
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800419 if MESON_FLAGS.get(pkg) is not None:
420 meson_flags.extend(MESON_FLAGS.get(pkg))
421 try:
422 check_call_cmd(pkgdir, 'meson', 'setup', '--reconfigure', 'build', *meson_flags)
423 except:
424 shutil.rmtree('build')
425 check_call_cmd(pkgdir, 'meson', 'setup', 'build', *meson_flags)
426 check_call_cmd(pkgdir, 'ninja', '-C', 'build')
427 check_call_cmd(pkgdir, 'sudo', '-n', '--', 'ninja', '-C', 'build', 'install')
428 # Assume we are autoconf otherwise
429 else:
430 conf_flags = [
431 enFlag('silent-rules', False),
432 enFlag('examples', build_for_testing),
433 enFlag('tests', build_for_testing),
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800434 ]
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800435 if not TEST_ONLY:
436 conf_flags.extend([
437 enFlag('code-coverage', build_for_testing),
438 enFlag('valgrind', build_for_testing),
439 ])
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800440 # Add any necessary configure flags for package
441 if CONFIGURE_FLAGS.get(pkg) is not None:
442 conf_flags.extend(CONFIGURE_FLAGS.get(pkg))
443 for bootstrap in ['bootstrap.sh', 'bootstrap', 'autogen.sh']:
444 if os.path.exists(bootstrap):
445 check_call_cmd(pkgdir, './' + bootstrap)
446 break
447 check_call_cmd(pkgdir, './configure', *conf_flags)
448 check_call_cmd(pkgdir, *make_parallel)
449 check_call_cmd(pkgdir, 'sudo', '-n', '--', *(make_parallel + [ 'install' ]))
William A. Kennington III780ec092018-12-06 14:46:50 -0800450
Andrew Geisslera61acb52019-01-03 16:32:44 -0600451def build_dep_tree(pkg, pkgdir, dep_added, head, branch, dep_tree=None):
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -0500452 """
453 For each package(pkg), starting with the package to be unit tested,
454 parse its 'configure.ac' file from within the package's directory(pkgdir)
455 for each package dependency defined recursively doing the same thing
456 on each package found as a dependency.
457
458 Parameter descriptions:
459 pkg Name of the package
460 pkgdir Directory where package source is located
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800461 dep_added Current dict of dependencies and added status
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -0500462 head Head node of the dependency tree
Andrew Geisslera61acb52019-01-03 16:32:44 -0600463 branch Branch to clone from pkg
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -0500464 dep_tree Current dependency tree node
465 """
466 if not dep_tree:
467 dep_tree = head
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800468
William A. Kennington IIIbe6aab22018-12-06 15:01:54 -0800469 with open("/tmp/depcache", "r") as depcache:
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800470 cache = depcache.readline()
471
472 # Read out pkg dependencies
473 pkg_deps = []
474 pkg_deps += get_autoconf_deps(pkgdir)
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800475 pkg_deps += get_meson_deps(pkgdir)
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800476
William A. Kennington III9a32d5e2018-12-06 17:38:53 -0800477 for dep in sets.Set(pkg_deps):
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800478 if dep in cache:
479 continue
480 # Dependency package not already known
481 if dep_added.get(dep) is None:
482 # Dependency package not added
483 new_child = dep_tree.AddChild(dep)
484 dep_added[dep] = False
Andrew Geisslera61acb52019-01-03 16:32:44 -0600485 dep_pkgdir = clone_pkg(dep,branch)
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800486 # Determine this dependency package's
487 # dependencies and add them before
488 # returning to add this package
489 dep_added = build_dep_tree(dep,
490 dep_pkgdir,
491 dep_added,
492 head,
Andrew Geisslera61acb52019-01-03 16:32:44 -0600493 branch,
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800494 new_child)
495 else:
496 # Dependency package known and added
497 if dep_added[dep]:
Andrew Jeffery2cb0c7a2018-03-08 13:19:08 +1030498 continue
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -0500499 else:
William A. Kennington IIIc048cc02018-12-06 15:39:18 -0800500 # Cyclic dependency failure
501 raise Exception("Cyclic dependencies found in "+pkg)
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -0500502
503 if not dep_added[pkg]:
504 dep_added[pkg] = True
505
506 return dep_added
Matthew Barthccb7f852016-11-23 17:43:02 -0600507
William A. Kennington III0f0a6802018-07-16 11:52:33 -0700508def make_target_exists(target):
509 """
510 Runs a check against the makefile in the current directory to determine
511 if the target exists so that it can be built.
512
513 Parameter descriptions:
514 target The make target we are checking
515 """
516 try:
517 cmd = [ 'make', '-n', target ]
518 with open(os.devnull, 'w') as devnull:
519 check_call(cmd, stdout=devnull, stderr=devnull)
520 return True
521 except CalledProcessError:
522 return False
523
524def run_unit_tests(top_dir):
525 """
526 Runs the unit tests for the package via `make check`
527
528 Parameter descriptions:
529 top_dir The root directory of our project
530 """
531 try:
532 cmd = make_parallel + [ 'check' ]
533 for i in range(0, args.repeat):
534 check_call_cmd(top_dir, *cmd)
535 except CalledProcessError:
536 for root, _, files in os.walk(top_dir):
537 if 'test-suite.log' not in files:
538 continue
539 check_call_cmd(root, 'cat', os.path.join(root, 'test-suite.log'))
540 raise Exception('Unit tests failed')
541
Patrick Venturead4354e2018-10-12 16:59:54 -0700542def run_cppcheck(top_dir):
543 try:
544 # http://cppcheck.sourceforge.net/manual.pdf
545 ignore_list = ['-i%s' % path for path in os.listdir(top_dir) \
546 if path.endswith('-src') or path.endswith('-build')]
547 ignore_list.extend(('-itest', '-iscripts'))
548 params = ['cppcheck', '-j', str(multiprocessing.cpu_count()),
549 '--enable=all']
550 params.extend(ignore_list)
551 params.append('.')
552
553 check_call_cmd(top_dir, *params)
554 except CalledProcessError:
555 raise Exception('Cppcheck failed')
William A. Kennington III0f0a6802018-07-16 11:52:33 -0700556
William A. Kennington III37a89a22018-12-13 14:32:02 -0800557def is_valgrind_safe():
558 """
559 Returns whether it is safe to run valgrind on our platform
560 """
561 return re.match('ppc64', platform.machine()) is None
562
William A. Kennington III282e3302019-02-04 16:55:05 -0800563def is_sanitize_safe():
564 """
565 Returns whether it is safe to run sanitizers on our platform
566 """
567 return re.match('ppc64', platform.machine()) is None
568
William A. Kennington III0f0a6802018-07-16 11:52:33 -0700569def maybe_run_valgrind(top_dir):
570 """
571 Potentially runs the unit tests through valgrind for the package
572 via `make check-valgrind`. If the package does not have valgrind testing
573 then it just skips over this.
574
575 Parameter descriptions:
576 top_dir The root directory of our project
577 """
William A. Kennington III4e1d0a12018-07-16 12:04:03 -0700578 # Valgrind testing is currently broken by an aggressive strcmp optimization
579 # that is inlined into optimized code for POWER by gcc 7+. Until we find
580 # a workaround, just don't run valgrind tests on POWER.
581 # https://github.com/openbmc/openbmc/issues/3315
William A. Kennington III37a89a22018-12-13 14:32:02 -0800582 if not is_valgrind_safe():
William A. Kennington III4e1d0a12018-07-16 12:04:03 -0700583 return
William A. Kennington III0f0a6802018-07-16 11:52:33 -0700584 if not make_target_exists('check-valgrind'):
585 return
586
587 try:
588 cmd = make_parallel + [ 'check-valgrind' ]
589 check_call_cmd(top_dir, *cmd)
590 except CalledProcessError:
591 for root, _, files in os.walk(top_dir):
592 for f in files:
593 if re.search('test-suite-[a-z]+.log', f) is None:
594 continue
595 check_call_cmd(root, 'cat', os.path.join(root, f))
596 raise Exception('Valgrind tests failed')
597
598def maybe_run_coverage(top_dir):
599 """
600 Potentially runs the unit tests through code coverage for the package
601 via `make check-code-coverage`. If the package does not have code coverage
602 testing then it just skips over this.
603
604 Parameter descriptions:
605 top_dir The root directory of our project
606 """
607 if not make_target_exists('check-code-coverage'):
608 return
609
610 # Actually run code coverage
611 try:
612 cmd = make_parallel + [ 'check-code-coverage' ]
613 check_call_cmd(top_dir, *cmd)
614 except CalledProcessError:
615 raise Exception('Code coverage failed')
Matthew Barthccb7f852016-11-23 17:43:02 -0600616
617if __name__ == '__main__':
618 # CONFIGURE_FLAGS = [GIT REPO]:[CONFIGURE FLAGS]
619 CONFIGURE_FLAGS = {
Adriana Kobylak43c31e82017-02-13 09:28:35 -0600620 'phosphor-objmgr': ['--enable-unpatched-systemd'],
Matthew Barth1d1c6732017-03-24 10:00:28 -0500621 'sdbusplus': ['--enable-transaction'],
622 'phosphor-logging':
623 ['--enable-metadata-processing',
Deepak Kodihalli3a4e1b42017-06-08 09:52:35 -0500624 'YAML_DIR=/usr/local/share/phosphor-dbus-yaml/yaml']
Matthew Barthccb7f852016-11-23 17:43:02 -0600625 }
626
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800627 # MESON_FLAGS = [GIT REPO]:[MESON FLAGS]
628 MESON_FLAGS = {
629 }
630
Matthew Barthccb7f852016-11-23 17:43:02 -0600631 # DEPENDENCIES = [MACRO]:[library/header]:[GIT REPO]
632 DEPENDENCIES = {
633 'AC_CHECK_LIB': {'mapper': 'phosphor-objmgr'},
Matthew Barth710f3f02017-01-18 15:20:19 -0600634 'AC_CHECK_HEADER': {
635 'host-ipmid': 'phosphor-host-ipmid',
Patrick Ventureb41a4462018-10-03 17:27:38 -0700636 'blobs-ipmid': 'phosphor-ipmi-blobs',
Matthew Barth710f3f02017-01-18 15:20:19 -0600637 'sdbusplus': 'sdbusplus',
William A. Kennington IIIb4f730a2018-09-12 11:21:20 -0700638 'sdeventplus': 'sdeventplus',
Patrick Venture22329962018-09-14 10:23:04 -0700639 'gpioplus': 'gpioplus',
Saqib Khan66145052017-02-14 12:02:07 -0600640 'phosphor-logging/log.hpp': 'phosphor-logging',
Patrick Williamseab8a372017-01-30 11:21:32 -0600641 },
Brad Bishopebb49112017-02-13 11:07:26 -0500642 'AC_PATH_PROG': {'sdbus++': 'sdbusplus'},
Patrick Williamseab8a372017-01-30 11:21:32 -0600643 'PKG_CHECK_MODULES': {
Matthew Barth19e261e2017-02-01 12:55:22 -0600644 'phosphor-dbus-interfaces': 'phosphor-dbus-interfaces',
Patrick Williamsf128b402017-03-29 06:45:59 -0500645 'openpower-dbus-interfaces': 'openpower-dbus-interfaces',
Matt Spinler7be19032018-04-13 09:43:14 -0500646 'ibm-dbus-interfaces': 'ibm-dbus-interfaces',
William A. Kennington III993ab332019-02-07 02:12:31 -0800647 'libipmid': 'phosphor-host-ipmid',
648 'libipmid-host': 'phosphor-host-ipmid',
Brad Bishopebb49112017-02-13 11:07:26 -0500649 'sdbusplus': 'sdbusplus',
William A. Kennington IIIb4f730a2018-09-12 11:21:20 -0700650 'sdeventplus': 'sdeventplus',
Patrick Venture22329962018-09-14 10:23:04 -0700651 'gpioplus': 'gpioplus',
Brad Bishopebb49112017-02-13 11:07:26 -0500652 'phosphor-logging': 'phosphor-logging',
Marri Devender Raoa3eee8a2018-08-13 05:34:27 -0500653 'phosphor-snmp': 'phosphor-snmp',
Brad Bishopebb49112017-02-13 11:07:26 -0500654 },
Matthew Barthccb7f852016-11-23 17:43:02 -0600655 }
656
William A. Kennington IIIe67f5fc2018-12-06 17:40:30 -0800657 # Offset into array of macro parameters MACRO(0, 1, ...N)
658 DEPENDENCIES_OFFSET = {
659 'AC_CHECK_LIB': 0,
660 'AC_CHECK_HEADER': 0,
661 'AC_PATH_PROG': 1,
662 'PKG_CHECK_MODULES': 1,
663 }
664
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -0500665 # DEPENDENCIES_REGEX = [GIT REPO]:[REGEX STRING]
666 DEPENDENCIES_REGEX = {
Patrick Ventured37b8052018-10-16 16:03:03 -0700667 'phosphor-logging': r'\S+-dbus-interfaces$'
Leonel Gonzaleza62a1a12017-03-24 11:03:47 -0500668 }
669
Matthew Barth33df8792016-12-19 14:30:17 -0600670 # Set command line arguments
671 parser = argparse.ArgumentParser()
672 parser.add_argument("-w", "--workspace", dest="WORKSPACE", required=True,
673 help="Workspace directory location(i.e. /home)")
674 parser.add_argument("-p", "--package", dest="PACKAGE", required=True,
675 help="OpenBMC package to be unit tested")
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800676 parser.add_argument("-t", "--test-only", dest="TEST_ONLY",
677 action="store_true", required=False, default=False,
678 help="Only run test cases, no other validation")
Matthew Barth33df8792016-12-19 14:30:17 -0600679 parser.add_argument("-v", "--verbose", action="store_true",
680 help="Print additional package status messages")
Andrew Jeffery468309d2018-03-08 13:46:33 +1030681 parser.add_argument("-r", "--repeat", help="Repeat tests N times",
682 type=int, default=1)
Andrew Geisslera61acb52019-01-03 16:32:44 -0600683 parser.add_argument("-b", "--branch", dest="BRANCH", required=False,
684 help="Branch to target for dependent repositories",
685 default="master")
Matthew Barth33df8792016-12-19 14:30:17 -0600686 args = parser.parse_args(sys.argv[1:])
687 WORKSPACE = args.WORKSPACE
688 UNIT_TEST_PKG = args.PACKAGE
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800689 TEST_ONLY = args.TEST_ONLY
Andrew Geisslera61acb52019-01-03 16:32:44 -0600690 BRANCH = args.BRANCH
Matthew Barth33df8792016-12-19 14:30:17 -0600691 if args.verbose:
692 def printline(*line):
693 for arg in line:
694 print arg,
695 print
696 else:
697 printline = lambda *l: None
Matthew Barthccb7f852016-11-23 17:43:02 -0600698
James Feist878df5c2018-07-26 14:54:28 -0700699 # First validate code formatting if repo has style formatting files.
Adriana Kobylakbcee22b2018-01-10 16:58:27 -0600700 # The format-code.sh checks for these files.
Andrew Geisslera28286d2018-01-10 11:00:00 -0800701 CODE_SCAN_DIR = WORKSPACE + "/" + UNIT_TEST_PKG
Adriana Kobylakbcee22b2018-01-10 16:58:27 -0600702 check_call_cmd(WORKSPACE, "./format-code.sh", CODE_SCAN_DIR)
Andrew Geisslera28286d2018-01-10 11:00:00 -0800703
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800704 # Automake and meson
705 if (os.path.isfile(CODE_SCAN_DIR + "/configure.ac") or
706 os.path.isfile(CODE_SCAN_DIR + '/meson.build')):
James Feist878df5c2018-07-26 14:54:28 -0700707 prev_umask = os.umask(000)
708 # Determine dependencies and add them
709 dep_added = dict()
710 dep_added[UNIT_TEST_PKG] = False
711 # Create dependency tree
712 dep_tree = DepTree(UNIT_TEST_PKG)
713 build_dep_tree(UNIT_TEST_PKG,
714 os.path.join(WORKSPACE, UNIT_TEST_PKG),
715 dep_added,
Andrew Geisslera61acb52019-01-03 16:32:44 -0600716 dep_tree,
717 BRANCH)
James Feist878df5c2018-07-26 14:54:28 -0700718
719 # Reorder Dependency Tree
720 for pkg_name, regex_str in DEPENDENCIES_REGEX.iteritems():
721 dep_tree.ReorderDeps(pkg_name, regex_str)
722 if args.verbose:
723 dep_tree.PrintTree()
724 install_list = dep_tree.GetInstallList()
William A. Kennington IIId61316d2018-12-06 14:56:12 -0800725 # We don't want to treat our package as a dependency
726 install_list.remove(UNIT_TEST_PKG)
James Feist878df5c2018-07-26 14:54:28 -0700727 # install reordered dependencies
William A. Kennington IIId61316d2018-12-06 14:56:12 -0800728 for dep in install_list:
729 build_and_install(dep, False)
James Feist878df5c2018-07-26 14:54:28 -0700730 top_dir = os.path.join(WORKSPACE, UNIT_TEST_PKG)
731 os.chdir(top_dir)
James Feist878df5c2018-07-26 14:54:28 -0700732 # Run package unit tests
William A. Kennington IIId61316d2018-12-06 14:56:12 -0800733 build_and_install(UNIT_TEST_PKG, True)
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800734 if os.path.isfile(CODE_SCAN_DIR + '/meson.build'):
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800735 if not TEST_ONLY:
736 # Run valgrind if it is supported
737 if is_valgrind_safe():
738 check_call_cmd(top_dir, 'meson', 'test', '-C', 'build',
739 '--wrap', 'valgrind')
William A. Kennington III40d5c7c2018-12-13 14:37:59 -0800740
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800741 # Run clang-tidy only if the project has a configuration
742 if os.path.isfile('.clang-tidy'):
743 check_call_cmd(top_dir, 'run-clang-tidy-6.0.py', '-p',
744 'build')
745 # Run the basic clang static analyzer otherwise
746 else:
747 os.environ['SCANBUILD'] = 'scan-build-6.0'
William A. Kennington III9fe58322018-12-13 19:33:39 -0800748 check_call_cmd(top_dir, 'ninja', '-C', 'build',
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800749 'scan-build')
750
751 # Run tests through sanitizers
752 # b_lundef is needed if clang++ is CXX since it resolves the
753 # asan symbols at runtime only. We don't want to set it earlier
754 # in the build process to ensure we don't have undefined
755 # runtime code.
William A. Kennington III282e3302019-02-04 16:55:05 -0800756 if is_sanitize_safe():
757 check_call_cmd(top_dir, 'meson', 'configure', 'build',
758 '-Db_sanitize=address,undefined',
759 '-Db_lundef=false')
760 check_call_cmd(top_dir, 'meson', 'test', '-C', 'build',
761 '--logbase', 'testlog-ubasan')
762 # TODO: Fix memory sanitizer
763 #check_call_cmd(top_dir, 'meson', 'configure', 'build',
764 # '-Db_sanitize=memory')
765 #check_call_cmd(top_dir, 'meson', 'test', '-C', 'build'
766 # '--logbase', 'testlog-msan')
767 check_call_cmd(top_dir, 'meson', 'configure', 'build',
768 '-Db_sanitize=none', '-Db_lundef=true')
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800769
770 # Run coverage checks
771 check_call_cmd(top_dir, 'meson', 'configure', 'build',
772 '-Db_coverage=true')
773 check_call_cmd(top_dir, 'meson', 'test', '-C', 'build')
774 # Only build coverage HTML if coverage files were produced
775 for root, dirs, files in os.walk('build'):
776 if any([f.endswith('.gcda') for f in files]):
777 check_call_cmd(top_dir, 'ninja', '-C', 'build',
778 'coverage-html')
779 break
780 check_call_cmd(top_dir, 'meson', 'configure', 'build',
781 '-Db_coverage=false')
782 else:
783 check_call_cmd(top_dir, 'meson', 'test', '-C', 'build')
William A. Kennington III3f1d1202018-12-06 18:02:07 -0800784 else:
785 run_unit_tests(top_dir)
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800786 if not TEST_ONLY:
787 maybe_run_valgrind(top_dir)
788 maybe_run_coverage(top_dir)
789 if not TEST_ONLY:
790 run_cppcheck(top_dir)
James Feist878df5c2018-07-26 14:54:28 -0700791
792 os.umask(prev_umask)
793
794 # Cmake
795 elif os.path.isfile(CODE_SCAN_DIR + "/CMakeLists.txt"):
796 top_dir = os.path.join(WORKSPACE, UNIT_TEST_PKG)
797 os.chdir(top_dir)
William A. Kennington IIIfafef892018-12-11 16:52:43 -0800798 check_call_cmd(top_dir, 'cmake', '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON', '.')
James Feist878df5c2018-07-26 14:54:28 -0700799 check_call_cmd(top_dir, 'cmake', '--build', '.', '--', '-j',
800 str(multiprocessing.cpu_count()))
801 if make_target_exists('test'):
802 check_call_cmd(top_dir, 'ctest', '.')
William A. Kennington III65b37fa2019-01-31 15:15:17 -0800803 if not TEST_ONLY:
804 maybe_run_valgrind(top_dir)
805 maybe_run_coverage(top_dir)
806 run_cppcheck(top_dir)
807 if os.path.isfile('.clang-tidy'):
808 check_call_cmd(top_dir, 'run-clang-tidy-6.0.py', '-p', '.')
James Feist878df5c2018-07-26 14:54:28 -0700809
810 else:
Andrew Geissler71a7cc12018-01-31 14:18:37 -0800811 print "Not a supported repo for CI Tests, exit"
812 quit()