Default greentea test case set up handler.

Definition at line 153 of file utest_default_handlers.h.

Test case handler (repeatable)

This handler is called only if the case setup succeeded and then may be repeated or awaiting a asynchronous callback, depending on the return modifiers.

Parameters

call_count

starting at 1, contains the number of times this handler has been called

Returns

A combination of control modifiers.

Definition at line 356 of file utest_types.h.

Complex test case handler.

This handler is called only if the case setup succeeded and then may be repeated or awaiting a asynchronous callback, depending on the return modifiers.

Returns

A combination of control modifiers.

Definition at line 344 of file utest_types.h.

Test case failure handler.

This handler is called whenever a failure occurred during the setup, execution or teardown.

Parameters

source	the test case in which the failure occurred
reason	the reason why this handler was called

Returns

You can return STATUS_ABORT to indicate that this failure is non-recoverable, which will call the case teardown handler with reason. If a failure occurs during teardown, the teardown will not be called again. You may return STATUS_IGNORE which will cause the harness to ignore and not count the failure.

Definition at line 386 of file utest_types.h.

Primitive test case handler.

This handler is called only if the case setup succeeded and is followed by the test case teardown handler.

Note

This handler is executed only once.

Definition at line 334 of file utest_types.h.

Test case setup handler.

This handler is called before execution of each test case and allows you to modify your environment before each test case.

Parameters

source	the test case to be setup
index_of_case	the current index of the test case within the specification

Returns

You can return STATUS_ABORT to indicate that your setup failed, which will call the case failure handler with REASON_SETUP and then the case teardown handler with REASON_SETUP. This gives the teardown handler a chance to clean up a failed setup.

Definition at line 326 of file utest_types.h.

Test case teardown handler.

This handler is called after execution of each test case or all repeated test cases and allows you to reset your environment after each test case.

Parameters

source	the test case to be torn down
passed	the number of cases without failures (can be >1 for repeated test cases)
failed	the number failures (can be larger than the number of (repeated) test cases)
failure	the reason why this handler was called

Returns

You can return STATUS_ABORT to indicate that your teardown failed, which will call the case failure handler with REASON_TEARDOWN.

Definition at line 372 of file utest_types.h.

Test failure handler.

This handler is called anytime a failure occurs during the execution of a test speficication. The handler only allows logging of failures and cannot influence test execution.

Parameters

failure

the reason why this handler was called

Definition at line 311 of file utest_types.h.

Test setup handler.

This handler is called before execution of any test case and allows you to initialize your common test environment.

Parameters

number_of_cases

the total number of test cases in the test specification

Returns

You can return STATUS_ABORT if you initialization failed and the test teardown handler will then be called with the REASON_SETUP.

Definition at line 287 of file utest_types.h.

Test teardown handler.

This handler is called after execution of all test case or if test execution is aborted. You can use this handler to de-initialize your test environment and output test statistics. The failure argument contains the immediate reason why this handler is called. If the test completed normally without failures, this will contain REASON_NONE.

After execution of this handler, the test harness will stop execution.

Parameters

passed	the number of cases without failures
failed	the number of cases with at least one failure
failure	the reason why this handler was called

Definition at line 302 of file utest_types.h.

The utest harness manages its own state and therefore does not require the scheduler to bind any arguments to the scheduled callback.

Definition at line 38 of file utest_scheduler.h.

utest needs to cancel callbacks with a non-zero delay some time later.

Even though utest only schedules one callback at any given time, it can cancel a callback more than once. You should therefore make use of the handle to make sure you do not cancel the wrong callback.

Note

If your scheduler cannot provide asynchronous callbacks, do nothing in this function and return non-zero.

Parameters

handle

the handle returned from the post call to identify which callback to be cancelled.

Return values

<tt>0</tt>	if success
non-zero	if failure

Definition at line 80 of file utest_scheduler.h.

utest calls this function before running the test specification.

Use this function to initialize your scheduler before the first callback is requested.

Return values

<tt>0</tt>	if success
non-zero	if failure

Definition at line 47 of file utest_scheduler.h.

utest calls this function when it needs to schedule a callback with a delay in milliseconds.

delay_ms will only be non-zero if an asynchronous test case exists in the test specification.

Note

If your scheduler cannot provide asynchronous callbacks (which probably require a hardware timer), then this scheduler may return NULL as a handle and utest will fail the asynchronous request and move on. Note that test cases which do not require asynchronous callback support will still work fine then.

Warning

You MUST NOT execute the callback inside this function, even for a delay of 0ms. Buffer the callback and call it in your main loop.

You MUST NOT execute the callback in an interrupt context! Buffer the callback and call it in your main loop.

Note

utest only schedules one callback at any given time. This should make the implementation of this scheduler a lot simpler for you.

Parameters

callback	the pointer to the callback function
delay_ms	the delay in milliseconds after which the callback should be executed

Returns

A handle to identify the scheduled callback, or NULL for failure.

Definition at line 67 of file utest_scheduler.h.

utest calls this function at the end of the Harness::run() function, after (!) the first callback has been requested.

This function is meant to implement an optional event loop, which may very well be blocking (if your scheduler works with that). This assumes that Harness::run() will be called on the main stack (ie. not in an interrupt!).

Return values

