test.c

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