free the memory for asprintf
[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 "gmqcc.h"
24 #include <sys/types.h>
25 #include <sys/stat.h>
26
27 opts_cmd_t opts;
28
29 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 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         data->handles[0] = fdopen(inhandle [1], "w");
105         data->handles[1] = fdopen(outhandle[0], mode);
106         data->handles[2] = fdopen(errhandle[0], mode);
107
108         /* sigh */
109         if (argv)
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         close(0), dup(inhandle [0]);
120         close(1), dup(outhandle[1]);
121         close(2), dup(errhandle[1]);
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     if (argv)
136         vec_free(argv);
137     return NULL;
138 }
139
140 int task_pclose(FILE **handles) {
141     popen_t *data   = (popen_t*)handles;
142     int      status = 0;
143
144     close(data->pipes[0]); /* stdin  */
145     close(data->pipes[1]); /* stdout */
146     close(data->pipes[2]); /* stderr */
147
148     waitpid(data->pid, &status, 0);
149
150     mem_d(data);
151
152     return status;
153 }
154 #else
155     /*
156      * Bidirectional piping implementation for windows using CreatePipe and DuplicateHandle +
157      * other hacks.
158      */
159     typedef struct {
160         char name_err[L_tmpnam];
161         char name_out[L_tmpnam];
162     } popen_t;
163
164     FILE **task_popen(const char *command, const char *mode) {
165         FILE   **handles = NULL;
166         char    *cmd     = NULL;
167         popen_t *open    = (popen_t*)mem_a(sizeof(popen_t) * 3);
168
169         tmpnam(open->name_err);
170         tmpnam(open->name_out);
171
172         (void)mode; /* excluded */
173
174         util_asprintf(&cmd, "%s -redirout=%s -redirerr=%s", command, open->name_out, open->name_err);
175
176         system(cmd); /* HACK */
177         handles    = (FILE**)(open + 1);
178         handles[0] = NULL;
179         handles[1] = fs_file_open(open->name_out, "r");
180         handles[2] = fs_file_open(open->name_err, "r");
181
182         mem_d(cmd);
183
184         return handles;
185     }
186
187     void task_pclose(FILE **files) {
188         popen_t *open = ((popen_t*)files) - 1;
189         fs_file_close(files[1]);
190         fs_file_close(files[2]);
191         remove(open->name_err);
192         remove(open->name_out);
193
194         mem_d(open);
195     }
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 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__, "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, "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
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     else /* cppcheck: possible nullpointer dereference */
338         exit(EXIT_FAILURE);
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 bool task_template_parse(const char *file, task_template_t *tmpl, FILE *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, "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, "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, "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, "tmpl parse error",
438                         "expected `:` after `%c`",
439                         *data
440                     );
441                     goto failure;
442                 }
443
444                 if (value && *value && (*value == ' ' || *value == '\t'))
445                     value++;
446
447                 /*
448                  * Value will contain a newline character at the end, we need to strip
449                  * this otherwise kaboom, seriously, kaboom :P
450                  */
451                 if (strrchr(value, '\n'))
452                     *strrchr(value, '\n')='\0';
453                 else /* cppcheck: possible null pointer dereference */
454                     exit(EXIT_FAILURE);
455
456                 vec_push(tmpl->comparematch, util_strdup(value));
457
458                 break;
459             }
460
461             default:
462                 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
463                     "invalid tag `%c`", *data
464                 );
465                 goto failure;
466             /* no break required */
467         }
468
469         /* update line and free old sata */
470         line++;
471         mem_d(back);
472         back = NULL;
473     }
474     if (back)
475         mem_d(back);
476     return true;
477
478 failure:
479     if (back)
480         mem_d (back);
481     return false;
482 }
483
484 /*
485  * Nullifies the template data: used during initialization of a new
486  * template and free.
487  */
488 void task_template_nullify(task_template_t *tmpl) {
489     if (!tmpl)
490         return;
491
492     tmpl->description    = NULL;
493     tmpl->proceduretype  = NULL;
494     tmpl->compileflags   = NULL;
495     tmpl->executeflags   = NULL;
496     tmpl->comparematch   = NULL;
497     tmpl->sourcefile     = NULL;
498     tmpl->tempfilename   = NULL;
499     tmpl->rulesfile      = NULL;
500     tmpl->testflags      = NULL;
501 }
502
503 task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
504     /* a page should be enough */
505     char             fullfile[4096];
506     size_t           filepadd = 0;
507     FILE            *tempfile = NULL;
508     task_template_t *tmpl     = NULL;
509
510     util_snprintf(fullfile,    sizeof(fullfile), "%s/%s", dir, file);
511
512     tempfile = fs_file_open(fullfile, "r");
513     tmpl     = (task_template_t*)mem_a(sizeof(task_template_t));
514     task_template_nullify(tmpl);
515
516     /*
517      * Create some padding for the printing to align the
518      * printing of the rules file to the console.
519      */
520     if ((filepadd = strlen(fullfile)) > pad[1])
521         pad[1] = filepadd;
522
523     tmpl->rulesfile = util_strdup(fullfile);
524
525     /*
526      * Esnure the file even exists for the task, this is pretty useless
527      * to even do.
528      */
529     if (!tempfile) {
530         con_err("template file: %s does not exist or invalid permissions\n",
531             file
532         );
533         goto failure;
534     }
535
536     if (!task_template_parse(file, tmpl, tempfile, pad)) {
537         con_err("template parse error: error during parsing\n");
538         goto failure;
539     }
540
541     /*
542      * Regardless procedure type, the following tags must exist:
543      *  D
544      *  T
545      *  C
546      *  I
547      */
548     if (!tmpl->description) {
549         con_err("template compile error: %s missing `D:` tag\n", file);
550         goto failure;
551     }
552     if (!tmpl->proceduretype) {
553         con_err("template compile error: %s missing `T:` tag\n", file);
554         goto failure;
555     }
556     if (!tmpl->compileflags) {
557         con_err("template compile error: %s missing `C:` tag\n", file);
558         goto failure;
559     }
560     if (!tmpl->sourcefile) {
561         con_err("template compile error: %s missing `I:` tag\n", file);
562         goto failure;
563     }
564
565     /*
566      * Now lets compile the template, compilation is really just
567      * the process of validating the input.
568      */
569     if (!strcmp(tmpl->proceduretype, "-compile")) {
570         if (tmpl->executeflags)
571             con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
572         if (tmpl->comparematch)
573             con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
574         goto success;
575     } else if (!strcmp(tmpl->proceduretype, "-execute")) {
576         if (!tmpl->executeflags) {
577             /* default to $null */
578             tmpl->executeflags = util_strdup("$null");
579         }
580         if (!tmpl->comparematch) {
581             con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
582             goto failure;
583         }
584     } else if (!strcmp(tmpl->proceduretype, "-fail")) {
585         if (tmpl->executeflags)
586             con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
587         if (tmpl->comparematch)
588             con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
589     } else if (!strcmp(tmpl->proceduretype, "-pp")) {
590         if (tmpl->executeflags)
591             con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
592         if (!tmpl->comparematch) {
593             con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
594             goto failure;
595         }
596     } else {
597         con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
598         goto failure;
599     }
600
601 success:
602     fs_file_close(tempfile);
603     return tmpl;
604
605 failure:
606     /*
607      * The file might not exist and we jump here when that doesn't happen
608      * so the check to see if it's not null here is required.
609      */
610     if (tempfile)
611         fs_file_close(tempfile);
612     mem_d (tmpl);
613
614     return NULL;
615 }
616
617 void task_template_destroy(task_template_t **tmpl) {
618     if (!tmpl)
619         return;
620
621     if ((*tmpl)->description)    mem_d((*tmpl)->description);
622     if ((*tmpl)->proceduretype)  mem_d((*tmpl)->proceduretype);
623     if ((*tmpl)->compileflags)   mem_d((*tmpl)->compileflags);
624     if ((*tmpl)->executeflags)   mem_d((*tmpl)->executeflags);
625     if ((*tmpl)->sourcefile)     mem_d((*tmpl)->sourcefile);
626     if ((*tmpl)->rulesfile)      mem_d((*tmpl)->rulesfile);
627     if ((*tmpl)->testflags)      mem_d((*tmpl)->testflags);
628
629     /*
630      * Delete all allocated string for task tmpl then destroy the
631      * main vector.
632      */
633     {
634         size_t i = 0;
635         for (; i < vec_size((*tmpl)->comparematch); i++)
636             mem_d((*tmpl)->comparematch[i]);
637
638         vec_free((*tmpl)->comparematch);
639     }
640
641     /*
642      * Nullify all the template members otherwise NULL comparision
643      * checks will fail if tmpl pointer is reused.
644      */
645     mem_d(*tmpl);
646 }
647
648 /*
649  * Now comes the task manager, this system allows adding tasks in and out
650  * of a task list.  This is the executor of the tasks essentially as well.
651  */
652 typedef struct {
653     task_template_t *tmpl;
654     FILE           **runhandles;
655     FILE            *stderrlog;
656     FILE            *stdoutlog;
657     char            *stdoutlogfile;
658     char            *stderrlogfile;
659     bool             compiled;
660 } task_t;
661
662 task_t *task_tasks = NULL;
663
664 /*
665  * Read a directory and searches for all template files in it
666  * which is later used to run all tests.
667  */
668 bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
669     bool             success = true;
670     DIR             *dir;
671     struct dirent   *files;
672     struct stat      directory;
673     char             buffer[4096];
674     size_t           found = 0;
675
676     dir = fs_dir_open(curdir);
677
678     while ((files = fs_dir_read(dir))) {
679         util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
680
681         if (stat(buffer, &directory) == -1) {
682             con_err("internal error: stat failed, aborting\n");
683             abort();
684         }
685
686         /* skip directories */
687         if (S_ISDIR(directory.st_mode))
688             continue;
689
690         /*
691          * We made it here, which concludes the file/directory is not
692          * actually a directory, so it must be a file :)
693          */
694         if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
695             task_template_t *tmpl = task_template_compile(files->d_name, curdir, pad);
696             char             buf[4096]; /* one page should be enough */
697             char            *qcflags = NULL;
698             task_t           task;
699
700             util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
701             found ++;
702             if (!tmpl) {
703                 con_err("error compiling task template: %s\n", files->d_name);
704                 success = false;
705                 continue;
706             }
707             /*
708              * Generate a temportary file name for the output binary
709              * so we don't trample over an existing one.
710              */
711             tmpl->tempfilename = NULL;
712             util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", curdir, files->d_name);
713
714             /*
715              * Additional QCFLAGS enviroment variable may be used
716              * to test compile flags for all tests.  This needs to be
717              * BEFORE other flags (so that the .tmpl can override them)
718              */
719             #ifdef _MSC_VER
720             {
721                 char   buffer[4096];
722                 size_t size;
723                 getenv_s(&size, buffer, sizeof(buffer), "QCFLAGS");
724                 qcflags = buffer;
725             }
726             #else
727             qcflags = getenv("QCFLAGS");
728             #endif
729
730             /*
731              * Generate the command required to open a pipe to a process
732              * which will be refered to with a handle in the task for
733              * reading the data from the pipe.
734              */
735             if (strcmp(tmpl->proceduretype, "-pp")) {
736                 if (qcflags) {
737                     if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
738                         util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
739                             task_bins[TASK_COMPILE],
740                             curdir,
741                             tmpl->sourcefile,
742                             qcflags,
743                             tmpl->compileflags,
744                             tmpl->tempfilename
745                         );
746                     } else {
747                         util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
748                             task_bins[TASK_COMPILE],
749                             curdir,
750                             defs,
751                             curdir,
752                             tmpl->sourcefile,
753                             qcflags,
754                             tmpl->compileflags,
755                             tmpl->tempfilename
756                         );
757                     }
758                 } else {
759                     if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
760                         util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
761                             task_bins[TASK_COMPILE],
762                             curdir,
763                             tmpl->sourcefile,
764                             tmpl->compileflags,
765                             tmpl->tempfilename
766                         );
767                     } else {
768                         util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
769                             task_bins[TASK_COMPILE],
770                             curdir,
771                             defs,
772                             curdir,
773                             tmpl->sourcefile,
774                             tmpl->compileflags,
775                             tmpl->tempfilename
776                         );
777                     }
778                 }
779             } else {
780                 /* Preprocessing (qcflags mean shit all here we don't allow them) */
781                 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
782                     util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
783                         task_bins[TASK_COMPILE],
784                         curdir,
785                         tmpl->sourcefile,
786                         tmpl->tempfilename
787                     );
788                 } else {
789                     util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
790                         task_bins[TASK_COMPILE],
791                         curdir,
792                         defs,
793                         curdir,
794                         tmpl->sourcefile,
795                         tmpl->tempfilename
796                     );
797                 }
798             }
799
800             /*
801              * The task template was compiled, now lets create a task from
802              * the template data which has now been propagated.
803              */
804             task.tmpl = tmpl;
805             if (!(task.runhandles = task_popen(buf, "r"))) {
806                 con_err("error opening pipe to process for test: %s\n", tmpl->description);
807                 success = false;
808                 continue;
809             }
810
811             util_debug("TEST", "executing test: `%s` [%s]\n", tmpl->description, buf);
812
813             /*
814              * Open up some file desciptors for logging the stdout/stderr
815              * to our own.
816              */
817             util_snprintf(buf,  sizeof(buf), "%s.stdout", tmpl->tempfilename);
818             task.stdoutlogfile = util_strdup(buf);
819             if (!(task.stdoutlog     = fs_file_open(buf, "w"))) {
820                 con_err("error opening %s for stdout\n", buf);
821                 continue;
822             }
823
824             util_snprintf(buf,  sizeof(buf), "%s.stderr", tmpl->tempfilename);
825             task.stderrlogfile = util_strdup(buf);
826             if (!(task.stderrlog = fs_file_open(buf, "w"))) {
827                 con_err("error opening %s for stderr\n", buf);
828                 continue;
829             }
830
831             vec_push(task_tasks, task);
832         }
833     }
834
835     util_debug("TEST", "compiled %d task template files out of %d\n",
836         vec_size(task_tasks),
837         found
838     );
839
840     fs_dir_close(dir);
841     return success;
842 }
843
844 /*
845  * Task precleanup removes any existing temporary files or log files
846  * left behind from a previous invoke of the test-suite.
847  */
848 void task_precleanup(const char *curdir) {
849     DIR             *dir;
850     struct dirent   *files;
851     char             buffer[4096];
852
853     dir = fs_dir_open(curdir);
854
855     while ((files = fs_dir_read(dir))) {
856         if (strstr(files->d_name, "TMP")     ||
857             strstr(files->d_name, ".stdout") ||
858             strstr(files->d_name, ".stderr"))
859         {
860             util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
861             if (remove(buffer))
862                 con_err("error removing temporary file: %s\n", buffer);
863             else
864                 util_debug("TEST", "removed temporary file: %s\n", buffer);
865         }
866     }
867
868     fs_dir_close(dir);
869 }
870
871 void task_destroy(void) {
872     /*
873      * Free all the data in the task list and finally the list itself
874      * then proceed to cleanup anything else outside the program like
875      * temporary files.
876      */
877     size_t i;
878     for (i = 0; i < vec_size(task_tasks); i++) {
879         /*
880          * Close any open handles to files or processes here.  It's mighty
881          * annoying to have to do all this cleanup work.
882          */
883         if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
884         if (task_tasks[i].stdoutlog)  fs_file_close (task_tasks[i].stdoutlog);
885         if (task_tasks[i].stderrlog)  fs_file_close (task_tasks[i].stderrlog);
886
887         /*
888          * Only remove the log files if the test actually compiled otherwise
889          * forget about it (or if it didn't compile, and the procedure type
890          * was set to -fail (meaning it shouldn't compile) .. stil remove)
891          */
892         if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
893             if (remove(task_tasks[i].stdoutlogfile))
894                 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
895             else
896                 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
897             if (remove(task_tasks[i].stderrlogfile))
898                 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
899             else
900                 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
901
902             remove(task_tasks[i].tmpl->tempfilename);
903         }
904
905         /* free util_strdup data for log files */
906         mem_d(task_tasks[i].stdoutlogfile);
907         mem_d(task_tasks[i].stderrlogfile);
908
909         task_template_destroy(&task_tasks[i].tmpl);
910     }
911     vec_free(task_tasks);
912 }
913
914 /*
915  * This executes the QCVM task for a specificly compiled progs.dat
916  * using the template passed into it for call-flags and user defined
917  * messages IF the procedure type is -execute, otherwise it matches
918  * the preprocessor output.
919  */
920 bool task_trymatch(task_template_t *tmpl, char ***line) {
921     bool     success = true;
922     bool     preprocessing = false;
923     FILE    *execute;
924     char     buffer[4096];
925     memset  (buffer,0,sizeof(buffer));
926
927     if (strcmp(tmpl->proceduretype, "-pp")) {
928         /*
929          * Drop the execution flags for the QCVM if none where
930          * actually specified.
931          */
932         if (!strcmp(tmpl->executeflags, "$null")) {
933             util_snprintf(buffer,  sizeof(buffer), "%s %s",
934                 task_bins[TASK_EXECUTE],
935                 tmpl->tempfilename
936             );
937         } else {
938             util_snprintf(buffer,  sizeof(buffer), "%s %s %s",
939                 task_bins[TASK_EXECUTE],
940                 tmpl->executeflags,
941                 tmpl->tempfilename
942             );
943         }
944
945         util_debug("TEST", "executing qcvm: `%s` [%s]\n",
946             tmpl->description,
947             buffer
948         );
949
950         execute = popen(buffer, "r");
951         if (!execute)
952             return false;
953     } else {
954         /*
955          * we're preprocessing, which means we need to read int
956          * the produced file and do some really weird shit.
957          */
958         if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
959             return false;
960
961         preprocessing = true;
962     }
963
964     /*
965      * Now lets read the lines and compare them to the matches we expect
966      * and handle accordingly.
967      */
968     {
969         char  *data    = NULL;
970         size_t size    = 0;
971         size_t compare = 0;
972         while (fs_file_getline(&data, &size, execute) != EOF) {
973             if (!strcmp(data, "No main function found\n")) {
974                 con_err("test failure: `%s` (No main function found) [%s]\n",
975                     tmpl->description,
976                     tmpl->rulesfile
977                 );
978                 if (preprocessing)
979                     fs_file_close(execute);
980                 else
981                     pclose(execute);
982                 return false;
983             }
984
985             /*
986              * Trim newlines from data since they will just break our
987              * ability to properly validate matches.
988              */
989             if  (strrchr(data, '\n'))
990                 *strrchr(data, '\n') = '\0';
991
992             /*
993              * If data is just null now, that means the line was an empty
994              * one and for that, we just ignore it.
995              */
996             if (!*data)
997                 continue;
998
999             if (vec_size(tmpl->comparematch) > compare) {
1000                 if (strcmp(data, tmpl->comparematch[compare++]))
1001                     success = false;
1002             } else {
1003                     success = false;
1004             }
1005
1006             /*
1007              * Copy to output vector for diagnostics if execution match
1008              * fails.
1009              */
1010             vec_push(*line, data);
1011
1012             /* reset */
1013             data = NULL;
1014             size = 0;
1015         }
1016         mem_d(data);
1017         data = NULL;
1018     }
1019
1020     if (!preprocessing)
1021         pclose(execute);
1022     else
1023         fs_file_close(execute);
1024
1025     return success;
1026 }
1027
1028 const char *task_type(task_template_t *tmpl) {
1029     if (!strcmp(tmpl->proceduretype, "-pp"))
1030         return "type: preprocessor";
1031     if (!strcmp(tmpl->proceduretype, "-execute"))
1032         return "type: execution";
1033     if (!strcmp(tmpl->proceduretype, "-compile"))
1034         return "type: compile";
1035     return "type: fail";
1036 }
1037
1038 /*
1039  * This schedualizes all tasks and actually runs them individually
1040  * this is generally easy for just -compile variants.  For compile and
1041  * execution this takes more work since a task needs to be generated
1042  * from thin air and executed INLINE.
1043  */
1044 #include <math.h>
1045 void task_schedualize(size_t *pad) {
1046     char   space[2][64];
1047     bool   execute  = false;
1048     char  *data     = NULL;
1049     char **match    = NULL;
1050     size_t size     = 0;
1051     size_t i        = 0;
1052     size_t j        = 0;
1053
1054     util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1055
1056     for (; i < vec_size(task_tasks); i++) {
1057         memset(space[1], 0, sizeof(space[1]));
1058         util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1059
1060         con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1061
1062         util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].tmpl->description);
1063         /*
1064          * Generate a task from thin air if it requires execution in
1065          * the QCVM.
1066          */
1067         execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1068                      (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp"));
1069
1070         /*
1071          * We assume it compiled before we actually compiled :).  On error
1072          * we change the value
1073          */
1074         task_tasks[i].compiled = true;
1075
1076         /*
1077          * Read data from stdout first and pipe that stuff into a log file
1078          * then we do the same for stderr.
1079          */
1080         while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1081             fs_file_puts(task_tasks[i].stdoutlog, data);
1082
1083             if (strstr(data, "failed to open file")) {
1084                 task_tasks[i].compiled = false;
1085                 execute                = false;
1086             }
1087         }
1088         while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1089             /*
1090              * If a string contains an error we just dissalow execution
1091              * of it in the vm.
1092              *
1093              * TODO: make this more percise, e.g if we print a warning
1094              * that refers to a variable named error, or something like
1095              * that .. then this will blowup :P
1096              */
1097             if (strstr(data, "error")) {
1098                 execute                = false;
1099                 task_tasks[i].compiled = false;
1100             }
1101
1102             fs_file_puts (task_tasks[i].stderrlog, data);
1103         }
1104
1105         if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1106             con_out("failure:   `%s` %*s %*s\n",
1107                 task_tasks[i].tmpl->description,
1108                 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1109                 task_tasks[i].tmpl->rulesfile,
1110                 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1111                 "(failed to compile)"
1112             );
1113             continue;
1114         }
1115
1116         if (!execute) {
1117             con_out("succeeded: `%s` %*s %*s\n",
1118                 task_tasks[i].tmpl->description,
1119                 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1120                 task_tasks[i].tmpl->rulesfile,
1121                 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1122                 task_type(task_tasks[i].tmpl)
1123
1124             );
1125             continue;
1126         }
1127
1128         /*
1129          * If we made it here that concludes the task is to be executed
1130          * in the virtual machine (or the preprocessor output needs to
1131          * be matched).
1132          */
1133         if (!task_trymatch(task_tasks[i].tmpl, &match)) {
1134             size_t d = 0;
1135
1136             con_out("failure:   `%s` %*s %*s\n",
1137                 task_tasks[i].tmpl->description,
1138                 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1139                 task_tasks[i].tmpl->rulesfile,
1140                 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1141                     (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1142                         ? "(invalid results from execution)"
1143                         : "(invalid results from preprocessing)"
1144                 ) - pad[2]),
1145                 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1146                     ? "(invalid results from execution)"
1147                     : "(invalid results from preprocessing)"
1148             );
1149
1150             /*
1151              * Print nicely formatted expected match lists to console error
1152              * handler for the all the given matches in the template file and
1153              * what was actually returned from executing.
1154              */
1155             con_out("    Expected From %u Matches: (got %u Matches)\n",
1156                 vec_size(task_tasks[i].tmpl->comparematch),
1157                 vec_size(match)
1158             );
1159             for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1160                 char  *select = task_tasks[i].tmpl->comparematch[d];
1161                 size_t length = 40 - strlen(select);
1162
1163                 con_out("        Expected: \"%s\"", select);
1164                 while (length --)
1165                     con_out(" ");
1166                 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1167             }
1168
1169             /*
1170              * Print the non-expected out (since we are simply not expecting it)
1171              * This will help track down bugs in template files that fail to match
1172              * something.
1173              */
1174             if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1175                 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1176                     con_out("        Expected: Nothing                                   | Got: \"%s\"\n",
1177                         match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1178                     );
1179                 }
1180             }
1181
1182
1183             for (j = 0; j < vec_size(match); j++)
1184                 mem_d(match[j]);
1185             vec_free(match);
1186             continue;
1187         }
1188         for (j = 0; j < vec_size(match); j++)
1189             mem_d(match[j]);
1190         vec_free(match);
1191
1192         con_out("succeeded: `%s` %*s %*s\n",
1193             task_tasks[i].tmpl->description,
1194             (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1195             task_tasks[i].tmpl->rulesfile,
1196             (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1197             task_type(task_tasks[i].tmpl)
1198
1199         );
1200     }
1201     mem_d(data);
1202 }
1203
1204 /*
1205  * This is the heart of the whole test-suite process.  This cleans up
1206  * any existing temporary files left behind as well as log files left
1207  * behind.  Then it propagates a list of tests from `curdir` by scaning
1208  * it for template files and compiling them into tasks, in which it
1209  * schedualizes them (executes them) and actually reports errors and
1210  * what not.  It then proceeds to destroy the tasks and return memory
1211  * it's the engine :)
1212  *
1213  * It returns true of tests could be propagated, otherwise it returns
1214  * false.
1215  *
1216  * It expects con_init() was called before hand.
1217  */
1218 GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1219     static const char *default_defs = "defs.qh";
1220
1221     size_t pad[] = {
1222         /* test ### [succeed/fail]: `description`      [tests/template.tmpl]     [type] */
1223                     0,                                 0,                        0
1224     };
1225
1226     /*
1227      * If the default definition file isn't set to anything.  We will
1228      * use the default_defs here, which is "defs.qc"
1229      */
1230     if (!defs) {
1231         defs = default_defs;
1232     }
1233
1234
1235     task_precleanup(curdir);
1236     if (!task_propagate(curdir, pad, defs)) {
1237         con_err("error: failed to propagate tasks\n");
1238         task_destroy();
1239         return false;
1240     }
1241     /*
1242      * If we made it here all tasks where propagated from their resultant
1243      * template file.  So we can start the FILO scheduler, this has been
1244      * designed in the most thread-safe way possible for future threading
1245      * it's designed to prevent lock contention, and possible syncronization
1246      * issues.
1247      */
1248     task_schedualize(pad);
1249     task_destroy();
1250
1251     return true;
1252 }
1253
1254 /*
1255  * Fancy GCC-like LONG parsing allows things like --opt=param with
1256  * assignment operator.  This is used for redirecting stdout/stderr
1257  * console to specific files of your choice.
1258  */
1259 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1260     int  argc   = *argc_;
1261     char **argv = *argv_;
1262
1263     size_t len = strlen(optname);
1264
1265     if (strncmp(argv[0]+ds, optname, len))
1266         return false;
1267
1268     /* it's --optname, check how the parameter is supplied */
1269     if (argv[0][ds+len] == '=') {
1270         *out = argv[0]+ds+len+1;
1271         return true;
1272     }
1273
1274     if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1275         return false;
1276
1277     /* using --opt param */
1278     *out = argv[1];
1279     --*argc_;
1280     ++*argv_;
1281     return true;
1282 }
1283
1284 int main(int argc, char **argv) {
1285     bool          succeed  = false;
1286     char         *redirout = (char*)stdout;
1287     char         *redirerr = (char*)stderr;
1288     char         *defs     = NULL;
1289
1290     con_init();
1291
1292     /*
1293      * Command line option parsing commences now We only need to support
1294      * a few things in the test suite.
1295      */
1296     while (argc > 1) {
1297         ++argv;
1298         --argc;
1299
1300         if (argv[0][0] == '-') {
1301             if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1302                 continue;
1303             if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1304                 continue;
1305             if (parsecmd("defs",     &argc, &argv, &defs,     1, false))
1306                 continue;
1307
1308             con_change(redirout, redirerr);
1309
1310             if (!strcmp(argv[0]+1, "debug")) {
1311                 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1312                 continue;
1313             }
1314             if (!strcmp(argv[0]+1, "memchk")) {
1315                 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1316                 continue;
1317             }
1318             if (!strcmp(argv[0]+1, "nocolor")) {
1319                 con_color(0);
1320                 continue;
1321             }
1322
1323             con_err("invalid argument %s\n", argv[0]+1);
1324             return -1;
1325         }
1326     }
1327     con_change(redirout, redirerr);
1328     succeed = test_perform("tests", defs);
1329     util_meminfo();
1330
1331
1332     return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;
1333 }