2672cb6a93fa955cf6f772d49ec41348aa1789a6
[xonotic/gmqcc.git] / test.c
1 /*
2  * Copyright (C) 2012, 2013
3  *     Dale Weiler
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is furnished to do
10  * so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 #define GMQCC_PLATFORM_HEADER /* TODO: eliminate! */
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "gmqcc.h"
28 #include "platform.h"
29
30 static const char *task_bins[] = {
31     "./gmqcc",
32     "./qcvm"
33 };
34
35 /*
36  * TODO: Windows version
37  * this implements a unique bi-directional popen-like function that
38  * allows reading data from both stdout and stderr. And writing to
39  * stdin :)
40  *
41  * Example of use:
42  * FILE *handles[3] = task_popen("ls", "-l", "r");
43  * if (!handles) { perror("failed to open stdin/stdout/stderr to ls");
44  * // handles[0] = stdin
45  * // handles[1] = stdout
46  * // handles[2] = stderr
47  *
48  * task_pclose(handles); // to close
49  */
50 #ifndef _WIN32
51 #include <sys/types.h>
52 #include <sys/wait.h>
53 #include <dirent.h>
54 #include <unistd.h>
55 typedef struct {
56     fs_file_t *handles[3];
57     int        pipes  [3];
58
59     int stderr_fd;
60     int stdout_fd;
61     int pid;
62 } popen_t;
63
64 static fs_file_t **task_popen(const char *command, const char *mode) {
65     int     inhandle  [2];
66     int     outhandle [2];
67     int     errhandle [2];
68     int     trypipe;
69
70     popen_t *data = (popen_t*)mem_a(sizeof(popen_t));
71
72     /*
73      * Parse the command now into a list for execv, this is a pain
74      * in the ass.
75      */
76     char  *line = (char*)command;
77     char **argv = NULL;
78     {
79
80         while (*line != '\0') {
81             while (*line == ' ' || *line == '\t' || *line == '\n')
82                 *line++ = '\0';
83             vec_push(argv, line);
84
85             while (*line != '\0' && *line != ' ' &&
86                    *line != '\t' && *line != '\n') line++;
87         }
88         vec_push(argv, '\0');
89     }
90
91
92     if ((trypipe = pipe(inhandle))  < 0) goto task_popen_error_0;
93     if ((trypipe = pipe(outhandle)) < 0) goto task_popen_error_1;
94     if ((trypipe = pipe(errhandle)) < 0) goto task_popen_error_2;
95
96     if ((data->pid = fork()) > 0) {
97         /* parent */
98         close(inhandle  [0]);
99         close(outhandle [1]);
100         close(errhandle [1]);
101
102         data->pipes  [0] = inhandle [1];
103         data->pipes  [1] = outhandle[0];
104         data->pipes  [2] = errhandle[0];
105
106         data->handles[0] = (fs_file_t*)fdopen(inhandle [1], "w");
107         data->handles[1] = (fs_file_t*)fdopen(outhandle[0], mode);
108         data->handles[2] = (fs_file_t*)fdopen(errhandle[0], mode);
109
110         /* sigh */
111         vec_free(argv);
112         return data->handles;
113     } else if (data->pid == 0) {
114         /* child */
115         close(inhandle [1]);
116         close(outhandle[0]);
117         close(errhandle[0]);
118
119         /* see piping documentation for this sillyness :P */
120         dup2(inhandle [0], 0);
121         dup2(outhandle[1], 1);
122         dup2(errhandle[1], 2);
123
124         execvp(*argv, argv);
125         exit(EXIT_FAILURE);
126     } else {
127         /* fork failed */
128         goto task_popen_error_3;
129     }
130
131 task_popen_error_3: close(errhandle[0]), close(errhandle[1]);
132 task_popen_error_2: close(outhandle[0]), close(outhandle[1]);
133 task_popen_error_1: close(inhandle [0]), close(inhandle [1]);
134 task_popen_error_0:
135
136     vec_free(argv);
137     return NULL;
138 }
139
140 static int task_pclose(fs_file_t **handles) {
141     popen_t *data   = (popen_t*)handles;
142     int      status = 0;
143
144     close(data->pipes[0]); /* stdin  */
145     close(data->pipes[1]); /* stdout */
146     close(data->pipes[2]); /* stderr */
147
148     waitpid(data->pid, &status, 0);
149
150     mem_d(data);
151
152     return status;
153 }
154 #else
155     typedef struct {
156         fs_file_t *handles[3];
157         char       name_err[L_tmpnam];
158         char       name_out[L_tmpnam];
159     } popen_t;
160
161     static fs_file_t **task_popen(const char *command, const char *mode) {
162         char    *cmd  = NULL;
163         popen_t *open = (popen_t*)mem_a(sizeof(popen_t));
164
165         util_tmpnam(open->name_err);
166         util_tmpnam(open->name_out);
167
168         (void)mode; /* excluded */
169
170         util_asprintf(&cmd, "%s -redirout=%s -redirerr=%s", command, open->name_out, open->name_err);
171
172         system(cmd); /* HACK */
173         open->handles[0] = NULL;
174         open->handles[1] = fs_file_open(open->name_out, "r");
175         open->handles[2] = fs_file_open(open->name_err, "r");
176
177         mem_d(cmd);
178
179         return open->handles;
180     }
181
182     static int task_pclose(fs_file_t **files) {
183         popen_t *open = ((popen_t*)files);
184
185         fs_file_close(files[1]);
186         fs_file_close(files[2]);
187
188         remove(open->name_err);
189         remove(open->name_out);
190
191         mem_d(open);
192
193         return EXIT_SUCCESS;
194     }
195 #   define popen _popen
196 #   define pclose _pclose
197 #endif /*! _WIN32 */
198
199 #define TASK_COMPILE    0
200 #define TASK_EXECUTE    1
201 /*
202  * Task template system:
203  *  templates are rules for a specific test, used to create a "task" that
204  *  is executed with those set of rules (arguments, and what not). Tests
205  *  that don't have a template with them cannot become tasks, since without
206  *  the information for that test there is no way to properly "test" them.
207  *  Rules for these templates are described in a template file, using a
208  *  task template language.
209  *
210  *  The language is a basic finite statemachine, top-down single-line
211  *  description language.
212  *
213  *  The languge is composed entierly of "tags" which describe a string of
214  *  text for a task.  Think of it much like a configuration file.  Except
215  *  it's been designed to allow flexibility and future support for prodecual
216  *  semantics.
217  *
218  *  The following "tags" are suported by the language
219  *
220  *      D:
221  *          Used to set a description of the current test, this must be
222  *          provided, this tag is NOT optional.
223  *
224  *      T:
225  *          Used to set the procedure for the given task, there are two
226  *          options for this:
227  *              -compile
228  *                  This simply performs compilation only
229  *              -execute
230  *                  This will perform compilation and execution
231  *              -fail
232  *                  This will perform compilation, but requires
233  *                  the compilation to fail in order to succeed.
234  *
235  *          This must be provided, this tag is NOT optional.
236  *
237  *      C:
238  *          Used to set the compilation flags for the given task, this
239  *          must be provided, this tag is NOT optional.
240  *
241  *      F:  Used to set some test suite flags, currently the only option
242  *          is -no-defs (to including of defs.qh)
243  *
244  *      E:
245  *          Used to set the execution flags for the given task. This tag
246  *          must be provided if T == -execute, otherwise it's erroneous
247  *          as compilation only takes place.
248  *
249  *      M:
250  *          Used to describe a string of text that should be matched from
251  *          the output of executing the task.  If this doesn't match the
252  *          task fails.  This tag must be provided if T == -execute, otherwise
253  *          it's erroneous as compilation only takes place.
254  *
255  *      I:
256  *          Used to specify the INPUT source file to operate on, this must be
257  *          provided, this tag is NOT optional
258  *
259  *
260  *  Notes:
261  *      These tags have one-time use, using them more than once will result
262  *      in template compilation errors.
263  *
264  *      Lines beginning with # or // in the template file are comments and
265  *      are ignored by the template parser.
266  *
267  *      Whitespace is optional, with exception to the colon ':' between the
268  *      tag and it's assignment value/
269  *
270  *      The template compiler will detect erronrous tags (optional tags
271  *      that need not be set), as well as missing tags, and error accordingly
272  *      this will result in the task failing.
273  */
274 typedef struct {
275     char  *description;
276     char  *compileflags;
277     char  *executeflags;
278     char  *proceduretype;
279     char  *sourcefile;
280     char  *tempfilename;
281     char **comparematch;
282     char  *rulesfile;
283     char  *testflags;
284 } task_template_t;
285
286 /*
287  * This is very much like a compiler code generator :-).  This generates
288  * a value from some data observed from the compiler.
289  */
290 static bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
291     size_t desclen = 0;
292     size_t filelen = 0;
293     char **destval = NULL;
294
295     if (!tmpl)
296         return false;
297
298     switch(tag) {
299         case 'D': destval = &tmpl->description;    break;
300         case 'T': destval = &tmpl->proceduretype;  break;
301         case 'C': destval = &tmpl->compileflags;   break;
302         case 'E': destval = &tmpl->executeflags;   break;
303         case 'I': destval = &tmpl->sourcefile;     break;
304         case 'F': destval = &tmpl->testflags;      break;
305         default:
306             con_printmsg(LVL_ERROR, __FILE__, __LINE__, 0, "internal error",
307                 "invalid tag `%c:` during code generation\n",
308                 tag
309             );
310             return false;
311     }
312
313     /*
314      * Ensure if for the given tag, there already exists a
315      * assigned value.
316      */
317     if (*destval) {
318         con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "compile error",
319             "tag `%c:` already assigned value: %s\n",
320             tag, *destval
321         );
322         return false;
323     }
324
325     /*
326      * Strip any whitespace that might exist in the value for assignments
327      * like "D:      foo"
328      */
329     if (value && *value && (*value == ' ' || *value == '\t'))
330         value++;
331     else if (!value)
332         exit(EXIT_FAILURE);
333
334     /*
335      * Value will contain a newline character at the end, we need to strip
336      * this otherwise kaboom, seriously, kaboom :P
337      */
338     if (strchr(value, '\n'))
339         *strrchr(value, '\n')='\0';
340
341     /*
342      * Now allocate and set the actual value for the specific tag. Which
343      * was properly selected and can be accessed with *destval.
344      */
345     *destval = util_strdup(value);
346
347
348     if (*destval == tmpl->description) {
349         /*
350          * Create some padding for the description to align the
351          * printing of the rules file.
352          */
353         if ((desclen = strlen(tmpl->description)) > pad[0])
354             pad[0] = desclen;
355     }
356
357     if ((filelen = strlen(file)) > pad[2])
358         pad[2] = filelen;
359
360     return true;
361 }
362
363 static bool task_template_parse(const char *file, task_template_t *tmpl, fs_file_t *fp, size_t *pad) {
364     char  *data = NULL;
365     char  *back = NULL;
366     size_t size = 0;
367     size_t line = 1;
368
369     if (!tmpl)
370         return false;
371
372     /* top down parsing */
373     while (fs_file_getline(&back, &size, fp) != FS_FILE_EOF) {
374         /* skip whitespace */
375         data = back;
376         if (*data && (*data == ' ' || *data == '\t'))
377             data++;
378
379         switch (*data) {
380             /*
381              * Handle comments inside task tmpl files.  We're strict
382              * about the language for fun :-)
383              */
384             case '/':
385                 if (data[1] != '/') {
386                     con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
387                         "invalid character `/`, perhaps you meant `//` ?");
388
389                     mem_d(back);
390                     return false;
391                 }
392             case '#':
393                 break;
394
395             /*
396              * Empty newlines are acceptable as well, so we handle that here
397              * despite being just odd since there should't be that many
398              * empty lines to begin with.
399              */
400             case '\r':
401             case '\n':
402                 break;
403
404
405             /*
406              * Now begin the actual "tag" stuff.  This works as you expect
407              * it to.
408              */
409             case 'D':
410             case 'T':
411             case 'C':
412             case 'E':
413             case 'I':
414             case 'F':
415                 if (data[1] != ':') {
416                     con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
417                         "expected `:` after `%c`",
418                         *data
419                     );
420                     goto failure;
421                 }
422                 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
423                     con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl compile error",
424                         "failed to generate for given task\n"
425                     );
426                     goto failure;
427                 }
428                 break;
429
430             /*
431              * Match requires it's own system since we allow multiple M's
432              * for multi-line matching.
433              */
434             case 'M':
435             {
436                 char *value = &data[3];
437                 if (data[1] != ':') {
438                     con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
439                         "expected `:` after `%c`",
440                         *data
441                     );
442                     goto failure;
443                 }
444
445                 /*
446                  * Value will contain a newline character at the end, we need to strip
447                  * this otherwise kaboom, seriously, kaboom :P
448                  */
449                 if (strrchr(value, '\n'))
450                     *strrchr(value, '\n')='\0';
451                 else /* cppcheck: possible null pointer dereference */
452                     exit(EXIT_FAILURE);
453
454                 vec_push(tmpl->comparematch, util_strdup(value));
455
456                 break;
457             }
458
459             default:
460                 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
461                     "invalid tag `%c`", *data
462                 );
463                 goto failure;
464             /* no break required */
465         }
466
467         /* update line and free old sata */
468         line++;
469         mem_d(back);
470         back = NULL;
471     }
472     if (back)
473         mem_d(back);
474     return true;
475
476 failure:
477     mem_d (back);
478     return false;
479 }
480
481 /*
482  * Nullifies the template data: used during initialization of a new
483  * template and free.
484  */
485 static void task_template_nullify(task_template_t *tmpl) {
486     if (!tmpl)
487         return;
488
489     tmpl->description    = NULL;
490     tmpl->proceduretype  = NULL;
491     tmpl->compileflags   = NULL;
492     tmpl->executeflags   = NULL;
493     tmpl->comparematch   = NULL;
494     tmpl->sourcefile     = NULL;
495     tmpl->tempfilename   = NULL;
496     tmpl->rulesfile      = NULL;
497     tmpl->testflags      = NULL;
498 }
499
500 static task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
501     /* a page should be enough */
502     char             fullfile[4096];
503     size_t           filepadd = 0;
504     fs_file_t       *tempfile = NULL;
505     task_template_t *tmpl     = NULL;
506
507     util_snprintf(fullfile,    sizeof(fullfile), "%s/%s", dir, file);
508
509     tempfile = fs_file_open(fullfile, "r");
510     tmpl     = (task_template_t*)mem_a(sizeof(task_template_t));
511     task_template_nullify(tmpl);
512
513     /*
514      * Create some padding for the printing to align the
515      * printing of the rules file to the console.
516      */
517     if ((filepadd = strlen(fullfile)) > pad[1])
518         pad[1] = filepadd;
519
520     tmpl->rulesfile = util_strdup(fullfile);
521
522     /*
523      * Esnure the file even exists for the task, this is pretty useless
524      * to even do.
525      */
526     if (!tempfile) {
527         con_err("template file: %s does not exist or invalid permissions\n",
528             file
529         );
530         goto failure;
531     }
532
533     if (!task_template_parse(file, tmpl, tempfile, pad)) {
534         con_err("template parse error: error during parsing\n");
535         goto failure;
536     }
537
538     /*
539      * Regardless procedure type, the following tags must exist:
540      *  D
541      *  T
542      *  C
543      *  I
544      */
545     if (!tmpl->description) {
546         con_err("template compile error: %s missing `D:` tag\n", file);
547         goto failure;
548     }
549     if (!tmpl->proceduretype) {
550         con_err("template compile error: %s missing `T:` tag\n", file);
551         goto failure;
552     }
553     if (!tmpl->compileflags) {
554         con_err("template compile error: %s missing `C:` tag\n", file);
555         goto failure;
556     }
557     if (!tmpl->sourcefile) {
558         con_err("template compile error: %s missing `I:` tag\n", file);
559         goto failure;
560     }
561
562     /*
563      * Now lets compile the template, compilation is really just
564      * the process of validating the input.
565      */
566     if (!strcmp(tmpl->proceduretype, "-compile")) {
567         if (tmpl->executeflags)
568             con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
569         if (tmpl->comparematch)
570             con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
571         goto success;
572     } else if (!strcmp(tmpl->proceduretype, "-execute")) {
573         if (!tmpl->executeflags) {
574             /* default to $null */
575             tmpl->executeflags = util_strdup("$null");
576         }
577         if (!tmpl->comparematch) {
578             con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
579             goto failure;
580         }
581     } else if (!strcmp(tmpl->proceduretype, "-fail")) {
582         if (tmpl->executeflags)
583             con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
584         if (tmpl->comparematch)
585             con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
586     } else if (!strcmp(tmpl->proceduretype, "-diagnostic")) {
587         if (tmpl->executeflags)
588             con_err("template compile warning: %s erroneous tag `E:` when only diagnostic\n", file);
589         if (!tmpl->comparematch) {
590             con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
591             goto failure;
592         }
593     } else if (!strcmp(tmpl->proceduretype, "-pp")) {
594         if (tmpl->executeflags)
595             con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
596         if (!tmpl->comparematch) {
597             con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
598             goto failure;
599         }
600     } else {
601         con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
602         goto failure;
603     }
604
605 success:
606     fs_file_close(tempfile);
607     return tmpl;
608
609 failure:
610     /*
611      * The file might not exist and we jump here when that doesn't happen
612      * so the check to see if it's not null here is required.
613      */
614     if (tempfile)
615         fs_file_close(tempfile);
616     mem_d (tmpl);
617
618     return NULL;
619 }
620
621 static void task_template_destroy(task_template_t *tmpl) {
622     if (!tmpl)
623         return;
624
625     if (tmpl->description)    mem_d(tmpl->description);
626     if (tmpl->proceduretype)  mem_d(tmpl->proceduretype);
627     if (tmpl->compileflags)   mem_d(tmpl->compileflags);
628     if (tmpl->executeflags)   mem_d(tmpl->executeflags);
629     if (tmpl->sourcefile)     mem_d(tmpl->sourcefile);
630     if (tmpl->rulesfile)      mem_d(tmpl->rulesfile);
631     if (tmpl->testflags)      mem_d(tmpl->testflags);
632
633     /*
634      * Delete all allocated string for task tmpl then destroy the
635      * main vector.
636      */
637     {
638         size_t i = 0;
639         for (; i < vec_size(tmpl->comparematch); i++)
640             mem_d(tmpl->comparematch[i]);
641
642         vec_free(tmpl->comparematch);
643     }
644
645     /*
646      * Nullify all the template members otherwise NULL comparision
647      * checks will fail if tmpl pointer is reused.
648      */
649     mem_d(tmpl->tempfilename);
650     mem_d(tmpl);
651 }
652
653 /*
654  * Now comes the task manager, this system allows adding tasks in and out
655  * of a task list.  This is the executor of the tasks essentially as well.
656  */
657 typedef struct {
658     task_template_t *tmpl;
659     fs_file_t       **runhandles;
660     fs_file_t       *stderrlog;
661     fs_file_t       *stdoutlog;
662     char            *stdoutlogfile;
663     char            *stderrlogfile;
664     bool             compiled;
665 } task_t;
666
667 static task_t *task_tasks = NULL;
668
669 /*
670  * Read a directory and searches for all template files in it
671  * which is later used to run all tests.
672  */
673 static bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
674     bool             success = true;
675     fs_dir_t        *dir;
676     fs_dirent_t     *files;
677     struct stat      directory;
678     char             buffer[4096];
679     size_t           found = 0;
680     char           **directories = NULL;
681     char            *claim = util_strdup(curdir);
682     size_t           i;
683
684     vec_push(directories, claim);
685     dir = fs_dir_open(claim);
686
687     /*
688      * Generate a list of subdirectories since we'll be checking them too
689      * for tmpl files.
690      */
691     while ((files = fs_dir_read(dir))) {
692         util_asprintf(&claim, "%s/%s", curdir, files->d_name);
693         if (stat(claim, &directory) == -1) {
694             fs_dir_close(dir);
695             mem_d(claim);
696             return false;
697         }
698
699         if (S_ISDIR(directory.st_mode) && files->d_name[0] != '.') {
700             vec_push(directories, claim);
701         } else {
702             mem_d(claim);
703             claim = NULL;
704         }
705     }
706     fs_dir_close(dir);
707
708     /*
709      * Now do all the work, by touching all the directories inside
710      * test as well and compile the task templates into data we can
711      * use to run the tests.
712      */
713     for (i = 0; i < vec_size(directories); i++) {
714         dir = fs_dir_open(directories[i]);
715
716         while ((files = fs_dir_read(dir))) {
717             util_snprintf(buffer, sizeof(buffer), "%s/%s", directories[i], files->d_name);
718             if (stat(buffer, &directory) == -1) {
719                 con_err("internal error: stat failed, aborting\n");
720                 abort();
721             }
722
723             if (S_ISDIR(directory.st_mode))
724                 continue;
725
726             /*
727              * We made it here, which concludes the file/directory is not
728              * actually a directory, so it must be a file :)
729              */
730             if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
731                 task_template_t *tmpl = task_template_compile(files->d_name, directories[i], pad);
732                 char             buf[4096]; /* one page should be enough */
733                 const char      *qcflags = NULL;
734                 task_t           task;
735
736                 found ++;
737                 if (!tmpl) {
738                     con_err("error compiling task template: %s\n", files->d_name);
739                     success = false;
740                     continue;
741                 }
742                 /*
743                  * Generate a temportary file name for the output binary
744                  * so we don't trample over an existing one.
745                  */
746                 tmpl->tempfilename = NULL;
747                 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", directories[i], files->d_name);
748
749                 /*
750                  * Additional QCFLAGS enviroment variable may be used
751                  * to test compile flags for all tests.  This needs to be
752                  * BEFORE other flags (so that the .tmpl can override them)
753                  */
754                 qcflags = platform_getenv("QCFLAGS");
755
756                 /*
757                  * Generate the command required to open a pipe to a process
758                  * which will be refered to with a handle in the task for
759                  * reading the data from the pipe.
760                  */
761                 if (strcmp(tmpl->proceduretype, "-pp")) {
762                     if (qcflags) {
763                         if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
764                             util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
765                                 task_bins[TASK_COMPILE],
766                                 directories[i],
767                                 tmpl->sourcefile,
768                                 qcflags,
769                                 tmpl->compileflags,
770                                 tmpl->tempfilename
771                             );
772                         } else {
773                             util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
774                                 task_bins[TASK_COMPILE],
775                                 curdir,
776                                 defs,
777                                 directories[i],
778                                 tmpl->sourcefile,
779                                 qcflags,
780                                 tmpl->compileflags,
781                                 tmpl->tempfilename
782                             );
783                         }
784                     } else {
785                         if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
786                             util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
787                                 task_bins[TASK_COMPILE],
788                                 directories[i],
789                                 tmpl->sourcefile,
790                                 tmpl->compileflags,
791                                 tmpl->tempfilename
792                             );
793                         } else {
794                             util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
795                                 task_bins[TASK_COMPILE],
796                                 curdir,
797                                 defs,
798                                 directories[i],
799                                 tmpl->sourcefile,
800                                 tmpl->compileflags,
801                                 tmpl->tempfilename
802                             );
803                         }
804                     }
805                 } else {
806                     /* Preprocessing (qcflags mean shit all here we don't allow them) */
807                     if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
808                         util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
809                             task_bins[TASK_COMPILE],
810                             directories[i],
811                             tmpl->sourcefile,
812                             tmpl->tempfilename
813                         );
814                     } else {
815                         util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
816                             task_bins[TASK_COMPILE],
817                             curdir,
818                             defs,
819                             directories[i],
820                             tmpl->sourcefile,
821                             tmpl->tempfilename
822                         );
823                     }
824                 }
825
826                 /*
827                  * The task template was compiled, now lets create a task from
828                  * the template data which has now been propagated.
829                  */
830                 task.tmpl = tmpl;
831                 if (!(task.runhandles = task_popen(buf, "r"))) {
832                     con_err("error opening pipe to process for test: %s\n", tmpl->description);
833                     success = false;
834                     continue;
835                 }
836
837                 /*
838                  * Open up some file desciptors for logging the stdout/stderr
839                  * to our own.
840                  */
841                 util_snprintf(buf,  sizeof(buf), "%s.stdout", tmpl->tempfilename);
842                 task.stdoutlogfile = util_strdup(buf);
843                 if (!(task.stdoutlog     = fs_file_open(buf, "w"))) {
844                     con_err("error opening %s for stdout\n", buf);
845                     continue;
846                 }
847
848                 util_snprintf(buf,  sizeof(buf), "%s.stderr", tmpl->tempfilename);
849                 task.stderrlogfile = util_strdup(buf);
850                 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
851                     con_err("error opening %s for stderr\n", buf);
852                     continue;
853                 }
854
855                 vec_push(task_tasks, task);
856             }
857         }
858
859         fs_dir_close(dir);
860         mem_d(directories[i]); /* free claimed memory */
861     }
862     vec_free(directories);
863
864     return success;
865 }
866
867 /*
868  * Task precleanup removes any existing temporary files or log files
869  * left behind from a previous invoke of the test-suite.
870  */
871 static void task_precleanup(const char *curdir) {
872     fs_dir_t     *dir;
873     fs_dirent_t  *files;
874     char          buffer[4096];
875
876     dir = fs_dir_open(curdir);
877
878     while ((files = fs_dir_read(dir))) {
879         if (strstr(files->d_name, "TMP")     ||
880             strstr(files->d_name, ".stdout") ||
881             strstr(files->d_name, ".stderr"))
882         {
883             util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
884             if (remove(buffer))
885                 con_err("error removing temporary file: %s\n", buffer);
886         }
887     }
888
889     fs_dir_close(dir);
890 }
891
892 static void task_destroy(void) {
893     /*
894      * Free all the data in the task list and finally the list itself
895      * then proceed to cleanup anything else outside the program like
896      * temporary files.
897      */
898     size_t i;
899     for (i = 0; i < vec_size(task_tasks); i++) {
900         /*
901          * Close any open handles to files or processes here.  It's mighty
902          * annoying to have to do all this cleanup work.
903          */
904         if (task_tasks[i].stdoutlog)  fs_file_close (task_tasks[i].stdoutlog);
905         if (task_tasks[i].stderrlog)  fs_file_close (task_tasks[i].stderrlog);
906
907         /*
908          * Only remove the log files if the test actually compiled otherwise
909          * forget about it (or if it didn't compile, and the procedure type
910          * was set to -fail (meaning it shouldn't compile) .. stil remove)
911          */
912         if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
913             if (remove(task_tasks[i].stdoutlogfile))
914                 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
915             if (remove(task_tasks[i].stderrlogfile))
916                 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
917
918             (void)!remove(task_tasks[i].tmpl->tempfilename);
919         }
920
921         /* free util_strdup data for log files */
922         mem_d(task_tasks[i].stdoutlogfile);
923         mem_d(task_tasks[i].stderrlogfile);
924
925         task_template_destroy(task_tasks[i].tmpl);
926     }
927     vec_free(task_tasks);
928 }
929
930 /*
931  * This executes the QCVM task for a specificly compiled progs.dat
932  * using the template passed into it for call-flags and user defined
933  * messages IF the procedure type is -execute, otherwise it matches
934  * the preprocessor output.
935  */
936 static bool task_trymatch(size_t i, char ***line) {
937     bool             success = true;
938     bool             process = true;
939     int              retval  = EXIT_SUCCESS;
940     fs_file_t       *execute;
941     char             buffer[4096];
942     task_template_t *tmpl = task_tasks[i].tmpl;
943
944     memset  (buffer,0,sizeof(buffer));
945
946     if (!strcmp(tmpl->proceduretype, "-execute")) {
947         /*
948          * Drop the execution flags for the QCVM if none where
949          * actually specified.
950          */
951         if (!strcmp(tmpl->executeflags, "$null")) {
952             util_snprintf(buffer,  sizeof(buffer), "%s %s",
953                 task_bins[TASK_EXECUTE],
954                 tmpl->tempfilename
955             );
956         } else {
957             util_snprintf(buffer,  sizeof(buffer), "%s %s %s",
958                 task_bins[TASK_EXECUTE],
959                 tmpl->executeflags,
960                 tmpl->tempfilename
961             );
962         }
963
964         execute = (fs_file_t*)popen(buffer, "r");
965         if (!execute)
966             return false;
967     } else if (!strcmp(tmpl->proceduretype, "-pp")) {
968         /*
969          * we're preprocessing, which means we need to read int
970          * the produced file and do some really weird shit.
971          */
972         if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
973             return false;
974
975         process = false;
976     } else {
977         /*
978          * we're testing diagnostic output, which means it will be
979          * in runhandles[2] (stderr) since that is where the compiler
980          * puts it's errors.
981          */
982         if (!(execute = fs_file_open(task_tasks[i].stderrlogfile, "r")))
983             return false;
984
985         process = false;
986     }
987
988     /*
989      * Now lets read the lines and compare them to the matches we expect
990      * and handle accordingly.
991      */
992     {
993         char  *data    = NULL;
994         size_t size    = 0;
995         size_t compare = 0;
996
997         while (fs_file_getline(&data, &size, execute) != FS_FILE_EOF) {
998             if (!strcmp(data, "No main function found\n")) {
999                 con_err("test failure: `%s` (No main function found) [%s]\n",
1000                     tmpl->description,
1001                     tmpl->rulesfile
1002                 );
1003                 if (!process)
1004                     fs_file_close(execute);
1005                 else
1006                     pclose((FILE*)execute);
1007                 return false;
1008             }
1009
1010             /*
1011              * Trim newlines from data since they will just break our
1012              * ability to properly validate matches.
1013              */
1014             if  (strrchr(data, '\n'))
1015                 *strrchr(data, '\n') = '\0';
1016
1017             /*
1018              * We remove the file/directory and stuff from the error
1019              * match messages when testing diagnostics.
1020              */
1021             if(!strcmp(tmpl->proceduretype, "-diagnostic")) {
1022                 if (strstr(data, "there have been errors, bailing out"))
1023                     continue; /* ignore it */
1024                 if (strstr(data, ": error: ")) {
1025                     char *claim = util_strdup(data + (strstr(data, ": error: ") - data) + 9);
1026                     mem_d(data);
1027                     data = claim;
1028                 }
1029             }
1030
1031             /*
1032              * We need to ignore null lines for when -pp is used (preprocessor), since
1033              * the preprocessor is likely to create empty newlines in certain macro
1034              * instantations, otherwise it's in the wrong nature to ignore empty newlines.
1035              */
1036             if (!strcmp(tmpl->proceduretype, "-pp") && !*data)
1037                 continue;
1038
1039             if (vec_size(tmpl->comparematch) > compare) {
1040                 if (strcmp(data, tmpl->comparematch[compare++])) {
1041                     success = false;
1042                 }
1043             } else {
1044                 success = false;
1045             }
1046
1047             /*
1048              * Copy to output vector for diagnostics if execution match
1049              * fails.
1050              */
1051             vec_push(*line, data);
1052
1053             /* reset */
1054             data = NULL;
1055             size = 0;
1056         }
1057
1058         if (compare != vec_size(tmpl->comparematch))
1059             success = false;
1060
1061         mem_d(data);
1062         data = NULL;
1063     }
1064
1065     if (process)
1066         retval = pclose((FILE*)execute);
1067     else
1068         fs_file_close(execute);
1069
1070     return success && retval == EXIT_SUCCESS;
1071 }
1072
1073 static const char *task_type(task_template_t *tmpl) {
1074     if (!strcmp(tmpl->proceduretype, "-pp"))
1075         return "type: preprocessor";
1076     if (!strcmp(tmpl->proceduretype, "-execute"))
1077         return "type: execution";
1078     if (!strcmp(tmpl->proceduretype, "-compile"))
1079         return "type: compile";
1080     if (!strcmp(tmpl->proceduretype, "-diagnostic"))
1081         return "type: diagnostic";
1082     return "type: fail";
1083 }
1084
1085 /*
1086  * This schedualizes all tasks and actually runs them individually
1087  * this is generally easy for just -compile variants.  For compile and
1088  * execution this takes more work since a task needs to be generated
1089  * from thin air and executed INLINE.
1090  */
1091 #include <math.h>
1092 static size_t task_schedualize(size_t *pad) {
1093     char   space[2][64];
1094     bool   execute  = false;
1095     char  *data     = NULL;
1096     char **match    = NULL;
1097     size_t size     = 0;
1098     size_t i        = 0;
1099     size_t j        = 0;
1100     size_t failed   = 0;
1101
1102     util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1103
1104     for (; i < vec_size(task_tasks); i++) {
1105         memset(space[1], 0, sizeof(space[1]));
1106         util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1107
1108         con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1109
1110         /*
1111          * Generate a task from thin air if it requires execution in
1112          * the QCVM.
1113          */
1114
1115         /* diagnostic is not executed, but compare tested instead, like preproessor */
1116         execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1117                      (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))      ||
1118                      (!strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"));
1119
1120         /*
1121          * We assume it compiled before we actually compiled :).  On error
1122          * we change the value
1123          */
1124         task_tasks[i].compiled = true;
1125
1126         /*
1127          * Read data from stdout first and pipe that stuff into a log file
1128          * then we do the same for stderr.
1129          */
1130         while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != FS_FILE_EOF) {
1131             fs_file_puts(task_tasks[i].stdoutlog, data);
1132
1133             if (strstr(data, "failed to open file")) {
1134                 task_tasks[i].compiled = false;
1135                 execute                = false;
1136             }
1137         }
1138         while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != FS_FILE_EOF) {
1139             /*
1140              * If a string contains an error we just dissalow execution
1141              * of it in the vm.
1142              *
1143              * TODO: make this more percise, e.g if we print a warning
1144              * that refers to a variable named error, or something like
1145              * that .. then this will blowup :P
1146              */
1147             if (strstr(data, "error") && strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic")) {
1148                 execute                = false;
1149                 task_tasks[i].compiled = false;
1150             }
1151
1152             fs_file_puts (task_tasks[i].stderrlog, data);
1153             fs_file_flush(task_tasks[i].stderrlog); /* fast flush for read */
1154         }
1155
1156         if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1157             con_out("failure:   `%s` %*s %*s\n",
1158                 task_tasks[i].tmpl->description,
1159                 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1160                 task_tasks[i].tmpl->rulesfile,
1161                 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1162                 "(failed to compile)"
1163             );
1164             failed++;
1165             continue;
1166         }
1167
1168         if (task_pclose(task_tasks[i].runhandles) != EXIT_SUCCESS && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1169             con_out("failure:   `%s` %*s %*s\n",
1170                 task_tasks[i].tmpl->description,
1171                 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1172                 task_tasks[i].tmpl->rulesfile,
1173                 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(compiler didn't return exit success)") - pad[2]),
1174                 "(compiler didn't return exit success)"
1175             );
1176             failed++;
1177             continue;
1178         }
1179
1180         if (!execute) {
1181             con_out("succeeded: `%s` %*s %*s\n",
1182                 task_tasks[i].tmpl->description,
1183                 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1184                 task_tasks[i].tmpl->rulesfile,
1185                 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1186                 task_type(task_tasks[i].tmpl)
1187
1188             );
1189             continue;
1190         }
1191
1192         /*
1193          * If we made it here that concludes the task is to be executed
1194          * in the virtual machine (or the preprocessor output needs to
1195          * be matched).
1196          */
1197         if (!task_trymatch(i, &match)) {
1198             size_t d = 0;
1199
1200             con_out("failure:   `%s` %*s %*s\n",
1201                 task_tasks[i].tmpl->description,
1202                 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1203                 task_tasks[i].tmpl->rulesfile,
1204                 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1205                     (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1206                         ? "(invalid results from execution)"
1207                         : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1208                             ? "(invalid results from preprocessing)"
1209                             : "(invalid results from compiler diagnsotics)"
1210                 ) - pad[2]),
1211                 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1212                     ? "(invalid results from execution)"
1213                     : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1214                             ? "(invalid results from preprocessing)"
1215                             : "(invalid results from compiler diagnsotics)"
1216             );
1217
1218             /*
1219              * Print nicely formatted expected match lists to console error
1220              * handler for the all the given matches in the template file and
1221              * what was actually returned from executing.
1222              */
1223             con_out("    Expected From %u Matches: (got %u Matches)\n",
1224                 vec_size(task_tasks[i].tmpl->comparematch),
1225                 vec_size(match)
1226             );
1227             for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1228                 char  *select = task_tasks[i].tmpl->comparematch[d];
1229                 size_t length = 60 - strlen(select);
1230
1231                 con_out("        Expected: \"%s\"", select);
1232                 while (length --)
1233                     con_out(" ");
1234                 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1235             }
1236
1237             /*
1238              * Print the non-expected out (since we are simply not expecting it)
1239              * This will help track down bugs in template files that fail to match
1240              * something.
1241              */
1242             if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1243                 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1244                     con_out("        Expected: Nothing                                                       | Got: \"%s\"\n",
1245                         match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1246                     );
1247                 }
1248             }
1249
1250
1251             for (j = 0; j < vec_size(match); j++)
1252                 mem_d(match[j]);
1253             vec_free(match);
1254             failed++;
1255             continue;
1256         }
1257
1258         for (j = 0; j < vec_size(match); j++)
1259             mem_d(match[j]);
1260         vec_free(match);
1261
1262         con_out("succeeded: `%s` %*s %*s\n",
1263             task_tasks[i].tmpl->description,
1264             (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1265             task_tasks[i].tmpl->rulesfile,
1266             (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1267             task_type(task_tasks[i].tmpl)
1268
1269         );
1270     }
1271     mem_d(data);
1272     return failed;
1273 }
1274
1275 /*
1276  * This is the heart of the whole test-suite process.  This cleans up
1277  * any existing temporary files left behind as well as log files left
1278  * behind.  Then it propagates a list of tests from `curdir` by scaning
1279  * it for template files and compiling them into tasks, in which it
1280  * schedualizes them (executes them) and actually reports errors and
1281  * what not.  It then proceeds to destroy the tasks and return memory
1282  * it's the engine :)
1283  *
1284  * It returns true of tests could be propagated, otherwise it returns
1285  * false.
1286  *
1287  * It expects con_init() was called before hand.
1288  */
1289 static GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1290     size_t             failed       = false;
1291     static const char *default_defs = "defs.qh";
1292
1293     size_t pad[] = {
1294         /* test ### [succeed/fail]: `description`      [tests/template.tmpl]     [type] */
1295                     0,                                 0,                        0
1296     };
1297
1298     /*
1299      * If the default definition file isn't set to anything.  We will
1300      * use the default_defs here, which is "defs.qc"
1301      */
1302     if (!defs) {
1303         defs = default_defs;
1304     }
1305
1306
1307     task_precleanup(curdir);
1308     if (!task_propagate(curdir, pad, defs)) {
1309         con_err("error: failed to propagate tasks\n");
1310         task_destroy();
1311         return false;
1312     }
1313     /*
1314      * If we made it here all tasks where propagated from their resultant
1315      * template file.  So we can start the FILO scheduler, this has been
1316      * designed in the most thread-safe way possible for future threading
1317      * it's designed to prevent lock contention, and possible syncronization
1318      * issues.
1319      */
1320     failed = task_schedualize(pad);
1321     if (failed)
1322         con_out("%u out of %u tests failed\n", failed, vec_size(task_tasks));
1323     task_destroy();
1324
1325     return (failed) ? false : true;
1326 }
1327
1328 /*
1329  * Fancy GCC-like LONG parsing allows things like --opt=param with
1330  * assignment operator.  This is used for redirecting stdout/stderr
1331  * console to specific files of your choice.
1332  */
1333 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1334     int  argc   = *argc_;
1335     char **argv = *argv_;
1336
1337     size_t len = strlen(optname);
1338
1339     if (strncmp(argv[0]+ds, optname, len))
1340         return false;
1341
1342     /* it's --optname, check how the parameter is supplied */
1343     if (argv[0][ds+len] == '=') {
1344         *out = argv[0]+ds+len+1;
1345         return true;
1346     }
1347
1348     if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1349         return false;
1350
1351     /* using --opt param */
1352     *out = argv[1];
1353     --*argc_;
1354     ++*argv_;
1355     return true;
1356 }
1357
1358 int main(int argc, char **argv) {
1359     bool          succeed  = false;
1360     char         *redirout = (char*)stdout;
1361     char         *redirerr = (char*)stderr;
1362     char         *defs     = NULL;
1363
1364     con_init();
1365     OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = 16;
1366
1367     /*
1368      * Command line option parsing commences now We only need to support
1369      * a few things in the test suite.
1370      */
1371     while (argc > 1) {
1372         ++argv;
1373         --argc;
1374
1375         if (argv[0][0] == '-') {
1376             if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1377                 continue;
1378             if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1379                 continue;
1380             if (parsecmd("defs",     &argc, &argv, &defs,     1, false))
1381                 continue;
1382
1383             con_change(redirout, redirerr);
1384
1385             if (!strcmp(argv[0]+1, "debug")) {
1386                 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1387                 continue;
1388             }
1389             if (!strcmp(argv[0]+1, "memchk")) {
1390                 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1391                 continue;
1392             }
1393             if (!strcmp(argv[0]+1, "nocolor")) {
1394                 con_color(0);
1395                 continue;
1396             }
1397
1398             con_err("invalid argument %s\n", argv[0]+1);
1399             return -1;
1400         }
1401     }
1402     con_change(redirout, redirerr);
1403     succeed = test_perform("tests", defs);
1404     stat_info();
1405
1406     return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;
1407 }