test_util.py 3.0 KB

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