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             con_err("template compile error: %s missing `E:` tag (use `$null` for exclude)\n", file);
 518             goto failure;
 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     task_template_nullify(*template);
 575     *template = NULL;
 576 }
 577
 578 /*
 579  * Now comes the task manager, this system allows adding tasks in and out
 580  * of a task list.  This is the executor of the tasks essentially as well.
 581  */
 582 typedef struct {
 583     task_template_t *template;
 584     FILE           **runhandles;
 585     FILE            *stderrlog;
 586     FILE            *stdoutlog;
 587     char            *stdoutlogfile;
 588     char            *stderrlogfile;
 589     bool             compiled;
 590 } task_t;
 591
 592 task_t *task_tasks = NULL;
 593
 594 /*
 595  * Read a directory and searches for all template files in it
 596  * which is later used to run all tests.
 597  */
 598 bool task_propogate(const char *curdir) {
 599     bool             success = true;
 600     DIR             *dir;
 601     struct dirent   *files;
 602     struct stat      directory;
 603     char             buffer[4096];
 604
 605     dir = opendir(curdir);
 606
 607     while ((files = readdir(dir))) {
 608         memset  (buffer, 0,sizeof(buffer));
 609         snprintf(buffer,   sizeof(buffer), "%s/%s", curdir, files->d_name);
 610
 611         if (stat(buffer, &directory) == -1) {
 612             con_err("internal error: stat failed, aborting\n");
 613             abort();
 614         }
 615
 616         /* skip directories */
 617         if (S_ISDIR(directory.st_mode))
 618             continue;
 619
 620         /*
 621          * We made it here, which concludes the file/directory is not
 622          * actually a directory, so it must be a file :)
 623          */
 624         if (strstr(files->d_name, ".tmpl") == &files->d_name[strlen(files->d_name) - (sizeof(".tmpl") - 1)]) {
 625             util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
 626             task_template_t *template = task_template_compile(files->d_name, curdir);
 627             if (!template) {
 628                 con_err("error compiling task template: %s\n", files->d_name);
 629                 success = false;
 630                 continue;
 631             }
 632             /*
 633              * Generate a temportary file name for the output binary
 634              * so we don't trample over an existing one.
 635              */
 636             template->tempfilename = tempnam(curdir, "TMPDAT");
 637
 638             /*
 639              * Generate the command required to open a pipe to a process
 640              * which will be refered to with a handle in the task for
 641              * reading the data from the pipe.
 642              */
 643             char     buf[4096]; /* one page should be enough */
 644             memset  (buf,0,sizeof(buf));
 645             snprintf(buf,  sizeof(buf), "%s %s/%s %s -o %s",
 646                 task_bins[TASK_COMPILE],
 647                 curdir,
 648                 template->sourcefile,
 649                 template->compileflags,
 650                 template->tempfilename
 651             );
 652
 653             /*
 654              * The task template was compiled, now lets create a task from
 655              * the template data which has now been propogated.
 656              */
 657             task_t task;
 658             task.template = template;
 659             if (!(task.runhandles = task_popen(buf, "r"))) {
 660                 con_err("error opening pipe to process for test: %s\n", template->description);
 661                 success = false;
 662                 continue;
 663             }
 664
 665             util_debug("TEST", "executing test: `%s` [%s]\n", template->description, buf);
 666
 667             /*
 668              * Open up some file desciptors for logging the stdout/stderr
 669              * to our own.
 670              */
 671             memset  (buf,0,sizeof(buf));
 672             snprintf(buf,  sizeof(buf), "%s.stdout", template->tempfilename);
 673             task.stdoutlogfile = util_strdup(buf);
 674             if (!(task.stdoutlog     = fopen(buf, "w"))) {
 675                 con_err("error opening %s for stdout\n", buf);
 676                 continue;
 677             }
 678
 679             memset  (buf,0,sizeof(buf));
 680             snprintf(buf,  sizeof(buf), "%s.stderr", template->tempfilename);
 681             task.stderrlogfile = util_strdup(buf);
 682             if (!(task.stderrlog     = fopen(buf, "w"))) {
 683                 con_err("error opening %s for stderr\n", buf);
 684                 continue;
 685             }
 686
 687             vec_push(task_tasks, task);
 688         }
 689     }
 690
 691     closedir(dir);
 692     return success;
 693 }
 694
 695 /*
 696  * Removes all temporary 'progs.dat' files created during compilation
 697  * of all tests'
 698  */
 699 void task_cleanup(const char *curdir) {
 700     DIR             *dir;
 701     struct dirent   *files;
 702     char             buffer[4096];
 703
 704     dir = opendir(curdir);
 705
 706     while ((files = readdir(dir))) {
 707         memset(buffer, 0, sizeof(buffer));
 708         if (strstr(files->d_name, "TMP")) {
 709             snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
 710             if (remove(buffer))
 711                 con_err("error removing temporary file: %s\n", buffer);
 712             else
 713                 util_debug("TEST", "removed temporary file: %s\n", buffer);
 714         }
 715     }
 716
 717     closedir(dir);
 718 }
 719
 720 /*
 721  * Task precleanup removes any existing temporary files or log files
 722  * left behind from a previous invoke of the test-suite.
 723  */
 724 void task_precleanup(const char *curdir) {
 725     DIR             *dir;
 726     struct dirent   *files;
 727     char             buffer[4096];
 728
 729     dir = opendir(curdir);
 730
 731     while ((files = readdir(dir))) {
 732         memset(buffer, 0, sizeof(buffer));
 733         if (strstr(files->d_name, "TMP")     ||
 734             strstr(files->d_name, ".stdout") ||
 735             strstr(files->d_name, ".stderr"))
 736         {
 737             snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
 738             if (remove(buffer))
 739                 con_err("error removing temporary file: %s\n", buffer);
 740             else
 741                 util_debug("TEST", "removed temporary file: %s\n", buffer);
 742         }
 743     }
 744
 745     closedir(dir);
 746 }
 747
 748 void task_destroy(const char *curdir) {
 749     /*
 750      * Free all the data in the task list and finally the list itself
 751      * then proceed to cleanup anything else outside the program like
 752      * temporary files.
 753      */
 754     size_t i;
 755     for (i = 0; i < vec_size(task_tasks); i++) {
 756         /*
 757          * Close any open handles to files or processes here.  It's mighty
 758          * annoying to have to do all this cleanup work.
 759          */
 760         if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
 761         if (task_tasks[i].stdoutlog)  fclose     (task_tasks[i].stdoutlog);
 762         if (task_tasks[i].stderrlog)  fclose     (task_tasks[i].stderrlog);
 763
 764         /*
 765          * Only remove the log files if the test actually compiled otherwise
 766          * forget about it.
 767          */
 768         if (task_tasks[i].compiled) {
 769             if (remove(task_tasks[i].stdoutlogfile))
 770                 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
 771             else
 772                 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
 773
 774             if (remove(task_tasks[i].stderrlogfile))
 775                 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
 776             else
 777                 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
 778         }
 779
 780         /* free util_strdup data for log files */
 781         mem_d(task_tasks[i].stdoutlogfile);
 782         mem_d(task_tasks[i].stderrlogfile);
 783
 784         task_template_destroy(&task_tasks[i].template);
 785     }
 786     vec_free(task_tasks);
 787
 788     /*
 789      * Cleanup outside stuff like temporary files.
 790      */
 791     task_cleanup(curdir);
 792 }
 793
 794 /*
 795  * This executes the QCVM task for a specificly compiled progs.dat
 796  * using the template passed into it for call-flags and user defined
 797  * messages.
 798  */
 799 bool task_execute(task_template_t *template) {
 800     bool     success = false;
 801     FILE    *execute;
 802     char     buffer[4096];
 803     memset  (buffer,0,sizeof(buffer));
 804
 805     /*
 806      * Drop the execution flags for the QCVM if none where
 807      * actually specified.
 808      */
 809     if (!strcmp(template->executeflags, "$null")) {
 810         snprintf(buffer,  sizeof(buffer), "%s %s",
 811             task_bins[TASK_EXECUTE],
 812             template->tempfilename
 813         );
 814     } else {
 815         snprintf(buffer,  sizeof(buffer), "%s %s %s",
 816             task_bins[TASK_EXECUTE],
 817             template->executeflags,
 818             template->tempfilename
 819         );
 820     }
 821
 822     util_debug("TEST", "executing qcvm: `%s` [%s]\n",
 823         template->description,
 824         buffer
 825     );
 826
 827     execute = popen(buffer, "r");
 828     if (!execute)
 829         return false;
 830
 831     /*
 832      * Now lets read the lines and compare them to the matches we expect
 833      * and handle accordingly.
 834      */
 835     {
 836         char  *data    = NULL;
 837         size_t size    = 0;
 838         size_t compare = 0;
 839         while (util_getline(&data, &size, execute) != EOF) {
 840             if (!strcmp(data, "No main function found\n")) {
 841                 con_err("test failure: `%s` [%s] (No main function found)\n",
 842                     template->description,
 843                     (template->failuremessage) ?
 844                     template->failuremessage : "unknown"
 845                 );
 846                 pclose(execute);
 847                 return false;
 848             }
 849
 850             /*
 851              * Trim newlines from data since they will just break our
 852              * ability to properly validate matches.
 853              */
 854             if  (strrchr(data, '\n'))
 855                 *strrchr(data, '\n') = '\0';
 856
 857
 858             /*
 859              * We only care about the last line from the output for now
 860              * implementing multi-line match is TODO.
 861              */
 862             success = !!!(strcmp(data, template->comparematch[compare++]));
 863         }
 864     }
 865     pclose(execute);
 866     return success;
 867 }
 868
 869 /*
 870  * This schedualizes all tasks and actually runs them individually
 871  * this is generally easy for just -compile variants.  For compile and
 872  * execution this takes more work since a task needs to be generated
 873  * from thin air and executed INLINE.
 874  */
 875 void task_schedualize(const char *curdir) {
 876     bool   execute  = false;
 877     char  *back     = NULL;
 878     char  *data     = NULL;
 879     size_t size     = 0;
 880     size_t i;
 881
 882     for (i = 0; i < vec_size(task_tasks); i++) {
 883         /*
 884         * Generate a task from thin air if it requires execution in
 885         * the QCVM.
 886         */
 887         if (!strcmp(task_tasks[i].template->proceduretype, "-execute"))
 888             execute = true;
 889
 890         /*
 891          * We assume it compiled before we actually compiled :).  On error
 892          * we change the value
 893          */
 894         task_tasks[i].compiled = true;
 895
 896         /*
 897          * Read data from stdout first and pipe that stuff into a log file
 898          * then we do the same for stderr.
 899          */
 900         while (util_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
 901             back = data;
 902             fputs(data, task_tasks[i].stdoutlog);
 903             fflush(task_tasks[i].stdoutlog);
 904         }
 905         while (util_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
 906             back = data;
 907             /*
 908              * If a string contains an error we just dissalow execution
 909              * of it in the vm.
 910              *
 911              * TODO: make this more percise, e.g if we print a warning
 912              * that refers to a variable named error, or something like
 913              * that .. then this will blowup :P
 914              */
 915             if (strstr(data, "error")) {
 916                 execute                = false;
 917                 task_tasks[i].compiled = false;
 918             }
 919
 920             fputs(data, task_tasks[i].stderrlog);
 921             fflush(task_tasks[i].stdoutlog);
 922         }
 923
 924         if (back)
 925             mem_d(back);
 926
 927         /*
 928          * If we can execute we do so after all data has been read and
 929          * this paticular task has coupled execution in its procedure type
 930          */
 931         if (!execute)
 932             continue;
 933
 934         /*
 935          * If we made it here that concludes the task is to be executed
 936          * in the virtual machine.
 937          */
 938         if (!task_execute(task_tasks[i].template)) {
 939             con_err("test failure: `%s` [%s]\n",
 940                 task_tasks[i].template->description,
 941                 (task_tasks[i].template->failuremessage) ?
 942                 task_tasks[i].template->failuremessage : "unknown"
 943             );
 944             continue;
 945         }
 946
 947         con_out("test succeed: `%s` [%s]\n",
 948             task_tasks[i].template->description,
 949             (task_tasks[i].template->successmessage) ?
 950             task_tasks[i].template->successmessage  : "unknown"
 951         );
 952     }
 953     if (back)
 954         mem_d(back);
 955 }
 956
 957 /*
 958  * This is the heart of the whole test-suite process.  This cleans up
 959  * any existing temporary files left behind as well as log files left
 960  * behind.  Then it propogates a list of tests from `curdir` by scaning
 961  * it for template files and compiling them into tasks, in which it
 962  * schedualizes them (executes them) and actually reports errors and
 963  * what not.  It then proceeds to destroy the tasks and return memory
 964  * it's the engine :)
 965  *
 966  * It returns true of tests could be propogated, otherwise it returns
 967  * false.
 968  *
 969  * It expects con_init() was called before hand.
 970  */
 971 bool test_perform(const char *curdir) {
 972     task_precleanup(curdir);
 973     if (!task_propogate(curdir)) {
 974         con_err("error: failed to propogate tasks\n");
 975         task_destroy(curdir);
 976         return false;
 977     }
 978     /*
 979      * If we made it here all tasks where propogated from their resultant
 980      * template file.  So we can start the FILO scheduler, this has been
 981      * designed in the most thread-safe way possible for future threading
 982      * it's designed to prevent lock contention, and possible syncronization
 983      * issues.
 984      */
 985     task_schedualize(curdir);
 986     task_destroy(curdir);
 987
 988     return true;
 989 }
 990
 991 /*
 992  * Fancy GCC-like LONG parsing allows things like --opt=param with
 993  * assignment operator.  This is used for redirecting stdout/stderr
 994  * console to specific files of your choice.
 995  */
 996 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
 997     int  argc   = *argc_;
 998     char **argv = *argv_;
 999
