test.c

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