2 # SPDX-License-Identifier: GPL-2.0+
4 # Copyright (c) 2016 Google, Inc
5 # Written by Simon Glass <sjg@chromium.org>
7 # Creates binary images from input files controlled by a description
10 """See README for more information"""
12 from distutils.sysconfig import get_python_lib
20 # Bring in the patman and dtoc libraries (but don't override the first path
22 our_path = os.path.dirname(os.path.realpath(__file__))
23 for dirname in ['../patman', '../dtoc', '../concurrencytest', '..']:
24 sys.path.insert(2, os.path.realpath(os.path.join(our_path, dirname)))
26 # Bring in the libfdt module
27 sys.path.insert(2, 'scripts/dtc/pylibfdt')
28 sys.path.insert(2, os.path.join(our_path,
29 '../../build-sandbox_spl/scripts/dtc/pylibfdt'))
31 # When running under python-coverage on Ubuntu 16.04, the dist-packages
32 # directories are dropped from the python path. Add them in so that we can find
33 # the elffile module. We could use site.getsitepackages() here but unfortunately
34 # that is not available in a virtualenv.
35 sys.path.append(get_python_lib())
37 from binman import cmdline
38 from binman import control
39 from patman import test_util
41 def RunTests(debug, verbosity, processes, test_preserve_dirs, args, toolpath):
42 """Run the functional tests and any embedded doctests
45 debug: True to enable debugging, which shows a full stack trace on error
46 verbosity: Verbosity level to use
47 test_preserve_dirs: True to preserve the input directory used by tests
48 so that it can be examined afterwards (only useful for debugging
49 tests). If a single test is selected (in args[0]) it also preserves
50 the output directory for this test. Both directories are displayed
52 processes: Number of processes to use to run tests (None=same as #CPUs)
53 args: List of positional args provided to binman. This can hold a test
54 name to execute (as in 'binman test testSections', for example)
55 toolpath: List of paths to use for tools
57 from binman import cbfs_util_test
58 from binman import elf_test
59 from binman import entry_test
60 from binman import fdt_test
61 from binman import ftest
62 from binman import image_test
63 from binman import test
66 result = unittest.TestResult()
67 test_name = args and args[0] or None
69 # Run the entry tests first ,since these need to be the first to import the
71 test_util.RunTestSuites(
72 result, debug, verbosity, test_preserve_dirs, processes, test_name,
74 [entry_test.TestEntry, ftest.TestFunctional, fdt_test.TestFdt,
75 elf_test.TestElf, image_test.TestImage, cbfs_util_test.TestCbfs])
77 return test_util.ReportResult('binman', test_name, result)
79 def GetEntryModules(include_testing=True):
80 """Get a set of entry class implementations
83 Set of paths to entry class filenames
85 glob_list = glob.glob(os.path.join(our_path, 'etype/*.py'))
86 return set([os.path.splitext(os.path.basename(item))[0]
88 if include_testing or '_testing' not in item])
90 def RunTestCoverage():
91 """Run the tests and check that we get 100% coverage"""
92 glob_list = GetEntryModules(False)
93 all_set = set([os.path.splitext(os.path.basename(item))[0]
94 for item in glob_list if '_testing' not in item])
95 test_util.RunTestCoverage('tools/binman/binman', None,
96 ['*test*', '*main.py', 'tools/patman/*', 'tools/dtoc/*'],
97 args.build_dir, all_set)
100 """Main entry point to binman once arguments are parsed
103 args: Command line arguments Namespace object
108 sys.tracebacklimit = 0
110 if args.cmd == 'test':
111 if args.test_coverage:
114 ret_code = RunTests(args.debug, args.verbosity, args.processes,
115 args.test_preserve_dirs, args.tests,
118 elif args.cmd == 'entry-docs':
119 control.WriteEntryDocs(GetEntryModules())
123 ret_code = control.Binman(args)
124 except Exception as e:
125 print('binman: %s' % e)
128 traceback.print_exc()
133 if __name__ == "__main__":
134 args = cmdline.ParseArgs(sys.argv[1:])
136 ret_code = RunBinman(args)