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