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