1000     size_t len = strlen(optname);
1001
1002     if (strncmp(argv[0]+ds, optname, len))
1003         return false;
1004
1005     /* it's --optname, check how the parameter is supplied */
1006     if (argv[0][ds+len] == '=') {
1007         *out = argv[0]+ds+len+1;
1008         return true;
1009     }
1010
1011     if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1012         return false;
1013
1014     /* using --opt param */
1015     *out = argv[1];
1016     --*argc_;
1017     ++*argv_;
1018     return true;
1019 }
1020
1021 int main(int argc, char **argv) {
1022     char *redirout = (char*)stdout;
1023     char *redirerr = (char*)stderr;
1024     con_init();
1025
1026     /*
1027      * Command line option parsing commences now We only need to support
1028      * a few things in the test suite.
1029      */
1030     while (argc > 1) {
1031         ++argv;
1032         --argc;
1033
1034         if (argv[0][0] == '-') {
1035             if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1036                 continue;
1037             if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1038                 continue;
1039
1040             con_change(redirout, redirerr);
1041
1042             if (!strcmp(argv[0]+1, "debug")) {
1043                 opts_debug = true;
1044                 continue;
1045             }
1046             if (!strcmp(argv[0]+1, "memchk")) {
1047                 opts_memchk = true;
1048                 continue;
1049             }
1050             if (!strcmp(argv[0]+1, "nocolor")) {
1051                 con_color(0);
1052                 continue;
1053             }
1054
1055             con_err("invalid argument %s\n", argv[0]+1);
1056             return -1;
1057         }
1058     }
1059     con_change(redirout, redirerr);
1060     test_perform("tests");
1061     util_meminfo();
1062     return 0;
1063 }