This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
plain_logger.h
1
2
3
4
5
#ifndef _PLAIN_LOGGER_H
#define _PLAIN_LOGGER_H
#include "logger.h"
6
7
8
9
10
11
/*!
* Prints out information about starting the test run.
*
* \param parameterCount How many parameters were given
* \param runnerParameters What parameters were given to the runner
* \param eventTime When the execution started
12
13
* \param data Any additional data logger needs
*
14
*/
15
16
void PlainRunStarted(int parameterCount, char *runnerParameters[], time_t eventTime,
void *data);
18
19
20
21
22
23
/*!
* Prints out information about ending the test run.
*
* \param testCount How many tests were executed in total
* \param suiteCount How many suite were executed in total
* \param testPassCount How many tests passed in total
24
* \param testSkippedCount How many tests were skipped in total
25
26
27
28
* \param testFailCount How many tests failed in total
* \param endTime When the execution ended
* \param totalRuntime How long the execution took
*/
29
void PlainRunEnded(int testCount, int suiteCount, int testPassCount, int testFailCount,
30
int testSkippedCount, time_t endTime, double totalRuntime);
32
33
34
35
36
37
/*!
* Prints the data about the test suite that'll be executed next
*
* \param suiteName Name of the test suite
* \param eventTime When the execution starts
*/
38
39
void PlainSuiteStarted(const char *suiteName, time_t eventTime);
40
41
42
43
44
45
46
47
48
/*!
* Prints information about the test suite that was just executed
*
* \param testsPassed how many tests passed from this suite
* \param testsFailed how many tests failed from this suite
* \param testsSkipped how many tests were skipped (not implemented)
* \param endTime When the suite execution ended
* \param totalRuntime How long did the suite's execution take
*/
49
void PlainSuiteEnded(int testsPassed, int testsFailed, int testsSkipped,
50
time_t endTime, double totalRuntime);
52
53
54
55
56
57
58
59
/*!
* Prints the data about the test test that'll be executed next
*
* \param testName Name of the test that'll be executed
* \param suiteName Name of the suite of the test
* \param testDescription Description of the test
* \param startTime When the test started to execute
*/
60
61
void PlainTestStarted(const char *testName, const char *suiteName,
const char *testDescription, time_t startTime);
63
64
65
66
67
68
69
70
71
/*!
* Prints information about the test test that was just executed
*
* \param testName Name of the executed test
* \param suiteName Name of the suite of the test
* \param testResult Did the test fail (!= 0) or pass (== 0)
* \param endTime When the test execution ended
* \param totalRuntime Total runtime of the executed test
*/
72
void PlainTestEnded(const char *testName, const char *suiteName,
73
int testResult, time_t endTime, double totalRuntime);
76
77
78
79
80
81
82
83
/*!
* Prints information about plain assert
*
* \param assertName Name of the assert
* \param assertResult Did assert fail (== 0) or success (!= 0)
* \param assertMessage Message of the assert
* \param eventTime When the assert happened
*/
84
void PlainAssert(const char *assertName, int assertResult, const char *assertMessage,
85
86
time_t eventTime);
87
88
89
90
91
92
93
94
95
96
/*!
* Prints information about assert that has actual and expected values
*
* \param assertName Name of the assert
* \param assertResult Did assert fail (== 0) or success (!= 0)
* \param assertMessage Message of the assert
* \param actualValue Actual value of assert
* \param expected Excepted value of assert
* \param eventTime When the assert happened
*/
97
void PlainAssertWithValues(const char *assertName, int assertResult, const char *assertMessage,
98
int actualValue, int expected, time_t eventTime);
100
101
102
103
104
105
106
107
/*!
* Prints summary of all assertions of certain tests
*
* \param numAsserts Total assert count for the executed test
* \param numAssertsFailed Count of failed asserts in the test
* \param numAssertsPass Count of passed asserts in the test
* \param eventTime Timestamp of the summary
*/
108
void PlainAssertSummary(int numAsserts, int numAssertsFailed, int numAssertsPass, time_t eventTime);
110
111
112
113
114
115
/*!
* Prints given message
*
* \param logMessage Message to be logged
* \param eventTime Timestamp for log message
*/
116
117
118
void PlainLog(const char *logMessage, time_t eventTime);
#endif