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 = true;
  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 #endif
 160
 161 #define TASK_COMPILE 0
 162 #define TASK_EXECUTE 1
 163
 164 /*
 165  * Task template system:
 166  *  templates are rules for a specific test, used to create a "task" that
 167  *  is executed with those set of rules (arguments, and what not). Tests
 168  *  that don't have a template with them cannot become tasks, since without
 169  *  the information for that test there is no way to properly "test" them.
 170  *  Rules for these templates are described in a template file, using a
 171  *  task template language.
 172  *
 173  *  The language is a basic finite statemachine, top-down single-line
 174  *  description language.
 175  *
 176  *  The languge is composed entierly of "tags" which describe a string of
 177  *  text for a task.  Think of it much like a configuration file.  Except
 178  *  it's been designed to allow flexibility and future support for prodecual
 179  *  semantics.
 180  *
 181  *  The following "tags" are suported by the language
 182  *
 183  *      D:
 184  *          Used to set a description of the current test, this must be
 185  *          provided, this tag is NOT optional.
 186  *
 187  *      F:
 188  *          Used to set a failure message, this message will be displayed
 189  *          if the test fails, this tag is optional
 190  *
 191  *      S:
 192  *          Used to set a success message, this message will be displayed
 193  *          if the test succeeds, this tag is optional.
 194  *
 195  *      T:
 196  *          Used to set the procedure for the given task, there are two
 197  *          options for this:
 198  *              -compile
 199  *                  This simply performs compilation only
 200  *              -execute
 201  *                  This will perform compilation and execution
 202  *
 203  *          This must be provided, this tag is NOT optional.
 204  *
 205  *      C:
 206  *          Used to set the compilation flags for the given task, this
 207  *          must be provided, this tag is NOT optional.
 208  *
 209  *      E:
 210  *          Used to set the execution flags for the given task. This tag
 211  *          must be provided if T == -execute, otherwise it's erroneous
 212  *          as compilation only takes place.
 213  *
 214  *      M:
 215  *          Used to describe a string of text that should be matched from
 216  *          the output of executing the task.  If this doesn't match the
 217  *          task fails.  This tag must be provided if T == -execute, otherwise
 218  *          it's erroneous as compilation only takes place.
 219  *
 220  *      I:
 221  *          Used to specify the INPUT source file to operate on, this must be
 222  *          provided, this tag is NOT optional
 223  *
 224  *
 225  *  Notes:
 226  *      These tags have one-time use, using them more than once will result
 227  *      in template compilation errors.
 228  *
 229  *      Lines beginning with # or // in the template file are comments and
 230  *      are ignored by the template parser.
 231  *
 232  *      Whitespace is optional, with exception to the colon ':' between the
 233  *      tag and it's assignment value/
 234  *
 235  *      The template compiler will detect erronrous tags (optional tags
 236  *      that need not be set), as well as missing tags, and error accordingly
 237  *      this will result in the task failing.
 238  */
 239 typedef struct {
 240     char *description;
 241     char *failuremessage;
 242     char *successmessage;
 243     char *compileflags;
 244     char *executeflags;
 245     char *comparematch;
 246     char *proceduretype;
 247     char *sourcefile;
 248     char *tempfilename;
 249 } task_template_t;
 250
 251 /*
 252  * This is very much like a compiler code generator :-).  This generates
 253  * a value from some data observed from the compiler.
 254  */
 255 bool task_template_generate(task_template_t *template, char tag, const char *file, size_t line, const char *value) {
 256     char **destval = NULL;
 257
 258     if (!template)
 259         return false;
 260
 261     switch(tag) {
 262         case 'D': destval = &template->description;    break;
 263         case 'F': destval = &template->failuremessage; break;
 264         case 'S': destval = &template->successmessage; break;
 265         case 'T': destval = &template->proceduretype;  break;
 266         case 'C': destval = &template->compileflags;   break;
 267         case 'E': destval = &template->executeflags;   break;
 268         case 'M': destval = &template->comparematch;   break;
 269         case 'I': destval = &template->sourcefile;     break;
 270         default:
 271             con_printmsg(LVL_ERROR, __FILE__, __LINE__, "internal error",
 272                 "invalid tag `%c:` during code generation\n",
 273                 tag
 274             );
 275             return false;
 276     }
 277
 278     /*
 279      * Ensure if for the given tag, there already exists a
 280      * assigned value.
 281      */
 282     if (*destval) {
 283         con_printmsg(LVL_ERROR, file, line, "compile error",
 284             "tag `%c:` already assigned value: %s\n",
 285             tag, *destval
 286         );
 287         return false;
 288     }
 289
 290     /*
 291      * Strip any whitespace that might exist in the value for assignments
 292      * like "D:      foo"
 293      */
 294     if (value && *value && (*value == ' ' || *value == '\t'))
 295         value++;
 296
 297     /*
 298      * Value will contain a newline character at the end, we need to strip
 299      * this otherwise kaboom, seriously, kaboom :P
 300      */
 301     *strrchr(value, '\n')='\0';
 302
 303     /*
 304      * Now allocate and set the actual value for the specific tag. Which
 305      * was properly selected and can be accessed with *destval.
 306      */
 307     *destval = util_strdup(value);
 308
 309     return true;
 310 }
 311
 312 bool task_template_parse(const char *file, task_template_t *template, FILE *fp) {
 313     char  *data = NULL;
 314     char  *back = NULL;
 315     size_t size = 0;
 316     size_t line = 1;
 317
 318     if (!template)
 319         return false;
 320
 321     /* top down parsing */
 322     while (util_getline(&back, &size, fp) != EOF) {
 323         /* skip whitespace */
 324         data = back;
 325         if (*data && (*data == ' ' || *data == '\t'))
 326             data++;
 327
 328         switch (*data) {
 329             /*
 330              * Handle comments inside task template files.  We're strict
 331              * about the language for fun :-)
 332              */
 333             case '/':
 334                 if (data[1] != '/') {
 335                     con_printmsg(LVL_ERROR, file, line, "template parse error",
 336                         "invalid character `/`, perhaps you meant `//` ?");
 337
 338                     mem_d(back);
 339                     return false;
 340                 }
 341             case '#':
 342                 break;
 343
 344             /*
 345              * Empty newlines are acceptable as well, so we handle that here
 346              * despite being just odd since there should't be that many
 347              * empty lines to begin with.
 348              */
 349             case '\r':
 350             case '\n':
 351                 break;
 352
 353
 354             /*
 355              * Now begin the actual "tag" stuff.  This works as you expect
 356              * it to.
 357              */
 358             case 'D':
 359             case 'F':
 360             case 'S':
 361             case 'T':
 362             case 'C':
 363             case 'E':
 364             case 'M':
 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             default:
 382                 con_printmsg(LVL_ERROR, file, line, "template parse error",
 383                     "invalid tag `%c`", *data
 384                 );
 385                 goto failure;
 386             /* no break required */
 387         }
 388
 389         /* update line and free old sata */
 390         line++;
 391         mem_d(back);
 392         back = NULL;
 393     }
 394     if (back)
 395         mem_d(back);
 396     return true;
 397
 398 failure:
 399     if (back)
 400         mem_d (back);
 401     return false;
 402 }
 403
 404 /*
 405  * Nullifies the template data: used during initialization of a new
 406  * template and free.
 407  */
 408 void task_template_nullify(task_template_t *template) {
 409     if (!template)
 410         return;
 411
 412     template->description    = NULL;
 413     template->failuremessage = NULL;
 414     template->successmessage = NULL;
 415     template->proceduretype  = NULL;
 416     template->compileflags   = NULL;
 417     template->executeflags   = NULL;
 418     template->comparematch   = NULL;
 419     template->sourcefile     = NULL;
 420     template->tempfilename   = NULL;
 421 }
 422
 423 task_template_t *task_template_compile(const char *file, const char *dir) {
 424     /* a page should be enough */
 425     char             fullfile[4096];
 426     FILE            *tempfile = NULL;
 427     task_template_t *template = NULL;
 428
 429     memset  (fullfile, 0, sizeof(fullfile));
 430     snprintf(fullfile,    sizeof(fullfile), "%s/%s", dir, file);
 431
 432     tempfile = fopen(fullfile, "r");
 433     template = mem_a(sizeof(task_template_t));
 434     task_template_nullify(template);
 435
 436     /*
 437      * Esnure the file even exists for the task, this is pretty useless
 438      * to even do.
 439      */
 440     if (!tempfile) {
 441         con_err("template file: %s does not exist or invalid permissions\n",
 442             file
 443         );
 444         goto failure;
 445     }
 446
 447     if (!task_template_parse(file, template, tempfile)) {
 448         con_err("template parse error: error during parsing\n");
 449         goto failure;
 450     }
 451
 452     /*
 453      * Regardless procedure type, the following tags must exist:
 454      *  D
 455      *  T
 456      *  C
 457      *  I
 458      */
 459     if (!template->description) {
 460         con_err("template compile error: %s missing `D:` tag\n", file);
 461         goto failure;
 462     }
 463     if (!template->proceduretype) {
 464         con_err("template compile error: %s missing `T:` tag\n", file);
 465         goto failure;
 466     }
 467     if (!template->compileflags) {
 468         con_err("template compile error: %s missing `C:` tag\n", file);
 469         goto failure;
 470     }
 471     if (!template->sourcefile) {
 472         con_err("template compile error: %s missing `I:` tag\n", file);
 473         goto failure;
 474     }
 475
 476     /*
 477      * Now lets compile the template, compilation is really just
 478      * the process of validating the input.
 479      */
 480     if (!strcmp(template->proceduretype, "-compile")) {
 481         if (template->executeflags)
 482             con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
 483         if (template->comparematch)
 484             con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
 485         goto success;
 486     } else if (!strcmp(template->proceduretype, "-execute")) {
 487         if (!template->executeflags) {
 488             con_err("template compile error: %s missing `E:` tag (use `$null` for exclude)\n", file);
 489             goto failure;
 490         }
 491         if (!template->comparematch) {
 492             con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
 493             goto failure;
 494         }
 495     } else {
 496         con_err("template compile error: %s invalid procedure type: %s\n", file, template->proceduretype);
 497         goto failure;
 498     }
 499
 500 success:
 501     fclose(tempfile);
 502     return template;
 503
 504 failure:
 505     /*
 506      * The file might not exist and we jump here when that doesn't happen
 507      * so the check to see if it's not null here is required.
 508      */
 509     if (tempfile)
 510         fclose(tempfile);
 511     mem_d (template);
 512
 513     return NULL;
 514 }
 515
 516 void task_template_destroy(task_template_t **template) {
 517     if (!template)
 518         return;
 519
 520     if ((*template)->description)    mem_d((*template)->description);
 521     if ((*template)->failuremessage) mem_d((*template)->failuremessage);
 522     if ((*template)->successmessage) mem_d((*template)->successmessage);
 523     if ((*template)->proceduretype)  mem_d((*template)->proceduretype);
 524     if ((*template)->compileflags)   mem_d((*template)->compileflags);
 525     if ((*template)->executeflags)   mem_d((*template)->executeflags);
 526     if ((*template)->comparematch)   mem_d((*template)->comparematch);
 527     if ((*template)->sourcefile)     mem_d((*template)->sourcefile);
 528
 529     /*
 530      * Nullify all the template members otherwise NULL comparision
 531      * checks will fail if template pointer is reused.
 532      */
 533     mem_d(*template);
 534     task_template_nullify(*template);
 535     *template = NULL;
 536 }
 537
 538 /*
 539  * Now comes the task manager, this system allows adding tasks in and out
 540  * of a task list.  This is the executor of the tasks essentially as well.
 541  */
 542 typedef struct {
 543     task_template_t *template;
 544     FILE           **runhandles;
 545     FILE            *stderrlog;
 546     FILE            *stdoutlog;
 547     char            *stdoutlogfile;
 548     char            *stderrlogfile;
 549     bool             compiled;
 550 } task_t;
 551
 552 task_t *task_tasks = NULL;
 553
 554 /*
 555  * Read a directory and searches for all template files in it
 556  * which is later used to run all tests.
 557  */
 558 bool task_propogate(const char *curdir) {
 559     bool             success = true;
 560     DIR             *dir;
 561     struct dirent   *files;
 562     struct stat      directory;
 563     char             buffer[4096];
 564
 565     dir = opendir(curdir);
 566
 567     while ((files = readdir(dir))) {
 568         memset  (buffer, 0,sizeof(buffer));
 569         snprintf(buffer,   sizeof(buffer), "%s/%s", curdir, files->d_name);
 570
 571         if (stat(buffer, &directory) == -1) {
 572             con_err("internal error: stat failed, aborting\n");
 573             abort();
 574         }
 575
 576         /* skip directories */
 577         if (S_ISDIR(directory.st_mode))
 578             continue;
 579
 580         /*
 581          * We made it here, which concludes the file/directory is not
 582          * actually a directory, so it must be a file :)
 583          */
 584         if (strstr(files->d_name, ".tmpl")) {
 585             con_out("compiling task template: %s/%s\n", curdir, files->d_name);
 586             task_template_t *template = task_template_compile(files->d_name, curdir);
 587             if (!template) {
 588                 con_err("error compiling task template: %s\n", files->d_name);
 589                 success = false;
 590                 continue;
 591             }
 592             /*
 593              * Generate a temportary file name for the output binary
 594              * so we don't trample over an existing one.
 595              */
 596             template->tempfilename = tempnam(curdir, "TMPDAT");
 597
 598             /*
 599              * Generate the command required to open a pipe to a process
 600              * which will be refered to with a handle in the task for
 601              * reading the data from the pipe.
 602              */
 603             char     buf[4096]; /* one page should be enough */
 604             memset  (buf,0,sizeof(buf));
 605             snprintf(buf,  sizeof(buf), "%s %s/%s %s -o %s",
 606                 task_bins[TASK_COMPILE],
 607                 curdir,
 608                 template->sourcefile,
 609                 template->compileflags,
 610                 template->tempfilename
 611             );
 612
 613             /*
 614              * The task template was compiled, now lets create a task from
 615              * the template data which has now been propogated.
 616              */
 617             task_t task;
 618             task.template = template;
 619             if (!(task.runhandles = task_popen(buf, "r"))) {
 620                 con_err("error opening pipe to process for test: %s\n", template->description);
 621                 success = false;
 622                 continue;
 623             }
 624
 625             con_out("executing test: `%s` [%s]\n", template->description, buf);
 626
 627             /*
 628              * Open up some file desciptors for logging the stdout/stderr
 629              * to our own.
 630              */
 631             memset  (buf,0,sizeof(buf));
 632             snprintf(buf,  sizeof(buf), "%s/%s.stdout", curdir, template->sourcefile);
 633             task.stdoutlogfile = util_strdup(buf);
 634             task.stdoutlog     = fopen(buf, "w");
 635
 636             memset  (buf,0,sizeof(buf));
 637             snprintf(buf,  sizeof(buf), "%s/%s.stderr", curdir, template->sourcefile);
 638             task.stderrlogfile = util_strdup(buf);
 639             task.stderrlog     = fopen(buf, "w");
 640
 641             vec_push(task_tasks, task);
 642         }
 643     }
 644
 645     closedir(dir);
 646     return success;
 647 }
 648
 649 /*
 650  * Removes all temporary 'progs.dat' files created during compilation
 651  * of all tests'
 652  */
 653 void task_cleanup(const char *curdir) {
 654     DIR             *dir;
 655     struct dirent   *files;
 656     char             buffer[4096];
 657
 658     dir = opendir(curdir);
 659
 660     while ((files = readdir(dir))) {
 661         memset(buffer, 0, sizeof(buffer));
 662         if (strstr(files->d_name, "TMP")) {
 663             snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
 664             if (remove(buffer))
 665                 con_err("error removing temporary file: %s\n", buffer);
 666             else
 667                 con_out("removed temporary file: %s\n", buffer);
 668         }
 669     }
 670
 671     closedir(dir);
 672 }
 673
 674 /*
 675  * Task precleanup removes any existing temporary files or log files
 676  * left behind from a previous invoke of the test-suite.
 677  */
 678 void task_precleanup(const char *curdir) {
 679     DIR             *dir;
 680     struct dirent   *files;
 681     char             buffer[4096];
 682
 683     dir = opendir(curdir);
 684
 685     while ((files = readdir(dir))) {
 686         memset(buffer, 0, sizeof(buffer));
 687         if (strstr(files->d_name, "TMP")     ||
 688             strstr(files->d_name, ".stdout") ||
 689             strstr(files->d_name, ".stderr"))
 690         {
 691             snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
 692             if (remove(buffer))
 693                 con_err("error removing temporary file: %s\n", buffer);
 694             else
 695                 con_out("removed temporary file: %s\n", buffer);
 696         }
 697     }
 698
 699     closedir(dir);
 700 }
 701
 702 void task_destroy(const char *curdir) {
 703     /*
 704      * Free all the data in the task list and finally the list itself
 705      * then proceed to cleanup anything else outside the program like
 706      * temporary files.
 707      */
 708     size_t i;
 709     for (i = 0; i < vec_size(task_tasks); i++) {
 710         /*
 711          * Close any open handles to files or processes here.  It's mighty
 712          * annoying to have to do all this cleanup work.
 713          */
 714         if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
 715         if (task_tasks[i].stdoutlog)  fclose     (task_tasks[i].stdoutlog);
 716         if (task_tasks[i].stderrlog)  fclose     (task_tasks[i].stderrlog);
 717
 718         /*
 719          * Only remove the log files if the test actually compiled otherwise
 720          * forget about it.
 721          */
 722         if (task_tasks[i].compiled) {
 723             if (remove(task_tasks[i].stdoutlogfile))
 724                 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
 725             else
 726                 con_out("removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
 727
 728             if (remove(task_tasks[i].stderrlogfile))
 729                 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
 730             else
 731                 con_out("removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
 732         }
 733
 734         /* free util_strdup data for log files */
 735         mem_d(task_tasks[i].stdoutlogfile);
 736         mem_d(task_tasks[i].stderrlogfile);
 737
 738         task_template_destroy(&task_tasks[i].template);
 739     }
 740     vec_free(task_tasks);
 741
 742     /*
 743      * Cleanup outside stuff like temporary files.
 744      */
 745     task_cleanup(curdir);
 746 }
 747
 748 /*
 749  * This executes the QCVM task for a specificly compiled progs.dat
 750  * using the template passed into it for call-flags and user defined
 751  * messages.
 752  */
 753 bool task_execute(task_template_t *template) {
 754     bool     success = false;
 755     FILE    *execute;
 756     char     buffer[4096];
 757     memset  (buffer,0,sizeof(buffer));
 758
 759     /*
 760      * Drop the execution flags for the QCVM if none where
 761      * actually specified.
 762      */
 763     if (!strcmp(template->executeflags, "$null")) {
 764         snprintf(buffer,  sizeof(buffer), "%s %s",
 765             task_bins[TASK_EXECUTE],
 766             template->tempfilename
 767         );
 768     } else {
 769         snprintf(buffer,  sizeof(buffer), "%s %s %s",
 770             task_bins[TASK_EXECUTE],
 771             template->executeflags,
 772             template->tempfilename
 773         );
 774     }
 775
 776     con_out("executing qcvm: `%s` [%s]\n",
 777         template->description,
 778         buffer
 779     );
 780
 781     execute = popen(buffer, "r");
 782     if (!execute)
 783         return false;
 784
 785     /*
 786      * Now lets read the lines and compare them to the matches we expect
 787      * and handle accordingly.
 788      */
 789     {
 790         char  *data  = NULL;
 791         size_t size  = 0;
 792         while (util_getline(&data, &size, execute) != EOF) {}
 793
 794         if (!strcmp(data, "No main function found\n")) {
 795             con_err("test failure: `%s` [%s] (No main function found)\n",
 796                 template->description,
 797                 (template->failuremessage) ?
 798                 template->failuremessage : "unknown"
 799             );
 800             pclose(execute);
 801             return false;
 802         }
 803
 804         /*
 805          * Trim newlines from data since they will just break our
 806          * ability to properly validate matches.
 807          */
 808         if  (strrchr(data, '\n'))
 809             *strrchr(data, '\n') = '\0';
 810
 811         /* null list */
 812         if (!strcmp(template->comparematch, "$null"))
 813             success = true;
 814
 815         /*
 816          * We only care about the last line from the output for now
 817          * implementing multi-line match is TODO.
 818          */
 819         if (!strcmp(data, template->comparematch))
 820             success = true;
 821     }
 822     pclose(execute);
 823     return success;
 824 }
 825
 826 /*
 827  * This schedualizes all tasks and actually runs them individually
 828  * this is generally easy for just -compile variants.  For compile and
 829  * execution this takes more work since a task needs to be generated
 830  * from thin air and executed INLINE.
 831  */
 832 void task_schedualize(const char *curdir) {
 833     bool   execute  = false;
 834     char  *back     = NULL;
 835     char  *data     = NULL;
 836     size_t size     = 0;
 837     size_t i;
 838
 839     for (i = 0; i < vec_size(task_tasks); i++) {
 840         /*
 841         * Generate a task from thin air if it requires execution in
 842         * the QCVM.
 843         */
 844         if (!strcmp(task_tasks[i].template->proceduretype, "-execute"))
 845             execute = true;
 846
 847         /*
 848          * We assume it compiled before we actually compiled :).  On error
 849          * we change the value
 850          */
 851         task_tasks[i].compiled = true;
 852
 853         /*
 854          * Read data from stdout first and pipe that stuff into a log file
 855          * then we do the same for stderr.
 856          */
 857         while (util_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
 858             back = data;
 859             fputs(data, task_tasks[i].stdoutlog);
 860             fflush(task_tasks[i].stdoutlog);
 861         }
 862         while (util_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
 863             back = data;
 864             /*
 865              * If a string contains an error we just dissalow execution
 866              * of it in the vm.
 867              *
 868              * TODO: make this more percise, e.g if we print a warning
 869              * that refers to a variable named error, or something like
 870              * that .. then this will blowup :P
 871              */
 872             if (strstr(data, "error")) {
 873                 execute                = false;
 874                 task_tasks[i].compiled = false;
 875             }
 876
 877             fputs(data, task_tasks[i].stderrlog);
 878             fflush(task_tasks[i].stdoutlog);
 879         }
 880
 881         if (back)
 882             mem_d(back);
 883
 884         /*
 885          * If we can execute we do so after all data has been read and
 886          * this paticular task has coupled execution in its procedure type
 887          */
 888         if (!execute)
 889             continue;
 890
 891         /*
 892          * If we made it here that concludes the task is to be executed
 893          * in the virtual machine.
 894          */
 895         if (!task_execute(task_tasks[i].template)) {
 896             con_err("test failure: `%s` [%s]\n",
 897                 task_tasks[i].template->description,
 898                 (task_tasks[i].template->failuremessage) ?
 899                 task_tasks[i].template->failuremessage : "unknown"
 900             );
 901             continue;
 902         }
 903
 904         con_out("test succeed: `%s` [%s]\n",
 905             task_tasks[i].template->description,
 906             (task_tasks[i].template->successmessage) ?
 907             task_tasks[i].template->successmessage  : "unknown"
 908         );
 909     }
 910     if (back)
 911         mem_d(back);
 912 }
 913
 914 /*
 915  * This is the heart of the whole test-suite process.  This cleans up
 916  * any existing temporary files left behind as well as log files left
 917  * behind.  Then it propogates a list of tests from `curdir` by scaning
 918  * it for template files and compiling them into tasks, in which it
 919  * schedualizes them (executes them) and actually reports errors and
 920  * what not.  It then proceeds to destroy the tasks and return memory
 921  * it's the engine :)
 922  *
 923  * It returns true of tests could be propogated, otherwise it returns
 924  * false.
 925  *
 926  * It expects con_init() was called before hand.
 927  */
 928 bool test_perform(const char *curdir) {
 929     task_precleanup(curdir);
 930     if (!task_propogate(curdir)) {
 931         con_err("error: failed to propogate tasks\n");
 932         task_destroy(curdir);
 933         return false;
 934     }
 935     /*
 936      * If we made it here all tasks where propogated from their resultant
 937      * template file.  So we can start the FILO scheduler, this has been
 938      * designed in the most thread-safe way possible for future threading
 939      * it's designed to prevent lock contention, and possible syncronization
 940      * issues.
 941      */
 942     task_schedualize(curdir);
 943     task_destroy(curdir);
 944
 945     return true;
 946 }
 947
 948 int main(int argc, char **argv) {
 949     con_init();
 950     test_perform("tests");
 951     util_meminfo();
 952     return 0;
 953 }