Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Macros | Typedefs | Enumerations | Enumerator | Functions | Variables
Frameworks

Data Structures

class  GreenteaSerial
 
struct  _Unity
 
struct  case_t
 POD data structure of the Case class. More...
 
class  Case
 Test case wrapper class. More...
 
struct  handlers_t
 A table of handlers. More...
 
class  Harness
 Test Harness. More...
 
struct  utest_v1_scheduler_t
 The scheduler interface consists out of the post and cancel functions, which you must implement to use utest. More...
 
class  Specification
 Test specification containing the setup and teardown handlers and test cases. More...
 
struct  failure_t
 Contains the reason and location of the failure. More...
 
struct  base_control_t
 POD version of the class control_t. More...
 
struct  control_t
 Control class for specifying test case attributes. More...
 

Macros

#define UTEST_DEFAULT_GREENTEA_TIMEOUT   10
 Default greentea test case set up handler. More...
 

Typedefs

typedef void(* utest_v1_harness_callback_t) (void)
 The utest harness manages its own state and therefore does not require the scheduler to bind any arguments to the scheduled callback. More...
 
typedef int32_t(* utest_v1_scheduler_init_callback_t) (void)
 utest calls this function before running the test specification. More...
 
typedef void *(* utest_v1_scheduler_post_callback_t) (const utest_v1_harness_callback_t callback, timestamp_t delay_ms)
 utest calls this function when it needs to schedule a callback with a delay in milliseconds. More...
 
typedef int32_t(* utest_v1_scheduler_cancel_callback_t) (void *handle)
 utest needs to cancel callbacks with a non-zero delay some time later. More...
 
typedef int32_t(* utest_v1_scheduler_run_callback_t) (void)
 utest calls this function at the end of the Harness::run() function, after (!) the first callback has been requested. More...
 
typedef utest::v1::status_t(* test_setup_handler_t) (const size_t number_of_cases)
 Test setup handler. More...
 
typedef void(* test_teardown_handler_t) (const size_t passed, const size_t failed, const failure_t failure)
 Test teardown handler. More...
 
typedef void(* test_failure_handler_t) (const failure_t reason)
 Test failure handler. More...
 
typedef utest::v1::status_t(* case_setup_handler_t) (const Case *const source, const size_t index_of_case)
 Test case setup handler. More...
 
typedef void(* case_handler_t) (void)
 Primitive test case handler. More...
 
typedef control_t(* case_control_handler_t) (void)
 Complex test case handler. More...
 
typedef control_t(* case_call_count_handler_t) (const size_t call_count)
 Test case handler (repeatable) More...
 
typedef utest::v1::status_t(* case_teardown_handler_t) (const Case *const source, const size_t passed, const size_t failed, const failure_t reason)
 Test case teardown handler. More...
 
typedef utest::v1::status_t(* case_failure_handler_t) (const Case *const source, const failure_t reason)
 Test case failure handler. More...
 

Enumerations

Functions

void greentea_metrics_setup (void)
 Setup platform specific metrics. More...
 
void greentea_metrics_report (void)
 Report and cleanup platform specifc metrics. More...
 
void GREENTEA_SETUP (const int timeout, const char *host_test)
 Greentea-client C API. More...
 
void utest_unity_assert_failure (void)
 this function is called from the unity module when an assertion failed. More...
 
void utest_unity_ignore_failure (void)
 this function is called from the unity module when an assertion failed, but is ignored. More...
 
const char * get_description () const
 
bool is_empty () const
 
utest::v1::status_t verbose_test_setup_handler (const size_t number_of_cases)
 Prints the number of tests to run and continues. More...
 
void verbose_test_teardown_handler (const size_t passed, const size_t failed, const failure_t failure)
 Prints the number of tests that passed and failed with a reason if provided. More...
 
void verbose_test_failure_handler (const failure_t failure)
 Prints the failure for REASON_TEST_SETUP and REASON_TEST_TEARDOWN and then dies. More...
 
utest::v1::status_t verbose_case_setup_handler (const Case *const source, const size_t index_of_case)
 Prints the index and description of the case being run and continues. More...
 
