AceUnitLogging.h File Reference

AceUnit Logging header file. More...

#include "AceUnit.h"

Go to the source code of this file.

Data Structures
struct	TestLogger_t
	A Logger logs events during test execution. More...
Defines
#define	ACEUNITLOGGING_H   1
	Include shield to protect the header file from being included more than once.
#define	ACEUNIT_LOGGING_STYLE_SIMPLE   1
	Value for ACEUNIT_LOGGING_STYLE for only logging failures.
#define	ACEUNIT_LOGGING_STYLE_FULL   2
	Value for ACEUNIT_LOGGING_STYLE for full logging with all events.
#define	ACEUNIT_LOGGING_STYLE   ACEUNIT_LOGGING_STYLE_FULL
	Determines the style of logging to use.
#define	ACEUNIT_LOG_RUNNER
	Determines that runner events are logged.
#define	ACEUNIT_LOG_SUITE
	Determines that suite events are logged.
#define	ACEUNIT_LOG_FIXTURE
	Determines that fixture events are logged.
#define	ACEUNIT_LOG_TESTCASE
	Determines that test case events are logged.
#define	AceUnitNewLogger(name, runnerStarted, suiteStarted, fixtureStarted, testCaseStarted, testCaseFailed, testCaseEnded, fixtureEnded, suiteEnded, runnerEnded)
	Declare a logger.

---

Detailed Description

AceUnit Logging header file.

You do no tneed to include this header file in a fixture. Test fixtures do not need this header file. This header file is only needed by runners and loggers.

Author:

Christian Hujer

---

Define Documentation

#define ACEUNIT_LOG_FIXTURE

Determines that fixture events are logged.

#define ACEUNIT_LOG_RUNNER

Determines that runner events are logged.

#define ACEUNIT_LOG_SUITE

Determines that suite events are logged.

#define ACEUNIT_LOG_TESTCASE

Determines that test case events are logged.

#define ACEUNIT_LOGGING_STYLE   ACEUNIT_LOGGING_STYLE_FULL

Determines the style of logging to use.

Defaults to ACEUNIT_LOGGING_STYLE_SIMPLE if ACEUNIT_EMBEDDED is defined. Defaults to ACEUNIT_LOGGING_STYLE_FULL otherwise.

See also:

ACEUNIT_LOGGING_STYLE_SIMPLE

ACEUNIT_LOGGING_STYLE_FULL

#define ACEUNIT_LOGGING_STYLE_FULL   2

Value for ACEUNIT_LOGGING_STYLE for full logging with all events.

See also:

ACEUNIT_LOGGING_STYLE

#define ACEUNIT_LOGGING_STYLE_SIMPLE   1

Value for ACEUNIT_LOGGING_STYLE for only logging failures.

This is primarily meant for embedded systems where everything should be as small and simple as possible.

See also:

ACEUNIT_LOGGING_STYLE

#define ACEUNITLOGGING_H   1

Include shield to protect the header file from being included more than once.

#define AceUnitNewLogger	(	name,
		runnerStarted,
		suiteStarted,
		fixtureStarted,
		testCaseStarted,
		testCaseFailed,
		testCaseEnded,
		fixtureEnded,
		suiteEnded,
		runnerEnded		)

Value:

TestLogger_t name = {\
    runnerStarted,\
    suiteStarted,\
    fixtureStarted,\
    testCaseStarted,\
    testCaseFailed,\
    testCaseEnded,\
    fixtureEnded,\
    suiteEnded,\
    runnerEnded\
}

Declare a logger.

Use this macro for declaring instance of TestLogger_t. Depending on the configuration / environment, this macro may or may not use all of its parameters.

Parameters:

	name	Name of the logger to declare, will create a variable with this name and of type TestLogger_t.
	runnerStarted	Delegates to TestLogger_t.runnerStarted.
	suiteStarted	Delegates to TestLogger_t.suiteStarted.
	fixtureStarted	Delegates to TestLogger_t.fixtureStarted.
	testCaseStarted	Delegates to TestLogger_t.testCaseStarted.
	testCaseFailed	Delegates to TestLogger_t.testCaseFailed.
	testCaseEnded	Delegates to TestLogger_t.testCaseEnded.
	fixtureEnded	Delegates to TestLogger_t.fixtureEnded.
	suiteEnded	Delegates to TestLogger_t.suiteEnded.
	runnerEnded	Delegates to TestLogger_t.runnerEnded.

---