test_util.py 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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. try:
  11. from StringIO import StringIO
  12. except ImportError:
  13. from io import StringIO
  14. def RunTestCoverage(prog, filter_fname, exclude_list, build_dir, required=None):
  15. """Run tests and check that we get 100% coverage
  16. Args:
  17. prog: Program to run (with be passed a '-t' argument to run tests
  18. filter_fname: Normally all *.py files in the program's directory will
  19. be included. If this is not None, then it is used to filter the
  20. list so that only filenames that don't contain filter_fname are
  21. included.
  22. exclude_list: List of file patterns to exclude from the coverage
  23. calculation
  24. build_dir: Build directory, used to locate libfdt.py
  25. required: List of modules which must be in the coverage report
  26. Raises:
  27. ValueError if the code coverage is not 100%
  28. """
  29. # This uses the build output from sandbox_spl to get _libfdt.so
  30. path = os.path.dirname(prog)
  31. if filter_fname:
  32. glob_list = glob.glob(os.path.join(path, '*.py'))
  33. glob_list = [fname for fname in glob_list if filter_fname in fname]
  34. else:
  35. glob_list = []
  36. glob_list += exclude_list
  37. glob_list += ['*libfdt.py', '*site-packages*']
  38. cmd = ('PYTHONPATH=$PYTHONPATH:%s/sandbox_spl/tools python-coverage run '
  39. '--omit "%s" %s -P1 -t' % (build_dir, ','.join(glob_list), prog))
  40. os.system(cmd)
  41. stdout = command.Output('python-coverage', '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.difference_update(test_set)
  49. if missing_list:
  50. print 'Missing tests for %s' % (', '.join(missing_list))
  51. print stdout
  52. ok = False
  53. coverage = lines[-1].split(' ')[-1]
  54. ok = True
  55. print coverage
  56. if coverage != '100%':
  57. print stdout
  58. print ("Type 'python-coverage html' to get a report in "
  59. 'htmlcov/index.html')
  60. print 'Coverage error: %s, but should be 100%%' % coverage
  61. ok = False
  62. if not ok:
  63. raise ValueError('Test coverage failure')
  64. # Use this to suppress stdout/stderr output:
  65. # with capture_sys_output() as (stdout, stderr)
  66. # ...do something...
  67. @contextmanager
  68. def capture_sys_output():
  69. capture_out, capture_err = StringIO(), StringIO()
  70. old_out, old_err = sys.stdout, sys.stderr
  71. try:
  72. sys.stdout, sys.stderr = capture_out, capture_err
  73. yield capture_out, capture_err
  74. finally:
  75. sys.stdout, sys.stderr = old_out, old_err