xref: /openbmc/openbmc-build-scripts/scripts/unit-test.py (revision 29b805194b99f4810c1cdd287b15ef74b2912d77)
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        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
256
257
258def 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
271    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')
277    with open(configure_ac, "rt") as f:
278        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
304
305def 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
331make_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
341def 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
351def 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
371def 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
386
387def build_and_install(pkg, build_for_testing=False):
388    """
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
394    build_for_testing   Enable options related to testing on the package?
395    """
396    os.chdir(os.path.join(WORKSPACE, pkg))
397
398    # Refresh dynamic linker run time bindings for dependencies
399    check_call_cmd('sudo', '-n', '--', 'ldconfig')
400
401    # Build & install this package
402    # Always try using meson first
403    if os.path.exists('meson.build'):
404        meson_options = sets.Set()
405        if os.path.exists("meson_options.txt"):
406            meson_options = parse_meson_options("meson_options.txt")
407        meson_flags = [
408            '-Db_colorout=never',
409            '-Dwerror=true',
410            '-Dwarning_level=3',
411        ]
412        if build_for_testing:
413            meson_flags.append('--buildtype=debug')
414        else:
415            meson_flags.append('--buildtype=debugoptimized')
416        if 'tests' in meson_options:
417            meson_flags.append('-Dtests=' + mesonFeature(build_for_testing))
418        if 'examples' in meson_options:
419            meson_flags.append('-Dexamples=' + str(build_for_testing).lower())
420        if MESON_FLAGS.get(pkg) is not None:
421            meson_flags.extend(MESON_FLAGS.get(pkg))
422        try:
423            check_call_cmd('meson', 'setup', '--reconfigure', 'build', *meson_flags)
424        except:
425            shutil.rmtree('build')
426            check_call_cmd('meson', 'setup', 'build', *meson_flags)
427        check_call_cmd('ninja', '-C', 'build')
428        check_call_cmd('sudo', '-n', '--', 'ninja', '-C', 'build', 'install')
429    # Assume we are autoconf otherwise
430    else:
431        conf_flags = [
432            enFlag('silent-rules', False),
433            enFlag('examples', build_for_testing),
434            enFlag('tests', build_for_testing),
435        ]
436        if not TEST_ONLY:
437            conf_flags.extend([
438                enFlag('code-coverage', build_for_testing),
439                enFlag('valgrind', build_for_testing),
440            ])
441        # Add any necessary configure flags for package
442        if CONFIGURE_FLAGS.get(pkg) is not None:
443            conf_flags.extend(CONFIGURE_FLAGS.get(pkg))
444        for bootstrap in ['bootstrap.sh', 'bootstrap', 'autogen.sh']:
445            if os.path.exists(bootstrap):
446                check_call_cmd('./' + bootstrap)
447                break
448        check_call_cmd('./configure', *conf_flags)
449        check_call_cmd(*make_parallel)
450        check_call_cmd('sudo', '-n', '--', *(make_parallel + [ 'install' ]))
451
452def build_dep_tree(pkg, pkgdir, dep_added, head, branch, dep_tree=None):
453    """
454    For each package(pkg), starting with the package to be unit tested,
455    parse its 'configure.ac' file from within the package's directory(pkgdir)
456    for each package dependency defined recursively doing the same thing
457    on each package found as a dependency.
458
459    Parameter descriptions:
460    pkg                 Name of the package
461    pkgdir              Directory where package source is located
462    dep_added           Current dict of dependencies and added status
463    head                Head node of the dependency tree
464    branch              Branch to clone from pkg
465    dep_tree            Current dependency tree node
466    """
467    if not dep_tree:
468        dep_tree = head
469
470    with open("/tmp/depcache", "r") as depcache:
471        cache = depcache.readline()
472
473    # Read out pkg dependencies
474    pkg_deps = []
475    pkg_deps += get_autoconf_deps(pkgdir)
476    pkg_deps += get_meson_deps(pkgdir)
477
478    for dep in sets.Set(pkg_deps):
479        if dep in cache:
480            continue
481        # Dependency package not already known
482        if dep_added.get(dep) is None:
483            # Dependency package not added
484            new_child = dep_tree.AddChild(dep)
485            dep_added[dep] = False
486            dep_pkgdir = clone_pkg(dep,branch)
487            # Determine this dependency package's
488            # dependencies and add them before
489            # returning to add this package
490            dep_added = build_dep_tree(dep,
491                                       dep_pkgdir,
492                                       dep_added,
493                                       head,
494                                       branch,
495                                       new_child)
496        else:
497            # Dependency package known and added
498            if dep_added[dep]:
499                continue
500            else:
501                # Cyclic dependency failure
502                raise Exception("Cyclic dependencies found in "+pkg)
503
504    if not dep_added[pkg]:
505        dep_added[pkg] = True
506
507    return dep_added
508
509def make_target_exists(target):
510    """
511    Runs a check against the makefile in the current directory to determine
512    if the target exists so that it can be built.
513
514    Parameter descriptions:
515    target              The make target we are checking
516    """
517    try:
518        cmd = [ 'make', '-n', target ]
519        with open(os.devnull, 'w') as devnull:
520            check_call(cmd, stdout=devnull, stderr=devnull)
521        return True
522    except CalledProcessError:
523        return False
524
525def run_unit_tests():
526    """
527    Runs the unit tests for the package via `make check`
528    """
529    try:
530        cmd = make_parallel + [ 'check' ]
531        for i in range(0, args.repeat):
532            check_call_cmd(*cmd)
533    except CalledProcessError:
534        for root, _, files in os.walk(os.getcwd()):
535            if 'test-suite.log' not in files:
536                continue
537            check_call_cmd('cat', os.path.join(root, 'test-suite.log'))
538        raise Exception('Unit tests failed')
539
540def run_cppcheck():
541    try:
542        # http://cppcheck.sourceforge.net/manual.pdf
543        ignore_list = ['-i%s' % path for path in os.listdir(os.getcwd()) \
544                       if path.endswith('-src') or path.endswith('-build')]
545        ignore_list.extend(('-itest', '-iscripts'))
546        params = ['cppcheck', '-j', str(multiprocessing.cpu_count()),
547                  '--enable=all']
548        params.extend(ignore_list)
549        params.append('.')
550
551        check_call_cmd(*params)
552    except CalledProcessError:
553        raise Exception('Cppcheck failed')
554
555def is_valgrind_safe():
556    """
557    Returns whether it is safe to run valgrind on our platform
558    """
559    src = 'unit-test-vg.c'
560    exe = './unit-test-vg'
561    with open(src, 'w') as h:
562        h.write('#include <stdlib.h>\n')
563        h.write('#include <string.h>\n')
564        h.write('int main() {\n')
565        h.write('char *heap_str = malloc(16);\n')
566        h.write('strcpy(heap_str, "RandString");\n')
567        h.write('int res = strcmp("RandString", heap_str);\n')
568        h.write('free(heap_str);\n')
569        h.write('return res;\n')
570        h.write('}\n')
571    try:
572        with open(os.devnull, 'w') as devnull:
573            check_call(['gcc', '-O2', '-o', exe, src],
574                       stdout=devnull, stderr=devnull)
575            check_call(['valgrind', '--error-exitcode=99', exe],
576                       stdout=devnull, stderr=devnull)
577        return True
578    except:
579        sys.stderr.write("###### Platform is not valgrind safe ######\n")
580        return False
581    finally:
582        os.remove(src)
583        os.remove(exe)
584
585def is_sanitize_safe():
586    """
587    Returns whether it is safe to run sanitizers on our platform
588    """
589    src = 'unit-test-sanitize.c'
590    exe = './unit-test-sanitize'
591    with open(src, 'w') as h:
592        h.write('int main() { return 0; }\n')
593    try:
594        with open(os.devnull, 'w') as devnull:
595            check_call(['gcc', '-O2', '-fsanitize=address',
596                        '-fsanitize=undefined', '-o', exe, src],
597                       stdout=devnull, stderr=devnull)
598            check_call([exe], stdout=devnull, stderr=devnull)
599        return True
600    except:
601        sys.stderr.write("###### Platform is not sanitize safe ######\n")
602        return False
603    finally:
604        os.remove(src)
605        os.remove(exe)
606
607def meson_setup_exists(setup):
608    """
609    Returns whether the meson build supports the named test setup.
610
611    Parameter descriptions:
612    setup              The setup target to check
613    """
614    try:
615        with open(os.devnull, 'w') as devnull:
616            output = subprocess.check_output(
617                    ['meson', 'test', '-C', 'build',
618                     '--setup', setup, '-t', '0'],
619                    stderr=subprocess.STDOUT)
620    except CalledProcessError as e:
621        output = e.output
622    return not re.search('Test setup .* not found from project', output)
623
624def maybe_meson_valgrind():
625    """
626    Potentially runs the unit tests through valgrind for the package
627    via `meson test`. The package can specify custom valgrind configurations
628    by utilizing add_test_setup() in a meson.build
629    """
630    if not is_valgrind_safe():
631        sys.stderr.write("###### Skipping valgrind ######\n")
632        return
633    if meson_setup_exists('valgrind'):
634        check_call_cmd('meson', 'test', '-C', 'build',
635                       '--setup', 'valgrind')
636    else:
637        check_call_cmd('meson', 'test', '-C', 'build',
638                       '--wrapper', 'valgrind')
639
640def maybe_make_valgrind():
641    """
642    Potentially runs the unit tests through valgrind for the package
643    via `make check-valgrind`. If the package does not have valgrind testing
644    then it just skips over this.
645    """
646    # Valgrind testing is currently broken by an aggressive strcmp optimization
647    # that is inlined into optimized code for POWER by gcc 7+. Until we find
648    # a workaround, just don't run valgrind tests on POWER.
649    # https://github.com/openbmc/openbmc/issues/3315
650    if not is_valgrind_safe():
651        sys.stderr.write("###### Skipping valgrind ######\n")
652        return
653    if not make_target_exists('check-valgrind'):
654        return
655
656    try:
657        cmd = make_parallel + [ 'check-valgrind' ]
658        check_call_cmd(*cmd)
659    except CalledProcessError:
660        for root, _, files in os.walk(os.getcwd()):
661            for f in files:
662                if re.search('test-suite-[a-z]+.log', f) is None:
663                    continue
664                check_call_cmd('cat', os.path.join(root, f))
665        raise Exception('Valgrind tests failed')
666
667def maybe_make_coverage():
668    """
669    Potentially runs the unit tests through code coverage for the package
670    via `make check-code-coverage`. If the package does not have code coverage
671    testing then it just skips over this.
672    """
673    if not make_target_exists('check-code-coverage'):
674        return
675
676    # Actually run code coverage
677    try:
678        cmd = make_parallel + [ 'check-code-coverage' ]
679        check_call_cmd(*cmd)
680    except CalledProcessError:
681        raise Exception('Code coverage failed')
682
683if __name__ == '__main__':
684    # CONFIGURE_FLAGS = [GIT REPO]:[CONFIGURE FLAGS]
685    CONFIGURE_FLAGS = {
686        'sdbusplus': ['--enable-transaction'],
687        'phosphor-logging':
688        ['--enable-metadata-processing',
689         'YAML_DIR=/usr/local/share/phosphor-dbus-yaml/yaml']
690    }
691
692    # MESON_FLAGS = [GIT REPO]:[MESON FLAGS]
693    MESON_FLAGS = {
694    }
695
696    # DEPENDENCIES = [MACRO]:[library/header]:[GIT REPO]
697    DEPENDENCIES = {
698        'AC_CHECK_LIB': {'mapper': 'phosphor-objmgr'},
699        'AC_CHECK_HEADER': {
700            'host-ipmid': 'phosphor-host-ipmid',
701            'blobs-ipmid': 'phosphor-ipmi-blobs',
702            'sdbusplus': 'sdbusplus',
703            'sdeventplus': 'sdeventplus',
704            'stdplus': 'stdplus',
705            'gpioplus': 'gpioplus',
706            'phosphor-logging/log.hpp': 'phosphor-logging',
707        },
708        'AC_PATH_PROG': {'sdbus++': 'sdbusplus'},
709        'PKG_CHECK_MODULES': {
710            'phosphor-dbus-interfaces': 'phosphor-dbus-interfaces',
711            'openpower-dbus-interfaces': 'openpower-dbus-interfaces',
712            'ibm-dbus-interfaces': 'ibm-dbus-interfaces',
713            'libipmid': 'phosphor-host-ipmid',
714            'libipmid-host': 'phosphor-host-ipmid',
715            'sdbusplus': 'sdbusplus',
716            'sdeventplus': 'sdeventplus',
717            'stdplus': 'stdplus',
718            'gpioplus': 'gpioplus',
719            'phosphor-logging': 'phosphor-logging',
720            'phosphor-snmp': 'phosphor-snmp',
721            'ipmiblob': 'ipmi-blob-tool',
722        },
723    }
724
725    # Offset into array of macro parameters MACRO(0, 1, ...N)
726    DEPENDENCIES_OFFSET = {
727        'AC_CHECK_LIB': 0,
728        'AC_CHECK_HEADER': 0,
729        'AC_PATH_PROG': 1,
730        'PKG_CHECK_MODULES': 1,
731    }
732
733    # DEPENDENCIES_REGEX = [GIT REPO]:[REGEX STRING]
734    DEPENDENCIES_REGEX = {
735        'phosphor-logging': r'\S+-dbus-interfaces$'
736    }
737
738    # Set command line arguments
739    parser = argparse.ArgumentParser()
740    parser.add_argument("-w", "--workspace", dest="WORKSPACE", required=True,
741                        help="Workspace directory location(i.e. /home)")
742    parser.add_argument("-p", "--package", dest="PACKAGE", required=True,
743                        help="OpenBMC package to be unit tested")
744    parser.add_argument("-t", "--test-only", dest="TEST_ONLY",
745                        action="store_true", required=False, default=False,
746                        help="Only run test cases, no other validation")
747    parser.add_argument("-v", "--verbose", action="store_true",
748                        help="Print additional package status messages")
749    parser.add_argument("-r", "--repeat", help="Repeat tests N times",
750                        type=int, default=1)
751    parser.add_argument("-b", "--branch", dest="BRANCH", required=False,
752                        help="Branch to target for dependent repositories",
753                        default="master")
754    args = parser.parse_args(sys.argv[1:])
755    WORKSPACE = args.WORKSPACE
756    UNIT_TEST_PKG = args.PACKAGE
757    TEST_ONLY = args.TEST_ONLY
758    BRANCH = args.BRANCH
759    if args.verbose:
760        def printline(*line):
761            for arg in line:
762                print arg,
763            print
764    else:
765        printline = lambda *l: None
766
767    # First validate code formatting if repo has style formatting files.
768    # The format-code.sh checks for these files.
769    CODE_SCAN_DIR = WORKSPACE + "/" + UNIT_TEST_PKG
770    check_call_cmd("./format-code.sh", CODE_SCAN_DIR)
771
772    # Automake and meson
773    if (os.path.isfile(CODE_SCAN_DIR + "/configure.ac") or
774        os.path.isfile(CODE_SCAN_DIR + '/meson.build')):
775        prev_umask = os.umask(000)
776        # Determine dependencies and add them
777        dep_added = dict()
778        dep_added[UNIT_TEST_PKG] = False
779        # Create dependency tree
780        dep_tree = DepTree(UNIT_TEST_PKG)
781        build_dep_tree(UNIT_TEST_PKG,
782                       os.path.join(WORKSPACE, UNIT_TEST_PKG),
783                       dep_added,
784                       dep_tree,
785                       BRANCH)
786
787        # Reorder Dependency Tree
788        for pkg_name, regex_str in DEPENDENCIES_REGEX.iteritems():
789            dep_tree.ReorderDeps(pkg_name, regex_str)
790        if args.verbose:
791            dep_tree.PrintTree()
792        install_list = dep_tree.GetInstallList()
793        # We don't want to treat our package as a dependency
794        install_list.remove(UNIT_TEST_PKG)
795        # install reordered dependencies
796        for dep in install_list:
797            build_and_install(dep, False)
798        os.chdir(os.path.join(WORKSPACE, UNIT_TEST_PKG))
799        # Run package unit tests
800        build_and_install(UNIT_TEST_PKG, True)
801        if os.path.isfile(CODE_SCAN_DIR + '/meson.build'):
802            if not TEST_ONLY:
803                maybe_meson_valgrind()
804
805                # Run clang-tidy only if the project has a configuration
806                if os.path.isfile('.clang-tidy'):
807                    check_call_cmd('run-clang-tidy-6.0.py', '-p',
808                                   'build')
809                # Run the basic clang static analyzer otherwise
810                else:
811                    os.environ['SCANBUILD'] = 'scan-build-6.0'
812                    check_call_cmd('ninja', '-C', 'build',
813                                   'scan-build')
814
815                # Run tests through sanitizers
816                # b_lundef is needed if clang++ is CXX since it resolves the
817                # asan symbols at runtime only. We don't want to set it earlier
818                # in the build process to ensure we don't have undefined
819                # runtime code.
820                if is_sanitize_safe():
821                    check_call_cmd('meson', 'configure', 'build',
822                                   '-Db_sanitize=address,undefined',
823                                   '-Db_lundef=false')
824                    check_call_cmd('meson', 'test', '-C', 'build',
825                                   '--logbase', 'testlog-ubasan')
826                    # TODO: Fix memory sanitizer
827                    #check_call_cmd('meson', 'configure', 'build',
828                    #               '-Db_sanitize=memory')
829                    #check_call_cmd('meson', 'test', '-C', 'build'
830                    #               '--logbase', 'testlog-msan')
831                    check_call_cmd('meson', 'configure', 'build',
832                                   '-Db_sanitize=none', '-Db_lundef=true')
833                else:
834                    sys.stderr.write("###### Skipping sanitizers ######\n")
835
836                # Run coverage checks
837                check_call_cmd('meson', 'configure', 'build',
838                               '-Db_coverage=true')
839                check_call_cmd('meson', 'test', '-C', 'build')
840                # Only build coverage HTML if coverage files were produced
841                for root, dirs, files in os.walk('build'):
842                    if any([f.endswith('.gcda') for f in files]):
843                        check_call_cmd('ninja', '-C', 'build',
844                                       'coverage-html')
845                        break
846                check_call_cmd('meson', 'configure', 'build',
847                               '-Db_coverage=false')
848            else:
849                check_call_cmd('meson', 'test', '-C', 'build')
850        else:
851            run_unit_tests()
852            if not TEST_ONLY:
853                maybe_make_valgrind()
854                maybe_make_coverage()
855        if not TEST_ONLY:
856            run_cppcheck()
857
858        os.umask(prev_umask)
859
860    # Cmake
861    elif os.path.isfile(CODE_SCAN_DIR + "/CMakeLists.txt"):
862        os.chdir(os.path.join(WORKSPACE, UNIT_TEST_PKG))
863        check_call_cmd('cmake', '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON', '.')
864        check_call_cmd('cmake', '--build', '.', '--', '-j',
865                       str(multiprocessing.cpu_count()))
866        if make_target_exists('test'):
867            check_call_cmd('ctest', '.')
868        if not TEST_ONLY:
869            maybe_make_valgrind()
870            maybe_make_coverage()
871            run_cppcheck()
872            if os.path.isfile('.clang-tidy'):
873                check_call_cmd('run-clang-tidy-6.0.py', '-p', '.')
874
875    else:
876        print "Not a supported repo for CI Tests, exit"
877        quit()
878