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