Microchip® Advanced Software Framework

suite.h File Reference

Test suite core declarations.

Copyright (c) 2011-2018 Microchip Technology Inc. and its subsidiaries.

#include <compiler.h>
#include <parts.h>
#include <stdio.h>
#include <progmem.h>

Data Structures

struct  test_case
 A test case. More...
 
struct  test_suite
 A test suite. More...
 

Macros

#define Assert(expr)
 Assert() macro definition for unit testing. More...
 
Wrappers for printing debug information
Note
The test suite framework feeds its output to printf. It is left up to the test application to set up the stream.
#define dbg(__fmt_)   printf_P(PROGMEM_STRING(__fmt_))
 
#define dbg_info(__fmt_,...)   printf_P(PROGMEM_STRING(__fmt_), __VA_ARGS__)
 
#define dbg_error(_x,...)   printf_P(PROGMEM_STRING(_x), __VA_ARGS__)
 
#define dbg_putchar(c)   putc(c, stdout)
 
#define dbg_vprintf_pgm(...)   vfprintf_P(stdout, __VA_ARGS__)
 
Test suite definition macros
#define DEFINE_TEST_CASE(_sym, _setup, _run, _cleanup, _name)
 Create a test case struct. More...
 
#define DEFINE_TEST_ARRAY(_sym)   const struct test_case *const _sym[]
 Create an array of test case pointers. More...
 
#define DEFINE_TEST_SUITE(_sym, _test_array, _name)
 Create a test suite. More...
 

Functions

void test_case_fail (const struct test_case *test, int result, const char *file, unsigned int line, const char *fmt,...)
 Report a failure and jump out of current test case function. More...
 
Test suite interaction
int test_suite_run (const struct test_suite *suite)
 Run a test suite. More...
 

Test data access

void * test_priv_data
 Data pointer for test cases. More...
 
static void test_set_data (void *data)
 Set private data pointer for the current test. More...
 
static void * test_get_data (void)
 Get the private data pointer for the current test. More...
 

Test case pointer access

struct test_casetest_case_ptr
 Pointer to current test case. More...
 
static void test_set_case (const struct test_case *test)
 Set pointer to current test. More...
 
static struct test_casetest_get_case (void)
 Get pointer to current test. More...
 

Test result reporting

#define test_fail(test, result,...)   test_case_fail(test, result, __FILE__, __LINE__, __VA_ARGS__)
 Fail the test. More...
 
#define test_assert_true(test, condition,...)
 Verify that condition is true. More...
 
#define test_assert_false(test, condition,...)   test_assert_true(test, !(condition), __VA_ARGS__)
 Verify that condition is false. More...
 
enum  test_status {
  TEST_ERROR = -1,
  TEST_PASS = 0,
  TEST_FAIL = 1
}
 Status codes returned by test cases and fixtures. More...
 

#define Assert (   expr)
Value:
{ \
if (test_get_case() != NULL) { \
"Assertion failed: %s", #expr); \
} else { \
if (!(expr)) { \
dbg_error("Assertion '%s' failed at %s:%d\r\n", \
#expr, __FILE__, __LINE__); \
while (true); \
} \
} \
}
#define test_assert_true(test, condition,...)
Verify that condition is true.
Definition: suite.h:386
#define dbg_error(_x,...)
Definition: suite.h:208
static struct test_case * test_get_case(void)
Get pointer to current test.
Definition: suite.h:328

Assert() macro definition for unit testing.

The Assert() macro is set up to use test_assert_true(), as this will only halt execution of the current test, allowing the remaining tests a chance to complete.

Referenced by _rtc_count_set_config(), _sercom_default_handler(), _sercom_get_default_pad(), _sercom_get_sercom_inst_index(), _system_pinmux_config(), _usart_read_buffer(), _usart_set_config(), _usart_write_buffer(), cpu_irq_leave_critical(), port_get_config_defaults(), port_group_get_input_level(), port_group_get_output_level(), port_group_set_config(), port_group_set_output_level(), port_group_toggle_output_level(), port_pin_set_config(), rtc_count_clear_compare_match(), rtc_count_clear_overflow(), rtc_count_disable(), rtc_count_disable_callback(), rtc_count_disable_events(), rtc_count_enable(), rtc_count_enable_callback(), rtc_count_enable_events(), rtc_count_frequency_correction(), rtc_count_get_compare(), rtc_count_get_config_defaults(), rtc_count_get_count(), rtc_count_get_period(), rtc_count_init(), rtc_count_is_compare_match(), rtc_count_is_overflow(), rtc_count_is_syncing(), rtc_count_reset(), rtc_count_set_compare(), rtc_count_set_count(), rtc_count_set_period(), rtc_tamper_clear_detect_flag(), rtc_tamper_get_config_defaults(), rtc_tamper_get_detect_flag(), system_apb_clock_clear_mask(), system_apb_clock_set_mask(), system_backup_pin_output_clear(), system_backup_pin_output_disable_rtc_toggle(), system_backup_pin_output_enable_rtc_toggle(), system_backup_pin_output_get(), system_backup_pin_output_set(), system_battery_backup_power_switch_get_config_defaults(), system_battery_backup_power_switch_set_config(), system_clock_init(), system_clock_source_dfll_get_config_defaults(), system_clock_source_disable(), system_clock_source_enable(), system_clock_source_osc16m_get_config_defaults(), system_clock_source_osc32k_get_config_defaults(), system_clock_source_osculp32k_get_config_defaults(), system_clock_source_write_calibration(), system_clock_source_xosc32k_get_config_defaults(), system_clock_source_xosc_get_config_defaults(), system_flash_set_waitstates(), system_gclk_chan_disable(), system_gclk_chan_get_config_defaults(), system_gclk_chan_set_config(), system_gclk_gen_get_config_defaults(), system_gclk_gen_set_config(), system_interrupt_clear_pending(), system_interrupt_is_pending(), system_interrupt_set_pending(), system_interrupt_set_priority(), system_pinmux_get_config_defaults(), system_pinmux_get_group_from_gpio_pin(), system_pinmux_group_set_config(), system_pinmux_group_set_input_sample_mode(), system_standby_get_config_defaults(), system_standby_set_config(), system_voltage_reference_disable(), system_voltage_reference_enable(), system_voltage_reference_get_config_defaults(), system_voltage_reference_set_config(), system_voltage_regulator_get_config_defaults(), system_voltage_regulator_set_config(), usart_abort_job(), usart_disable(), usart_disable_callback(), usart_disable_transceiver(), usart_enable(), usart_enable_callback(), usart_enable_transceiver(), usart_get_config_defaults(), usart_get_job_status(), usart_init(), usart_is_syncing(), usart_read_buffer_job(), usart_read_buffer_wait(), usart_read_job(), usart_read_wait(), usart_register_callback(), usart_reset(), usart_unregister_callback(), usart_write_buffer_job(), usart_write_buffer_wait(), usart_write_job(), and usart_write_wait().