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);
155 # define _WIN32_LEAN_AND_MEAN
156 # define popen _popen
157 # define pclose _pclose
158 # include <windows.h>
162 * Bidirectional piping implementation for windows using CreatePipe and DuplicateHandle +
168 /* TODO: implement */
171 FILE **task_popen(const char *command, const char *mode) {
175 /* TODO: implement */
179 void task_pclose(FILE **files) {
180 /* TODO: implement */
186 /* mingw32 has dirent.h */
188 # elif defined (_WIN32)
190 * visual studio lacks dirent.h it's a posix thing
191 * so we emulate it with the WinAPI.
196 unsigned short d_reclen;
197 unsigned short d_namlen;
198 char d_name[FILENAME_MAX];
202 struct _finddata_t dd_dta;
203 struct dirent dd_dir;
209 DIR *opendir(const char *name) {
210 DIR *dir = (DIR*)mem_a(sizeof(DIR) + strlen(name));
214 strcpy(dir->dd_name, name);
218 int closedir(DIR *dir) {
219 FindClose((HANDLE)dir->dd_handle);
224 struct dirent *readdir(DIR *dir) {
225 WIN32_FIND_DATA info;
229 if (!dir->dd_handle) {
232 size_t n = strlen(dir->dd_name);
233 if ((dirname = (char*)mem_a(n + 5) /* 4 + 1 */)) {
234 strcpy(dirname, dir->dd_name);
235 strcpy(dirname + n, "\\*.*"); /* 4 + 1 */
238 if (!(dirname = util_strdup("\\*.*")))
242 dir->dd_handle = (long)FindFirstFile(dirname, &info);
244 rets = !(!dir->dd_handle);
245 } else if (dir->dd_handle != -11) {
246 rets = FindNextFile ((HANDLE)dir->dd_handle, &info);
254 if ((data = (struct dirent*)mem_a(sizeof(struct dirent)))) {
255 strncpy(data->d_name, info.cFileName, FILENAME_MAX - 1);
256 data->d_name[FILENAME_MAX - 1] = '\0'; /* terminate */
257 data->d_namlen = strlen(data->d_name);
263 * Visual studio also lacks S_ISDIR for sys/stat.h, so we emulate this as well
264 * which is not hard at all.
266 # undef S_ISDIR /* undef just incase */
267 # define S_ISDIR(X) ((X)&_S_IFDIR)
271 #define TASK_COMPILE 0
272 #define TASK_EXECUTE 1
275 * Task template system:
276 * templates are rules for a specific test, used to create a "task" that
277 * is executed with those set of rules (arguments, and what not). Tests
278 * that don't have a template with them cannot become tasks, since without
279 * the information for that test there is no way to properly "test" them.
280 * Rules for these templates are described in a template file, using a
281 * task template language.
283 * The language is a basic finite statemachine, top-down single-line
284 * description language.
286 * The languge is composed entierly of "tags" which describe a string of
287 * text for a task. Think of it much like a configuration file. Except
288 * it's been designed to allow flexibility and future support for prodecual
291 * The following "tags" are suported by the language
294 * Used to set a description of the current test, this must be
295 * provided, this tag is NOT optional.
298 * Used to set the procedure for the given task, there are two
301 * This simply performs compilation only
303 * This will perform compilation and execution
305 * This will perform compilation, but requires
306 * the compilation to fail in order to succeed.
308 * This must be provided, this tag is NOT optional.
311 * Used to set the compilation flags for the given task, this
312 * must be provided, this tag is NOT optional.
314 * F: Used to set some test suite flags, currently the only option
315 * is -no-defs (to including of defs.qh)
318 * Used to set the execution flags for the given task. This tag
319 * must be provided if T == -execute, otherwise it's erroneous
320 * as compilation only takes place.
323 * Used to describe a string of text that should be matched from
324 * the output of executing the task. If this doesn't match the
325 * task fails. This tag must be provided if T == -execute, otherwise
326 * it's erroneous as compilation only takes place.
329 * Used to specify the INPUT source file to operate on, this must be
330 * provided, this tag is NOT optional
334 * These tags have one-time use, using them more than once will result
335 * in template compilation errors.
337 * Lines beginning with # or // in the template file are comments and
338 * are ignored by the template parser.
340 * Whitespace is optional, with exception to the colon ':' between the
341 * tag and it's assignment value/
343 * The template compiler will detect erronrous tags (optional tags
344 * that need not be set), as well as missing tags, and error accordingly
345 * this will result in the task failing.
360 * This is very much like a compiler code generator :-). This generates
361 * a value from some data observed from the compiler.
363 bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
365 char **destval = NULL;
371 case 'D': destval = &tmpl->description; break;
372 case 'T': destval = &tmpl->proceduretype; break;
373 case 'C': destval = &tmpl->compileflags; break;
374 case 'E': destval = &tmpl->executeflags; break;
375 case 'I': destval = &tmpl->sourcefile; break;
376 case 'F': destval = &tmpl->testflags; break;
378 con_printmsg(LVL_ERROR, __FILE__, __LINE__, "internal error",
379 "invalid tag `%c:` during code generation\n",
386 * Ensure if for the given tag, there already exists a
390 con_printmsg(LVL_ERROR, file, line, "compile error",
391 "tag `%c:` already assigned value: %s\n",
398 * Strip any whitespace that might exist in the value for assignments
401 if (value && *value && (*value == ' ' || *value == '\t'))
405 * Value will contain a newline character at the end, we need to strip
406 * this otherwise kaboom, seriously, kaboom :P
408 if (strchr(value, '\n'))
409 *strrchr(value, '\n')='\0';
410 else /* cppcheck: possible nullpointer dereference */
414 * Now allocate and set the actual value for the specific tag. Which
415 * was properly selected and can be accessed with *destval.
417 *destval = util_strdup(value);
420 if (*destval == tmpl->description) {
422 * Create some padding for the description to align the
423 * printing of the rules file.
425 if ((desclen = strlen(tmpl->description)) > pad[0])
432 bool task_template_parse(const char *file, task_template_t *tmpl, FILE *fp, size_t *pad) {
441 /* top down parsing */
442 while (file_getline(&back, &size, fp) != EOF) {
443 /* skip whitespace */
445 if (*data && (*data == ' ' || *data == '\t'))
450 * Handle comments inside task tmpl files. We're strict
451 * about the language for fun :-)
454 if (data[1] != '/') {
455 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
456 "invalid character `/`, perhaps you meant `//` ?");
465 * Empty newlines are acceptable as well, so we handle that here
466 * despite being just odd since there should't be that many
467 * empty lines to begin with.
475 * Now begin the actual "tag" stuff. This works as you expect
484 if (data[1] != ':') {
485 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
486 "expected `:` after `%c`",
491 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
492 con_printmsg(LVL_ERROR, file, line, "tmpl compile error",
493 "failed to generate for given task\n"
500 * Match requires it's own system since we allow multiple M's
501 * for multi-line matching.
505 char *value = &data[3];
506 if (data[1] != ':') {
507 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
508 "expected `:` after `%c`",
514 if (value && *value && (*value == ' ' || *value == '\t'))
518 * Value will contain a newline character at the end, we need to strip
519 * this otherwise kaboom, seriously, kaboom :P
521 if (strrchr(value, '\n'))
522 *strrchr(value, '\n')='\0';
523 else /* cppcheck: possible null pointer dereference */
526 vec_push(tmpl->comparematch, util_strdup(value));
532 con_printmsg(LVL_ERROR, file, line, "tmpl parse error",
533 "invalid tag `%c`", *data
536 /* no break required */
539 /* update line and free old sata */
555 * Nullifies the template data: used during initialization of a new
558 void task_template_nullify(task_template_t *tmpl) {
562 tmpl->description = NULL;
563 tmpl->proceduretype = NULL;
564 tmpl->compileflags = NULL;
565 tmpl->executeflags = NULL;
566 tmpl->comparematch = NULL;
567 tmpl->sourcefile = NULL;
568 tmpl->tempfilename = NULL;
569 tmpl->rulesfile = NULL;
570 tmpl->testflags = NULL;
573 task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
574 /* a page should be enough */
577 FILE *tempfile = NULL;
578 task_template_t *tmpl = NULL;
580 memset (fullfile, 0, sizeof(fullfile));
581 snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
583 tempfile = file_open(fullfile, "r");
584 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
585 task_template_nullify(tmpl);
588 * Create some padding for the printing to align the
589 * printing of the rules file to the console.
591 if ((filepadd = strlen(fullfile)) > pad[1])
594 tmpl->rulesfile = util_strdup(fullfile);
597 * Esnure the file even exists for the task, this is pretty useless
601 con_err("template file: %s does not exist or invalid permissions\n",
607 if (!task_template_parse(file, tmpl, tempfile, pad)) {
608 con_err("template parse error: error during parsing\n");
613 * Regardless procedure type, the following tags must exist:
619 if (!tmpl->description) {
620 con_err("template compile error: %s missing `D:` tag\n", file);
623 if (!tmpl->proceduretype) {
624 con_err("template compile error: %s missing `T:` tag\n", file);
627 if (!tmpl->compileflags) {
628 con_err("template compile error: %s missing `C:` tag\n", file);
631 if (!tmpl->sourcefile) {
632 con_err("template compile error: %s missing `I:` tag\n", file);
637 * Now lets compile the template, compilation is really just
638 * the process of validating the input.
640 if (!strcmp(tmpl->proceduretype, "-compile")) {
641 if (tmpl->executeflags)
642 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
643 if (tmpl->comparematch)
644 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
646 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
647 if (!tmpl->executeflags) {
648 /* default to $null */
649 tmpl->executeflags = util_strdup("$null");
651 if (!tmpl->comparematch) {
652 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
655 } else if (!strcmp(tmpl->proceduretype, "-fail")) {
656 if (tmpl->executeflags)
657 con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
658 if (tmpl->comparematch)
659 con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
662 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
667 file_close(tempfile);
672 * The file might not exist and we jump here when that doesn't happen
673 * so the check to see if it's not null here is required.
676 file_close(tempfile);
682 void task_template_destroy(task_template_t **tmpl) {
686 if ((*tmpl)->description) mem_d((*tmpl)->description);
687 if ((*tmpl)->proceduretype) mem_d((*tmpl)->proceduretype);
688 if ((*tmpl)->compileflags) mem_d((*tmpl)->compileflags);
689 if ((*tmpl)->executeflags) mem_d((*tmpl)->executeflags);
690 if ((*tmpl)->sourcefile) mem_d((*tmpl)->sourcefile);
691 if ((*tmpl)->rulesfile) mem_d((*tmpl)->rulesfile);
692 if ((*tmpl)->testflags) mem_d((*tmpl)->testflags);
695 * Delete all allocated string for task tmpl then destroy the
700 for (; i < vec_size((*tmpl)->comparematch); i++)
701 mem_d((*tmpl)->comparematch[i]);
703 vec_free((*tmpl)->comparematch);
707 * Nullify all the template members otherwise NULL comparision
708 * checks will fail if tmpl pointer is reused.
714 * Now comes the task manager, this system allows adding tasks in and out
715 * of a task list. This is the executor of the tasks essentially as well.
718 task_template_t *tmpl;
727 task_t *task_tasks = NULL;
730 * Read a directory and searches for all template files in it
731 * which is later used to run all tests.
733 bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
736 struct dirent *files;
737 struct stat directory;
741 dir = opendir(curdir);
743 while ((files = readdir(dir))) {
744 memset (buffer, 0,sizeof(buffer));
745 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
747 if (stat(buffer, &directory) == -1) {
748 con_err("internal error: stat failed, aborting\n");
752 /* skip directories */
753 if (S_ISDIR(directory.st_mode))
757 * We made it here, which concludes the file/directory is not
758 * actually a directory, so it must be a file :)
760 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
761 task_template_t *tmpl = task_template_compile(files->d_name, curdir, pad);
762 char buf[4096]; /* one page should be enough */
763 char *qcflags = NULL;
766 util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
769 con_err("error compiling task template: %s\n", files->d_name);
774 * Generate a temportary file name for the output binary
775 * so we don't trample over an existing one.
777 tmpl->tempfilename = tempnam(curdir, "TMPDAT");
780 * Additional QCFLAGS enviroment variable may be used
781 * to test compile flags for all tests. This needs to be
782 * BEFORE other flags (so that the .tmpl can override them)
784 qcflags = getenv("QCFLAGS");
787 * Generate the command required to open a pipe to a process
788 * which will be refered to with a handle in the task for
789 * reading the data from the pipe.
791 memset (buf,0,sizeof(buf));
793 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
794 snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
795 task_bins[TASK_COMPILE],
803 snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
804 task_bins[TASK_COMPILE],
815 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
816 snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
817 task_bins[TASK_COMPILE],
824 snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
825 task_bins[TASK_COMPILE],
837 * The task template was compiled, now lets create a task from
838 * the template data which has now been propagated.
841 if (!(task.runhandles = task_popen(buf, "r"))) {
842 con_err("error opening pipe to process for test: %s\n", tmpl->description);
847 util_debug("TEST", "executing test: `%s` [%s]\n", tmpl->description, buf);
850 * Open up some file desciptors for logging the stdout/stderr
853 memset (buf,0,sizeof(buf));
854 snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
855 task.stdoutlogfile = util_strdup(buf);
856 if (!(task.stdoutlog = file_open(buf, "w"))) {
857 con_err("error opening %s for stdout\n", buf);
861 memset (buf,0,sizeof(buf));
862 snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
863 task.stderrlogfile = util_strdup(buf);
864 if (!(task.stderrlog = file_open(buf, "w"))) {
865 con_err("error opening %s for stderr\n", buf);
869 vec_push(task_tasks, task);
873 util_debug("TEST", "compiled %d task template files out of %d\n",
874 vec_size(task_tasks),
883 * Task precleanup removes any existing temporary files or log files
884 * left behind from a previous invoke of the test-suite.
886 void task_precleanup(const char *curdir) {
888 struct dirent *files;
891 dir = opendir(curdir);
893 while ((files = readdir(dir))) {
894 memset(buffer, 0, sizeof(buffer));
895 if (strstr(files->d_name, "TMP") ||
896 strstr(files->d_name, ".stdout") ||
897 strstr(files->d_name, ".stderr"))
899 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
901 con_err("error removing temporary file: %s\n", buffer);
903 util_debug("TEST", "removed temporary file: %s\n", buffer);
910 void task_destroy(void) {
912 * Free all the data in the task list and finally the list itself
913 * then proceed to cleanup anything else outside the program like
917 for (i = 0; i < vec_size(task_tasks); i++) {
919 * Close any open handles to files or processes here. It's mighty
920 * annoying to have to do all this cleanup work.
922 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
923 if (task_tasks[i].stdoutlog) file_close (task_tasks[i].stdoutlog);
924 if (task_tasks[i].stderrlog) file_close (task_tasks[i].stderrlog);
927 * Only remove the log files if the test actually compiled otherwise
928 * forget about it (or if it didn't compile, and the procedure type
929 * was set to -fail (meaning it shouldn't compile) .. stil remove)
931 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
932 if (remove(task_tasks[i].stdoutlogfile))
933 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
935 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
936 if (remove(task_tasks[i].stderrlogfile))
937 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
939 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
941 remove(task_tasks[i].tmpl->tempfilename);
944 /* free util_strdup data for log files */
945 mem_d(task_tasks[i].stdoutlogfile);
946 mem_d(task_tasks[i].stderrlogfile);
948 task_template_destroy(&task_tasks[i].tmpl);
950 vec_free(task_tasks);
954 * This executes the QCVM task for a specificly compiled progs.dat
955 * using the template passed into it for call-flags and user defined
958 bool task_execute(task_template_t *tmpl, char ***line) {
962 memset (buffer,0,sizeof(buffer));
965 * Drop the execution flags for the QCVM if none where
966 * actually specified.
968 if (!strcmp(tmpl->executeflags, "$null")) {
969 snprintf(buffer, sizeof(buffer), "%s %s",
970 task_bins[TASK_EXECUTE],
974 snprintf(buffer, sizeof(buffer), "%s %s %s",
975 task_bins[TASK_EXECUTE],
981 util_debug("TEST", "executing qcvm: `%s` [%s]\n",
986 execute = popen(buffer, "r");
991 * Now lets read the lines and compare them to the matches we expect
992 * and handle accordingly.
998 while (file_getline(&data, &size, execute) != EOF) {
999 if (!strcmp(data, "No main function found\n")) {
1000 con_err("test failure: `%s` (No main function found) [%s]\n",
1009 * Trim newlines from data since they will just break our
1010 * ability to properly validate matches.
1012 if (strrchr(data, '\n'))
1013 *strrchr(data, '\n') = '\0';
1015 if (vec_size(tmpl->comparematch) > compare) {
1016 if (strcmp(data, tmpl->comparematch[compare++]))
1023 * Copy to output vector for diagnostics if execution match
1026 vec_push(*line, data);
1040 * This schedualizes all tasks and actually runs them individually
1041 * this is generally easy for just -compile variants. For compile and
1042 * execution this takes more work since a task needs to be generated
1043 * from thin air and executed INLINE.
1045 void task_schedualize(size_t *pad) {
1046 bool execute = false;
1048 char **match = NULL;
1053 util_debug("TEST", "found %d tasks, preparing to execute\n", vec_size(task_tasks));
1055 for (i = 0; i < vec_size(task_tasks); i++) {
1056 util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].tmpl->description);
1058 * Generate a task from thin air if it requires execution in
1061 execute = !!(!strcmp(task_tasks[i].tmpl->proceduretype, "-execute"));
1064 * We assume it compiled before we actually compiled :). On error
1065 * we change the value
1067 task_tasks[i].compiled = true;
1070 * Read data from stdout first and pipe that stuff into a log file
1071 * then we do the same for stderr.
1073 while (file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1074 file_puts(task_tasks[i].stdoutlog, data);
1076 if (strstr(data, "failed to open file")) {
1077 task_tasks[i].compiled = false;
1081 fflush(task_tasks[i].stdoutlog);
1083 while (file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1085 * If a string contains an error we just dissalow execution
1088 * TODO: make this more percise, e.g if we print a warning
1089 * that refers to a variable named error, or something like
1090 * that .. then this will blowup :P
1092 if (strstr(data, "error")) {
1094 task_tasks[i].compiled = false;
1097 file_puts(task_tasks[i].stderrlog, data);
1098 fflush(task_tasks[i].stdoutlog);
1101 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1102 con_err("test failure: `%s` (failed to compile) see %s.stdout and %s.stderr [%s]\n",
1103 task_tasks[i].tmpl->description,
1104 task_tasks[i].tmpl->tempfilename,
1105 task_tasks[i].tmpl->tempfilename,
1106 task_tasks[i].tmpl->rulesfile
1112 con_out("test succeeded: `%s` %*s\n",
1113 task_tasks[i].tmpl->description,
1114 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) +
1115 (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1116 task_tasks[i].tmpl->rulesfile
1123 * If we made it here that concludes the task is to be executed
1124 * in the virtual machine.
1126 if (!task_execute(task_tasks[i].tmpl, &match)) {
1129 con_err("test failure: `%s` (invalid results from execution) [%s]\n",
1130 task_tasks[i].tmpl->description,
1131 task_tasks[i].tmpl->rulesfile
1135 * Print nicely formatted expected match lists to console error
1136 * handler for the all the given matches in the template file and
1137 * what was actually returned from executing.
1139 con_err(" Expected From %u Matches: (got %u Matches)\n",
1140 vec_size(task_tasks[i].tmpl->comparematch),
1143 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1144 char *select = task_tasks[i].tmpl->comparematch[d];
1145 size_t length = 40 - strlen(select);
1147 con_err(" Expected: \"%s\"", select);
1150 con_err("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1154 * Print the non-expected out (since we are simply not expecting it)
1155 * This will help track down bugs in template files that fail to match
1158 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1159 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1160 con_err(" Expected: Nothing | Got: \"%s\"\n",
1161 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1167 for (j = 0; j < vec_size(match); j++)
1172 for (j = 0; j < vec_size(match); j++)
1176 con_out("test succeeded: `%s` %*s\n",
1177 task_tasks[i].tmpl->description,
1178 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) +
1179 (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1180 task_tasks[i].tmpl->rulesfile
1188 * This is the heart of the whole test-suite process. This cleans up
1189 * any existing temporary files left behind as well as log files left
1190 * behind. Then it propagates a list of tests from `curdir` by scaning
1191 * it for template files and compiling them into tasks, in which it
1192 * schedualizes them (executes them) and actually reports errors and
1193 * what not. It then proceeds to destroy the tasks and return memory
1194 * it's the engine :)
1196 * It returns true of tests could be propagated, otherwise it returns
1199 * It expects con_init() was called before hand.
1201 GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1202 static const char *default_defs = "defs.qh";
1209 * If the default definition file isn't set to anything. We will
1210 * use the default_defs here, which is "defs.qc"
1213 defs = default_defs;
1217 task_precleanup(curdir);
1218 if (!task_propagate(curdir, pad, defs)) {
1219 con_err("error: failed to propagate tasks\n");
1224 * If we made it here all tasks where propagated from their resultant
1225 * template file. So we can start the FILO scheduler, this has been
1226 * designed in the most thread-safe way possible for future threading
1227 * it's designed to prevent lock contention, and possible syncronization
1230 task_schedualize(pad);
1237 * Fancy GCC-like LONG parsing allows things like --opt=param with
1238 * assignment operator. This is used for redirecting stdout/stderr
1239 * console to specific files of your choice.
1241 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1243 char **argv = *argv_;
1245 size_t len = strlen(optname);
1247 if (strncmp(argv[0]+ds, optname, len))
1250 /* it's --optname, check how the parameter is supplied */
1251 if (argv[0][ds+len] == '=') {
1252 *out = argv[0]+ds+len+1;
1256 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1259 /* using --opt param */
1266 int main(int argc, char **argv) {
1267 bool succeed = false;
1268 char *redirout = (char*)stdout;
1269 char *redirerr = (char*)stderr;
1275 * Command line option parsing commences now We only need to support
1276 * a few things in the test suite.
1282 if (argv[0][0] == '-') {
1283 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1285 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1287 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1290 con_change(redirout, redirerr);
1292 if (!strcmp(argv[0]+1, "debug")) {
1293 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1296 if (!strcmp(argv[0]+1, "memchk")) {
1297 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1300 if (!strcmp(argv[0]+1, "nocolor")) {
1305 con_err("invalid argument %s\n", argv[0]+1);
1309 con_change(redirout, redirerr);
1310 succeed = test_perform("tests", defs);
1314 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;