test.c

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