1 #include <tools/ccanlint/ccanlint.h>
11 #include <ccan/talloc/talloc.h>
13 static char test_is_not_dir[] = "test is not a directory";
15 static void *check_has_tests(struct manifest *m,
17 unsigned int *timeleft)
20 char *test_dir = talloc_asprintf(m, "%s/test", m->dir);
22 if (lstat(test_dir, &st) != 0) {
24 err(1, "statting %s", test_dir);
25 return "You have no test directory";
28 if (!S_ISDIR(st.st_mode))
29 return test_is_not_dir;
31 if (list_empty(&m->api_tests)
32 && list_empty(&m->run_tests)
33 && list_empty(&m->compile_ok_tests)) {
34 if (list_empty(&m->compile_fail_tests))
35 return "You have no tests in the test directory";
37 return "You have no positive tests in the test directory";
42 static const char *describe_has_tests(struct manifest *m, void *check_result)
44 return talloc_asprintf(m, "%s\n\n"
45 "CCAN modules have a directory called test/ which contains tests.\n"
46 "There are four kinds of tests: api, run, compile_ok and compile_fail:\n"
47 "you can tell which type of test a C file is by its name, eg 'run.c'\n"
48 "and 'run-simple.c' are both run tests.\n\n"
50 "The simplest kind of test is a run test, which must compile with no\n"
51 "warnings, and then run: it is expected to use libtap to report its\n"
52 "results in a simple and portable format. It should #include the C\n"
53 "files from the module directly (so it can probe the internals): the\n"
54 "module will not be linked in. The test will be run in a temporary\n"
55 "directory, with the test directory symlinked under test/.\n\n"
57 "api tests are just like a run test, except it is a guarantee of API\n"
58 "stability: this test should pass on all future versions of the\n"
59 "module. They *are* linked to the module, since they should only\n"
60 "test the API, not the internal state.\n\n"
62 "compile_ok tests are a subset of run tests: they must compile and\n"
63 "link, but aren't run.\n\n"
65 "compile_fail tests are tests which should fail to compile (or emit\n"
66 "warnings) or link when FAIL is defined, but should compile and link\n"
67 "when it's not defined: this helps ensure unrelated errors don't make\n"
68 "compilation fail.\n\n"
70 "Note that the tests are not linked against the files in the\n"
71 "above: you should directly #include those C files you want. This\n"
72 "allows access to static functions and use special effects inside\n"
73 "test files\n", (char *)check_result);
76 static void handle_no_tests(struct manifest *m, void *check_result)
81 if (check_result == test_is_not_dir)
84 if (!ask("Should I create a template test/run.c file for you?"))
87 if (mkdir("test", 0700) != 0) {
89 err(1, "Creating test/ directory");
92 run = fopen("test/run.c", "w");
94 err(1, "Trying to create a test/run.c");
96 fputs("/* Include the main header first, to test it works */\n", run);
97 fprintf(run, "#include \"%s/%s.h\"\n", m->basename, m->basename);
98 fputs("/* Include the C files directly. */\n", run);
99 list_for_each(&m->c_files, i, list)
100 fprintf(run, "#include \"%s/%s\"\n", m->basename, i->name);
101 fputs("#include \"tap/tap.h\"\n", run);
104 fputs("int main(void)\n", run);
106 fputs("\t/* This is how many tests you plan to run */\n", run);
107 fputs("\tplan_tests(3);\n", run);
109 fputs("\t/* Simple thing we expect to succeed */\n", run);
110 fputs("\tok1(some_test())\n", run);
111 fputs("\t/* Same, with an explicit description of the test. */\n", run);
112 fputs("\tok(some_test(), \"%s with no args should return 1\", \"some_test\")\n", run);
113 fputs("\t/* How to print out messages for debugging. */\n", run);
114 fputs("\tdiag(\"Address of some_test is %p\", &some_test)\n", run);
115 fputs("\t/* Conditional tests must be explicitly skipped. */\n", run);
116 fputs("#if HAVE_SOME_FEATURE\n", run);
117 fputs("\tok1(test_some_feature())\n", run);
118 fputs("#else\n", run);
119 fputs("\tskip(1, \"Don\'t have SOME_FEATURE\")\n", run);
120 fputs("#endif\n", run);
122 fputs("\t/* This exits depending on whether all tests passed */\n", run);
123 fputs("\treturn exit_status();\n", run);
129 struct ccanlint has_tests = {
131 .name = "Module has tests",
132 .check = check_has_tests,
133 .describe = describe_has_tests,
135 .handle = handle_no_tests,
138 REGISTER_TEST(has_tests, NULL);