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