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

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