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