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