tools/patman/test_util.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 #
   3 # Copyright (c) 2016 Google, Inc
   4 #
   5
   6 from contextlib import contextmanager
   7 import glob
   8 import os
   9 import sys
  10
  11 import command
  12
  13 from io import StringIO
  14
  15
  16 def RunTestCoverage(prog, filter_fname, exclude_list, build_dir, required=None):
  17     """Run tests and check that we get 100% coverage
  18
  19     Args:
  20         prog: Program to run (with be passed a '-t' argument to run tests
  21         filter_fname: Normally all *.py files in the program's directory will
  22             be included. If this is not None, then it is used to filter the
  23             list so that only filenames that don't contain filter_fname are
  24             included.
  25         exclude_list: List of file patterns to exclude from the coverage
  26             calculation
  27         build_dir: Build directory, used to locate libfdt.py
  28         required: List of modules which must be in the coverage report
  29
  30     Raises:
  31         ValueError if the code coverage is not 100%
  32     """
  33     # This uses the build output from sandbox_spl to get _libfdt.so
  34     path = os.path.dirname(prog)
  35     if filter_fname:
  36         glob_list = glob.glob(os.path.join(path, '*.py'))
  37         glob_list = [fname for fname in glob_list if filter_fname in fname]
  38     else:
  39         glob_list = []
  40     glob_list += exclude_list
  41     glob_list += ['*libfdt.py', '*site-packages*', '*dist-packages*']
  42     test_cmd = 'test' if 'binman' in prog else '-t'
  43     prefix = ''
  44     if build_dir:
  45         prefix = 'PYTHONPATH=$PYTHONPATH:%s/sandbox_spl/tools ' % build_dir
  46     cmd = ('%spython3-coverage run '
  47            '--omit "%s" %s %s -P1' % (prefix, ','.join(glob_list),
  48                                       prog, test_cmd))
  49     os.system(cmd)
  50     stdout = command.Output('python3-coverage', 'report')
  51     lines = stdout.splitlines()
  52     if required:
  53         # Convert '/path/to/name.py' just the module name 'name'
  54         test_set = set([os.path.splitext(os.path.basename(line.split()[0]))[0]
  55                         for line in lines if '/etype/' in line])
  56         missing_list = required
  57         missing_list.discard('__init__')
  58         missing_list.difference_update(test_set)
  59         if missing_list:
  60             print('Missing tests for %s' % (', '.join(missing_list)))
  61             print(stdout)
  62             ok = False
  63
  64     coverage = lines[-1].split(' ')[-1]
  65     ok = True
  66     print(coverage)
  67     if coverage != '100%':
  68         print(stdout)
  69         print("Type 'python3-coverage html' to get a report in "
  70               'htmlcov/index.html')
  71         print('Coverage error: %s, but should be 100%%' % coverage)
  72         ok = False
  73     if not ok:
  74         raise ValueError('Test coverage failure')
  75
  76
  77 # Use this to suppress stdout/stderr output:
  78 # with capture_sys_output() as (stdout, stderr)
  79 #   ...do something...
  80 @contextmanager
  81 def capture_sys_output():
  82     capture_out, capture_err = StringIO(), StringIO()
  83     old_out, old_err = sys.stdout, sys.stderr
  84     try:
  85         sys.stdout, sys.stderr = capture_out, capture_err
  86         yield capture_out, capture_err
  87     finally:
  88         sys.stdout, sys.stderr = old_out, old_err