utest::v1::status_t verbose_case_teardown_handler (const Case *const source, const size_t passed, const size_t failed, const failure_t failure)
 Prints the number of tests that passed and failed with a reason if provided within this case and continues. More...
 
utest::v1::status_t verbose_case_failure_handler (const Case *const source, const failure_t reason)
 Prints the reason of the failure and continues, unless the teardown handler failed, for which it aborts. More...
 
utest::v1::status_t greentea_test_setup_handler (const size_t number_of_cases)
 Requests the start test case from greentea and continues. More...
 
void greentea_test_teardown_handler (const size_t passed, const size_t failed, const failure_t failure)
 Reports the test results to greentea. More...
 
void greentea_test_failure_handler (const failure_t failure)
 Reports the failure for REASON_TEST_SETUP and REASON_TEST_TEARDOWN to greentea and then dies. More...
 
utest::v1::status_t greentea_case_setup_handler (const Case *const source, const size_t index_of_case)
 Registers the test case setup with greentea. More...
 
utest::v1::status_t greentea_case_teardown_handler (const Case *const source, const size_t passed, const size_t failed, const failure_t failure)
 Registers the test case teardown with greentea. More...
 
utest::v1::status_t greentea_case_failure_abort_handler (const Case *const source, const failure_t reason)
 Reports the failure to greentea and then aborts. More...
 
utest::v1::status_t greentea_case_failure_continue_handler (const Case *const source, const failure_t reason)
 Reports the failure to greentea and then continues. More...
 
void greentea_testcase_notification_handler (const char *testcase)
 Notify greentea of testcase name. More...
 
static bool run (const Specification &specification)
 Runs a test specification. More...
 
static bool is_busy ()
 
static bool set_scheduler (utest_v1_scheduler_t scheduler)
 Sets the scheduler to be used. More...
 
static void validate_callback (const control_t control=control_t())
 Call this function in the asynchronous callback that you have been waiting for. More...
 
static void raise_failure (const failure_reason_t reason)
 Raising a failure causes the failure to be counted and the failure handler to be called. More...
 
void utest_v1_enter_critical_section (void)
 must be implemented by the port More...
 
utest_v1_scheduler_t utest_v1_get_scheduler (void)
 This is the default scheduler implementation used by the harness. More...
 
 failure_t (const failure_t &obj)
 Copy constructor. More...
 
failure_t ignored () const
 
const char * stringify (failure_reason_t reason)
 Stringifies a failure reason for understandable error messages. More...
 
const char * stringify (failure_t failure)
 Stringifies a failure for understandable error messages. More...
 
const char * stringify (location_t location)
 Stringifies a location. More...
 
const char * stringify (utest::v1::status_t status)
 Stringifies a status. More...
 
control_t operator+ (const base_control_t &lhs, const base_control_t &rhs)
 
control_t operator+ (const base_control_t &lhs, const control_t &rhs)
 
control_t operator+ (const control_t &lhs, const base_control_t &rhs)
 
control_t CaseTimeout (uint32_t ms)
 Alias class for asynchronous timeout control in milliseconds. More...
 
control_t CaseRepeatAllOnTimeout (uint32_t ms)
 Alias class for asynchronous timeout control in milliseconds and repeats the test case handler with calling teardown and setup handlers. More...
 
control_t CaseRepeatHandlerOnTimeout (uint32_t ms)
 Alias class for asynchronous timeout control in milliseconds and repeats only the test case handler without calling teardown and setup handlers. More...
 

Variables

const char * description
 Textual description of the test case. More...
 
const case_handler_t handler
 Primitive test case handler This is called only if the case setup succeeded. More...
 
const case_control_handler_t control_handler
 
const case_call_count_handler_t repeat_count_handler
 
const case_setup_handler_t setup_handler
 Handler called before the execution of the case handler. More...
 
const case_teardown_handler_t teardown_handler
 Handler called after the execution of the case handler. More...
 
const case_failure_handler_t failure_handler
 Handler called whenever a faillure occur; at any stage of the case execution (including setup and teardown). More...
 
