TestLogger_t Struct Reference

A Logger logs events during test execution. More...

#include <AceUnitLogging.h>

Data Fields
void(*	runnerStarted )(void)
	Informs this logger that the runner has started running.
void(*	suiteStarted )(SuiteId_t const suiteId)
	Informs this logger that the runner has started a suite.
void(*	fixtureStarted )(const FixtureId_t fixture)
	Informs this logger that the runner has started a fixture.
void(*	testCaseStarted )(TestCaseId_t testCase)
	Informs this logger that the runner starts a test case.
void(*	testCaseFailed )(const AssertionError_t *error)
	Informs this logger that the runner failed a test case.
void(*	testCaseEnded )(TestCaseId_t testCase)
	Informs this logger that the runner ended a test case.
void(*	fixtureEnded )(FixtureId_t fixture)
	Informs this logger that the runner has ended a fixture.
void(*	suiteEnded )(SuiteId_t const suiteId)
	Informs this logger that the runner has ended a suite.
void(*	runnerEnded )(void)
	Informs this logger that the runner is about to end.

---

Detailed Description

A Logger logs events during test execution.

Warning:

When you write a logger, you should not use this structure directly. If you violate this rule, your logger will be much more dependant on changes to the structure than it should. Instead, use the macro AceUnitNewLogger() to declare an instance of this type.

See also:

AceUnitNewLogger()

Author:

Christian Hujer

---

Field Documentation

void(* TestLogger_t::runnerStarted)(void)

Informs this logger that the runner has started running.

Maybe NULL in case this logger does not implement this function.

void(* TestLogger_t::suiteStarted)(SuiteId_t const suiteId)

Informs this logger that the runner has started a suite.

Maybe NULL in case this logger does not implement this function.

void(* TestLogger_t::fixtureStarted)(const FixtureId_t fixture)

Informs this logger that the runner has started a fixture.

Maybe NULL in case this logger does not implement this function.

Parameters:

fixture

Fixture that was started.

void(* TestLogger_t::testCaseStarted)(TestCaseId_t testCase)

Informs this logger that the runner starts a test case.

Maybe NULL in case this logger does not implement this function.

Parameters:

testCase

Test case that was started.

void(* TestLogger_t::testCaseFailed)(const AssertionError_t *error)

Informs this logger that the runner failed a test case.

Maybe NULL in case this logger does not implement this function.

Parameters:

error

Assertion error with error information.

void(* TestLogger_t::testCaseEnded)(TestCaseId_t testCase)

Informs this logger that the runner ended a test case.

This will be invoked for failed test cases as well as for successful test cases. Maybe NULL in case this logger does not implement this function.

Parameters:

testCase

Test case that was ended.

void(* TestLogger_t::fixtureEnded)(FixtureId_t fixture)

Informs this logger that the runner has ended a fixture.

Maybe NULL in case this logger does not implement this function.

Parameters:

fixture

Fixture that was ended.

void(* TestLogger_t::suiteEnded)(SuiteId_t const suiteId)

Informs this logger that the runner has ended a suite.

Maybe NULL in case this logger does not implement this function.

void(* TestLogger_t::runnerEnded)(void)

Informs this logger that the runner is about to end.

Maybe NULL in case this logger does not implement this function.

---

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

• AceUnitLogging.h

---