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 +
161 /* TODO: implement */
164 FILE **task_popen(const char *command, const char *mode) {
168 /* TODO: implement */
172 void task_pclose(FILE **files) {
173 /* TODO: implement */
179 #define TASK_COMPILE 0
180 #define TASK_EXECUTE 1
182 * Task template system:
183 * templates are rules for a specific test, used to create a "task" that
184 * is executed with those set of rules (arguments, and what not). Tests
185 * that don't have a template with them cannot become tasks, since without
186 * the information for that test there is no way to properly "test" them.
187 * Rules for these templates are described in a template file, using a
188 * task template language.
190 * The language is a basic finite statemachine, top-down single-line
191 * description language.
193 * The languge is composed entierly of "tags" which describe a string of
194 * text for a task. Think of it much like a configuration file. Except
195 * it's been designed to allow flexibility and future support for prodecual
198 * The following "tags" are suported by the language
201 * Used to set a description of the current test, this must be
202 * provided, this tag is NOT optional.
205 * Used to set the procedure for the given task, there are two
208 * This simply performs compilation only
210 * This will perform compilation and execution
212 * This will perform compilation, but requires
213 * the compilation to fail in order to succeed.
215 * This must be provided, this tag is NOT optional.
218 * Used to set the compilation flags for the given task, this
219 * must be provided, this tag is NOT optional.
221 * F: Used to set some test suite flags, currently the only option
222 * is -no-defs (to including of defs.qh)
225 * Used to set the execution flags for the given task. This tag
226 * must be provided if T == -execute, otherwise it's erroneous
227 * as compilation only takes place.
230 * Used to describe a string of text that should be matched from
231 * the output of executing the task. If this doesn't match the
232 * task fails. This tag must be provided if T == -execute, otherwise
233 * it's erroneous as compilation only takes place.
236 * Used to specify the INPUT source file to operate on, this must be
237 * provided, this tag is NOT optional
241 * These tags have one-time use, using them more than once will result
242 * in template compilation errors.
244 * Lines beginning with # or // in the template file are comments and
245 * are ignored by the template parser.
247 * Whitespace is optional, with exception to the colon ':' between the
248 * tag and it's assignment value/
250 * The template compiler will detect erronrous tags (optional tags
251 * that need not be set), as well as missing tags, and error accordingly
252 * this will result in the task failing.
267 * This is very much like a compiler code generator :-). This generates
268 * a value from some data observed from the compiler.
270 bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
273 char **destval = NULL;
279 case 'D': destval = &tmpl->description; break;
280 case 'T': destval = &tmpl->proceduretype; break;
281 case 'C': destval = &tmpl->compileflags; break;
282 case 'E': destval = &tmpl->executeflags; break;
283 case 'I': destval = &tmpl->sourcefile; break;
284 case 'F': destval = &tmpl->testflags; break;
286 con_printmsg(LVL_ERROR, __FILE__, __LINE__, "internal error",
287 "invalid tag `%c:` during code generation\n",
294 * Ensure if for the given tag, there already exists a
298 con_printmsg(LVL_ERROR, file, line, "compile error",
299 "tag `%c:` already assigned value: %s\n",
306 * Strip any whitespace that might exist in the value for assignments
309 if (value && *value && (*value == ' ' || *value == '\t'))
313 * Value will contain a newline character at the end, we need to strip
314 * this otherwise kaboom, seriously, kaboom :P
316 if (strchr(value, '\n'))
317 *strrchr(value, '\n')='\0';
318 else /* cppcheck: possible nullpointer dereference */
322 * Now allocate and set the actual value for the specific tag. Which
323 * was properly selected and can be accessed with *destval.
325 *destval = util_strdup(value);
328 if (*destval == tmpl->description) {
330 * Create some padding for the description to align the
331 * printing of the rules file.
333 if ((desclen = strlen(tmpl->description)) > pad[0])
337 if ((filelen = strlen(file)) > pad[2])
343 bool task_template_parse(const char *file, task_template_t *tmpl, FILE *fp, size_t *pad) {
352 /* top down parsing */
353 while (fs_file_getline(&back, &size, fp) != EOF) {
354 /* skip whitespace */
356 if (*data && (*data == ' ' || *data == '\t'))
361 * Handle comments inside task tmpl files. We're strict
362 * about the language for fun :-)
365 if (data[1] != '/') {
366 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
367 "invalid character `/`, perhaps you meant `//` ?");
376 * Empty newlines are acceptable as well, so we handle that here
377 * despite being just odd since there should't be that many
378 * empty lines to begin with.
386 * Now begin the actual "tag" stuff. This works as you expect
395 if (data[1] != ':') {
396 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
397 "expected `:` after `%c`",
402 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
403 con_printmsg(LVL_ERROR, file, line, "tmpl compile error",
404 "failed to generate for given task\n"
411 * Match requires it's own system since we allow multiple M's
412 * for multi-line matching.
416 char *value = &data[3];
417 if (data[1] != ':') {
418 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
419 "expected `:` after `%c`",
425 if (value && *value && (*value == ' ' || *value == '\t'))
429 * Value will contain a newline character at the end, we need to strip
430 * this otherwise kaboom, seriously, kaboom :P
432 if (strrchr(value, '\n'))
433 *strrchr(value, '\n')='\0';
434 else /* cppcheck: possible null pointer dereference */
437 vec_push(tmpl->comparematch, util_strdup(value));
443 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
444 "invalid tag `%c`", *data
447 /* no break required */
450 /* update line and free old sata */
466 * Nullifies the template data: used during initialization of a new
469 void task_template_nullify(task_template_t *tmpl) {
473 tmpl->description = NULL;
474 tmpl->proceduretype = NULL;
475 tmpl->compileflags = NULL;
476 tmpl->executeflags = NULL;
477 tmpl->comparematch = NULL;
478 tmpl->sourcefile = NULL;
479 tmpl->tempfilename = NULL;
480 tmpl->rulesfile = NULL;
481 tmpl->testflags = NULL;
484 task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
485 /* a page should be enough */
488 FILE *tempfile = NULL;
489 task_template_t *tmpl = NULL;
491 util_snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
493 tempfile = fs_file_open(fullfile, "r");
494 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
495 task_template_nullify(tmpl);
498 * Create some padding for the printing to align the
499 * printing of the rules file to the console.
501 if ((filepadd = strlen(fullfile)) > pad[1])
504 tmpl->rulesfile = util_strdup(fullfile);
507 * Esnure the file even exists for the task, this is pretty useless
511 con_err("template file: %s does not exist or invalid permissions\n",
517 if (!task_template_parse(file, tmpl, tempfile, pad)) {
518 con_err("template parse error: error during parsing\n");
523 * Regardless procedure type, the following tags must exist:
529 if (!tmpl->description) {
530 con_err("template compile error: %s missing `D:` tag\n", file);
533 if (!tmpl->proceduretype) {
534 con_err("template compile error: %s missing `T:` tag\n", file);
537 if (!tmpl->compileflags) {
538 con_err("template compile error: %s missing `C:` tag\n", file);
541 if (!tmpl->sourcefile) {
542 con_err("template compile error: %s missing `I:` tag\n", file);
547 * Now lets compile the template, compilation is really just
548 * the process of validating the input.
550 if (!strcmp(tmpl->proceduretype, "-compile")) {
551 if (tmpl->executeflags)
552 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
553 if (tmpl->comparematch)
554 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
556 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
557 if (!tmpl->executeflags) {
558 /* default to $null */
559 tmpl->executeflags = util_strdup("$null");
561 if (!tmpl->comparematch) {
562 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
565 } else if (!strcmp(tmpl->proceduretype, "-fail")) {
566 if (tmpl->executeflags)
567 con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
568 if (tmpl->comparematch)
569 con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
570 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
571 if (tmpl->executeflags)
572 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
573 if (!tmpl->comparematch) {
574 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
578 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
583 fs_file_close(tempfile);
588 * The file might not exist and we jump here when that doesn't happen
589 * so the check to see if it's not null here is required.
592 fs_file_close(tempfile);
598 void task_template_destroy(task_template_t **tmpl) {
602 if ((*tmpl)->description) mem_d((*tmpl)->description);
603 if ((*tmpl)->proceduretype) mem_d((*tmpl)->proceduretype);
604 if ((*tmpl)->compileflags) mem_d((*tmpl)->compileflags);
605 if ((*tmpl)->executeflags) mem_d((*tmpl)->executeflags);
606 if ((*tmpl)->sourcefile) mem_d((*tmpl)->sourcefile);
607 if ((*tmpl)->rulesfile) mem_d((*tmpl)->rulesfile);
608 if ((*tmpl)->testflags) mem_d((*tmpl)->testflags);
611 * Delete all allocated string for task tmpl then destroy the
616 for (; i < vec_size((*tmpl)->comparematch); i++)
617 mem_d((*tmpl)->comparematch[i]);
619 vec_free((*tmpl)->comparematch);
623 * Nullify all the template members otherwise NULL comparision
624 * checks will fail if tmpl pointer is reused.
630 * Now comes the task manager, this system allows adding tasks in and out
631 * of a task list. This is the executor of the tasks essentially as well.
634 task_template_t *tmpl;
643 task_t *task_tasks = NULL;
646 * Read a directory and searches for all template files in it
647 * which is later used to run all tests.
649 bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
652 struct dirent *files;
653 struct stat directory;
657 dir = fs_dir_open(curdir);
659 while ((files = fs_dir_read(dir))) {
660 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
662 if (stat(buffer, &directory) == -1) {
663 con_err("internal error: stat failed, aborting\n");
667 /* skip directories */
668 if (S_ISDIR(directory.st_mode))
672 * We made it here, which concludes the file/directory is not
673 * actually a directory, so it must be a file :)
675 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
676 task_template_t *tmpl = task_template_compile(files->d_name, curdir, pad);
677 char buf[4096]; /* one page should be enough */
678 char *qcflags = NULL;
681 util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
684 con_err("error compiling task template: %s\n", files->d_name);
689 * Generate a temportary file name for the output binary
690 * so we don't trample over an existing one.
692 tmpl->tempfilename = NULL;
693 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", curdir, files->d_name);
696 * Additional QCFLAGS enviroment variable may be used
697 * to test compile flags for all tests. This needs to be
698 * BEFORE other flags (so that the .tmpl can override them)
704 getenv_s(&size, buffer, sizeof(buffer), "QCFLAGS");
708 qcflags = getenv("QCFLAGS");
712 * Generate the command required to open a pipe to a process
713 * which will be refered to with a handle in the task for
714 * reading the data from the pipe.
716 if (strcmp(tmpl->proceduretype, "-pp")) {
718 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
719 util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
720 task_bins[TASK_COMPILE],
728 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
729 task_bins[TASK_COMPILE],
740 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
741 util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
742 task_bins[TASK_COMPILE],
749 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
750 task_bins[TASK_COMPILE],
761 /* Preprocessing (qcflags mean shit all here we don't allow them) */
762 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
763 util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
764 task_bins[TASK_COMPILE],
770 util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
771 task_bins[TASK_COMPILE],
782 * The task template was compiled, now lets create a task from
783 * the template data which has now been propagated.
786 if (!(task.runhandles = task_popen(buf, "r"))) {
787 con_err("error opening pipe to process for test: %s\n", tmpl->description);
792 util_debug("TEST", "executing test: `%s` [%s]\n", tmpl->description, buf);
795 * Open up some file desciptors for logging the stdout/stderr
798 util_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
799 task.stdoutlogfile = util_strdup(buf);
800 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
801 con_err("error opening %s for stdout\n", buf);
805 util_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
806 task.stderrlogfile = util_strdup(buf);
807 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
808 con_err("error opening %s for stderr\n", buf);
812 vec_push(task_tasks, task);
816 util_debug("TEST", "compiled %d task template files out of %d\n",
817 vec_size(task_tasks),
826 * Task precleanup removes any existing temporary files or log files
827 * left behind from a previous invoke of the test-suite.
829 void task_precleanup(const char *curdir) {
831 struct dirent *files;
834 dir = fs_dir_open(curdir);
836 while ((files = fs_dir_read(dir))) {
837 if (strstr(files->d_name, "TMP") ||
838 strstr(files->d_name, ".stdout") ||
839 strstr(files->d_name, ".stderr"))
841 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
843 con_err("error removing temporary file: %s\n", buffer);
845 util_debug("TEST", "removed temporary file: %s\n", buffer);
852 void task_destroy(void) {
854 * Free all the data in the task list and finally the list itself
855 * then proceed to cleanup anything else outside the program like
859 for (i = 0; i < vec_size(task_tasks); i++) {
861 * Close any open handles to files or processes here. It's mighty
862 * annoying to have to do all this cleanup work.
864 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
865 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
866 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
869 * Only remove the log files if the test actually compiled otherwise
870 * forget about it (or if it didn't compile, and the procedure type
871 * was set to -fail (meaning it shouldn't compile) .. stil remove)
873 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
874 if (remove(task_tasks[i].stdoutlogfile))
875 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
877 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
878 if (remove(task_tasks[i].stderrlogfile))
879 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
881 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
883 remove(task_tasks[i].tmpl->tempfilename);
886 /* free util_strdup data for log files */
887 mem_d(task_tasks[i].stdoutlogfile);
888 mem_d(task_tasks[i].stderrlogfile);
890 task_template_destroy(&task_tasks[i].tmpl);
892 vec_free(task_tasks);
896 * This executes the QCVM task for a specificly compiled progs.dat
897 * using the template passed into it for call-flags and user defined
898 * messages IF the procedure type is -execute, otherwise it matches
899 * the preprocessor output.
901 bool task_trymatch(task_template_t *tmpl, char ***line) {
903 bool preprocessing = false;
906 memset (buffer,0,sizeof(buffer));
908 if (strcmp(tmpl->proceduretype, "-pp")) {
910 * Drop the execution flags for the QCVM if none where
911 * actually specified.
913 if (!strcmp(tmpl->executeflags, "$null")) {
914 util_snprintf(buffer, sizeof(buffer), "%s %s",
915 task_bins[TASK_EXECUTE],
919 util_snprintf(buffer, sizeof(buffer), "%s %s %s",
920 task_bins[TASK_EXECUTE],
926 util_debug("TEST", "executing qcvm: `%s` [%s]\n",
931 execute = popen(buffer, "r");
936 * we're preprocessing, which means we need to read int
937 * the produced file and do some really weird shit.
939 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
942 preprocessing = true;
946 * Now lets read the lines and compare them to the matches we expect
947 * and handle accordingly.
953 while (fs_file_getline(&data, &size, execute) != EOF) {
954 if (!strcmp(data, "No main function found\n")) {
955 con_err("test failure: `%s` (No main function found) [%s]\n",
960 fs_file_close(execute);
967 * Trim newlines from data since they will just break our
968 * ability to properly validate matches.
970 if (strrchr(data, '\n'))
971 *strrchr(data, '\n') = '\0';
974 * If data is just null now, that means the line was an empty
975 * one and for that, we just ignore it.
980 if (vec_size(tmpl->comparematch) > compare) {
981 if (strcmp(data, tmpl->comparematch[compare++]))
988 * Copy to output vector for diagnostics if execution match
991 vec_push(*line, data);
1004 fs_file_close(execute);
1009 const char *task_type(task_template_t *tmpl) {
1010 if (!strcmp(tmpl->proceduretype, "-pp"))
1011 return "type: preprocessor";
1012 if (!strcmp(tmpl->proceduretype, "-execute"))
1013 return "type: execution";
1014 if (!strcmp(tmpl->proceduretype, "-compile"))
1015 return "type: compile";
1016 return "type: fail";
1020 * This schedualizes all tasks and actually runs them individually
1021 * this is generally easy for just -compile variants. For compile and
1022 * execution this takes more work since a task needs to be generated
1023 * from thin air and executed INLINE.
1026 void task_schedualize(size_t *pad) {
1028 bool execute = false;
1030 char **match = NULL;
1035 util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1037 for (; i < vec_size(task_tasks); i++) {
1038 memset(space[1], 0, sizeof(space[1]));
1039 util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1041 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1043 util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].tmpl->description);
1045 * Generate a task from thin air if it requires execution in
1048 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1049 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp"));
1052 * We assume it compiled before we actually compiled :). On error
1053 * we change the value
1055 task_tasks[i].compiled = true;
1058 * Read data from stdout first and pipe that stuff into a log file
1059 * then we do the same for stderr.
1061 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1062 fs_file_puts(task_tasks[i].stdoutlog, data);
1064 if (strstr(data, "failed to open file")) {
1065 task_tasks[i].compiled = false;
1069 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1071 * If a string contains an error we just dissalow execution
1074 * TODO: make this more percise, e.g if we print a warning
1075 * that refers to a variable named error, or something like
1076 * that .. then this will blowup :P
1078 if (strstr(data, "error")) {
1080 task_tasks[i].compiled = false;
1083 fs_file_puts (task_tasks[i].stderrlog, data);
1086 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1087 con_out("failure: `%s` %*s %*s\n",
1088 task_tasks[i].tmpl->description,
1089 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1090 task_tasks[i].tmpl->rulesfile,
1091 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1092 "(failed to compile)"
1098 con_out("succeeded: `%s` %*s %*s\n",
1099 task_tasks[i].tmpl->description,
1100 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1101 task_tasks[i].tmpl->rulesfile,
1102 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1103 task_type(task_tasks[i].tmpl)
1110 * If we made it here that concludes the task is to be executed
1111 * in the virtual machine (or the preprocessor output needs to
1114 if (!task_trymatch(task_tasks[i].tmpl, &match)) {
1117 con_out("failure: `%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(
1122 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1123 ? "(invalid results from execution)"
1124 : "(invalid results from preprocessing)"
1126 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1127 ? "(invalid results from execution)"
1128 : "(invalid results from preprocessing)"
1132 * Print nicely formatted expected match lists to console error
1133 * handler for the all the given matches in the template file and
1134 * what was actually returned from executing.
1136 con_out(" Expected From %u Matches: (got %u Matches)\n",
1137 vec_size(task_tasks[i].tmpl->comparematch),
1140 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1141 char *select = task_tasks[i].tmpl->comparematch[d];
1142 size_t length = 40 - strlen(select);
1144 con_out(" Expected: \"%s\"", select);
1147 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1151 * Print the non-expected out (since we are simply not expecting it)
1152 * This will help track down bugs in template files that fail to match
1155 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1156 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1157 con_out(" Expected: Nothing | Got: \"%s\"\n",
1158 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1164 for (j = 0; j < vec_size(match); j++)
1169 for (j = 0; j < vec_size(match); j++)
1173 con_out("succeeded: `%s` %*s %*s\n",
1174 task_tasks[i].tmpl->description,
1175 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1176 task_tasks[i].tmpl->rulesfile,
1177 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1178 task_type(task_tasks[i].tmpl)
1186 * This is the heart of the whole test-suite process. This cleans up
1187 * any existing temporary files left behind as well as log files left
1188 * behind. Then it propagates a list of tests from `curdir` by scaning
1189 * it for template files and compiling them into tasks, in which it
1190 * schedualizes them (executes them) and actually reports errors and
1191 * what not. It then proceeds to destroy the tasks and return memory
1192 * it's the engine :)
1194 * It returns true of tests could be propagated, otherwise it returns
1197 * It expects con_init() was called before hand.
1199 GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1200 static const char *default_defs = "defs.qh";
1203 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1208 * If the default definition file isn't set to anything. We will
1209 * use the default_defs here, which is "defs.qc"
1212 defs = default_defs;
1216 task_precleanup(curdir);
1217 if (!task_propagate(curdir, pad, defs)) {
1218 con_err("error: failed to propagate tasks\n");
1223 * If we made it here all tasks where propagated from their resultant
1224 * template file. So we can start the FILO scheduler, this has been
1225 * designed in the most thread-safe way possible for future threading
1226 * it's designed to prevent lock contention, and possible syncronization
1229 task_schedualize(pad);
1236 * Fancy GCC-like LONG parsing allows things like --opt=param with
1237 * assignment operator. This is used for redirecting stdout/stderr
1238 * console to specific files of your choice.
1240 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1242 char **argv = *argv_;
1244 size_t len = strlen(optname);
1246 if (strncmp(argv[0]+ds, optname, len))
1249 /* it's --optname, check how the parameter is supplied */
1250 if (argv[0][ds+len] == '=') {
1251 *out = argv[0]+ds+len+1;
1255 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1258 /* using --opt param */
1265 int main(int argc, char **argv) {
1266 bool succeed = false;
1267 char *redirout = (char*)stdout;
1268 char *redirerr = (char*)stderr;
1274 * Command line option parsing commences now We only need to support
1275 * a few things in the test suite.
1281 if (argv[0][0] == '-') {
1282 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1284 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1286 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1289 con_change(redirout, redirerr);
1291 if (!strcmp(argv[0]+1, "debug")) {
1292 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1295 if (!strcmp(argv[0]+1, "memchk")) {
1296 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1299 if (!strcmp(argv[0]+1, "nocolor")) {
1304 con_err("invalid argument %s\n", argv[0]+1);
1308 con_change(redirout, redirerr);
1309 succeed = test_perform("tests", defs);
1313 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;