struct {
default_handler
 Default handler hint. More...
 
struct {
ignore_handler
 Ignore handler hint. More...
 
const handlers_t verbose_continue_handlers
 The verbose default handlers that always continue on failure. More...
 
const handlers_t greentea_abort_handlers
 The greentea default handlers that always abort on the first encountered failure. More...
 
const handlers_t greentea_continue_handlers
 The greentea default handlers that always continue on failure. More...
 
const handlers_t selftest_handlers
 The selftest default handlers that always abort on any assertion failure, otherwise continue. More...
 
const handlers_t & default_handlers
 The greentea aborting handlers are the default. More...
 
const base_control_t CaseNext
 does not repeat this test case and immediately moves on to the next one without timeout More...
 
const base_control_t CaseNoRepeat
 does not repeat this test case, moves on to the next one More...
 
const base_control_t CaseRepeatAll
 repeats the test case handler with calling teardown and setup handlers More...
 
const base_control_t CaseRepeatHandler
 repeats only the test case handler without calling teardown and setup handlers More...
 
const base_control_t CaseNoTimeout
 No timeout, immediately moves on to the next case, but allows repeats. More...
 
const base_control_t CaseAwait
 Awaits until the callback is validated and never times out. Use with caution! More...
 

Detailed Description

Macro Definition Documentation

#define UTEST_DEFAULT_GREENTEA_TIMEOUT   10

Default greentea test case set up handler.

Definition at line 153 of file utest_default_handlers.h.

Typedef Documentation

typedef control_t(* case_call_count_handler_t) (const size_t call_count)

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_countstarting 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.

typedef control_t(* case_control_handler_t) (void)

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.

typedef utest::v1::status_t(* case_failure_handler_t) (const Case *const source, const failure_t reason)

Test case failure handler.

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

Parameters
sourcethe test case in which the failure occurred
reasonthe 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.

typedef void(* case_handler_t) (void)

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.

typedef utest::v1::status_t(* case_setup_handler_t) (const Case *const source, const size_t index_of_case)

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
sourcethe test case to be setup
index_of_casethe 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.

typedef utest::v1::status_t(* case_teardown_handler_t) (const Case *const source, const size_t passed, const size_t failed, const failure_t reason)

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
sourcethe test case to be torn down
passedthe number of cases without failures (can be >1 for repeated test cases)
failedthe number failures (can be larger than the number of (repeated) test cases)
failurethe 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.

typedef void(* test_failure_handler_t) (const failure_t reason)

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
failurethe reason why this handler was called

Definition at line 311 of file utest_types.h.

typedef utest::v1::status_t(* test_setup_handler_t) (const size_t number_of_cases)

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_casesthe 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.

typedef void(* test_teardown_handler_t) (const size_t passed, const size_t failed, const failure_t failure)

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
passedthe number of cases without failures
failedthe number of cases with at least one failure
failurethe reason why this handler was called

Definition at line 302 of file utest_types.h.

typedef void(* utest_v1_harness_callback_t) (void)

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.

typedef int32_t(* utest_v1_scheduler_cancel_callback_t) (void *handle)

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
handlethe handle returned from the post call to identify which callback to be cancelled.
Return values
<tt>0</tt>if success
non-zeroif failure

Definition at line 80 of file utest_scheduler.h.

typedef int32_t(* utest_v1_scheduler_init_callback_t) (void)

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-zeroif failure

Definition at line 47 of file utest_scheduler.h.

typedef void*(* utest_v1_scheduler_post_callback_t) (const utest_v1_harness_callback_t callback, timestamp_t delay_ms)

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
callbackthe pointer to the callback function
delay_msthe 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.

typedef int32_t(* utest_v1_scheduler_run_callback_t) (void)

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-zeroif failure

Definition at line 90 of file utest_scheduler.h.

Enumeration Type Documentation

anonymous enum
Enumerator
TIMEOUT_NONE 

Do not use a timeout.

TIMEOUT_UNDECLR 

Timeout not explicitly specified, defaults to NONE.

TIMEOUT_FOREVER 

Never time out.

Definition at line 114 of file utest_types.h.

enum failure_reason_t

failure_reason_t

Enumerator
REASON_NONE 

No failure occurred.

REASON_UNKNOWN 

An unknown failure occurred.

REASON_CASES 

A failure occurred in at least one test case.

REASON_EMPTY_CASE 

The test case contains only empty handlers.

REASON_TIMEOUT 

An expected asynchronous call timed out.

REASON_ASSERTION 

An assertion failed.

REASON_TEST_SETUP 

Test setup failed.

REASON_TEST_TEARDOWN 

Test teardown failed.

REASON_CASE_SETUP 

Case setup failed.

REASON_CASE_HANDLER 

Case handler failed.

REASON_CASE_TEARDOWN 

Case teardown failed.

REASON_CASE_INDEX 

Case index out-of-range.

REASON_SCHEDULER 

Asynchronous callback scheduling failed.

REASON_IGNORE 

The failure may be ignored.

Definition at line 59 of file utest_types.h.

enum location_t

location_t

Enumerator
LOCATION_NONE 

No location information.

LOCATION_TEST_SETUP 

A failure occurred in the test setup.

LOCATION_TEST_TEARDOWN 

A failure occurred in the test teardown.

LOCATION_CASE_SETUP 

A failure occurred in the case setup.

LOCATION_CASE_HANDLER 

A failure occurred in the case handler.

LOCATION_CASE_TEARDOWN 

A failure occurred in the case teardown.

LOCATION_UNKNOWN 

A failure occurred in an unknown location.

Definition at line 81 of file utest_types.h.

enum repeat_t

repeat_t

Enumerator
REPEAT_NONE 

continue with the next test case

REPEAT_ALL_ON_TIMEOUT 

repeat the handler with setup and teardown on timeout

REPEAT_HANDLER_ON_TIMEOUT 

repeat only the handler on timeout

REPEAT_ALL 

repeat the handler with setup and teardown

REPEAT_HANDLER 

repeat only the handler

Definition at line 34 of file utest_types.h.

enum status_t

status_t

Enumerator
STATUS_CONTINUE 

continues testing

STATUS_IGNORE 

ignores failure and continues testing

STATUS_ABORT 

stops testing

Definition at line 52 of file utest_types.h.

Function Documentation

control_t utest::v1::CaseRepeatAllOnTimeout ( uint32_t  ms)

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.

control_t utest::v1::CaseRepeatHandlerOnTimeout ( uint32_t  ms)

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.

control_t utest::v1::CaseTimeout ( uint32_t  ms)

Alias class for asynchronous timeout control in milliseconds.

Definition at line 265 of file utest_types.h.

failure_t ( const failure_t obj)

Copy constructor.

Definition at line 99 of file utest_types.h.

const char* get_description ( ) const
Returns
the textual description of the test case
utest::v1::status_t utest::v1::greentea_case_failure_abort_handler ( const Case *const  source,
const failure_t  reason 
)

Reports the failure to greentea and then aborts.

utest::v1::status_t utest::v1::greentea_case_failure_continue_handler ( const Case *const  source,
const failure_t  reason 
)

Reports the failure to greentea and then continues.

utest::v1::status_t utest::v1::greentea_case_setup_handler ( const Case *const  source,
const size_t  index_of_case 
)

Registers the test case setup with greentea.

utest::v1::status_t utest::v1::greentea_case_teardown_handler ( const Case *const  source,
const size_t  passed,
const size_t  failed,
const failure_t  failure 
)

Registers the test case teardown with greentea.

void greentea_metrics_report ( void  )

Report and cleanup platform specifc metrics.

void greentea_metrics_setup ( void  )

Setup platform specific metrics.

void GREENTEA_SETUP ( const int  timeout,
const char *  host_test 
)

Greentea-client C API.

void utest::v1::greentea_test_failure_handler ( const failure_t  failure)

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

utest::v1::status_t utest::v1::greentea_test_setup_handler ( const size_t  number_of_cases)

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);

void utest::v1::greentea_test_teardown_handler ( const size_t  passed,
const size_t  failed,
const failure_t  failure 
)

Reports the test results to greentea.

void utest::v1::greentea_testcase_notification_handler ( const char *  testcase)

Notify greentea of testcase name.

failure_t ignored ( ) const
Returns
a copy of the failure with the reason ignored.

Definition at line 105 of file utest_types.h.

static bool is_busy ( )
static
Returns
true if a test specification is being executed, false otherwise
bool is_empty ( ) const
Returns
true if setup, test and teardown handlers are set to ignore_handler
control_t utest::v1::operator+ ( const base_control_t lhs,
const base_control_t rhs 
)
See also
operator+ in control_t

Definition at line 236 of file utest_types.h.

control_t utest::v1::operator+ ( const base_control_t lhs,
const control_t rhs 
)
See also
operator+ in control_t

Definition at line 241 of file utest_types.h.

control_t utest::v1::operator+ ( const control_t lhs,
const base_control_t rhs 
)
See also
operator+ in control_t

Definition at line 246 of file utest_types.h.

static void raise_failure ( const failure_reason_t  reason)
static

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

Further action then depends on its return state.

static bool run ( const Specification specification)
static

Runs a test specification.

Return values
<tt>true</tt>if the specification can be run
<tt>false</tt>if another specification is currently running
static bool set_scheduler ( utest_v1_scheduler_t  scheduler)
static

Sets the scheduler to be used.

Returns
true if scheduler is properly specified (all functions non-null).
const char* utest::v1::stringify ( failure_reason_t  reason)

Stringifies a failure reason for understandable error messages.

const char* utest::v1::stringify ( failure_t  failure)

Stringifies a failure for understandable error messages.

const char* utest::v1::stringify ( location_t  location)

Stringifies a location.

const char* utest::v1::stringify ( utest::v1::status_t  status)

Stringifies a status.

void utest_unity_assert_failure ( void  )

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

void utest_unity_ignore_failure ( void  )

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

void utest_v1_enter_critical_section ( void  )

must be implemented by the port

utest_v1_scheduler_t utest_v1_get_scheduler ( void  )

This is the default scheduler implementation used by the harness.

static void validate_callback ( const control_t  control = control_t())
static

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
controlthe test case attribute to be added to the existing attributes.
utest::v1::status_t utest::v1::verbose_case_failure_handler ( const Case *const  source,
const failure_t  reason 
)

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

utest::v1::status_t utest::v1::verbose_case_setup_handler ( const Case *const  source,
const size_t  index_of_case 
)

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

utest::v1::status_t utest::v1::verbose_case_teardown_handler ( const Case *const  source,
const size_t  passed,
const size_t  failed,
const failure_t  failure 
)

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

void utest::v1::verbose_test_failure_handler ( const failure_t  failure)

Prints the failure for REASON_TEST_SETUP and REASON_TEST_TEARDOWN and then dies.

utest::v1::status_t utest::v1::verbose_test_setup_handler ( const size_t  number_of_cases)

Prints the number of tests to run and continues.

void utest::v1::verbose_test_teardown_handler ( const size_t  passed,
const size_t  failed,
const failure_t  failure 
)

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

Variable Documentation

const base_control_t CaseAwait

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

const base_control_t CaseNext

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

const base_control_t CaseNoRepeat

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

const base_control_t CaseNoTimeout

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

const base_control_t CaseRepeatAll

repeats the test case handler with calling teardown and setup handlers

const base_control_t CaseRepeatHandler

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

const case_control_handler_t control_handler
See also
case_control_handler_t

Definition at line 61 of file utest_case.h.

const { ... } default_handler

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.

const handlers_t& default_handlers

The greentea aborting handlers are the default.

const char* description

Textual description of the test case.

Definition at line 49 of file utest_case.h.

const case_failure_handler_t failure_handler

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.

const handlers_t greentea_abort_handlers

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

const handlers_t greentea_continue_handlers

The greentea default handlers that always continue on failure.

const case_handler_t handler

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.

const { ... } ignore_handler

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.

const case_call_count_handler_t repeat_count_handler
See also
case_call_count_handler_t

Definition at line 66 of file utest_case.h.

const handlers_t selftest_handlers

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

const case_setup_handler_t setup_handler

Handler called before the execution of the case handler.

It sets up the case environment.

Definition at line 72 of file utest_case.h.

const case_teardown_handler_t teardown_handler

Handler called after the execution of the case handler.

It cleans up the case environment.

Definition at line 78 of file utest_case.h.

const handlers_t verbose_continue_handlers

The verbose default handlers that always continue on failure.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.