<tt>0</tt>	if success
non-zero	if failure

Definition at line 90 of file utest_scheduler.h.

Definition at line 114 of file utest_types.h.

failure_reason_t

Definition at line 59 of file utest_types.h.

location_t

Definition at line 81 of file utest_types.h.

repeat_t

Definition at line 34 of file utest_types.h.

status_t

Definition at line 52 of file utest_types.h.

Alias class for asynchronous timeout control in milliseconds and repeats the test case handler with calling teardown and setup handlers.

Definition at line 269 of file utest_types.h.

Alias class for asynchronous timeout control in milliseconds and repeats only the test case handler without calling teardown and setup handlers.

Definition at line 272 of file utest_types.h.

Alias class for asynchronous timeout control in milliseconds.

Definition at line 265 of file utest_types.h.

Copy constructor.

Definition at line 99 of file utest_types.h.

Returns

the textual description of the test case

Reports the failure to greentea and then aborts.

Reports the failure to greentea and then continues.

Registers the test case setup with greentea.

Registers the test case teardown with greentea.

Report and cleanup platform specifc metrics.

Setup platform specific metrics.

Greentea-client C API.

Reports the failure for REASON_TEST_SETUP and REASON_TEST_TEARDOWN to greentea and then dies.

Requests the start test case from greentea and continues.

Example usage: utest::v1::status_t greentea_test_setup(const size_t number_of_cases) { GREENTEA_SETUP(5, "default_auto"); return greentea_test_setup_handler(number_of_cases); }

Specification specification(greentea_test_setup, cases, greentea_test_teardown_handler);

Reports the test results to greentea.

Notify greentea of testcase name.

Returns

a copy of the failure with the reason ignored.

Definition at line 105 of file utest_types.h.

Returns

true if a test specification is being executed, false otherwise

Returns

true if setup, test and teardown handlers are set to ignore_handler

See also

operator+ in control_t

Definition at line 236 of file utest_types.h.

See also

operator+ in control_t

Definition at line 241 of file utest_types.h.

See also

operator+ in control_t

Definition at line 246 of file utest_types.h.

Raising a failure causes the failure to be counted and the failure handler to be called.

Further action then depends on its return state.

Runs a test specification.

Return values

<tt>true</tt>	if the specification can be run
<tt>false</tt>	if another specification is currently running

Sets the scheduler to be used.

Returns

true if scheduler is properly specified (all functions non-null).

Stringifies a failure reason for understandable error messages.

Stringifies a failure for understandable error messages.

Stringifies a location.

Stringifies a status.

this function is called from the unity module when an assertion failed.

this function is called from the unity module when an assertion failed, but is ignored.

must be implemented by the port

This is the default scheduler implementation used by the harness.

Call this function in the asynchronous callback that you have been waiting for.

You can only validate a callback once, calling this function when no callback is expected has no side effects. After callback validation, the next test case is scheduled.

You may specify additional test case attributes with this callback. So for example, you may delay the decision to repeat an asynchronous test case until the callback needs to be validated.

However, be aware, that only the repeat attributes can be modified and the usual arbitration rules apply. The modified case attributes are only valid until the case handler returns updated attributes.

Parameters

control

the test case attribute to be added to the existing attributes.

Prints the reason of the failure and continues, unless the teardown handler failed, for which it aborts.

Prints the index and description of the case being run and continues.

Prints the number of tests that passed and failed with a reason if provided within this case and continues.

Prints the failure for REASON_TEST_SETUP and REASON_TEST_TEARDOWN and then dies.

Prints the number of tests to run and continues.

Prints the number of tests that passed and failed with a reason if provided.

Awaits until the callback is validated and never times out. Use with caution!

does not repeat this test case and immediately moves on to the next one without timeout

does not repeat this test case, moves on to the next one

No timeout, immediately moves on to the next case, but allows repeats.

repeats the test case handler with calling teardown and setup handlers

repeats only the test case handler without calling teardown and setup handlers

See also

case_control_handler_t

Definition at line 61 of file utest_case.h.

Default handler hint.

Use this handler to indicate the you want the default handler to be called. This type automatically casts itself into the appropriate handler type, when possible. Use the constants to default a handler unambigously.

The greentea aborting handlers are the default.

Textual description of the test case.

Definition at line 49 of file utest_case.h.

Handler called whenever a faillure occur; at any stage of the case execution (including setup and teardown).

Definition at line 84 of file utest_case.h.

The greentea default handlers that always abort on the first encountered failure.

The greentea default handlers that always continue on failure.

Primitive test case handler This is called only if the case setup succeeded.

It is followed by the test case teardown handler.

Definition at line 56 of file utest_case.h.

Ignore handler hint.

Use this handler to indicate the you want to ignore this handler and it will not be called. This type automatically casts itself into the appropriate handler type, when possible. Use the constants to ignore a handler unambigously.

See also

case_call_count_handler_t

Definition at line 66 of file utest_case.h.

The selftest default handlers that always abort on any assertion failure, otherwise continue.

Handler called before the execution of the case handler.

It sets up the case environment.

Definition at line 72 of file utest_case.h.

Handler called after the execution of the case handler.

It cleans up the case environment.

Definition at line 78 of file utest_case.h.

The verbose default handlers that always continue on failure.