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
181 #define TASK_PREPROCESS 2
183 * Task template system:
184 * templates are rules for a specific test, used to create a "task" that
185 * is executed with those set of rules (arguments, and what not). Tests
186 * that don't have a template with them cannot become tasks, since without
187 * the information for that test there is no way to properly "test" them.
188 * Rules for these templates are described in a template file, using a
189 * task template language.
191 * The language is a basic finite statemachine, top-down single-line
192 * description language.
194 * The languge is composed entierly of "tags" which describe a string of
195 * text for a task. Think of it much like a configuration file. Except
196 * it's been designed to allow flexibility and future support for prodecual
199 * The following "tags" are suported by the language
202 * Used to set a description of the current test, this must be
203 * provided, this tag is NOT optional.
206 * Used to set the procedure for the given task, there are two
209 * This simply performs compilation only
211 * This will perform compilation and execution
213 * This will perform compilation, but requires
214 * the compilation to fail in order to succeed.
216 * This must be provided, this tag is NOT optional.
219 * Used to set the compilation flags for the given task, this
220 * must be provided, this tag is NOT optional.
222 * F: Used to set some test suite flags, currently the only option
223 * is -no-defs (to including of defs.qh)
226 * Used to set the execution flags for the given task. This tag
227 * must be provided if T == -execute, otherwise it's erroneous
228 * as compilation only takes place.
231 * Used to describe a string of text that should be matched from
232 * the output of executing the task. If this doesn't match the
233 * task fails. This tag must be provided if T == -execute, otherwise
234 * it's erroneous as compilation only takes place.
237 * Used to specify the INPUT source file to operate on, this must be
238 * provided, this tag is NOT optional
242 * These tags have one-time use, using them more than once will result
243 * in template compilation errors.
245 * Lines beginning with # or // in the template file are comments and
246 * are ignored by the template parser.
248 * Whitespace is optional, with exception to the colon ':' between the
249 * tag and it's assignment value/
251 * The template compiler will detect erronrous tags (optional tags
252 * that need not be set), as well as missing tags, and error accordingly
253 * this will result in the task failing.
268 * This is very much like a compiler code generator :-). This generates
269 * a value from some data observed from the compiler.
271 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])
340 bool task_template_parse(const char *file, task_template_t *tmpl, FILE *fp, size_t *pad) {
349 /* top down parsing */
350 while (fs_file_getline(&back, &size, fp) != EOF) {
351 /* skip whitespace */
353 if (*data && (*data == ' ' || *data == '\t'))
358 * Handle comments inside task tmpl files. We're strict
359 * about the language for fun :-)
362 if (data[1] != '/') {
363 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
364 "invalid character `/`, perhaps you meant `//` ?");
373 * Empty newlines are acceptable as well, so we handle that here
374 * despite being just odd since there should't be that many
375 * empty lines to begin with.
383 * Now begin the actual "tag" stuff. This works as you expect
392 if (data[1] != ':') {
393 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
394 "expected `:` after `%c`",
399 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
400 con_printmsg(LVL_ERROR, file, line, "tmpl compile error",
401 "failed to generate for given task\n"
408 * Match requires it's own system since we allow multiple M's
409 * for multi-line matching.
413 char *value = &data[3];
414 if (data[1] != ':') {
415 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
416 "expected `:` after `%c`",
422 if (value && *value && (*value == ' ' || *value == '\t'))
426 * Value will contain a newline character at the end, we need to strip
427 * this otherwise kaboom, seriously, kaboom :P
429 if (strrchr(value, '\n'))
430 *strrchr(value, '\n')='\0';
431 else /* cppcheck: possible null pointer dereference */
434 vec_push(tmpl->comparematch, util_strdup(value));
440 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
441 "invalid tag `%c`", *data
444 /* no break required */
447 /* update line and free old sata */
463 * Nullifies the template data: used during initialization of a new
466 void task_template_nullify(task_template_t *tmpl) {
470 tmpl->description = NULL;
471 tmpl->proceduretype = NULL;
472 tmpl->compileflags = NULL;
473 tmpl->executeflags = NULL;
474 tmpl->comparematch = NULL;
475 tmpl->sourcefile = NULL;
476 tmpl->tempfilename = NULL;
477 tmpl->rulesfile = NULL;
478 tmpl->testflags = NULL;
481 task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
482 /* a page should be enough */
485 FILE *tempfile = NULL;
486 task_template_t *tmpl = NULL;
488 snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
490 tempfile = fs_file_open(fullfile, "r");
491 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
492 task_template_nullify(tmpl);
495 * Create some padding for the printing to align the
496 * printing of the rules file to the console.
498 if ((filepadd = strlen(fullfile)) > pad[1])
501 tmpl->rulesfile = util_strdup(fullfile);
504 * Esnure the file even exists for the task, this is pretty useless
508 con_err("template file: %s does not exist or invalid permissions\n",
514 if (!task_template_parse(file, tmpl, tempfile, pad)) {
515 con_err("template parse error: error during parsing\n");
520 * Regardless procedure type, the following tags must exist:
526 if (!tmpl->description) {
527 con_err("template compile error: %s missing `D:` tag\n", file);
530 if (!tmpl->proceduretype) {
531 con_err("template compile error: %s missing `T:` tag\n", file);
534 if (!tmpl->compileflags) {
535 con_err("template compile error: %s missing `C:` tag\n", file);
538 if (!tmpl->sourcefile) {
539 con_err("template compile error: %s missing `I:` tag\n", file);
544 * Now lets compile the template, compilation is really just
545 * the process of validating the input.
547 if (!strcmp(tmpl->proceduretype, "-compile")) {
548 if (tmpl->executeflags)
549 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
550 if (tmpl->comparematch)
551 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
553 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
554 if (!tmpl->executeflags) {
555 /* default to $null */
556 tmpl->executeflags = util_strdup("$null");
558 if (!tmpl->comparematch) {
559 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
562 } else if (!strcmp(tmpl->proceduretype, "-fail")) {
563 if (tmpl->executeflags)
564 con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
565 if (tmpl->comparematch)
566 con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
567 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
568 if (!tmpl->executeflags)
569 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
570 if (!tmpl->comparematch) {
571 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
575 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
580 fs_file_close(tempfile);
585 * The file might not exist and we jump here when that doesn't happen
586 * so the check to see if it's not null here is required.
589 fs_file_close(tempfile);
595 void task_template_destroy(task_template_t **tmpl) {
599 if ((*tmpl)->description) mem_d((*tmpl)->description);
600 if ((*tmpl)->proceduretype) mem_d((*tmpl)->proceduretype);
601 if ((*tmpl)->compileflags) mem_d((*tmpl)->compileflags);
602 if ((*tmpl)->executeflags) mem_d((*tmpl)->executeflags);
603 if ((*tmpl)->sourcefile) mem_d((*tmpl)->sourcefile);
604 if ((*tmpl)->rulesfile) mem_d((*tmpl)->rulesfile);
605 if ((*tmpl)->testflags) mem_d((*tmpl)->testflags);
608 * Delete all allocated string for task tmpl then destroy the
613 for (; i < vec_size((*tmpl)->comparematch); i++)
614 mem_d((*tmpl)->comparematch[i]);
616 vec_free((*tmpl)->comparematch);
620 * Nullify all the template members otherwise NULL comparision
621 * checks will fail if tmpl pointer is reused.
627 * Now comes the task manager, this system allows adding tasks in and out
628 * of a task list. This is the executor of the tasks essentially as well.
631 task_template_t *tmpl;
640 task_t *task_tasks = NULL;
643 * Read a directory and searches for all template files in it
644 * which is later used to run all tests.
646 bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
649 struct dirent *files;
650 struct stat directory;
654 dir = fs_dir_open(curdir);
656 while ((files = fs_dir_read(dir))) {
657 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
659 if (stat(buffer, &directory) == -1) {
660 con_err("internal error: stat failed, aborting\n");
664 /* skip directories */
665 if (S_ISDIR(directory.st_mode))
669 * We made it here, which concludes the file/directory is not
670 * actually a directory, so it must be a file :)
672 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
673 task_template_t *tmpl = task_template_compile(files->d_name, curdir, pad);
674 char buf[4096]; /* one page should be enough */
675 char *qcflags = NULL;
678 util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
681 con_err("error compiling task template: %s\n", files->d_name);
686 * Generate a temportary file name for the output binary
687 * so we don't trample over an existing one.
689 tmpl->tempfilename = NULL;
690 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", curdir, files->d_name);
693 * Additional QCFLAGS enviroment variable may be used
694 * to test compile flags for all tests. This needs to be
695 * BEFORE other flags (so that the .tmpl can override them)
697 qcflags = getenv("QCFLAGS");
700 * Generate the command required to open a pipe to a process
701 * which will be refered to with a handle in the task for
702 * reading the data from the pipe.
704 if (strcmp(tmpl->proceduretype, "-pp")) {
706 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
707 snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
708 task_bins[TASK_COMPILE],
716 snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
717 task_bins[TASK_COMPILE],
728 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
729 snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
730 task_bins[TASK_COMPILE],
737 snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
738 task_bins[TASK_COMPILE],
749 /* Preprocessing (qcflags mean shit all here we don't allow them) */
750 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
751 snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
752 task_bins[TASK_COMPILE],
758 snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
759 task_bins[TASK_COMPILE],
770 * The task template was compiled, now lets create a task from
771 * the template data which has now been propagated.
774 if (!(task.runhandles = task_popen(buf, "r"))) {
775 con_err("error opening pipe to process for test: %s\n", tmpl->description);
780 util_debug("TEST", "executing test: `%s` [%s]\n", tmpl->description, buf);
783 * Open up some file desciptors for logging the stdout/stderr
786 snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
787 task.stdoutlogfile = util_strdup(buf);
788 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
789 con_err("error opening %s for stdout\n", buf);
793 snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
794 task.stderrlogfile = util_strdup(buf);
795 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
796 con_err("error opening %s for stderr\n", buf);
800 vec_push(task_tasks, task);
804 util_debug("TEST", "compiled %d task template files out of %d\n",
805 vec_size(task_tasks),
814 * Task precleanup removes any existing temporary files or log files
815 * left behind from a previous invoke of the test-suite.
817 void task_precleanup(const char *curdir) {
819 struct dirent *files;
822 dir = fs_dir_open(curdir);
824 while ((files = fs_dir_read(dir))) {
825 if (strstr(files->d_name, "TMP") ||
826 strstr(files->d_name, ".stdout") ||
827 strstr(files->d_name, ".stderr"))
829 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
831 con_err("error removing temporary file: %s\n", buffer);
833 util_debug("TEST", "removed temporary file: %s\n", buffer);
840 void task_destroy(void) {
842 * Free all the data in the task list and finally the list itself
843 * then proceed to cleanup anything else outside the program like
847 for (i = 0; i < vec_size(task_tasks); i++) {
849 * Close any open handles to files or processes here. It's mighty
850 * annoying to have to do all this cleanup work.
852 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
853 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
854 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
857 * Only remove the log files if the test actually compiled otherwise
858 * forget about it (or if it didn't compile, and the procedure type
859 * was set to -fail (meaning it shouldn't compile) .. stil remove)
861 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
862 if (remove(task_tasks[i].stdoutlogfile))
863 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
865 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
866 if (remove(task_tasks[i].stderrlogfile))
867 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
869 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
871 remove(task_tasks[i].tmpl->tempfilename);
874 /* free util_strdup data for log files */
875 mem_d(task_tasks[i].stdoutlogfile);
876 mem_d(task_tasks[i].stderrlogfile);
878 task_template_destroy(&task_tasks[i].tmpl);
880 vec_free(task_tasks);
884 * This executes the QCVM task for a specificly compiled progs.dat
885 * using the template passed into it for call-flags and user defined
888 bool task_execute(task_template_t *tmpl, char ***line) {
892 memset (buffer,0,sizeof(buffer));
895 * Drop the execution flags for the QCVM if none where
896 * actually specified.
898 if (!strcmp(tmpl->executeflags, "$null")) {
899 snprintf(buffer, sizeof(buffer), "%s %s",
900 task_bins[TASK_EXECUTE],
904 snprintf(buffer, sizeof(buffer), "%s %s %s",
905 task_bins[TASK_EXECUTE],
911 util_debug("TEST", "executing qcvm: `%s` [%s]\n",
916 execute = popen(buffer, "r");
921 * Now lets read the lines and compare them to the matches we expect
922 * and handle accordingly.
928 while (fs_file_getline(&data, &size, execute) != EOF) {
929 if (!strcmp(data, "No main function found\n")) {
930 con_err("test failure: `%s` (No main function found) [%s]\n",
939 * Trim newlines from data since they will just break our
940 * ability to properly validate matches.
942 if (strrchr(data, '\n'))
943 *strrchr(data, '\n') = '\0';
945 if (vec_size(tmpl->comparematch) > compare) {
946 if (strcmp(data, tmpl->comparematch[compare++]))
953 * Copy to output vector for diagnostics if execution match
956 vec_push(*line, data);
969 const char *task_type(task_template_t *tmpl) {
970 if (!strcmp(tmpl->proceduretype, "-pp"))
971 return "preprocessor test";
972 if (!strcmp(tmpl->proceduretype, "-execute"))
973 return "execution test";
974 if (!strcmp(tmpl->proceduretype, "-compile"))
975 return "compile test";
976 if (!strcmp(tmpl->proceduretype, "-fail"))
978 return "<undefined test>";
982 * This schedualizes all tasks and actually runs them individually
983 * this is generally easy for just -compile variants. For compile and
984 * execution this takes more work since a task needs to be generated
985 * from thin air and executed INLINE.
988 void task_schedualize(size_t *pad) {
990 bool execute = false;
997 snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
999 for (; i < vec_size(task_tasks); i++) {
1000 memset(space[1], 0, sizeof(space[1]));
1001 snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1003 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1005 util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].tmpl->description);
1007 * Generate a task from thin air if it requires execution in
1010 execute = !!(!strcmp(task_tasks[i].tmpl->proceduretype, "-execute"));
1013 * We assume it compiled before we actually compiled :). On error
1014 * we change the value
1016 task_tasks[i].compiled = true;
1019 * Read data from stdout first and pipe that stuff into a log file
1020 * then we do the same for stderr.
1022 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1023 fs_file_puts(task_tasks[i].stdoutlog, data);
1025 if (strstr(data, "failed to open file")) {
1026 task_tasks[i].compiled = false;
1030 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1032 * If a string contains an error we just dissalow execution
1035 * TODO: make this more percise, e.g if we print a warning
1036 * that refers to a variable named error, or something like
1037 * that .. then this will blowup :P
1039 if (strstr(data, "error")) {
1041 task_tasks[i].compiled = false;
1044 fs_file_puts (task_tasks[i].stderrlog, data);
1047 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1048 con_err("failure: `%s` (failed to compile) see %s.stdout and %s.stderr [%s]\n",
1049 task_tasks[i].tmpl->description,
1050 task_tasks[i].tmpl->tempfilename,
1051 task_tasks[i].tmpl->tempfilename,
1052 task_tasks[i].tmpl->rulesfile
1058 con_out("succeeded: `%s` %*s (%*s)\n",
1059 task_tasks[i].tmpl->description,
1060 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1061 task_tasks[i].tmpl->rulesfile,
1062 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[0]),
1063 task_type(task_tasks[i].tmpl)
1070 * If we made it here that concludes the task is to be executed
1071 * in the virtual machine.
1073 if (!task_execute(task_tasks[i].tmpl, &match)) {
1076 con_err("failure: `%s` (invalid results from execution) [%s]\n",
1077 task_tasks[i].tmpl->description,
1078 task_tasks[i].tmpl->rulesfile
1082 * Print nicely formatted expected match lists to console error
1083 * handler for the all the given matches in the template file and
1084 * what was actually returned from executing.
1086 con_err(" Expected From %u Matches: (got %u Matches)\n",
1087 vec_size(task_tasks[i].tmpl->comparematch),
1090 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1091 char *select = task_tasks[i].tmpl->comparematch[d];
1092 size_t length = 40 - strlen(select);
1094 con_err(" Expected: \"%s\"", select);
1097 con_err("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1101 * Print the non-expected out (since we are simply not expecting it)
1102 * This will help track down bugs in template files that fail to match
1105 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1106 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1107 con_err(" Expected: Nothing | Got: \"%s\"\n",
1108 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1114 for (j = 0; j < vec_size(match); j++)
1119 for (j = 0; j < vec_size(match); j++)
1123 con_out("succeeded: `%s` %*s\n",
1124 task_tasks[i].tmpl->description,
1125 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1126 task_tasks[i].tmpl->rulesfile
1134 * This is the heart of the whole test-suite process. This cleans up
1135 * any existing temporary files left behind as well as log files left
1136 * behind. Then it propagates a list of tests from `curdir` by scaning
1137 * it for template files and compiling them into tasks, in which it
1138 * schedualizes them (executes them) and actually reports errors and
1139 * what not. It then proceeds to destroy the tasks and return memory
1140 * it's the engine :)
1142 * It returns true of tests could be propagated, otherwise it returns
1145 * It expects con_init() was called before hand.
1147 GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1148 static const char *default_defs = "defs.qh";
1155 * If the default definition file isn't set to anything. We will
1156 * use the default_defs here, which is "defs.qc"
1159 defs = default_defs;
1163 task_precleanup(curdir);
1164 if (!task_propagate(curdir, pad, defs)) {
1165 con_err("error: failed to propagate tasks\n");
1170 * If we made it here all tasks where propagated from their resultant
1171 * template file. So we can start the FILO scheduler, this has been
1172 * designed in the most thread-safe way possible for future threading
1173 * it's designed to prevent lock contention, and possible syncronization
1176 task_schedualize(pad);
1183 * Fancy GCC-like LONG parsing allows things like --opt=param with
1184 * assignment operator. This is used for redirecting stdout/stderr
1185 * console to specific files of your choice.
1187 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1189 char **argv = *argv_;
1191 size_t len = strlen(optname);
1193 if (strncmp(argv[0]+ds, optname, len))
1196 /* it's --optname, check how the parameter is supplied */
1197 if (argv[0][ds+len] == '=') {
1198 *out = argv[0]+ds+len+1;
1202 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1205 /* using --opt param */
1212 int main(int argc, char **argv) {
1213 bool succeed = false;
1214 char *redirout = (char*)stdout;
1215 char *redirerr = (char*)stderr;
1221 * Command line option parsing commences now We only need to support
1222 * a few things in the test suite.
1228 if (argv[0][0] == '-') {
1229 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1231 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1233 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1236 con_change(redirout, redirerr);
1238 if (!strcmp(argv[0]+1, "debug")) {
1239 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1242 if (!strcmp(argv[0]+1, "memchk")) {
1243 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1246 if (!strcmp(argv[0]+1, "nocolor")) {
1251 con_err("invalid argument %s\n", argv[0]+1);
1255 con_change(redirout, redirerr);
1256 succeed = test_perform("tests", defs);
1260 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;