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