git.sur5r.net Git - u-boot/blob - tools/binman/binman.py

   1 #!/usr/bin/env python2
   2 # SPDX-License-Identifier: GPL-2.0+
   3
   4 # Copyright (c) 2016 Google, Inc
   5 # Written by Simon Glass <sjg@chromium.org>
   6 #
   7 # Creates binary images from input files controlled by a description
   8 #
   9
  10 """See README for more information"""
  11
  12 import glob
  13 import os
  14 import sys
  15 import traceback
  16 import unittest
  17
  18 # Bring in the patman and dtoc libraries
  19 our_path = os.path.dirname(os.path.realpath(__file__))
  20 for dirname in ['../patman', '../dtoc', '..']:
  21     sys.path.insert(0, os.path.join(our_path, dirname))
  22
  23 # Bring in the libfdt module
  24 sys.path.insert(0, 'scripts/dtc/pylibfdt')
  25
  26 import cmdline
  27 import command
  28 import control
  29
  30 def RunTests(debug):
  31     """Run the functional tests and any embedded doctests"""
  32     import elf_test
  33     import entry_test
  34     import fdt_test
  35     import ftest
  36     import image_test
  37     import test
  38     import doctest
  39
  40     result = unittest.TestResult()
  41     for module in []:
  42         suite = doctest.DocTestSuite(module)
  43         suite.run(result)
  44
  45     sys.argv = [sys.argv[0]]
  46     if debug:
  47         sys.argv.append('-D')
  48
  49     # Run the entry tests first ,since these need to be the first to import the
  50     # 'entry' module.
  51     suite = unittest.TestLoader().loadTestsFromTestCase(entry_test.TestEntry)
  52     suite.run(result)
  53     for module in (ftest.TestFunctional, fdt_test.TestFdt, elf_test.TestElf,
  54                    image_test.TestImage):
  55         suite = unittest.TestLoader().loadTestsFromTestCase(module)
  56         suite.run(result)
  57
  58     print result
  59     for test, err in result.errors:
  60         print test.id(), err
  61     for test, err in result.failures:
  62         print err, result.failures
  63     if result.errors or result.failures:
  64       print 'binman tests FAILED'
  65       return 1
  66     return 0
  67
  68 def RunTestCoverage():
  69     """Run the tests and check that we get 100% coverage"""
  70     # This uses the build output from sandbox_spl to get _libfdt.so
  71     cmd = ('PYTHONPATH=$PYTHONPATH:%s/sandbox_spl/tools coverage run '
  72             '--include "tools/binman/*.py" --omit "*test*,*binman.py" '
  73             'tools/binman/binman.py -t' % options.build_dir)
  74     os.system(cmd)
  75     stdout = command.Output('coverage', 'report')
  76     lines = stdout.splitlines()
  77
  78     test_set= set([os.path.basename(line.split()[0])
  79                      for line in lines if '/etype/' in line])
  80     glob_list = glob.glob(os.path.join(our_path, 'etype/*.py'))
  81     all_set = set([os.path.basename(item) for item in glob_list])
  82     missing_list = all_set
  83     missing_list.difference_update(test_set)
  84     missing_list.remove('_testing.py')
  85     coverage = lines[-1].split(' ')[-1]
  86     ok = True
  87     if missing_list:
  88         print 'Missing tests for %s' % (', '.join(missing_list))
  89         ok = False
  90     if coverage != '100%':
  91         print stdout
  92         print "Type 'coverage html' to get a report in htmlcov/index.html"
  93         print 'Coverage error: %s, but should be 100%%' % coverage
  94         ok = False
  95     if not ok:
  96       raise ValueError('Test coverage failure')
  97
  98 def RunBinman(options, args):
  99     """Main entry point to binman once arguments are parsed
 100
 101     Args:
 102         options: Command-line options
 103         args: Non-option arguments
 104     """
 105     ret_code = 0
 106
 107     # For testing: This enables full exception traces.
 108     #options.debug = True
 109
 110     if not options.debug:
 111         sys.tracebacklimit = 0
 112
 113     if options.test:
 114         ret_code = RunTests(options.debug)
 115
 116     elif options.test_coverage:
 117         RunTestCoverage()
 118
 119     elif options.full_help:
 120         pager = os.getenv('PAGER')
 121         if not pager:
 122             pager = 'more'
 123         fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
 124                             'README')
 125         command.Run(pager, fname)
 126
 127     else:
 128         try:
 129             ret_code = control.Binman(options, args)
 130         except Exception as e:
 131             print 'binman: %s' % e
 132             if options.debug:
 133                 print
 134                 traceback.print_exc()
 135             ret_code = 1
 136     return ret_code
 137
 138
 139 if __name__ == "__main__":
 140     (options, args) = cmdline.ParseArgs(sys.argv)
 141     ret_code = RunBinman(options, args)
 142     sys.exit(ret_code)