1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
#ifndef TAP_TO_SUBUNIT_H
#define TAP_TO_SUBUNIT_H
/*
* tap-style wrapper for subunit.
*
* Copyright (c) 2011 Rusty Russell
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include "replace.h"
/**
* plan_tests - announce the number of tests you plan to run
* @tests: the number of tests
*
* This should be the first call in your test program: it allows tracing
* of failures which mean that not all tests are run.
*
* If you don't know how many tests will actually be run, assume all of them
* and use skip() if you don't actually run some tests.
*
* Example:
* plan_tests(13);
*/
void plan_tests(unsigned int tests);
/**
* ok1 - Simple conditional test
* @e: the expression which we expect to be true.
*
* This is the simplest kind of test: if the expression is true, the
* test passes. The name of the test which is printed will simply be
* file name, line number, and the expression itself.
*
* Example:
* ok1(somefunc() == 1);
*/
# define ok1(e) ((e) ? \
_gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
_gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
/**
* ok - Conditional test with a name
* @e: the expression which we expect to be true.
* @...: the printf-style name of the test.
*
* If the expression is true, the test passes. The name of the test will be
* the filename, line number, and the printf-style string. This can be clearer
* than simply the expression itself.
*
* Example:
* ok1(somefunc() == 1);
* ok(somefunc() == 0, "Second somefunc() should fail");
*/
# define ok(e, ...) ((e) ? \
_gen_result(1, __func__, __FILE__, __LINE__, \
__VA_ARGS__) : \
_gen_result(0, __func__, __FILE__, __LINE__, \
__VA_ARGS__))
/**
* pass - Note that a test passed
* @...: the printf-style name of the test.
*
* For complicated code paths, it can be easiest to simply call pass() in one
* branch and fail() in another.
*
* Example:
* int x = somefunc();
* if (x > 0)
* pass("somefunc() returned a valid value");
* else
* fail("somefunc() returned an invalid value");
*/
# define pass(...) ok(1, __VA_ARGS__)
/**
* fail - Note that a test failed
* @...: the printf-style name of the test.
*
* For complicated code paths, it can be easiest to simply call pass() in one
* branch and fail() in another.
*/
# define fail(...) ok(0, __VA_ARGS__)
unsigned int _gen_result(int, const char *, const char *, unsigned int,
const char *, ...) PRINTF_ATTRIBUTE(5, 6);
/**
* diag - print a diagnostic message (use instead of printf/fprintf)
* @fmt: the format of the printf-style message
*
* diag ensures that the output will not be considered to be a test
* result by the TAP test harness. It will append '\n' for you.
*
* Example:
* diag("Now running complex tests");
*/
void diag(const char *fmt, ...) PRINTF_ATTRIBUTE(1, 2);
/**
* skip - print a diagnostic message (use instead of printf/fprintf)
* @n: number of tests you're skipping.
* @fmt: the format of the reason you're skipping the tests.
*
* Sometimes tests cannot be run because the test system lacks some feature:
* you should explicitly document that you're skipping tests using skip().
*
* From the Test::More documentation:
* If it's something the user might not be able to do, use SKIP. This
* includes optional modules that aren't installed, running under an OS that
* doesn't have some feature (like fork() or symlinks), or maybe you need an
* Internet connection and one isn't available.
*
* Example:
* #ifdef HAVE_SOME_FEATURE
* ok1(somefunc());
* #else
* skip(1, "Don't have SOME_FEATURE");
* #endif
*/
void skip(unsigned int n, const char *fmt, ...) PRINTF_ATTRIBUTE(2, 3);
/**
* exit_status - the value that main should return.
*
* For maximum compatibility your test program should return a particular exit
* code (ie. 0 if all tests were run, and every test which was expected to
* succeed succeeded).
*
* Example:
* exit(exit_status());
*/
int exit_status(void);
#endif /* CCAN_TAP_H */
|
