2 * Copyright (C) 2012, 2013
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:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
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
24 #include <sys/types.h>
29 const char *task_bins[] = {
35 * TODO: Windows version
36 * this implements a unique bi-directional popen-like function that
37 * allows reading data from both stdout and stderr. And writing to
41 * FILE *handles[3] = task_popen("ls", "-l", "r");
42 * if (!handles) { perror("failed to open stdin/stdout/stderr to ls");
43 * // handles[0] = stdin
44 * // handles[1] = stdout
45 * // handles[2] = stderr
47 * task_pclose(handles); // to close
50 #include <sys/types.h>
63 FILE ** task_popen(const char *command, const char *mode) {
69 popen_t *data = (popen_t*)mem_a(sizeof(popen_t));
72 * Parse the command now into a list for execv, this is a pain
75 char *line = (char*)command;
79 while (*line != '\0') {
80 while (*line == ' ' || *line == '\t' || *line == '\n')
84 while (*line != '\0' && *line != ' ' &&
85 *line != '\t' && *line != '\n') line++;
91 if ((trypipe = pipe(inhandle)) < 0) goto task_popen_error_0;
92 if ((trypipe = pipe(outhandle)) < 0) goto task_popen_error_1;
93 if ((trypipe = pipe(errhandle)) < 0) goto task_popen_error_2;
95 if ((data->pid = fork()) > 0) {
101 data->pipes [0] = inhandle [1];
102 data->pipes [1] = outhandle[0];
103 data->pipes [2] = errhandle[0];
104 data->handles[0] = fdopen(inhandle [1], "w");
105 data->handles[1] = fdopen(outhandle[0], mode);
106 data->handles[2] = fdopen(errhandle[0], mode);
111 return data->handles;
112 } else if (data->pid == 0) {
118 /* see piping documentation for this sillyness :P */
119 close(0), dup(inhandle [0]);
120 close(1), dup(outhandle[1]);
121 close(2), dup(errhandle[1]);
127 goto task_popen_error_3;
130 task_popen_error_3: close(errhandle[0]), close(errhandle[1]);
131 task_popen_error_2: close(outhandle[0]), close(outhandle[1]);
132 task_popen_error_1: close(inhandle [0]), close(inhandle [1]);
140 int task_pclose(FILE **handles) {
141 popen_t *data = (popen_t*)handles;
144 close(data->pipes[0]); /* stdin */
145 close(data->pipes[1]); /* stdout */
146 close(data->pipes[2]); /* stderr */
148 waitpid(data->pid, &status, 0);
156 * Bidirectional piping implementation for windows using CreatePipe and DuplicateHandle +
160 char name_err[L_tmpnam];
161 char name_out[L_tmpnam];
164 FILE **task_popen(const char *command, const char *mode) {
165 FILE **handles = NULL;
167 popen_t *open = (popen_t*)mem_a(sizeof(popen_t) * 3);
169 tmpnam(open->name_err);
170 tmpnam(open->name_out);
172 (void)mode; /* excluded */
174 util_asprintf(&cmd, "%s -redirout=%s -redirerr=%s", command, open->name_out, open->name_err);
176 system(cmd); /* HACK */
177 handles = (FILE**)(open + 1);
179 handles[1] = fs_file_open(open->name_out, "r");
180 handles[2] = fs_file_open(open->name_err, "r");
187 void task_pclose(FILE **files) {
188 popen_t *open = ((popen_t*)files) - 1;
189 fs_file_close(files[1]);
190 fs_file_close(files[2]);
191 remove(open->name_err);
192 remove(open->name_out);
198 #define TASK_COMPILE 0
199 #define TASK_EXECUTE 1
201 * Task template system:
202 * templates are rules for a specific test, used to create a "task" that
203 * is executed with those set of rules (arguments, and what not). Tests
204 * that don't have a template with them cannot become tasks, since without
205 * the information for that test there is no way to properly "test" them.
206 * Rules for these templates are described in a template file, using a
207 * task template language.
209 * The language is a basic finite statemachine, top-down single-line
210 * description language.
212 * The languge is composed entierly of "tags" which describe a string of
213 * text for a task. Think of it much like a configuration file. Except
214 * it's been designed to allow flexibility and future support for prodecual
217 * The following "tags" are suported by the language
220 * Used to set a description of the current test, this must be
221 * provided, this tag is NOT optional.
224 * Used to set the procedure for the given task, there are two
227 * This simply performs compilation only
229 * This will perform compilation and execution
231 * This will perform compilation, but requires
232 * the compilation to fail in order to succeed.
234 * This must be provided, this tag is NOT optional.
237 * Used to set the compilation flags for the given task, this
238 * must be provided, this tag is NOT optional.
240 * F: Used to set some test suite flags, currently the only option
241 * is -no-defs (to including of defs.qh)
244 * Used to set the execution flags for the given task. This tag
245 * must be provided if T == -execute, otherwise it's erroneous
246 * as compilation only takes place.
249 * Used to describe a string of text that should be matched from
250 * the output of executing the task. If this doesn't match the
251 * task fails. This tag must be provided if T == -execute, otherwise
252 * it's erroneous as compilation only takes place.
255 * Used to specify the INPUT source file to operate on, this must be
256 * provided, this tag is NOT optional
260 * These tags have one-time use, using them more than once will result
261 * in template compilation errors.
263 * Lines beginning with # or // in the template file are comments and
264 * are ignored by the template parser.
266 * Whitespace is optional, with exception to the colon ':' between the
267 * tag and it's assignment value/
269 * The template compiler will detect erronrous tags (optional tags
270 * that need not be set), as well as missing tags, and error accordingly
271 * this will result in the task failing.
286 * This is very much like a compiler code generator :-). This generates
287 * a value from some data observed from the compiler.
289 bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
292 char **destval = NULL;
298 case 'D': destval = &tmpl->description; break;
299 case 'T': destval = &tmpl->proceduretype; break;
300 case 'C': destval = &tmpl->compileflags; break;
301 case 'E': destval = &tmpl->executeflags; break;
302 case 'I': destval = &tmpl->sourcefile; break;
303 case 'F': destval = &tmpl->testflags; break;
305 con_printmsg(LVL_ERROR, __FILE__, __LINE__, "internal error",
306 "invalid tag `%c:` during code generation\n",
313 * Ensure if for the given tag, there already exists a
317 con_printmsg(LVL_ERROR, file, line, "compile error",
318 "tag `%c:` already assigned value: %s\n",
325 * Strip any whitespace that might exist in the value for assignments
328 if (value && *value && (*value == ' ' || *value == '\t'))
332 * Value will contain a newline character at the end, we need to strip
333 * this otherwise kaboom, seriously, kaboom :P
335 if (strchr(value, '\n'))
336 *strrchr(value, '\n')='\0';
337 else /* cppcheck: possible nullpointer dereference */
341 * Now allocate and set the actual value for the specific tag. Which
342 * was properly selected and can be accessed with *destval.
344 *destval = util_strdup(value);
347 if (*destval == tmpl->description) {
349 * Create some padding for the description to align the
350 * printing of the rules file.
352 if ((desclen = strlen(tmpl->description)) > pad[0])
356 if ((filelen = strlen(file)) > pad[2])
362 bool task_template_parse(const char *file, task_template_t *tmpl, FILE *fp, size_t *pad) {
371 /* top down parsing */
372 while (fs_file_getline(&back, &size, fp) != EOF) {
373 /* skip whitespace */
375 if (*data && (*data == ' ' || *data == '\t'))
380 * Handle comments inside task tmpl files. We're strict
381 * about the language for fun :-)
384 if (data[1] != '/') {
385 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
386 "invalid character `/`, perhaps you meant `//` ?");
395 * Empty newlines are acceptable as well, so we handle that here
396 * despite being just odd since there should't be that many
397 * empty lines to begin with.
405 * Now begin the actual "tag" stuff. This works as you expect
414 if (data[1] != ':') {
415 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
416 "expected `:` after `%c`",
421 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
422 con_printmsg(LVL_ERROR, file, line, "tmpl compile error",
423 "failed to generate for given task\n"
430 * Match requires it's own system since we allow multiple M's
431 * for multi-line matching.
435 char *value = &data[3];
436 if (data[1] != ':') {
437 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
438 "expected `:` after `%c`",
444 if (value && *value && (*value == ' ' || *value == '\t'))
448 * Value will contain a newline character at the end, we need to strip
449 * this otherwise kaboom, seriously, kaboom :P
451 if (strrchr(value, '\n'))
452 *strrchr(value, '\n')='\0';
453 else /* cppcheck: possible null pointer dereference */
456 vec_push(tmpl->comparematch, util_strdup(value));
462 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
463 "invalid tag `%c`", *data
466 /* no break required */
469 /* update line and free old sata */
485 * Nullifies the template data: used during initialization of a new
488 void task_template_nullify(task_template_t *tmpl) {
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;
503 task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
504 /* a page should be enough */
507 FILE *tempfile = NULL;
508 task_template_t *tmpl = NULL;
510 util_snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
512 tempfile = fs_file_open(fullfile, "r");
513 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
514 task_template_nullify(tmpl);
517 * Create some padding for the printing to align the
518 * printing of the rules file to the console.
520 if ((filepadd = strlen(fullfile)) > pad[1])
523 tmpl->rulesfile = util_strdup(fullfile);
526 * Esnure the file even exists for the task, this is pretty useless
530 con_err("template file: %s does not exist or invalid permissions\n",
536 if (!task_template_parse(file, tmpl, tempfile, pad)) {
537 con_err("template parse error: error during parsing\n");
542 * Regardless procedure type, the following tags must exist:
548 if (!tmpl->description) {
549 con_err("template compile error: %s missing `D:` tag\n", file);
552 if (!tmpl->proceduretype) {
553 con_err("template compile error: %s missing `T:` tag\n", file);
556 if (!tmpl->compileflags) {
557 con_err("template compile error: %s missing `C:` tag\n", file);
560 if (!tmpl->sourcefile) {
561 con_err("template compile error: %s missing `I:` tag\n", file);
566 * Now lets compile the template, compilation is really just
567 * the process of validating the input.
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);
575 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
576 if (!tmpl->executeflags) {
577 /* default to $null */
578 tmpl->executeflags = util_strdup("$null");
580 if (!tmpl->comparematch) {
581 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
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, "-pp")) {
590 if (tmpl->executeflags)
591 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
592 if (!tmpl->comparematch) {
593 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
597 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
602 fs_file_close(tempfile);
607 * The file might not exist and we jump here when that doesn't happen
608 * so the check to see if it's not null here is required.
611 fs_file_close(tempfile);
617 void task_template_destroy(task_template_t **tmpl) {
621 if ((*tmpl)->description) mem_d((*tmpl)->description);
622 if ((*tmpl)->proceduretype) mem_d((*tmpl)->proceduretype);
623 if ((*tmpl)->compileflags) mem_d((*tmpl)->compileflags);
624 if ((*tmpl)->executeflags) mem_d((*tmpl)->executeflags);
625 if ((*tmpl)->sourcefile) mem_d((*tmpl)->sourcefile);
626 if ((*tmpl)->rulesfile) mem_d((*tmpl)->rulesfile);
627 if ((*tmpl)->testflags) mem_d((*tmpl)->testflags);
630 * Delete all allocated string for task tmpl then destroy the
635 for (; i < vec_size((*tmpl)->comparematch); i++)
636 mem_d((*tmpl)->comparematch[i]);
638 vec_free((*tmpl)->comparematch);
642 * Nullify all the template members otherwise NULL comparision
643 * checks will fail if tmpl pointer is reused.
649 * Now comes the task manager, this system allows adding tasks in and out
650 * of a task list. This is the executor of the tasks essentially as well.
653 task_template_t *tmpl;
662 task_t *task_tasks = NULL;
665 * Read a directory and searches for all template files in it
666 * which is later used to run all tests.
668 bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
671 struct dirent *files;
672 struct stat directory;
676 dir = fs_dir_open(curdir);
678 while ((files = fs_dir_read(dir))) {
679 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
681 if (stat(buffer, &directory) == -1) {
682 con_err("internal error: stat failed, aborting\n");
686 /* skip directories */
687 if (S_ISDIR(directory.st_mode))
691 * We made it here, which concludes the file/directory is not
692 * actually a directory, so it must be a file :)
694 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
695 task_template_t *tmpl = task_template_compile(files->d_name, curdir, pad);
696 char buf[4096]; /* one page should be enough */
697 char *qcflags = NULL;
700 util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
703 con_err("error compiling task template: %s\n", files->d_name);
708 * Generate a temportary file name for the output binary
709 * so we don't trample over an existing one.
711 tmpl->tempfilename = NULL;
712 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", curdir, files->d_name);
715 * Additional QCFLAGS enviroment variable may be used
716 * to test compile flags for all tests. This needs to be
717 * BEFORE other flags (so that the .tmpl can override them)
723 getenv_s(&size, buffer, sizeof(buffer), "QCFLAGS");
727 qcflags = getenv("QCFLAGS");
731 * Generate the command required to open a pipe to a process
732 * which will be refered to with a handle in the task for
733 * reading the data from the pipe.
735 if (strcmp(tmpl->proceduretype, "-pp")) {
737 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
738 util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
739 task_bins[TASK_COMPILE],
747 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
748 task_bins[TASK_COMPILE],
759 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
760 util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
761 task_bins[TASK_COMPILE],
768 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
769 task_bins[TASK_COMPILE],
780 /* Preprocessing (qcflags mean shit all here we don't allow them) */
781 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
782 util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
783 task_bins[TASK_COMPILE],
789 util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
790 task_bins[TASK_COMPILE],
801 * The task template was compiled, now lets create a task from
802 * the template data which has now been propagated.
805 if (!(task.runhandles = task_popen(buf, "r"))) {
806 con_err("error opening pipe to process for test: %s\n", tmpl->description);
811 util_debug("TEST", "executing test: `%s` [%s]\n", tmpl->description, buf);
814 * Open up some file desciptors for logging the stdout/stderr
817 util_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
818 task.stdoutlogfile = util_strdup(buf);
819 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
820 con_err("error opening %s for stdout\n", buf);
824 util_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
825 task.stderrlogfile = util_strdup(buf);
826 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
827 con_err("error opening %s for stderr\n", buf);
831 vec_push(task_tasks, task);
835 util_debug("TEST", "compiled %d task template files out of %d\n",
836 vec_size(task_tasks),
845 * Task precleanup removes any existing temporary files or log files
846 * left behind from a previous invoke of the test-suite.
848 void task_precleanup(const char *curdir) {
850 struct dirent *files;
853 dir = fs_dir_open(curdir);
855 while ((files = fs_dir_read(dir))) {
856 if (strstr(files->d_name, "TMP") ||
857 strstr(files->d_name, ".stdout") ||
858 strstr(files->d_name, ".stderr"))
860 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
862 con_err("error removing temporary file: %s\n", buffer);
864 util_debug("TEST", "removed temporary file: %s\n", buffer);
871 void task_destroy(void) {
873 * Free all the data in the task list and finally the list itself
874 * then proceed to cleanup anything else outside the program like
878 for (i = 0; i < vec_size(task_tasks); i++) {
880 * Close any open handles to files or processes here. It's mighty
881 * annoying to have to do all this cleanup work.
883 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
884 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
885 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
888 * Only remove the log files if the test actually compiled otherwise
889 * forget about it (or if it didn't compile, and the procedure type
890 * was set to -fail (meaning it shouldn't compile) .. stil remove)
892 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
893 if (remove(task_tasks[i].stdoutlogfile))
894 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
896 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
897 if (remove(task_tasks[i].stderrlogfile))
898 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
900 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
902 remove(task_tasks[i].tmpl->tempfilename);
905 /* free util_strdup data for log files */
906 mem_d(task_tasks[i].stdoutlogfile);
907 mem_d(task_tasks[i].stderrlogfile);
909 task_template_destroy(&task_tasks[i].tmpl);
911 vec_free(task_tasks);
915 * This executes the QCVM task for a specificly compiled progs.dat
916 * using the template passed into it for call-flags and user defined
917 * messages IF the procedure type is -execute, otherwise it matches
918 * the preprocessor output.
920 bool task_trymatch(task_template_t *tmpl, char ***line) {
922 bool preprocessing = false;
925 memset (buffer,0,sizeof(buffer));
927 if (strcmp(tmpl->proceduretype, "-pp")) {
929 * Drop the execution flags for the QCVM if none where
930 * actually specified.
932 if (!strcmp(tmpl->executeflags, "$null")) {
933 util_snprintf(buffer, sizeof(buffer), "%s %s",
934 task_bins[TASK_EXECUTE],
938 util_snprintf(buffer, sizeof(buffer), "%s %s %s",
939 task_bins[TASK_EXECUTE],
945 util_debug("TEST", "executing qcvm: `%s` [%s]\n",
950 execute = popen(buffer, "r");
955 * we're preprocessing, which means we need to read int
956 * the produced file and do some really weird shit.
958 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
961 preprocessing = true;
965 * Now lets read the lines and compare them to the matches we expect
966 * and handle accordingly.
972 while (fs_file_getline(&data, &size, execute) != EOF) {
973 if (!strcmp(data, "No main function found\n")) {
974 con_err("test failure: `%s` (No main function found) [%s]\n",
979 fs_file_close(execute);
986 * Trim newlines from data since they will just break our
987 * ability to properly validate matches.
989 if (strrchr(data, '\n'))
990 *strrchr(data, '\n') = '\0';
993 * If data is just null now, that means the line was an empty
994 * one and for that, we just ignore it.
999 if (vec_size(tmpl->comparematch) > compare) {
1000 if (strcmp(data, tmpl->comparematch[compare++]))
1007 * Copy to output vector for diagnostics if execution match
1010 vec_push(*line, data);
1023 fs_file_close(execute);
1028 const char *task_type(task_template_t *tmpl) {
1029 if (!strcmp(tmpl->proceduretype, "-pp"))
1030 return "type: preprocessor";
1031 if (!strcmp(tmpl->proceduretype, "-execute"))
1032 return "type: execution";
1033 if (!strcmp(tmpl->proceduretype, "-compile"))
1034 return "type: compile";
1035 return "type: fail";
1039 * This schedualizes all tasks and actually runs them individually
1040 * this is generally easy for just -compile variants. For compile and
1041 * execution this takes more work since a task needs to be generated
1042 * from thin air and executed INLINE.
1045 void task_schedualize(size_t *pad) {
1047 bool execute = false;
1049 char **match = NULL;
1054 util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1056 for (; i < vec_size(task_tasks); i++) {
1057 memset(space[1], 0, sizeof(space[1]));
1058 util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1060 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1062 util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].tmpl->description);
1064 * Generate a task from thin air if it requires execution in
1067 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1068 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp"));
1071 * We assume it compiled before we actually compiled :). On error
1072 * we change the value
1074 task_tasks[i].compiled = true;
1077 * Read data from stdout first and pipe that stuff into a log file
1078 * then we do the same for stderr.
1080 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1081 fs_file_puts(task_tasks[i].stdoutlog, data);
1083 if (strstr(data, "failed to open file")) {
1084 task_tasks[i].compiled = false;
1088 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1090 * If a string contains an error we just dissalow execution
1093 * TODO: make this more percise, e.g if we print a warning
1094 * that refers to a variable named error, or something like
1095 * that .. then this will blowup :P
1097 if (strstr(data, "error")) {
1099 task_tasks[i].compiled = false;
1102 fs_file_puts (task_tasks[i].stderrlog, data);
1105 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1106 con_out("failure: `%s` %*s %*s\n",
1107 task_tasks[i].tmpl->description,
1108 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1109 task_tasks[i].tmpl->rulesfile,
1110 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1111 "(failed to compile)"
1117 con_out("succeeded: `%s` %*s %*s\n",
1118 task_tasks[i].tmpl->description,
1119 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1120 task_tasks[i].tmpl->rulesfile,
1121 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1122 task_type(task_tasks[i].tmpl)
1129 * If we made it here that concludes the task is to be executed
1130 * in the virtual machine (or the preprocessor output needs to
1133 if (!task_trymatch(task_tasks[i].tmpl, &match)) {
1136 con_out("failure: `%s` %*s %*s\n",
1137 task_tasks[i].tmpl->description,
1138 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1139 task_tasks[i].tmpl->rulesfile,
1140 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1141 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1142 ? "(invalid results from execution)"
1143 : "(invalid results from preprocessing)"
1145 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1146 ? "(invalid results from execution)"
1147 : "(invalid results from preprocessing)"
1151 * Print nicely formatted expected match lists to console error
1152 * handler for the all the given matches in the template file and
1153 * what was actually returned from executing.
1155 con_out(" Expected From %u Matches: (got %u Matches)\n",
1156 vec_size(task_tasks[i].tmpl->comparematch),
1159 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1160 char *select = task_tasks[i].tmpl->comparematch[d];
1161 size_t length = 40 - strlen(select);
1163 con_out(" Expected: \"%s\"", select);
1166 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1170 * Print the non-expected out (since we are simply not expecting it)
1171 * This will help track down bugs in template files that fail to match
1174 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1175 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1176 con_out(" Expected: Nothing | Got: \"%s\"\n",
1177 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1183 for (j = 0; j < vec_size(match); j++)
1188 for (j = 0; j < vec_size(match); j++)
1192 con_out("succeeded: `%s` %*s %*s\n",
1193 task_tasks[i].tmpl->description,
1194 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1195 task_tasks[i].tmpl->rulesfile,
1196 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1197 task_type(task_tasks[i].tmpl)
1205 * This is the heart of the whole test-suite process. This cleans up
1206 * any existing temporary files left behind as well as log files left
1207 * behind. Then it propagates a list of tests from `curdir` by scaning
1208 * it for template files and compiling them into tasks, in which it
1209 * schedualizes them (executes them) and actually reports errors and
1210 * what not. It then proceeds to destroy the tasks and return memory
1211 * it's the engine :)
1213 * It returns true of tests could be propagated, otherwise it returns
1216 * It expects con_init() was called before hand.
1218 GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1219 static const char *default_defs = "defs.qh";
1222 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1227 * If the default definition file isn't set to anything. We will
1228 * use the default_defs here, which is "defs.qc"
1231 defs = default_defs;
1235 task_precleanup(curdir);
1236 if (!task_propagate(curdir, pad, defs)) {
1237 con_err("error: failed to propagate tasks\n");
1242 * If we made it here all tasks where propagated from their resultant
1243 * template file. So we can start the FILO scheduler, this has been
1244 * designed in the most thread-safe way possible for future threading
1245 * it's designed to prevent lock contention, and possible syncronization
1248 task_schedualize(pad);
1255 * Fancy GCC-like LONG parsing allows things like --opt=param with
1256 * assignment operator. This is used for redirecting stdout/stderr
1257 * console to specific files of your choice.
1259 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1261 char **argv = *argv_;
1263 size_t len = strlen(optname);
1265 if (strncmp(argv[0]+ds, optname, len))
1268 /* it's --optname, check how the parameter is supplied */
1269 if (argv[0][ds+len] == '=') {
1270 *out = argv[0]+ds+len+1;
1274 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1277 /* using --opt param */
1284 int main(int argc, char **argv) {
1285 bool succeed = false;
1286 char *redirout = (char*)stdout;
1287 char *redirerr = (char*)stderr;
1293 * Command line option parsing commences now We only need to support
1294 * a few things in the test suite.
1300 if (argv[0][0] == '-') {
1301 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1303 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1305 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1308 con_change(redirout, redirerr);
1310 if (!strcmp(argv[0]+1, "debug")) {
1311 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1314 if (!strcmp(argv[0]+1, "memchk")) {
1315 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1318 if (!strcmp(argv[0]+1, "nocolor")) {
1323 con_err("invalid argument %s\n", argv[0]+1);
1327 con_change(redirout, redirerr);
1328 succeed = test_perform("tests", defs);
1332 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;