| 1 | /*- |
| 2 | * Copyright (c) 2004 Nik Clayton |
| 3 | * All rights reserved. |
| 4 | * |
| 5 | * Redistribution and use in source and binary forms, with or without |
| 6 | * modification, are permitted provided that the following conditions |
| 7 | * are met: |
| 8 | * 1. Redistributions of source code must retain the above copyright |
| 9 | * notice, this list of conditions and the following disclaimer. |
| 10 | * 2. Redistributions in binary form must reproduce the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer in the |
| 12 | * documentation and/or other materials provided with the distribution. |
| 13 | * |
| 14 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
| 15 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 16 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 17 | * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
| 18 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 19 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 20 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 21 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 22 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 23 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 24 | * SUCH DAMAGE. |
| 25 | */ |
| 26 | |
| 27 | /** |
| 28 | * plan_tests - announce the number of tests you plan to run |
| 29 | * @tests: the number of tests |
| 30 | * |
| 31 | * This should be the first call in your test program: it allows tracing |
| 32 | * of failures which mean that not all tests are run. |
| 33 | * |
| 34 | * If you don't know how many tests will actually be run, assume all of them |
| 35 | * and use skip() if you don't actually run some tests. |
| 36 | * |
| 37 | * Example: |
| 38 | * plan_tests(13); |
| 39 | */ |
| 40 | int plan_tests(unsigned int tests); |
| 41 | static inline int plan(unsigned int tests) |
| 42 | { |
| 43 | return plan_tests(tests); |
| 44 | } |
| 45 | #if (!defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L) && !defined(__GNUC__) |
| 46 | # error "Needs gcc or C99 compiler for variadic macros." |
| 47 | #else |
| 48 | |
| 49 | /** |
| 50 | * ok1 - Simple conditional test |
| 51 | * @e: the expression which we expect to be true. |
| 52 | * |
| 53 | * This is the simplest kind of test: if the expression is true, the |
| 54 | * test passes. The name of the test which is printed will simply be |
| 55 | * file name, line number, and the expression itself. |
| 56 | * |
| 57 | * Example: |
| 58 | * ok1(init_subsystem() == 1); |
| 59 | */ |
| 60 | # define ok1(e) ((e) ? \ |
| 61 | _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \ |
| 62 | _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e)) |
| 63 | |
| 64 | /** |
| 65 | * ok - Conditional test with a name |
| 66 | * @e: the expression which we expect to be true. |
| 67 | * @...: the printf-style name of the test. |
| 68 | * |
| 69 | * If the expression is true, the test passes. The name of the test will be |
| 70 | * the filename, line number, and the printf-style string. This can be clearer |
| 71 | * than simply the expression itself. |
| 72 | * |
| 73 | * Example: |
| 74 | * ok1(init_subsystem() == 1); |
| 75 | * ok(init_subsystem() == 0, "Second initialization should fail"); |
| 76 | */ |
| 77 | # define ok(e, ...) ((e) ? \ |
| 78 | _gen_result(1, __func__, __FILE__, __LINE__, \ |
| 79 | __VA_ARGS__) : \ |
| 80 | _gen_result(0, __func__, __FILE__, __LINE__, \ |
| 81 | __VA_ARGS__)) |
| 82 | |
| 83 | /** |
| 84 | * pass - Note that a test passed |
| 85 | * @...: the printf-style name of the test. |
| 86 | * |
| 87 | * For complicated code paths, it can be easiest to simply call pass() in one |
| 88 | * branch and fail() in another. |
| 89 | * |
| 90 | * Example: |
| 91 | * x = do_something(); |
| 92 | * if (!checkable(x) || check_value(x)) |
| 93 | * pass("do_something() returned a valid value"); |
| 94 | * else |
| 95 | * fail("do_something() returned an invalid value"); |
| 96 | */ |
| 97 | # define pass(...) ok(1, __VA_ARGS__) |
| 98 | |
| 99 | /** |
| 100 | * fail - Note that a test failed |
| 101 | * @...: the printf-style name of the test. |
| 102 | * |
| 103 | * For complicated code paths, it can be easiest to simply call pass() in one |
| 104 | * branch and fail() in another. |
| 105 | */ |
| 106 | # define fail(...) ok(0, __VA_ARGS__) |
| 107 | |
| 108 | /* I don't find these to be useful. */ |
| 109 | # define skip_if(cond, n, ...) \ |
| 110 | if (cond) skip((n), __VA_ARGS__); \ |
| 111 | else |
| 112 | |
| 113 | # define skip_start(test, n, ...) \ |
| 114 | do { \ |
| 115 | if((test)) { \ |
| 116 | skip(n, __VA_ARGS__); \ |
| 117 | continue; \ |
| 118 | } |
| 119 | |
| 120 | # define skip_end } while(0) |
| 121 | |
| 122 | #ifndef PRINTF_ATTRIBUTE |
| 123 | #ifdef __GNUC__ |
| 124 | #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2))) |
| 125 | #else |
| 126 | #define PRINTF_ATTRIBUTE(a1, a2) |
| 127 | #endif |
| 128 | #endif |
| 129 | |
| 130 | unsigned int _gen_result(int, const char *, const char *, unsigned int, |
| 131 | const char *, ...) PRINTF_ATTRIBUTE(5, 6); |
| 132 | |
| 133 | /** |
| 134 | * diag - print a diagnostic message (use instead of printf/fprintf) |
| 135 | * @fmt: the format of the printf-style message |
| 136 | * |
| 137 | * diag ensures that the output will not be considered to be a test |
| 138 | * result by the TAP test harness. It will append '\n' for you. |
| 139 | * |
| 140 | * Example: |
| 141 | * diag("Now running complex tests"); |
| 142 | */ |
| 143 | unsigned int diag(const char *fmt, ...) PRINTF_ATTRIBUTE(1, 2); |
| 144 | |
| 145 | /** |
| 146 | * skip - print a diagnostic message (use instead of printf/fprintf) |
| 147 | * @n: number of tests you're skipping. |
| 148 | * @fmt: the format of the reason you're skipping the tests. |
| 149 | * |
| 150 | * Sometimes tests cannot be run because the test system lacks some feature: |
| 151 | * you should explicitly document that you're skipping tests using skip(). |
| 152 | * |
| 153 | * From the Test::More documentation: |
| 154 | * If it's something the user might not be able to do, use SKIP. This |
| 155 | * includes optional modules that aren't installed, running under an OS that |
| 156 | * doesn't have some feature (like fork() or symlinks), or maybe you need an |
| 157 | * Internet connection and one isn't available. |
| 158 | * |
| 159 | * Example: |
| 160 | * #ifdef HAVE_SOME_FEATURE |
| 161 | * ok1(test_some_feature()); |
| 162 | * #else |
| 163 | * skip(1, "Don't have SOME_FEATURE"); |
| 164 | * #endif |
| 165 | */ |
| 166 | int skip(unsigned int n, const char *fmt, ...) PRINTF_ATTRIBUTE(2, 3); |
| 167 | |
| 168 | /** |
| 169 | * todo_start - mark tests that you expect to fail. |
| 170 | * @fmt: the reason they currently fail. |
| 171 | * |
| 172 | * It's extremely useful to write tests before you implement the matching fix |
| 173 | * or features: surround these tests by todo_start()/todo_end(). These tests |
| 174 | * will still be run, but with additional output that indicates that they are |
| 175 | * expected to fail. |
| 176 | * |
| 177 | * This way, should a test start to succeed unexpectedly, tools like prove(1) |
| 178 | * will indicate this and you can move the test out of the todo block. This |
| 179 | * is much more useful than simply commenting out (or '#if 0') the tests. |
| 180 | * |
| 181 | * From the Test::More documentation: |
| 182 | * If it's something the programmer hasn't done yet, use TODO. This is for |
| 183 | * any code you haven't written yet, or bugs you have yet to fix, but want to |
| 184 | * put tests in your testing script (always a good idea). |
| 185 | * |
| 186 | * Example: |
| 187 | * todo_start("dwim() not returning true yet"); |
| 188 | * ok(dwim(), "Did what the user wanted"); |
| 189 | * todo_end(); |
| 190 | */ |
| 191 | void todo_start(const char *fmt, ...) PRINTF_ATTRIBUTE(1, 2); |
| 192 | |
| 193 | /** |
| 194 | * todo_end - end of tests you expect to fail. |
| 195 | * |
| 196 | * See todo_start(). |
| 197 | */ |
| 198 | void todo_end(void); |
| 199 | |
| 200 | /** |
| 201 | * exit_status - the value that main should return. |
| 202 | * |
| 203 | * For maximum compatability your test program should return a particular exit |
| 204 | * code (ie. 0 if all tests were run, and every test which was expected to |
| 205 | * succeed succeeded). |
| 206 | * |
| 207 | * Example: |
| 208 | * exit(exit_status()); |
| 209 | */ |
| 210 | int exit_status(void); |
| 211 | |
| 212 | /** |
| 213 | * plan_no_plan - I have no idea how many tests I'm going to run. |
| 214 | * |
| 215 | * In some situations you may not know how many tests you will be running, or |
| 216 | * you are developing your test program, and do not want to update the |
| 217 | * plan_tests() call every time you make a change. For those situations use |
| 218 | * plan_no_plan() instead of plan_tests(). It indicates to the test harness |
| 219 | * that an indeterminate number of tests will be run. |
| 220 | * |
| 221 | * Remember, if you fail to plan, you plan to fail. |
| 222 | * |
| 223 | * Example: |
| 224 | * plan_no_plan(); |
| 225 | * while (random() % 2) |
| 226 | * ok1(some_test()); |
| 227 | * exit(exit_status()); |
| 228 | */ |
| 229 | int plan_no_plan(void); |
| 230 | |
| 231 | /** |
| 232 | * plan_skip_all - Indicate that you will skip all tests. |
| 233 | * @reason: the string indicating why you can't run any tests. |
| 234 | * |
| 235 | * If your test program detects at run time that some required functionality |
| 236 | * is missing (for example, it relies on a database connection which is not |
| 237 | * present, or a particular configuration option that has not been included |
| 238 | * in the running kernel) use plan_skip_all() instead of plan_tests(). |
| 239 | * |
| 240 | * Example: |
| 241 | * if (!have_some_feature) { |
| 242 | * plan_skip_all("Need some_feature support"); |
| 243 | * exit(exit_status()); |
| 244 | * } |
| 245 | * plan_tests(13); |
| 246 | */ |
| 247 | int plan_skip_all(const char *reason); |
| 248 | |
| 249 | #endif /* C99 or gcc */ |