ztest_suite_node Struct Reference

A single node of test suite. More...

#include <ztest_test_deprecated.h>

Data Fields
const char *	name
	The name of the test suite.
struct unit_test *	suite
	Pointer to the test suite.
bool(*	predicate )(const void *state)
	An optional predicate function to determine if the test should run.
struct ztest_suite_stats *	stats
	Stats.
const char *const	name
	The name of the test suite.
const ztest_suite_setup_t	setup
	Setup function.
const ztest_suite_before_t	before
	Before function.
const ztest_suite_after_t	after
	After function.
const ztest_suite_teardown_t	teardown
	Teardown function.
const ztest_suite_predicate_t	predicate
	Optional predicate filter.
struct ztest_suite_stats *const	stats
	Stats.

Detailed Description

A single node of test suite.

Each node should be added to a single linker section which will allow ztest_run_registered_test_suites() to iterate over the various nodes.

Each node should be added to a single linker section which will allow ztest_run_test_suites() to iterate over the various nodes.

Field Documentation

after

const ztest_suite_after_t ztest_suite_node::after

After function.

before

const ztest_suite_before_t ztest_suite_node::before

Before function.

name [1/2]

const char* ztest_suite_node::name

The name of the test suite.

name [2/2]

const char* const ztest_suite_node::name

The name of the test suite.

predicate [1/2]

bool(* ztest_suite_node::predicate) (const void *state)

An optional predicate function to determine if the test should run.

If NULL, then the test will only run once on the first attempt.

Parameters

state

The current state of the test application.

Returns

True if the suite should be run; false to skip.

predicate [2/2]

const ztest_suite_predicate_t ztest_suite_node::predicate

Optional predicate filter.

setup

const ztest_suite_setup_t ztest_suite_node::setup

Setup function.

stats [1/2]

struct ztest_suite_stats* ztest_suite_node::stats

Stats.

stats [2/2]

struct ztest_suite_stats* const ztest_suite_node::stats

Stats.

suite

struct unit_test* ztest_suite_node::suite

Pointer to the test suite.

teardown

const ztest_suite_teardown_t ztest_suite_node::teardown

Teardown function.

---

The documentation for this struct was generated from the following files:

• subsys/testsuite/ztest/include/zephyr/ztest_test_deprecated.h
• subsys/testsuite/ztest/include/zephyr/ztest_test_new.h