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