Skip to content

Commit

Permalink
Fixing constant cleaning when compiling tests
Browse files Browse the repository at this point in the history
This addresses the issue where building tests via test.py always triggered
a clean build. This is because the mbed_config.h file was being deleted from
the shared OS build to ensure that the correct config was always being
used. However, this contanstly triggered a rebuild of the OS since the
config file was not present.

Due to the shared build, having multiple app configurations that could
override the OS settings is not possible. For this reason, we now ignore
app config files unless explicitly set via the command line option
'--app-config'. Though there will now be two mbed_config.h files in the
include path of the build, it shouldn't matter since the contents will be
the same.
  • Loading branch information
bridadan committed Sep 22, 2016
1 parent c1c1492 commit aeca796
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/testing_mbed_OS_5.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The way tests are run and compiled in mbed OS 5 is substantially different from
- [Test names](#test-names)
- [Building tests](#building-tests)
- [Building process](#building-process)
- [App config](#app-config)
- [Running tests](#running-tests)
- [Writing tests](#writing-tests)
- [Debugging tests](#debugging-tests)
Expand Down Expand Up @@ -73,6 +74,12 @@ The full build process is:
1. For each discovered test, build all of its source files and link it with the non-test code that was built in step 1.
1. If specified, create a test specification file and place it in the given directory for use by testing tools. This is placed in the build directory by default when using mbed CLI.

#### App config

When building an mbed application, the presence of a `mbed_app.json` file allows you to set or override different config settings from libraries and targets. However, because the tests share a common build, this can cause issues when tests have different configurations that affect the OS.

If you need to use app config, this must be set via the `--app-config` option when calling `mbed test`. **If this option is not specified, the build system will ignore all `mbed_app.json` files and use the default config values.**

### Running tests

Automated tests can be run easily through mbed CLI. For information on using mbed CLI, please see its documentation.
Expand Down
10 changes: 9 additions & 1 deletion tools/test.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,15 @@
"Currently set search path: %s"
% (toolchain, search_path))

# App config
# Disable finding `mbed_app.json` files in the source tree if not
# explicitly defined on the command line. Config system searches for
# `mbed_app.json` files if `app_config` is None, but will set the
# app config data to an empty dictionary if the path value is another
# falsey value besides None.
if options.app_config is None:
options.app_config = ''

# Find all tests in the relevant paths
for path in all_paths:
all_tests.update(find_tests(path, mcu, toolchain, options.options,
Expand Down Expand Up @@ -184,7 +193,6 @@
verbose=options.verbose,
notify=notify,
archive=False,
remove_config_header_file=True,
app_config=options.app_config)

library_build_success = True
Expand Down

0 comments on commit aeca796

Please sign in to comment.