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");
185 void task_pclose(FILE **files) {
186 popen_t *open = ((popen_t*)files) - 1;
187 fs_file_close(files[1]);
188 fs_file_close(files[2]);
189 remove(open->name_err);
190 remove(open->name_out);
196 #define TASK_COMPILE 0
197 #define TASK_EXECUTE 1
199 * Task template system:
200 * templates are rules for a specific test, used to create a "task" that
201 * is executed with those set of rules (arguments, and what not). Tests
202 * that don't have a template with them cannot become tasks, since without
203 * the information for that test there is no way to properly "test" them.
204 * Rules for these templates are described in a template file, using a
205 * task template language.
207 * The language is a basic finite statemachine, top-down single-line
208 * description language.
210 * The languge is composed entierly of "tags" which describe a string of
211 * text for a task. Think of it much like a configuration file. Except
212 * it's been designed to allow flexibility and future support for prodecual
215 * The following "tags" are suported by the language
218 * Used to set a description of the current test, this must be
219 * provided, this tag is NOT optional.
222 * Used to set the procedure for the given task, there are two
225 * This simply performs compilation only
227 * This will perform compilation and execution
229 * This will perform compilation, but requires
230 * the compilation to fail in order to succeed.
232 * This must be provided, this tag is NOT optional.
235 * Used to set the compilation flags for the given task, this
236 * must be provided, this tag is NOT optional.
238 * F: Used to set some test suite flags, currently the only option
239 * is -no-defs (to including of defs.qh)
242 * Used to set the execution flags for the given task. This tag
243 * must be provided if T == -execute, otherwise it's erroneous
244 * as compilation only takes place.
247 * Used to describe a string of text that should be matched from
248 * the output of executing the task. If this doesn't match the
249 * task fails. This tag must be provided if T == -execute, otherwise
250 * it's erroneous as compilation only takes place.
253 * Used to specify the INPUT source file to operate on, this must be
254 * provided, this tag is NOT optional
258 * These tags have one-time use, using them more than once will result
259 * in template compilation errors.
261 * Lines beginning with # or // in the template file are comments and
262 * are ignored by the template parser.
264 * Whitespace is optional, with exception to the colon ':' between the
265 * tag and it's assignment value/
267 * The template compiler will detect erronrous tags (optional tags
268 * that need not be set), as well as missing tags, and error accordingly
269 * this will result in the task failing.
284 * This is very much like a compiler code generator :-). This generates
285 * a value from some data observed from the compiler.
287 bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
290 char **destval = NULL;
296 case 'D': destval = &tmpl->description; break;
297 case 'T': destval = &tmpl->proceduretype; break;
298 case 'C': destval = &tmpl->compileflags; break;
299 case 'E': destval = &tmpl->executeflags; break;
300 case 'I': destval = &tmpl->sourcefile; break;
301 case 'F': destval = &tmpl->testflags; break;
303 con_printmsg(LVL_ERROR, __FILE__, __LINE__, "internal error",
304 "invalid tag `%c:` during code generation\n",
311 * Ensure if for the given tag, there already exists a
315 con_printmsg(LVL_ERROR, file, line, "compile error",
316 "tag `%c:` already assigned value: %s\n",
323 * Strip any whitespace that might exist in the value for assignments
326 if (value && *value && (*value == ' ' || *value == '\t'))
330 * Value will contain a newline character at the end, we need to strip
331 * this otherwise kaboom, seriously, kaboom :P
333 if (strchr(value, '\n'))
334 *strrchr(value, '\n')='\0';
335 else /* cppcheck: possible nullpointer dereference */
339 * Now allocate and set the actual value for the specific tag. Which
340 * was properly selected and can be accessed with *destval.
342 *destval = util_strdup(value);
345 if (*destval == tmpl->description) {
347 * Create some padding for the description to align the
348 * printing of the rules file.
350 if ((desclen = strlen(tmpl->description)) > pad[0])
354 if ((filelen = strlen(file)) > pad[2])
360 bool task_template_parse(const char *file, task_template_t *tmpl, FILE *fp, size_t *pad) {
369 /* top down parsing */
370 while (fs_file_getline(&back, &size, fp) != EOF) {
371 /* skip whitespace */
373 if (*data && (*data == ' ' || *data == '\t'))
378 * Handle comments inside task tmpl files. We're strict
379 * about the language for fun :-)
382 if (data[1] != '/') {
383 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
384 "invalid character `/`, perhaps you meant `//` ?");
393 * Empty newlines are acceptable as well, so we handle that here
394 * despite being just odd since there should't be that many
395 * empty lines to begin with.
403 * Now begin the actual "tag" stuff. This works as you expect
412 if (data[1] != ':') {
413 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
414 "expected `:` after `%c`",
419 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
420 con_printmsg(LVL_ERROR, file, line, "tmpl compile error",
421 "failed to generate for given task\n"
428 * Match requires it's own system since we allow multiple M's
429 * for multi-line matching.
433 char *value = &data[3];
434 if (data[1] != ':') {
435 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
436 "expected `:` after `%c`",
442 if (value && *value && (*value == ' ' || *value == '\t'))
446 * Value will contain a newline character at the end, we need to strip
447 * this otherwise kaboom, seriously, kaboom :P
449 if (strrchr(value, '\n'))
450 *strrchr(value, '\n')='\0';
451 else /* cppcheck: possible null pointer dereference */
454 vec_push(tmpl->comparematch, util_strdup(value));
460 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
461 "invalid tag `%c`", *data
464 /* no break required */
467 /* update line and free old sata */
483 * Nullifies the template data: used during initialization of a new
486 void task_template_nullify(task_template_t *tmpl) {
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;
501 task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
502 /* a page should be enough */
505 FILE *tempfile = NULL;
506 task_template_t *tmpl = NULL;
508 util_snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
510 tempfile = fs_file_open(fullfile, "r");
511 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
512 task_template_nullify(tmpl);
515 * Create some padding for the printing to align the
516 * printing of the rules file to the console.
518 if ((filepadd = strlen(fullfile)) > pad[1])
521 tmpl->rulesfile = util_strdup(fullfile);
524 * Esnure the file even exists for the task, this is pretty useless
528 con_err("template file: %s does not exist or invalid permissions\n",
534 if (!task_template_parse(file, tmpl, tempfile, pad)) {
535 con_err("template parse error: error during parsing\n");
540 * Regardless procedure type, the following tags must exist:
546 if (!tmpl->description) {
547 con_err("template compile error: %s missing `D:` tag\n", file);
550 if (!tmpl->proceduretype) {
551 con_err("template compile error: %s missing `T:` tag\n", file);
554 if (!tmpl->compileflags) {
555 con_err("template compile error: %s missing `C:` tag\n", file);
558 if (!tmpl->sourcefile) {
559 con_err("template compile error: %s missing `I:` tag\n", file);
564 * Now lets compile the template, compilation is really just
565 * the process of validating the input.
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);
573 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
574 if (!tmpl->executeflags) {
575 /* default to $null */
576 tmpl->executeflags = util_strdup("$null");
578 if (!tmpl->comparematch) {
579 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
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, "-pp")) {
588 if (tmpl->executeflags)
589 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
590 if (!tmpl->comparematch) {
591 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
595 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
600 fs_file_close(tempfile);
605 * The file might not exist and we jump here when that doesn't happen
606 * so the check to see if it's not null here is required.
609 fs_file_close(tempfile);
615 void task_template_destroy(task_template_t **tmpl) {
619 if ((*tmpl)->description) mem_d((*tmpl)->description);
620 if ((*tmpl)->proceduretype) mem_d((*tmpl)->proceduretype);
621 if ((*tmpl)->compileflags) mem_d((*tmpl)->compileflags);
622 if ((*tmpl)->executeflags) mem_d((*tmpl)->executeflags);
623 if ((*tmpl)->sourcefile) mem_d((*tmpl)->sourcefile);
624 if ((*tmpl)->rulesfile) mem_d((*tmpl)->rulesfile);
625 if ((*tmpl)->testflags) mem_d((*tmpl)->testflags);
628 * Delete all allocated string for task tmpl then destroy the
633 for (; i < vec_size((*tmpl)->comparematch); i++)
634 mem_d((*tmpl)->comparematch[i]);
636 vec_free((*tmpl)->comparematch);
640 * Nullify all the template members otherwise NULL comparision
641 * checks will fail if tmpl pointer is reused.
647 * Now comes the task manager, this system allows adding tasks in and out
648 * of a task list. This is the executor of the tasks essentially as well.
651 task_template_t *tmpl;
660 task_t *task_tasks = NULL;
663 * Read a directory and searches for all template files in it
664 * which is later used to run all tests.
666 bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
669 struct dirent *files;
670 struct stat directory;
674 dir = fs_dir_open(curdir);
676 while ((files = fs_dir_read(dir))) {
677 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
679 if (stat(buffer, &directory) == -1) {
680 con_err("internal error: stat failed, aborting\n");
684 /* skip directories */
685 if (S_ISDIR(directory.st_mode))
689 * We made it here, which concludes the file/directory is not
690 * actually a directory, so it must be a file :)
692 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
693 task_template_t *tmpl = task_template_compile(files->d_name, curdir, pad);
694 char buf[4096]; /* one page should be enough */
695 char *qcflags = NULL;
698 util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
701 con_err("error compiling task template: %s\n", files->d_name);
706 * Generate a temportary file name for the output binary
707 * so we don't trample over an existing one.
709 tmpl->tempfilename = NULL;
710 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", curdir, files->d_name);
713 * Additional QCFLAGS enviroment variable may be used
714 * to test compile flags for all tests. This needs to be
715 * BEFORE other flags (so that the .tmpl can override them)
721 getenv_s(&size, buffer, sizeof(buffer), "QCFLAGS");
725 qcflags = getenv("QCFLAGS");
729 * Generate the command required to open a pipe to a process
730 * which will be refered to with a handle in the task for
731 * reading the data from the pipe.
733 if (strcmp(tmpl->proceduretype, "-pp")) {
735 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
736 util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
737 task_bins[TASK_COMPILE],
745 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
746 task_bins[TASK_COMPILE],
757 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
758 util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
759 task_bins[TASK_COMPILE],
766 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
767 task_bins[TASK_COMPILE],
778 /* Preprocessing (qcflags mean shit all here we don't allow them) */
779 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
780 util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
781 task_bins[TASK_COMPILE],
787 util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
788 task_bins[TASK_COMPILE],
799 * The task template was compiled, now lets create a task from
800 * the template data which has now been propagated.
803 if (!(task.runhandles = task_popen(buf, "r"))) {
804 con_err("error opening pipe to process for test: %s\n", tmpl->description);
809 util_debug("TEST", "executing test: `%s` [%s]\n", tmpl->description, buf);
812 * Open up some file desciptors for logging the stdout/stderr
815 util_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
816 task.stdoutlogfile = util_strdup(buf);
817 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
818 con_err("error opening %s for stdout\n", buf);
822 util_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
823 task.stderrlogfile = util_strdup(buf);
824 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
825 con_err("error opening %s for stderr\n", buf);
829 vec_push(task_tasks, task);
833 util_debug("TEST", "compiled %d task template files out of %d\n",
834 vec_size(task_tasks),
843 * Task precleanup removes any existing temporary files or log files
844 * left behind from a previous invoke of the test-suite.
846 void task_precleanup(const char *curdir) {
848 struct dirent *files;
851 dir = fs_dir_open(curdir);
853 while ((files = fs_dir_read(dir))) {
854 if (strstr(files->d_name, "TMP") ||
855 strstr(files->d_name, ".stdout") ||
856 strstr(files->d_name, ".stderr"))
858 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
860 con_err("error removing temporary file: %s\n", buffer);
862 util_debug("TEST", "removed temporary file: %s\n", buffer);
869 void task_destroy(void) {
871 * Free all the data in the task list and finally the list itself
872 * then proceed to cleanup anything else outside the program like
876 for (i = 0; i < vec_size(task_tasks); i++) {
878 * Close any open handles to files or processes here. It's mighty
879 * annoying to have to do all this cleanup work.
881 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
882 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
883 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
886 * Only remove the log files if the test actually compiled otherwise
887 * forget about it (or if it didn't compile, and the procedure type
888 * was set to -fail (meaning it shouldn't compile) .. stil remove)
890 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
891 if (remove(task_tasks[i].stdoutlogfile))
892 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
894 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
895 if (remove(task_tasks[i].stderrlogfile))
896 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
898 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
900 remove(task_tasks[i].tmpl->tempfilename);
903 /* free util_strdup data for log files */
904 mem_d(task_tasks[i].stdoutlogfile);
905 mem_d(task_tasks[i].stderrlogfile);
907 task_template_destroy(&task_tasks[i].tmpl);
909 vec_free(task_tasks);
913 * This executes the QCVM task for a specificly compiled progs.dat
914 * using the template passed into it for call-flags and user defined
915 * messages IF the procedure type is -execute, otherwise it matches
916 * the preprocessor output.
918 bool task_trymatch(task_template_t *tmpl, char ***line) {
920 bool preprocessing = false;
923 memset (buffer,0,sizeof(buffer));
925 if (strcmp(tmpl->proceduretype, "-pp")) {
927 * Drop the execution flags for the QCVM if none where
928 * actually specified.
930 if (!strcmp(tmpl->executeflags, "$null")) {
931 util_snprintf(buffer, sizeof(buffer), "%s %s",
932 task_bins[TASK_EXECUTE],
936 util_snprintf(buffer, sizeof(buffer), "%s %s %s",
937 task_bins[TASK_EXECUTE],
943 util_debug("TEST", "executing qcvm: `%s` [%s]\n",
948 execute = popen(buffer, "r");
953 * we're preprocessing, which means we need to read int
954 * the produced file and do some really weird shit.
956 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
959 preprocessing = true;
963 * Now lets read the lines and compare them to the matches we expect
964 * and handle accordingly.
970 while (fs_file_getline(&data, &size, execute) != EOF) {
971 if (!strcmp(data, "No main function found\n")) {
972 con_err("test failure: `%s` (No main function found) [%s]\n",
977 fs_file_close(execute);
984 * Trim newlines from data since they will just break our
985 * ability to properly validate matches.
987 if (strrchr(data, '\n'))
988 *strrchr(data, '\n') = '\0';
991 * If data is just null now, that means the line was an empty
992 * one and for that, we just ignore it.
997 if (vec_size(tmpl->comparematch) > compare) {
998 if (strcmp(data, tmpl->comparematch[compare++]))
1005 * Copy to output vector for diagnostics if execution match
1008 vec_push(*line, data);
1021 fs_file_close(execute);
1026 const char *task_type(task_template_t *tmpl) {
1027 if (!strcmp(tmpl->proceduretype, "-pp"))
1028 return "type: preprocessor";
1029 if (!strcmp(tmpl->proceduretype, "-execute"))
1030 return "type: execution";
1031 if (!strcmp(tmpl->proceduretype, "-compile"))
1032 return "type: compile";
1033 return "type: fail";
1037 * This schedualizes all tasks and actually runs them individually
1038 * this is generally easy for just -compile variants. For compile and
1039 * execution this takes more work since a task needs to be generated
1040 * from thin air and executed INLINE.
1043 void task_schedualize(size_t *pad) {
1045 bool execute = false;
1047 char **match = NULL;
1052 util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1054 for (; i < vec_size(task_tasks); i++) {
1055 memset(space[1], 0, sizeof(space[1]));
1056 util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1058 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1060 util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].tmpl->description);
1062 * Generate a task from thin air if it requires execution in
1065 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1066 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp"));
1069 * We assume it compiled before we actually compiled :). On error
1070 * we change the value
1072 task_tasks[i].compiled = true;
1075 * Read data from stdout first and pipe that stuff into a log file
1076 * then we do the same for stderr.
1078 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1079 fs_file_puts(task_tasks[i].stdoutlog, data);
1081 if (strstr(data, "failed to open file")) {
1082 task_tasks[i].compiled = false;
1086 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1088 * If a string contains an error we just dissalow execution
1091 * TODO: make this more percise, e.g if we print a warning
1092 * that refers to a variable named error, or something like
1093 * that .. then this will blowup :P
1095 if (strstr(data, "error")) {
1097 task_tasks[i].compiled = false;
1100 fs_file_puts (task_tasks[i].stderrlog, data);
1103 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1104 con_out("failure: `%s` %*s %*s\n",
1105 task_tasks[i].tmpl->description,
1106 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1107 task_tasks[i].tmpl->rulesfile,
1108 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1109 "(failed to compile)"
1115 con_out("succeeded: `%s` %*s %*s\n",
1116 task_tasks[i].tmpl->description,
1117 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1118 task_tasks[i].tmpl->rulesfile,
1119 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1120 task_type(task_tasks[i].tmpl)
1127 * If we made it here that concludes the task is to be executed
1128 * in the virtual machine (or the preprocessor output needs to
1131 if (!task_trymatch(task_tasks[i].tmpl, &match)) {
1134 con_out("failure: `%s` %*s %*s\n",
1135 task_tasks[i].tmpl->description,
1136 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1137 task_tasks[i].tmpl->rulesfile,
1138 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1139 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1140 ? "(invalid results from execution)"
1141 : "(invalid results from preprocessing)"
1143 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1144 ? "(invalid results from execution)"
1145 : "(invalid results from preprocessing)"
1149 * Print nicely formatted expected match lists to console error
1150 * handler for the all the given matches in the template file and
1151 * what was actually returned from executing.
1153 con_out(" Expected From %u Matches: (got %u Matches)\n",
1154 vec_size(task_tasks[i].tmpl->comparematch),
1157 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1158 char *select = task_tasks[i].tmpl->comparematch[d];
1159 size_t length = 40 - strlen(select);
1161 con_out(" Expected: \"%s\"", select);
1164 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1168 * Print the non-expected out (since we are simply not expecting it)
1169 * This will help track down bugs in template files that fail to match
1172 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1173 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1174 con_out(" Expected: Nothing | Got: \"%s\"\n",
1175 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1181 for (j = 0; j < vec_size(match); j++)
1186 for (j = 0; j < vec_size(match); j++)
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)
1203 * This is the heart of the whole test-suite process. This cleans up
1204 * any existing temporary files left behind as well as log files left
1205 * behind. Then it propagates a list of tests from `curdir` by scaning
1206 * it for template files and compiling them into tasks, in which it
1207 * schedualizes them (executes them) and actually reports errors and
1208 * what not. It then proceeds to destroy the tasks and return memory
1209 * it's the engine :)
1211 * It returns true of tests could be propagated, otherwise it returns
1214 * It expects con_init() was called before hand.
1216 GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1217 static const char *default_defs = "defs.qh";
1220 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1225 * If the default definition file isn't set to anything. We will
1226 * use the default_defs here, which is "defs.qc"
1229 defs = default_defs;
1233 task_precleanup(curdir);
1234 if (!task_propagate(curdir, pad, defs)) {
1235 con_err("error: failed to propagate tasks\n");
1240 * If we made it here all tasks where propagated from their resultant
1241 * template file. So we can start the FILO scheduler, this has been
1242 * designed in the most thread-safe way possible for future threading
1243 * it's designed to prevent lock contention, and possible syncronization
1246 task_schedualize(pad);
1253 * Fancy GCC-like LONG parsing allows things like --opt=param with
1254 * assignment operator. This is used for redirecting stdout/stderr
1255 * console to specific files of your choice.
1257 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1259 char **argv = *argv_;
1261 size_t len = strlen(optname);
1263 if (strncmp(argv[0]+ds, optname, len))
1266 /* it's --optname, check how the parameter is supplied */
1267 if (argv[0][ds+len] == '=') {
1268 *out = argv[0]+ds+len+1;
1272 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1275 /* using --opt param */
1282 int main(int argc, char **argv) {
1283 bool succeed = false;
1284 char *redirout = (char*)stdout;
1285 char *redirerr = (char*)stderr;
1291 * Command line option parsing commences now We only need to support
1292 * a few things in the test suite.
1298 if (argv[0][0] == '-') {
1299 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1301 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1303 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1306 con_change(redirout, redirerr);
1308 if (!strcmp(argv[0]+1, "debug")) {
1309 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1312 if (!strcmp(argv[0]+1, "memchk")) {
1313 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1316 if (!strcmp(argv[0]+1, "nocolor")) {
1321 con_err("invalid argument %s\n", argv[0]+1);
1325 con_change(redirout, redirerr);
1326 succeed = test_perform("tests", defs);
1330 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;