blob: 3e463b0119b83dc19f43c96f5eba1d159f456f7f [file] [log] [blame]
Simon Glass38856012019-10-31 07:43:05 -06001#!/usr/bin/env python3
Tom Rini83d290c2018-05-06 17:58:06 -04002# SPDX-License-Identifier: GPL-2.0+
Simon Glassbf7fd502016-11-25 20:15:51 -07003
4# Copyright (c) 2016 Google, Inc
5# Written by Simon Glass <sjg@chromium.org>
6#
Simon Glassbf7fd502016-11-25 20:15:51 -07007# Creates binary images from input files controlled by a description
8#
9
10"""See README for more information"""
11
Simon Glass86679ce2019-07-08 13:18:36 -060012from distutils.sysconfig import get_python_lib
Simon Glassbf7fd502016-11-25 20:15:51 -070013import os
Simon Glass86679ce2019-07-08 13:18:36 -060014import site
Simon Glassbf7fd502016-11-25 20:15:51 -070015import sys
16import traceback
17import unittest
18
Simon Glass53cd5d92019-07-08 14:25:29 -060019# Bring in the patman and dtoc libraries (but don't override the first path
20# in PYTHONPATH)
Simon Glassbf7fd502016-11-25 20:15:51 -070021our_path = os.path.dirname(os.path.realpath(__file__))
Simon Glassb4fa9492020-04-17 18:09:05 -060022sys.path.insert(2, os.path.join(our_path, '..'))
23
24from patman import test_util
Simon Glassbf7fd502016-11-25 20:15:51 -070025
Simon Glassb4360202017-05-27 07:38:22 -060026# Bring in the libfdt module
Simon Glass53cd5d92019-07-08 14:25:29 -060027sys.path.insert(2, 'scripts/dtc/pylibfdt')
Simon Glassfdb30402020-07-09 18:39:28 -060028sys.path.insert(2, os.path.join(our_path, '../../scripts/dtc/pylibfdt'))
Simon Glass53cd5d92019-07-08 14:25:29 -060029sys.path.insert(2, os.path.join(our_path,
Simon Glassed59e002018-10-01 21:12:40 -060030 '../../build-sandbox_spl/scripts/dtc/pylibfdt'))
Simon Glassb4360202017-05-27 07:38:22 -060031
Simon Glass86679ce2019-07-08 13:18:36 -060032# When running under python-coverage on Ubuntu 16.04, the dist-packages
33# directories are dropped from the python path. Add them in so that we can find
34# the elffile module. We could use site.getsitepackages() here but unfortunately
35# that is not available in a virtualenv.
36sys.path.append(get_python_lib())
37
Simon Glass16287932020-04-17 18:09:03 -060038from binman import cmdline
39from binman import control
Simon Glassbf776672020-04-17 18:09:04 -060040from patman import test_util
Simon Glassbf7fd502016-11-25 20:15:51 -070041
Simon Glass8acce602019-07-08 13:18:50 -060042def RunTests(debug, verbosity, processes, test_preserve_dirs, args, toolpath):
Simon Glass084059a2018-06-01 09:38:18 -060043 """Run the functional tests and any embedded doctests
44
45 Args:
46 debug: True to enable debugging, which shows a full stack trace on error
Simon Glassee0c9a72019-07-08 13:18:48 -060047 verbosity: Verbosity level to use
Simon Glassd5164a72019-07-08 13:18:49 -060048 test_preserve_dirs: True to preserve the input directory used by tests
49 so that it can be examined afterwards (only useful for debugging
50 tests). If a single test is selected (in args[0]) it also preserves
51 the output directory for this test. Both directories are displayed
52 on the command line.
53 processes: Number of processes to use to run tests (None=same as #CPUs)
Simon Glass084059a2018-06-01 09:38:18 -060054 args: List of positional args provided to binman. This can hold a test
Simon Glass53cd5d92019-07-08 14:25:29 -060055 name to execute (as in 'binman test testSections', for example)
Simon Glass8acce602019-07-08 13:18:50 -060056 toolpath: List of paths to use for tools
Simon Glass084059a2018-06-01 09:38:18 -060057 """
Simon Glass16287932020-04-17 18:09:03 -060058 from binman import cbfs_util_test
59 from binman import elf_test
60 from binman import entry_test
61 from binman import fdt_test
62 from binman import ftest
63 from binman import image_test
64 from binman import test
Simon Glassbf7fd502016-11-25 20:15:51 -070065 import doctest
66
67 result = unittest.TestResult()
Simon Glassce0dc2e2020-04-17 18:09:01 -060068 test_name = args and args[0] or None
Simon Glass934cdcf2017-11-12 21:52:21 -070069
70 # Run the entry tests first ,since these need to be the first to import the
71 # 'entry' module.
Simon Glassce0dc2e2020-04-17 18:09:01 -060072 test_util.RunTestSuites(
73 result, debug, verbosity, test_preserve_dirs, processes, test_name,
74 toolpath,
75 [entry_test.TestEntry, ftest.TestFunctional, fdt_test.TestFdt,
76 elf_test.TestElf, image_test.TestImage, cbfs_util_test.TestCbfs])
Simon Glassbf7fd502016-11-25 20:15:51 -070077
Simon Glassce0dc2e2020-04-17 18:09:01 -060078 return test_util.ReportResult('binman', test_name, result)
Simon Glassbf7fd502016-11-25 20:15:51 -070079
Simon Glass32eb66d2020-07-09 18:39:29 -060080def RunTestCoverage(toolpath):
Simon Glassbf7fd502016-11-25 20:15:51 -070081 """Run the tests and check that we get 100% coverage"""
Simon Glass87d43322020-08-05 13:27:46 -060082 glob_list = control.GetEntryModules(False)
Tom Rini16d836c2018-07-06 10:27:14 -060083 all_set = set([os.path.splitext(os.path.basename(item))[0]
84 for item in glob_list if '_testing' not in item])
Simon Glass32eb66d2020-07-09 18:39:29 -060085 extra_args = ''
86 if toolpath:
87 for path in toolpath:
88 extra_args += ' --toolpath %s' % path
Simon Glassc07ab6e2020-04-17 18:08:58 -060089 test_util.RunTestCoverage('tools/binman/binman', None,
90 ['*test*', '*main.py', 'tools/patman/*', 'tools/dtoc/*'],
Simon Glass32eb66d2020-07-09 18:39:29 -060091 args.build_dir, all_set, extra_args or None)
Simon Glassbf7fd502016-11-25 20:15:51 -070092
Simon Glass53cd5d92019-07-08 14:25:29 -060093def RunBinman(args):
Simon Glassbf7fd502016-11-25 20:15:51 -070094 """Main entry point to binman once arguments are parsed
95
96 Args:
Simon Glass53cd5d92019-07-08 14:25:29 -060097 args: Command line arguments Namespace object
Simon Glassbf7fd502016-11-25 20:15:51 -070098 """
99 ret_code = 0
100
Simon Glass53cd5d92019-07-08 14:25:29 -0600101 if not args.debug:
Simon Glassbf7fd502016-11-25 20:15:51 -0700102 sys.tracebacklimit = 0
103
Simon Glassb5287c42020-07-09 18:39:30 -0600104 # Provide a default toolpath in the hope of finding a mkimage built from
105 # current source
106 if not args.toolpath:
107 args.toolpath = ['./tools', 'build-sandbox/tools']
108
Simon Glass53cd5d92019-07-08 14:25:29 -0600109 if args.cmd == 'test':
110 if args.test_coverage:
Simon Glass32eb66d2020-07-09 18:39:29 -0600111 RunTestCoverage(args.toolpath)
Simon Glass53cd5d92019-07-08 14:25:29 -0600112 else:
113 ret_code = RunTests(args.debug, args.verbosity, args.processes,
114 args.test_preserve_dirs, args.tests,
115 args.toolpath)
Simon Glassbf7fd502016-11-25 20:15:51 -0700116
Simon Glass53cd5d92019-07-08 14:25:29 -0600117 elif args.cmd == 'entry-docs':
Simon Glass87d43322020-08-05 13:27:46 -0600118 control.WriteEntryDocs(control.GetEntryModules())
Simon Glassbf7fd502016-11-25 20:15:51 -0700119
120 else:
121 try:
Simon Glass53cd5d92019-07-08 14:25:29 -0600122 ret_code = control.Binman(args)
Simon Glassbf7fd502016-11-25 20:15:51 -0700123 except Exception as e:
Simon Glass6c8e0bf2020-07-09 18:39:26 -0600124 print('binman: %s' % e, file=sys.stderr)
Simon Glass53cd5d92019-07-08 14:25:29 -0600125 if args.debug:
Simon Glass2ca84682019-05-14 15:53:37 -0600126 print()
Simon Glassbf7fd502016-11-25 20:15:51 -0700127 traceback.print_exc()
128 ret_code = 1
129 return ret_code
130
131
132if __name__ == "__main__":
Simon Glass53cd5d92019-07-08 14:25:29 -0600133 args = cmdline.ParseArgs(sys.argv[1:])
134
135 ret_code = RunBinman(args)
Simon Glassbf7fd502016-11-25 20:15:51 -0700136 sys.exit(ret_code)