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