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