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
25 #include <sys/types.h>
30 static const char *task_bins[] = {
36 * TODO: Windows version
37 * this implements a unique bi-directional popen-like function that
38 * allows reading data from both stdout and stderr. And writing to
42 * FILE *handles[3] = task_popen("ls", "-l", "r");
43 * if (!handles) { perror("failed to open stdin/stdout/stderr to ls");
44 * // handles[0] = stdin
45 * // handles[1] = stdout
46 * // handles[2] = stderr
48 * task_pclose(handles); // to close
51 #include <sys/types.h>
64 static FILE ** task_popen(const char *command, const char *mode) {
70 popen_t *data = (popen_t*)mem_a(sizeof(popen_t));
73 * Parse the command now into a list for execv, this is a pain
76 char *line = (char*)command;
80 while (*line != '\0') {
81 while (*line == ' ' || *line == '\t' || *line == '\n')
85 while (*line != '\0' && *line != ' ' &&
86 *line != '\t' && *line != '\n') line++;
92 if ((trypipe = pipe(inhandle)) < 0) goto task_popen_error_0;
93 if ((trypipe = pipe(outhandle)) < 0) goto task_popen_error_1;
94 if ((trypipe = pipe(errhandle)) < 0) goto task_popen_error_2;
96 if ((data->pid = fork()) > 0) {
100 close(errhandle [1]);
102 data->pipes [0] = inhandle [1];
103 data->pipes [1] = outhandle[0];
104 data->pipes [2] = errhandle[0];
106 data->handles[0] = fdopen(inhandle [1], "w");
107 data->handles[1] = fdopen(outhandle[0], mode);
108 data->handles[2] = fdopen(errhandle[0], mode);
112 return data->handles;
113 } else if (data->pid == 0) {
119 /* see piping documentation for this sillyness :P */
120 dup2(inhandle [0], 0);
121 dup2(outhandle[1], 1);
122 dup2(errhandle[1], 2);
128 goto task_popen_error_3;
131 task_popen_error_3: close(errhandle[0]), close(errhandle[1]);
132 task_popen_error_2: close(outhandle[0]), close(outhandle[1]);
133 task_popen_error_1: close(inhandle [0]), close(inhandle [1]);
140 static 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);
157 char name_err[L_tmpnam];
158 char name_out[L_tmpnam];
161 static FILE **task_popen(const char *command, const char *mode) {
163 popen_t *open = (popen_t*)mem_a(sizeof(popen_t));
166 tmpnam(open->name_err);
167 tmpnam(open->name_out);
169 tmpnam_s(open->name_err, L_tmpnam);
170 tmpnam_s(open->name_out, L_tmpnam);
173 (void)mode; /* excluded */
175 util_asprintf(&cmd, "%s -redirout=%s -redirerr=%s", command, open->name_out, open->name_err);
177 system(cmd); /* HACK */
178 open->handles[0] = NULL;
179 open->handles[1] = fs_file_open(open->name_out, "r");
180 open->handles[2] = fs_file_open(open->name_err, "r");
184 return open->handles;
187 static int task_pclose(FILE **files) {
188 popen_t *open = ((popen_t*)files);
189 fs_file_close(files[1]);
190 fs_file_close(files[2]);
191 remove(open->name_err);
192 remove(open->name_out);
198 # define popen _popen
199 # define pclose _pclose
202 #define TASK_COMPILE 0
203 #define TASK_EXECUTE 1
205 * Task template system:
206 * templates are rules for a specific test, used to create a "task" that
207 * is executed with those set of rules (arguments, and what not). Tests
208 * that don't have a template with them cannot become tasks, since without
209 * the information for that test there is no way to properly "test" them.
210 * Rules for these templates are described in a template file, using a
211 * task template language.
213 * The language is a basic finite statemachine, top-down single-line
214 * description language.
216 * The languge is composed entierly of "tags" which describe a string of
217 * text for a task. Think of it much like a configuration file. Except
218 * it's been designed to allow flexibility and future support for prodecual
221 * The following "tags" are suported by the language
224 * Used to set a description of the current test, this must be
225 * provided, this tag is NOT optional.
228 * Used to set the procedure for the given task, there are two
231 * This simply performs compilation only
233 * This will perform compilation and execution
235 * This will perform compilation, but requires
236 * the compilation to fail in order to succeed.
238 * This must be provided, this tag is NOT optional.
241 * Used to set the compilation flags for the given task, this
242 * must be provided, this tag is NOT optional.
244 * F: Used to set some test suite flags, currently the only option
245 * is -no-defs (to including of defs.qh)
248 * Used to set the execution flags for the given task. This tag
249 * must be provided if T == -execute, otherwise it's erroneous
250 * as compilation only takes place.
253 * Used to describe a string of text that should be matched from
254 * the output of executing the task. If this doesn't match the
255 * task fails. This tag must be provided if T == -execute, otherwise
256 * it's erroneous as compilation only takes place.
259 * Used to specify the INPUT source file to operate on, this must be
260 * provided, this tag is NOT optional
264 * These tags have one-time use, using them more than once will result
265 * in template compilation errors.
267 * Lines beginning with # or // in the template file are comments and
268 * are ignored by the template parser.
270 * Whitespace is optional, with exception to the colon ':' between the
271 * tag and it's assignment value/
273 * The template compiler will detect erronrous tags (optional tags
274 * that need not be set), as well as missing tags, and error accordingly
275 * this will result in the task failing.
290 * This is very much like a compiler code generator :-). This generates
291 * a value from some data observed from the compiler.
293 static bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
296 char **destval = NULL;
302 case 'D': destval = &tmpl->description; break;
303 case 'T': destval = &tmpl->proceduretype; break;
304 case 'C': destval = &tmpl->compileflags; break;
305 case 'E': destval = &tmpl->executeflags; break;
306 case 'I': destval = &tmpl->sourcefile; break;
307 case 'F': destval = &tmpl->testflags; break;
309 con_printmsg(LVL_ERROR, __FILE__, __LINE__, 0, "internal error",
310 "invalid tag `%c:` during code generation\n",
317 * Ensure if for the given tag, there already exists a
321 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "compile error",
322 "tag `%c:` already assigned value: %s\n",
329 * Strip any whitespace that might exist in the value for assignments
332 if (value && *value && (*value == ' ' || *value == '\t'))
338 * Value will contain a newline character at the end, we need to strip
339 * this otherwise kaboom, seriously, kaboom :P
341 if (strchr(value, '\n'))
342 *strrchr(value, '\n')='\0';
345 * Now allocate and set the actual value for the specific tag. Which
346 * was properly selected and can be accessed with *destval.
348 *destval = util_strdup(value);
351 if (*destval == tmpl->description) {
353 * Create some padding for the description to align the
354 * printing of the rules file.
356 if ((desclen = strlen(tmpl->description)) > pad[0])
360 if ((filelen = strlen(file)) > pad[2])
366 static bool task_template_parse(const char *file, task_template_t *tmpl, FILE *fp, size_t *pad) {
375 /* top down parsing */
376 while (fs_file_getline(&back, &size, fp) != EOF) {
377 /* skip whitespace */
379 if (*data && (*data == ' ' || *data == '\t'))
384 * Handle comments inside task tmpl files. We're strict
385 * about the language for fun :-)
388 if (data[1] != '/') {
389 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
390 "invalid character `/`, perhaps you meant `//` ?");
399 * Empty newlines are acceptable as well, so we handle that here
400 * despite being just odd since there should't be that many
401 * empty lines to begin with.
409 * Now begin the actual "tag" stuff. This works as you expect
418 if (data[1] != ':') {
419 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
420 "expected `:` after `%c`",
425 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
426 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl compile error",
427 "failed to generate for given task\n"
434 * Match requires it's own system since we allow multiple M's
435 * for multi-line matching.
439 char *value = &data[3];
440 if (data[1] != ':') {
441 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
442 "expected `:` after `%c`",
448 if (value && (*value == ' ' || *value == '\t'))
452 * Value will contain a newline character at the end, we need to strip
453 * this otherwise kaboom, seriously, kaboom :P
455 if (strrchr(value, '\n'))
456 *strrchr(value, '\n')='\0';
457 else /* cppcheck: possible null pointer dereference */
460 vec_push(tmpl->comparematch, util_strdup(value));
466 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
467 "invalid tag `%c`", *data
470 /* no break required */
473 /* update line and free old sata */
488 * Nullifies the template data: used during initialization of a new
491 static void task_template_nullify(task_template_t *tmpl) {
495 tmpl->description = NULL;
496 tmpl->proceduretype = NULL;
497 tmpl->compileflags = NULL;
498 tmpl->executeflags = NULL;
499 tmpl->comparematch = NULL;
500 tmpl->sourcefile = NULL;
501 tmpl->tempfilename = NULL;
502 tmpl->rulesfile = NULL;
503 tmpl->testflags = NULL;
506 static task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
507 /* a page should be enough */
510 FILE *tempfile = NULL;
511 task_template_t *tmpl = NULL;
513 util_snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
515 tempfile = fs_file_open(fullfile, "r");
516 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
517 task_template_nullify(tmpl);
520 * Create some padding for the printing to align the
521 * printing of the rules file to the console.
523 if ((filepadd = strlen(fullfile)) > pad[1])
526 tmpl->rulesfile = util_strdup(fullfile);
529 * Esnure the file even exists for the task, this is pretty useless
533 con_err("template file: %s does not exist or invalid permissions\n",
539 if (!task_template_parse(file, tmpl, tempfile, pad)) {
540 con_err("template parse error: error during parsing\n");
545 * Regardless procedure type, the following tags must exist:
551 if (!tmpl->description) {
552 con_err("template compile error: %s missing `D:` tag\n", file);
555 if (!tmpl->proceduretype) {
556 con_err("template compile error: %s missing `T:` tag\n", file);
559 if (!tmpl->compileflags) {
560 con_err("template compile error: %s missing `C:` tag\n", file);
563 if (!tmpl->sourcefile) {
564 con_err("template compile error: %s missing `I:` tag\n", file);
569 * Now lets compile the template, compilation is really just
570 * the process of validating the input.
572 if (!strcmp(tmpl->proceduretype, "-compile")) {
573 if (tmpl->executeflags)
574 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
575 if (tmpl->comparematch)
576 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
578 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
579 if (!tmpl->executeflags) {
580 /* default to $null */
581 tmpl->executeflags = util_strdup("$null");
583 if (!tmpl->comparematch) {
584 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
587 } else if (!strcmp(tmpl->proceduretype, "-fail")) {
588 if (tmpl->executeflags)
589 con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
590 if (tmpl->comparematch)
591 con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
592 } else if (!strcmp(tmpl->proceduretype, "-diagnostic")) {
593 if (tmpl->executeflags)
594 con_err("template compile warning: %s erroneous tag `E:` when only diagnostic\n", file);
595 if (!tmpl->comparematch) {
596 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
599 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
600 if (tmpl->executeflags)
601 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
602 if (!tmpl->comparematch) {
603 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
607 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
612 fs_file_close(tempfile);
617 * The file might not exist and we jump here when that doesn't happen
618 * so the check to see if it's not null here is required.
621 fs_file_close(tempfile);
627 static void task_template_destroy(task_template_t **tmpl) {
631 if ((*tmpl)->description) mem_d((*tmpl)->description);
632 if ((*tmpl)->proceduretype) mem_d((*tmpl)->proceduretype);
633 if ((*tmpl)->compileflags) mem_d((*tmpl)->compileflags);
634 if ((*tmpl)->executeflags) mem_d((*tmpl)->executeflags);
635 if ((*tmpl)->sourcefile) mem_d((*tmpl)->sourcefile);
636 if ((*tmpl)->rulesfile) mem_d((*tmpl)->rulesfile);
637 if ((*tmpl)->testflags) mem_d((*tmpl)->testflags);
640 * Delete all allocated string for task tmpl then destroy the
645 for (; i < vec_size((*tmpl)->comparematch); i++)
646 mem_d((*tmpl)->comparematch[i]);
648 vec_free((*tmpl)->comparematch);
652 * Nullify all the template members otherwise NULL comparision
653 * checks will fail if tmpl pointer is reused.
655 mem_d((*tmpl)->tempfilename);
660 * Now comes the task manager, this system allows adding tasks in and out
661 * of a task list. This is the executor of the tasks essentially as well.
664 task_template_t *tmpl;
673 static task_t *task_tasks = NULL;
676 * Read a directory and searches for all template files in it
677 * which is later used to run all tests.
679 static bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
682 struct dirent *files;
683 struct stat directory;
686 char **directories = NULL;
687 char *claim = util_strdup(curdir);
690 vec_push(directories, claim);
691 dir = fs_dir_open(claim);
694 * Generate a list of subdirectories since we'll be checking them too
697 while ((files = fs_dir_read(dir))) {
698 util_asprintf(&claim, "%s/%s", curdir, files->d_name);
699 if (stat(claim, &directory) == -1) {
705 if (S_ISDIR(directory.st_mode) && files->d_name[0] != '.') {
706 vec_push(directories, claim);
715 * Now do all the work, by touching all the directories inside
716 * test as well and compile the task templates into data we can
717 * use to run the tests.
719 for (i = 0; i < vec_size(directories); i++) {
720 dir = fs_dir_open(directories[i]);
722 while ((files = fs_dir_read(dir))) {
723 util_snprintf(buffer, sizeof(buffer), "%s/%s", directories[i], files->d_name);
724 if (stat(buffer, &directory) == -1) {
725 con_err("internal error: stat failed, aborting\n");
729 if (S_ISDIR(directory.st_mode))
733 * We made it here, which concludes the file/directory is not
734 * actually a directory, so it must be a file :)
736 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
737 task_template_t *tmpl = task_template_compile(files->d_name, directories[i], pad);
738 char buf[4096]; /* one page should be enough */
739 char *qcflags = NULL;
742 util_debug("TEST", "compiling task template: %s/%s\n", directories[i], files->d_name);
745 con_err("error compiling task template: %s\n", files->d_name);
750 * Generate a temportary file name for the output binary
751 * so we don't trample over an existing one.
753 tmpl->tempfilename = NULL;
754 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", directories[i], files->d_name);
757 * Additional QCFLAGS enviroment variable may be used
758 * to test compile flags for all tests. This needs to be
759 * BEFORE other flags (so that the .tmpl can override them)
765 getenv_s(&size, buffer, sizeof(buffer), "QCFLAGS");
769 qcflags = getenv("QCFLAGS");
773 * Generate the command required to open a pipe to a process
774 * which will be refered to with a handle in the task for
775 * reading the data from the pipe.
777 if (strcmp(tmpl->proceduretype, "-pp")) {
779 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
780 util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
781 task_bins[TASK_COMPILE],
789 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
790 task_bins[TASK_COMPILE],
801 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
802 util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
803 task_bins[TASK_COMPILE],
810 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
811 task_bins[TASK_COMPILE],
822 /* Preprocessing (qcflags mean shit all here we don't allow them) */
823 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
824 util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
825 task_bins[TASK_COMPILE],
831 util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
832 task_bins[TASK_COMPILE],
843 * The task template was compiled, now lets create a task from
844 * the template data which has now been propagated.
847 if (!(task.runhandles = task_popen(buf, "r"))) {
848 con_err("error opening pipe to process for test: %s\n", tmpl->description);
853 util_debug("TEST", "executing test: `%s` [%s]\n", tmpl->description, buf);
856 * Open up some file desciptors for logging the stdout/stderr
859 util_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
860 task.stdoutlogfile = util_strdup(buf);
861 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
862 con_err("error opening %s for stdout\n", buf);
866 util_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
867 task.stderrlogfile = util_strdup(buf);
868 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
869 con_err("error opening %s for stderr\n", buf);
873 vec_push(task_tasks, task);
878 mem_d(directories[i]); /* free claimed memory */
880 vec_free(directories);
882 util_debug("TEST", "compiled %d task template files out of %d\n",
883 vec_size(task_tasks),
891 * Task precleanup removes any existing temporary files or log files
892 * left behind from a previous invoke of the test-suite.
894 static void task_precleanup(const char *curdir) {
896 struct dirent *files;
899 dir = fs_dir_open(curdir);
901 while ((files = fs_dir_read(dir))) {
902 if (strstr(files->d_name, "TMP") ||
903 strstr(files->d_name, ".stdout") ||
904 strstr(files->d_name, ".stderr"))
906 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
908 con_err("error removing temporary file: %s\n", buffer);
910 util_debug("TEST", "removed temporary file: %s\n", buffer);
917 static void task_destroy(void) {
919 * Free all the data in the task list and finally the list itself
920 * then proceed to cleanup anything else outside the program like
924 for (i = 0; i < vec_size(task_tasks); i++) {
926 * Close any open handles to files or processes here. It's mighty
927 * annoying to have to do all this cleanup work.
929 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
930 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
931 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
934 * Only remove the log files if the test actually compiled otherwise
935 * forget about it (or if it didn't compile, and the procedure type
936 * was set to -fail (meaning it shouldn't compile) .. stil remove)
938 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
939 if (remove(task_tasks[i].stdoutlogfile))
940 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
942 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
943 if (remove(task_tasks[i].stderrlogfile))
944 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
946 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
948 (void)!remove(task_tasks[i].tmpl->tempfilename);
951 /* free util_strdup data for log files */
952 mem_d(task_tasks[i].stdoutlogfile);
953 mem_d(task_tasks[i].stderrlogfile);
955 task_template_destroy(&task_tasks[i].tmpl);
957 vec_free(task_tasks);
961 * This executes the QCVM task for a specificly compiled progs.dat
962 * using the template passed into it for call-flags and user defined
963 * messages IF the procedure type is -execute, otherwise it matches
964 * the preprocessor output.
966 static bool task_trymatch(size_t i, char ***line) {
969 int retval = EXIT_SUCCESS;
972 task_template_t *tmpl = task_tasks[i].tmpl;
974 memset (buffer,0,sizeof(buffer));
976 if (!strcmp(tmpl->proceduretype, "-execute")) {
978 * Drop the execution flags for the QCVM if none where
979 * actually specified.
981 if (!strcmp(tmpl->executeflags, "$null")) {
982 util_snprintf(buffer, sizeof(buffer), "%s %s",
983 task_bins[TASK_EXECUTE],
987 util_snprintf(buffer, sizeof(buffer), "%s %s %s",
988 task_bins[TASK_EXECUTE],
994 util_debug("TEST", "executing qcvm: `%s` [%s]\n",
999 execute = popen(buffer, "r");
1002 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
1004 * we're preprocessing, which means we need to read int
1005 * the produced file and do some really weird shit.
1007 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
1013 * we're testing diagnostic output, which means it will be
1014 * in runhandles[2] (stderr) since that is where the compiler
1017 if (!(execute = fs_file_open(task_tasks[i].stderrlogfile, "r")))
1024 * Now lets read the lines and compare them to the matches we expect
1025 * and handle accordingly.
1032 while (fs_file_getline(&data, &size, execute) != EOF) {
1033 if (!strcmp(data, "No main function found\n")) {
1034 con_err("test failure: `%s` (No main function found) [%s]\n",
1039 fs_file_close(execute);
1046 * Trim newlines from data since they will just break our
1047 * ability to properly validate matches.
1049 if (strrchr(data, '\n'))
1050 *strrchr(data, '\n') = '\0';
1053 * We remove the file/directory and stuff from the error
1054 * match messages when testing diagnostics.
1056 if(!strcmp(tmpl->proceduretype, "-diagnostic")) {
1057 if (strstr(data, "there have been errors, bailing out"))
1058 continue; /* ignore it */
1059 if (strstr(data, ": error: ")) {
1060 char *claim = util_strdup(data + (strstr(data, ": error: ") - data) + 9);
1067 * If data is just null now, that means the line was an empty
1068 * one and for that, we just ignore it.
1073 if (vec_size(tmpl->comparematch) > compare) {
1074 if (strcmp(data, tmpl->comparematch[compare++])) {
1082 * Copy to output vector for diagnostics if execution match
1085 vec_push(*line, data);
1092 if (compare != vec_size(tmpl->comparematch))
1100 retval = pclose(execute);
1102 fs_file_close(execute);
1104 return success && retval == EXIT_SUCCESS;
1107 static const char *task_type(task_template_t *tmpl) {
1108 if (!strcmp(tmpl->proceduretype, "-pp"))
1109 return "type: preprocessor";
1110 if (!strcmp(tmpl->proceduretype, "-execute"))
1111 return "type: execution";
1112 if (!strcmp(tmpl->proceduretype, "-compile"))
1113 return "type: compile";
1114 if (!strcmp(tmpl->proceduretype, "-diagnostic"))
1115 return "type: diagnostic";
1116 return "type: fail";
1120 * This schedualizes all tasks and actually runs them individually
1121 * this is generally easy for just -compile variants. For compile and
1122 * execution this takes more work since a task needs to be generated
1123 * from thin air and executed INLINE.
1126 static size_t task_schedualize(size_t *pad) {
1128 bool execute = false;
1130 char **match = NULL;
1136 util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1138 for (; i < vec_size(task_tasks); i++) {
1139 memset(space[1], 0, sizeof(space[1]));
1140 util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1142 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1144 util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].tmpl->description);
1146 * Generate a task from thin air if it requires execution in
1150 /* diagnostic is not executed, but compare tested instead, like preproessor */
1151 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1152 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp")) ||
1153 (!strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"));
1156 * We assume it compiled before we actually compiled :). On error
1157 * we change the value
1159 task_tasks[i].compiled = true;
1162 * Read data from stdout first and pipe that stuff into a log file
1163 * then we do the same for stderr.
1165 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1166 fs_file_puts(task_tasks[i].stdoutlog, data);
1168 if (strstr(data, "failed to open file")) {
1169 task_tasks[i].compiled = false;
1173 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1175 * If a string contains an error we just dissalow execution
1178 * TODO: make this more percise, e.g if we print a warning
1179 * that refers to a variable named error, or something like
1180 * that .. then this will blowup :P
1182 if (strstr(data, "error") && strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic")) {
1184 task_tasks[i].compiled = false;
1187 fs_file_puts (task_tasks[i].stderrlog, data);
1188 fflush(task_tasks[i].stderrlog); /* fast flush for read */
1191 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1192 con_out("failure: `%s` %*s %*s\n",
1193 task_tasks[i].tmpl->description,
1194 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1195 task_tasks[i].tmpl->rulesfile,
1196 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1197 "(failed to compile)"
1204 con_out("succeeded: `%s` %*s %*s\n",
1205 task_tasks[i].tmpl->description,
1206 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1207 task_tasks[i].tmpl->rulesfile,
1208 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1209 task_type(task_tasks[i].tmpl)
1216 * If we made it here that concludes the task is to be executed
1217 * in the virtual machine (or the preprocessor output needs to
1220 if (!task_trymatch(i, &match)) {
1223 con_out("failure: `%s` %*s %*s\n",
1224 task_tasks[i].tmpl->description,
1225 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1226 task_tasks[i].tmpl->rulesfile,
1227 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1228 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1229 ? "(invalid results from execution)"
1230 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1231 ? "(invalid results from preprocessing)"
1232 : "(invalid results from compiler diagnsotics)"
1234 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1235 ? "(invalid results from execution)"
1236 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1237 ? "(invalid results from preprocessing)"
1238 : "(invalid results from compiler diagnsotics)"
1242 * Print nicely formatted expected match lists to console error
1243 * handler for the all the given matches in the template file and
1244 * what was actually returned from executing.
1246 con_out(" Expected From %u Matches: (got %u Matches)\n",
1247 vec_size(task_tasks[i].tmpl->comparematch),
1250 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1251 char *select = task_tasks[i].tmpl->comparematch[d];
1252 size_t length = 60 - strlen(select);
1254 con_out(" Expected: \"%s\"", select);
1257 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1261 * Print the non-expected out (since we are simply not expecting it)
1262 * This will help track down bugs in template files that fail to match
1265 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1266 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1267 con_out(" Expected: Nothing | Got: \"%s\"\n",
1268 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1274 for (j = 0; j < vec_size(match); j++)
1281 for (j = 0; j < vec_size(match); j++)
1285 con_out("succeeded: `%s` %*s %*s\n",
1286 task_tasks[i].tmpl->description,
1287 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1288 task_tasks[i].tmpl->rulesfile,
1289 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1290 task_type(task_tasks[i].tmpl)
1299 * This is the heart of the whole test-suite process. This cleans up
1300 * any existing temporary files left behind as well as log files left
1301 * behind. Then it propagates a list of tests from `curdir` by scaning
1302 * it for template files and compiling them into tasks, in which it
1303 * schedualizes them (executes them) and actually reports errors and
1304 * what not. It then proceeds to destroy the tasks and return memory
1305 * it's the engine :)
1307 * It returns true of tests could be propagated, otherwise it returns
1310 * It expects con_init() was called before hand.
1312 static GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1313 size_t failed = false;
1314 static const char *default_defs = "defs.qh";
1317 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1322 * If the default definition file isn't set to anything. We will
1323 * use the default_defs here, which is "defs.qc"
1326 defs = default_defs;
1330 task_precleanup(curdir);
1331 if (!task_propagate(curdir, pad, defs)) {
1332 con_err("error: failed to propagate tasks\n");
1337 * If we made it here all tasks where propagated from their resultant
1338 * template file. So we can start the FILO scheduler, this has been
1339 * designed in the most thread-safe way possible for future threading
1340 * it's designed to prevent lock contention, and possible syncronization
1343 failed = task_schedualize(pad);
1345 con_out("%u out of %u tests failed\n", failed, vec_size(task_tasks));
1348 return (failed) ? false : true;
1352 * Fancy GCC-like LONG parsing allows things like --opt=param with
1353 * assignment operator. This is used for redirecting stdout/stderr
1354 * console to specific files of your choice.
1356 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1358 char **argv = *argv_;
1360 size_t len = strlen(optname);
1362 if (strncmp(argv[0]+ds, optname, len))
1365 /* it's --optname, check how the parameter is supplied */
1366 if (argv[0][ds+len] == '=') {
1367 *out = argv[0]+ds+len+1;
1371 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1374 /* using --opt param */
1381 int main(int argc, char **argv) {
1382 bool succeed = false;
1383 char *redirout = (char*)stdout;
1384 char *redirerr = (char*)stderr;
1388 OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = 16;
1391 * Command line option parsing commences now We only need to support
1392 * a few things in the test suite.
1398 if (argv[0][0] == '-') {
1399 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1401 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1403 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1406 con_change(redirout, redirerr);
1408 if (!strcmp(argv[0]+1, "debug")) {
1409 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1412 if (!strcmp(argv[0]+1, "memchk")) {
1413 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1416 if (!strcmp(argv[0]+1, "nocolor")) {
1421 con_err("invalid argument %s\n", argv[0]+1);
1425 con_change(redirout, redirerr);
1426 succeed = test_perform("tests", defs);
1429 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;