test.c

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