summaryrefslogtreecommitdiff
path: root/lib/ccan/failtest/_info
blob: 4a5b97c9313e337df1f9e9155fb2526f4974cf2d (plain)
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
#include <stdio.h>
#include <string.h>
#include "config.h"

/**
 * failtest - unit test helpers for testing malloc and other failures.
 *
 * The failtest module overrides various standard functions, and forks
 * your unit test at those points to test failure paths.  The failing
 * child are expected to fail (eg. when malloc fails), but should not
 * leak memory or crash.  After including failtest_override.h, you can
 * include failtest_restore.h to return to non-failing versions.
 *
 * The unit test is a normal CCAN tap-style test, except it should
 * start by calling failtest_init() and end by calling
 * failtest_exit().
 *
 * You can control what functions fail: see failtest_hook.
 *
 * Example:
 *	#include <stdio.h>
 *	#include <stdlib.h>
 *	#include <string.h>
 *	#include <ccan/tap/tap.h>
 *	#include <ccan/failtest/failtest_override.h>
 *	#include <ccan/failtest/failtest.h>
 *
 *	int main(int argc, char *argv[])
 *	{
 *		char *a, *b;
 *
 *		failtest_init(argc, argv);
 *		plan_tests(3);
 *
 *		// Simple malloc test.
 *		a = malloc(100);
 *		if (ok1(a)) {
 *			// Fill the memory.
 *			memset(a, 'x', 100);
 *			b = realloc(a, 200);
 *			if (ok1(b)) {
 *				// Fill the rest of the memory.
 *				memset(b + 100, 'y', 100);
 *				// Check it got a copy of a as expected.
 *				ok1(strspn(b, "x") == 100);
 *				free(b);
 *			} else {
 *				// Easy to miss: free a on realloc failure!
 *				free(a);
 *			}
 *		}
 *		failtest_exit(exit_status());
 *	}
 *
 * License: LGPL
 * Author: Rusty Russell <rusty@rustcorp.com.au>
 * Ccanlint:
 *	// valgrind seems to mess up rlimit.
 *	tests_pass_valgrind test/run-with-fdlimit.c:FAIL
 */
int main(int argc, char *argv[])
{
	if (argc != 2)
		return 1;

	if (strcmp(argv[1], "depends") == 0) {
		printf("ccan/build_assert\n");
		printf("ccan/compiler\n");
		printf("ccan/hash\n");
		printf("ccan/htable\n");
		printf("ccan/read_write_all\n");
		printf("ccan/str\n");
		printf("ccan/time\n");
		printf("ccan/tlist\n");
		return 0;
	}

	return 1;
}