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