tools::test_api Namespace Reference

This is a worker function for the parallel building of tests. The `args`
and `kwargs` are passed directly to `build_project`. It returns a dictionary
with the following structure:

{
    'result': `True` if no exceptions were thrown, `False` otherwise
    'reason': Instance of exception that was thrown on failure
    'bin_file': Path to the created binary if `build_project` was
                successful. Not present otherwise
    'kwargs': The keyword arguments that were passed to `build_project`.
              This includes arguments that were modified (ex. report)
}

Given the data structure from 'find_tests' and the typical build parameters,
build all the tests

Returns a tuple of the build result (True or False) followed by the test
build data structure

uses verbose mode (prints) database detection sequence to check it database connection string is valid

Factory database driver depending on database type supplied in database connection string db_url

Finds all tests in a directory recursively
base_dir: path to the directory to scan for tests (ex. 'path/to/project')
target_name: name of the target to use for scanning (ex. 'K64F')
toolchain_name: name of the toolchain to use for scanning (ex. 'GCC_ARM')
options: Compile options to pass to the toolchain (ex. ['debug-info'])
app_config - location of a chosen mbed_app.json file

returns a dictionary where keys are the test name, and the values are
lists of paths needed to biuld the test.

Function detects all connected to host mbed-enabled devices and generates artificial MUTS file.
    If function fails to auto-detect devices it will return empty dictionary.

    if get_module_avail('mbed_lstools'):
        mbeds = mbed_lstools.create()
        mbeds_list = mbeds.list_mbeds()

    @param mbeds_list list of mbeds captured from mbed_lstools
    @param platform_name You can filter 'platform_name' with list of filtered targets from 'platform_name_filter'

Function detects all connected to host mbed-enabled devices and generates artificial test_spec file.
    If function fails to auto-detect devices it will return empty 'targets' test_spec description.

    use_default_toolchain - if True add default toolchain to test_spec
    use_supported_toolchains - if True add all supported toolchains to test_spec
    toolchain_filter - if [...list of toolchains...] add from all toolchains only those in filter to test_spec

Generates table summary with all test cases and additional test cases
    information using pretty print functionality. Allows test suite user to
    see test cases

Get common test script options used by CLI, web services etc.

Loads from file JSON formatted string to data structure

This function returns True if module_name is already imported module

Finds the path to a test configuration file
config_name: path to a custom configuration file OR mbed OS interface "ethernet, wifi_odin, etc"
target_name: name of target to determing if mbed OS interface given is valid
returns path to config, will return None if no valid config is found

Gets list of unique target names

Gets list of unique target names and return dictionary

Gets first error line and column in JSON file format.
    Parsed from exception thrown by json.loads() string

This function will create a normalized, relative path. It mimics the
python os.path.relpath function, but also normalizes a Windows-syle path
that use backslashes to a Unix style path that uses forward slashes.

Prints MUTs configuration passed to test script for verboseness

Prints test specification configuration passed to test script for verboseness

Given a dictionary of tests (as returned from "find_tests"), print them
in the specified format

This function creates progress bar with optional simple saturation mark

Prints JSON broken content

Runs SingleTestRunner object in CLI (Command line interface) mode

    @return returns success code (0 == success) for building and running tests

Change all slashes in a path into hyphens
This creates a unique cross-platform test name based on the path
This can eventually be overriden by a to-be-determined meta-data mechanism