ccanlint: fix directory issues properly.
[ccan] / tools / ccanlint / compulsory_tests / has_tests.c
1 #include <tools/ccanlint/ccanlint.h>
2 #include <sys/types.h>
3 #include <sys/stat.h>
4 #include <fcntl.h>
5 #include <unistd.h>
6 #include <limits.h>
7 #include <errno.h>
8 #include <stdlib.h>
9 #include <stdio.h>
10 #include <err.h>
11 #include <ccan/talloc/talloc.h>
12
13 static char test_is_not_dir[] = "test is not a directory";
14
15 static void *check_has_tests(struct manifest *m)
16 {
17         struct stat st;
18         char *test_dir = talloc_asprintf(m, "%s/test", m->dir);
19
20         if (lstat(test_dir, &st) != 0) {
21                 if (errno != ENOENT)
22                         err(1, "statting %s", test_dir);
23                 return "You have no test directory";
24         }
25
26         if (!S_ISDIR(st.st_mode))
27                 return test_is_not_dir;
28
29         if (list_empty(&m->api_tests)
30             && list_empty(&m->run_tests)
31             && list_empty(&m->compile_ok_tests)) {
32                 if (list_empty(&m->compile_fail_tests)) 
33                         return "You have no tests in the test directory";
34                 else
35                         return "You have no positive tests in the test directory";
36         }
37         return NULL;
38 }
39
40 static const char *describe_has_tests(struct manifest *m, void *check_result)
41 {
42         return talloc_asprintf(m, "%s\n\n"
43         "CCAN modules have a directory called test/ which contains tests.\n"
44         "There are four kinds of tests: api, run, compile_ok and compile_fail:\n"
45         "you can tell which type of test a C file is by its name, eg 'run.c'\n"
46         "and 'run-simple.c' are both run tests.\n\n"
47
48         "The simplest kind of test is a run test, which must compile with no\n"
49         "warnings, and then run: it is expected to use libtap to report its\n"
50         "results in a simple and portable format.  It should #include the C\n"
51         "files from the module directly (so it can probe the internals): the\n"
52         "module will not be linked in.\n\n"
53
54         "api tests are just like a run test, except it is a guarantee of API\n"
55         "stability: this test should pass on all future versions of the\n"
56         "module.  They *are* linked to the module, since they should only\n"
57         "test the API, not the internal state.\n\n"
58
59         "compile_ok tests are a subset of run tests: they must compile and\n"
60         "link, but aren't run.\n\n"
61
62         "compile_fail tests are tests which should fail to compile (or emit\n"
63         "warnings) or link when FAIL is defined, but should compile and link\n"
64         "when it's not defined: this helps ensure unrelated errors don't make\n"
65         "compilation fail.\n\n"
66
67         "Note that the tests are not linked against the files in the\n"
68         "above: you should directly #include those C files you want.  This\n"
69         "allows access to static functions and use special effects inside\n"
70         "test files\n", (char *)check_result);
71 }
72
73 static void handle_no_tests(struct manifest *m, void *check_result)
74 {
75         FILE *run;
76         struct ccan_file *i;
77
78         if (check_result == test_is_not_dir)
79                 return;
80
81         if (!ask("Should I create a template test/run.c file for you?"))
82                 return;
83
84         if (mkdir("test", 0700) != 0) {
85                 if (errno != EEXIST)
86                         err(1, "Creating test/ directory");
87         }
88
89         run = fopen("test/run.c", "w");
90         if (!run)
91                 err(1, "Trying to create a test/run.c");
92
93         fputs("/* Include the main header first, to test it works */\n", run);
94         fprintf(run, "#include \"%s/%s.h\"\n", m->basename, m->basename);
95         fputs("/* Include the C files directly. */\n", run);
96         list_for_each(&m->c_files, i, list)
97                 fprintf(run, "#include \"%s/%s\"\n", m->basename, i->name);
98         fputs("#include \"tap/tap.h\"\n", run);
99         fputs("\n", run);
100
101         fputs("int main(void)\n", run);
102         fputs("{\n", run);
103         fputs("\t/* This is how many tests you plan to run */\n", run);
104         fputs("\tplan_tests(3);\n", run);
105         fputs("\n", run);
106         fputs("\t/* Simple thing we expect to succeed */\n", run);
107         fputs("\tok1(some_test())\n", run);
108         fputs("\t/* Same, with an explicit description of the test. */\n", run);
109         fputs("\tok(some_test(), \"%s with no args should return 1\", \"some_test\")\n", run);
110         fputs("\t/* How to print out messages for debugging. */\n", run);
111         fputs("\tdiag(\"Address of some_test is %p\", &some_test)\n", run);
112         fputs("\t/* Conditional tests must be explicitly skipped. */\n", run);
113         fputs("#if HAVE_SOME_FEATURE\n", run);
114         fputs("\tok1(test_some_feature())\n", run);
115         fputs("#else\n", run);
116         fputs("\tskip(1, \"Don\'t have SOME_FEATURE\")\n", run);
117         fputs("#endif\n", run);
118         fputs("\n", run);
119         fputs("\t/* This exits depending on whether all tests passed */\n", run);
120         fputs("\treturn exit_status();\n", run);
121         fputs("}\n", run);
122
123         fclose(run);
124 }       
125
126 struct ccanlint has_tests = {
127         .name = "Has tests",
128         .check = check_has_tests,
129         .describe = describe_has_tests,
130         .handle = handle_no_tests,
131 };
132
133 REGISTER_TEST(has_tests, NULL);