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