tools/patman/test_util.py

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