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