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
29 static 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>
55 fs_file_t *handles[3];
63 static fs_file_t **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];
105 data->handles[0] = (fs_file_t*)fdopen(inhandle [1], "w");
106 data->handles[1] = (fs_file_t*)fdopen(outhandle[0], mode);
107 data->handles[2] = (fs_file_t*)fdopen(errhandle[0], mode);
111 return data->handles;
112 } else if (data->pid == 0) {
118 /* see piping documentation for this sillyness :P */
119 dup2(inhandle [0], 0);
120 dup2(outhandle[1], 1);
121 dup2(errhandle[1], 2);
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]);
139 static int task_pclose(fs_file_t **handles) {
140 popen_t *data = (popen_t*)handles;
143 close(data->pipes[0]); /* stdin */
144 close(data->pipes[1]); /* stdout */
145 close(data->pipes[2]); /* stderr */
147 waitpid(data->pid, &status, 0);
155 fs_file_t *handles[3];
156 char name_err[L_tmpnam];
157 char name_out[L_tmpnam];
160 static fs_file_t **task_popen(const char *command, const char *mode) {
162 popen_t *open = (popen_t*)mem_a(sizeof(popen_t));
164 platform_tmpnam(open->name_err);
165 platform_tmpnam(open->name_out);
167 (void)mode; /* excluded */
169 util_asprintf(&cmd, "%s -redirout=%s -redirerr=%s", command, open->name_out, open->name_err);
171 system(cmd); /* HACK */
172 open->handles[0] = NULL;
173 open->handles[1] = fs_file_open(open->name_out, "r");
174 open->handles[2] = fs_file_open(open->name_err, "r");
178 return open->handles;
181 static int task_pclose(fs_file_t **files) {
182 popen_t *open = ((popen_t*)files);
184 fs_file_close(files[1]);
185 fs_file_close(files[2]);
187 remove(open->name_err);
188 remove(open->name_out);
194 # define popen _popen
195 # define pclose _pclose
198 #define TASK_COMPILE 0
199 #define TASK_EXECUTE 1
201 * Task template system:
202 * templates are rules for a specific test, used to create a "task" that
203 * is executed with those set of rules (arguments, and what not). Tests
204 * that don't have a template with them cannot become tasks, since without
205 * the information for that test there is no way to properly "test" them.
206 * Rules for these templates are described in a template file, using a
207 * task template language.
209 * The language is a basic finite statemachine, top-down single-line
210 * description language.
212 * The languge is composed entierly of "tags" which describe a string of
213 * text for a task. Think of it much like a configuration file. Except
214 * it's been designed to allow flexibility and future support for prodecual
217 * The following "tags" are suported by the language
220 * Used to set a description of the current test, this must be
221 * provided, this tag is NOT optional.
224 * Used to set the procedure for the given task, there are two
227 * This simply performs compilation only
229 * This will perform compilation and execution
231 * This will perform compilation, but requires
232 * the compilation to fail in order to succeed.
234 * This must be provided, this tag is NOT optional.
237 * Used to set the compilation flags for the given task, this
238 * must be provided, this tag is NOT optional.
240 * F: Used to set some test suite flags, currently the only option
241 * is -no-defs (to including of defs.qh)
244 * Used to set the execution flags for the given task. This tag
245 * must be provided if T == -execute, otherwise it's erroneous
246 * as compilation only takes place.
249 * Used to describe a string of text that should be matched from
250 * the output of executing the task. If this doesn't match the
251 * task fails. This tag must be provided if T == -execute, otherwise
252 * it's erroneous as compilation only takes place.
255 * Used to specify the INPUT source file to operate on, this must be
256 * provided, this tag is NOT optional
260 * These tags have one-time use, using them more than once will result
261 * in template compilation errors.
263 * Lines beginning with # or // in the template file are comments and
264 * are ignored by the template parser.
266 * Whitespace is optional, with exception to the colon ':' between the
267 * tag and it's assignment value/
269 * The template compiler will detect erronrous tags (optional tags
270 * that need not be set), as well as missing tags, and error accordingly
271 * this will result in the task failing.
286 * This is very much like a compiler code generator :-). This generates
287 * a value from some data observed from the compiler.
289 static bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
292 char **destval = NULL;
298 case 'D': destval = &tmpl->description; break;
299 case 'T': destval = &tmpl->proceduretype; break;
300 case 'C': destval = &tmpl->compileflags; break;
301 case 'E': destval = &tmpl->executeflags; break;
302 case 'I': destval = &tmpl->sourcefile; break;
303 case 'F': destval = &tmpl->testflags; break;
305 con_printmsg(LVL_ERROR, __FILE__, __LINE__, 0, "internal error",
306 "invalid tag `%c:` during code generation\n",
313 * Ensure if for the given tag, there already exists a
317 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "compile error",
318 "tag `%c:` already assigned value: %s\n",
325 * Strip any whitespace that might exist in the value for assignments
328 if (value && *value && (*value == ' ' || *value == '\t'))
334 * Value will contain a newline character at the end, we need to strip
335 * this otherwise kaboom, seriously, kaboom :P
337 if (strchr(value, '\n'))
338 *strrchr(value, '\n')='\0';
341 * Now allocate and set the actual value for the specific tag. Which
342 * was properly selected and can be accessed with *destval.
344 *destval = util_strdup(value);
347 if (*destval == tmpl->description) {
349 * Create some padding for the description to align the
350 * printing of the rules file.
352 if ((desclen = strlen(tmpl->description)) > pad[0])
356 if ((filelen = strlen(file)) > pad[2])
362 static bool task_template_parse(const char *file, task_template_t *tmpl, fs_file_t *fp, size_t *pad) {
371 /* top down parsing */
372 while (fs_file_getline(&back, &size, fp) != EOF) {
373 /* skip whitespace */
375 if (*data && (*data == ' ' || *data == '\t'))
380 * Handle comments inside task tmpl files. We're strict
381 * about the language for fun :-)
384 if (data[1] != '/') {
385 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
386 "invalid character `/`, perhaps you meant `//` ?");
395 * Empty newlines are acceptable as well, so we handle that here
396 * despite being just odd since there should't be that many
397 * empty lines to begin with.
405 * Now begin the actual "tag" stuff. This works as you expect
414 if (data[1] != ':') {
415 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
416 "expected `:` after `%c`",
421 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
422 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl compile error",
423 "failed to generate for given task\n"
430 * Match requires it's own system since we allow multiple M's
431 * for multi-line matching.
435 char *value = &data[3];
436 if (data[1] != ':') {
437 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
438 "expected `:` after `%c`",
445 * Value will contain a newline character at the end, we need to strip
446 * this otherwise kaboom, seriously, kaboom :P
448 if (strrchr(value, '\n'))
449 *strrchr(value, '\n')='\0';
450 else /* cppcheck: possible null pointer dereference */
453 vec_push(tmpl->comparematch, util_strdup(value));
459 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
460 "invalid tag `%c`", *data
463 /* no break required */
466 /* update line and free old sata */
481 * Nullifies the template data: used during initialization of a new
484 static void task_template_nullify(task_template_t *tmpl) {
488 tmpl->description = NULL;
489 tmpl->proceduretype = NULL;
490 tmpl->compileflags = NULL;
491 tmpl->executeflags = NULL;
492 tmpl->comparematch = NULL;
493 tmpl->sourcefile = NULL;
494 tmpl->tempfilename = NULL;
495 tmpl->rulesfile = NULL;
496 tmpl->testflags = NULL;
499 static task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
500 /* a page should be enough */
503 fs_file_t *tempfile = NULL;
504 task_template_t *tmpl = NULL;
506 platform_snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
508 tempfile = fs_file_open(fullfile, "r");
509 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
510 task_template_nullify(tmpl);
513 * Create some padding for the printing to align the
514 * printing of the rules file to the console.
516 if ((filepadd = strlen(fullfile)) > pad[1])
519 tmpl->rulesfile = util_strdup(fullfile);
522 * Esnure the file even exists for the task, this is pretty useless
526 con_err("template file: %s does not exist or invalid permissions\n",
532 if (!task_template_parse(file, tmpl, tempfile, pad)) {
533 con_err("template parse error: error during parsing\n");
538 * Regardless procedure type, the following tags must exist:
544 if (!tmpl->description) {
545 con_err("template compile error: %s missing `D:` tag\n", file);
548 if (!tmpl->proceduretype) {
549 con_err("template compile error: %s missing `T:` tag\n", file);
552 if (!tmpl->compileflags) {
553 con_err("template compile error: %s missing `C:` tag\n", file);
556 if (!tmpl->sourcefile) {
557 con_err("template compile error: %s missing `I:` tag\n", file);
562 * Now lets compile the template, compilation is really just
563 * the process of validating the input.
565 if (!strcmp(tmpl->proceduretype, "-compile")) {
566 if (tmpl->executeflags)
567 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
568 if (tmpl->comparematch)
569 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
571 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
572 if (!tmpl->executeflags) {
573 /* default to $null */
574 tmpl->executeflags = util_strdup("$null");
576 if (!tmpl->comparematch) {
577 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
580 } else if (!strcmp(tmpl->proceduretype, "-fail")) {
581 if (tmpl->executeflags)
582 con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
583 if (tmpl->comparematch)
584 con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
585 } else if (!strcmp(tmpl->proceduretype, "-diagnostic")) {
586 if (tmpl->executeflags)
587 con_err("template compile warning: %s erroneous tag `E:` when only diagnostic\n", file);
588 if (!tmpl->comparematch) {
589 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
592 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
593 if (tmpl->executeflags)
594 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
595 if (!tmpl->comparematch) {
596 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
600 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
605 fs_file_close(tempfile);
610 * The file might not exist and we jump here when that doesn't happen
611 * so the check to see if it's not null here is required.
614 fs_file_close(tempfile);
620 static void task_template_destroy(task_template_t *tmpl) {
624 if (tmpl->description) mem_d(tmpl->description);
625 if (tmpl->proceduretype) mem_d(tmpl->proceduretype);
626 if (tmpl->compileflags) mem_d(tmpl->compileflags);
627 if (tmpl->executeflags) mem_d(tmpl->executeflags);
628 if (tmpl->sourcefile) mem_d(tmpl->sourcefile);
629 if (tmpl->rulesfile) mem_d(tmpl->rulesfile);
630 if (tmpl->testflags) mem_d(tmpl->testflags);
633 * Delete all allocated string for task tmpl then destroy the
638 for (; i < vec_size(tmpl->comparematch); i++)
639 mem_d(tmpl->comparematch[i]);
641 vec_free(tmpl->comparematch);
645 * Nullify all the template members otherwise NULL comparision
646 * checks will fail if tmpl pointer is reused.
648 mem_d(tmpl->tempfilename);
653 * Now comes the task manager, this system allows adding tasks in and out
654 * of a task list. This is the executor of the tasks essentially as well.
657 task_template_t *tmpl;
658 fs_file_t **runhandles;
659 fs_file_t *stderrlog;
660 fs_file_t *stdoutlog;
666 static task_t *task_tasks = NULL;
669 * Read a directory and searches for all template files in it
670 * which is later used to run all tests.
672 static bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
676 struct stat directory;
679 char **directories = NULL;
680 char *claim = util_strdup(curdir);
683 vec_push(directories, claim);
684 dir = fs_dir_open(claim);
687 * Generate a list of subdirectories since we'll be checking them too
690 while ((files = fs_dir_read(dir))) {
691 util_asprintf(&claim, "%s/%s", curdir, files->d_name);
692 if (stat(claim, &directory) == -1) {
698 if (S_ISDIR(directory.st_mode) && files->d_name[0] != '.') {
699 vec_push(directories, claim);
708 * Now do all the work, by touching all the directories inside
709 * test as well and compile the task templates into data we can
710 * use to run the tests.
712 for (i = 0; i < vec_size(directories); i++) {
713 dir = fs_dir_open(directories[i]);
715 while ((files = fs_dir_read(dir))) {
716 platform_snprintf(buffer, sizeof(buffer), "%s/%s", directories[i], files->d_name);
717 if (stat(buffer, &directory) == -1) {
718 con_err("internal error: stat failed, aborting\n");
722 if (S_ISDIR(directory.st_mode))
726 * We made it here, which concludes the file/directory is not
727 * actually a directory, so it must be a file :)
729 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
730 task_template_t *tmpl = task_template_compile(files->d_name, directories[i], pad);
731 char buf[4096]; /* one page should be enough */
732 const char *qcflags = NULL;
737 con_err("error compiling task template: %s\n", files->d_name);
742 * Generate a temportary file name for the output binary
743 * so we don't trample over an existing one.
745 tmpl->tempfilename = NULL;
746 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", directories[i], files->d_name);
749 * Additional QCFLAGS enviroment variable may be used
750 * to test compile flags for all tests. This needs to be
751 * BEFORE other flags (so that the .tmpl can override them)
753 qcflags = platform_getenv("QCFLAGS");
756 * Generate the command required to open a pipe to a process
757 * which will be refered to with a handle in the task for
758 * reading the data from the pipe.
760 if (strcmp(tmpl->proceduretype, "-pp")) {
762 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
763 platform_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
764 task_bins[TASK_COMPILE],
772 platform_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
773 task_bins[TASK_COMPILE],
784 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
785 platform_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
786 task_bins[TASK_COMPILE],
793 platform_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
794 task_bins[TASK_COMPILE],
805 /* Preprocessing (qcflags mean shit all here we don't allow them) */
806 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
807 platform_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
808 task_bins[TASK_COMPILE],
814 platform_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
815 task_bins[TASK_COMPILE],
826 * The task template was compiled, now lets create a task from
827 * the template data which has now been propagated.
830 if (!(task.runhandles = task_popen(buf, "r"))) {
831 con_err("error opening pipe to process for test: %s\n", tmpl->description);
837 * Open up some file desciptors for logging the stdout/stderr
840 platform_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
841 task.stdoutlogfile = util_strdup(buf);
842 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
843 con_err("error opening %s for stdout\n", buf);
847 platform_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
848 task.stderrlogfile = util_strdup(buf);
849 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
850 con_err("error opening %s for stderr\n", buf);
854 vec_push(task_tasks, task);
859 mem_d(directories[i]); /* free claimed memory */
861 vec_free(directories);
867 * Task precleanup removes any existing temporary files or log files
868 * left behind from a previous invoke of the test-suite.
870 static void task_precleanup(const char *curdir) {
875 dir = fs_dir_open(curdir);
877 while ((files = fs_dir_read(dir))) {
878 if (strstr(files->d_name, "TMP") ||
879 strstr(files->d_name, ".stdout") ||
880 strstr(files->d_name, ".stderr"))
882 platform_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
884 con_err("error removing temporary file: %s\n", buffer);
891 static void task_destroy(void) {
893 * Free all the data in the task list and finally the list itself
894 * then proceed to cleanup anything else outside the program like
898 for (i = 0; i < vec_size(task_tasks); i++) {
900 * Close any open handles to files or processes here. It's mighty
901 * annoying to have to do all this cleanup work.
903 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
904 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
907 * Only remove the log files if the test actually compiled otherwise
908 * forget about it (or if it didn't compile, and the procedure type
909 * was set to -fail (meaning it shouldn't compile) .. stil remove)
911 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
912 if (remove(task_tasks[i].stdoutlogfile))
913 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
914 if (remove(task_tasks[i].stderrlogfile))
915 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
917 (void)!remove(task_tasks[i].tmpl->tempfilename);
920 /* free util_strdup data for log files */
921 mem_d(task_tasks[i].stdoutlogfile);
922 mem_d(task_tasks[i].stderrlogfile);
924 task_template_destroy(task_tasks[i].tmpl);
926 vec_free(task_tasks);
930 * This executes the QCVM task for a specificly compiled progs.dat
931 * using the template passed into it for call-flags and user defined
932 * messages IF the procedure type is -execute, otherwise it matches
933 * the preprocessor output.
935 static bool task_trymatch(size_t i, char ***line) {
938 int retval = EXIT_SUCCESS;
941 task_template_t *tmpl = task_tasks[i].tmpl;
943 memset (buffer,0,sizeof(buffer));
945 if (!strcmp(tmpl->proceduretype, "-execute")) {
947 * Drop the execution flags for the QCVM if none where
948 * actually specified.
950 if (!strcmp(tmpl->executeflags, "$null")) {
951 platform_snprintf(buffer, sizeof(buffer), "%s %s",
952 task_bins[TASK_EXECUTE],
956 platform_snprintf(buffer, sizeof(buffer), "%s %s %s",
957 task_bins[TASK_EXECUTE],
963 execute = (fs_file_t*)popen(buffer, "r");
966 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
968 * we're preprocessing, which means we need to read int
969 * the produced file and do some really weird shit.
971 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
977 * we're testing diagnostic output, which means it will be
978 * in runhandles[2] (stderr) since that is where the compiler
981 if (!(execute = fs_file_open(task_tasks[i].stderrlogfile, "r")))
988 * Now lets read the lines and compare them to the matches we expect
989 * and handle accordingly.
996 while (fs_file_getline(&data, &size, execute) != EOF) {
997 if (!strcmp(data, "No main function found\n")) {
998 con_err("test failure: `%s` (No main function found) [%s]\n",
1003 fs_file_close(execute);
1005 pclose((FILE*)execute);
1010 * Trim newlines from data since they will just break our
1011 * ability to properly validate matches.
1013 if (strrchr(data, '\n'))
1014 *strrchr(data, '\n') = '\0';
1017 * We remove the file/directory and stuff from the error
1018 * match messages when testing diagnostics.
1020 if(!strcmp(tmpl->proceduretype, "-diagnostic")) {
1021 if (strstr(data, "there have been errors, bailing out"))
1022 continue; /* ignore it */
1023 if (strstr(data, ": error: ")) {
1024 char *claim = util_strdup(data + (strstr(data, ": error: ") - data) + 9);
1031 * We need to ignore null lines for when -pp is used (preprocessor), since
1032 * the preprocessor is likely to create empty newlines in certain macro
1033 * instantations, otherwise it's in the wrong nature to ignore empty newlines.
1035 if (!strcmp(tmpl->proceduretype, "-pp") && !*data)
1038 if (vec_size(tmpl->comparematch) > compare) {
1039 if (strcmp(data, tmpl->comparematch[compare++])) {
1047 * Copy to output vector for diagnostics if execution match
1050 vec_push(*line, data);
1057 if (compare != vec_size(tmpl->comparematch))
1065 retval = pclose((FILE*)execute);
1067 fs_file_close(execute);
1069 return success && retval == EXIT_SUCCESS;
1072 static const char *task_type(task_template_t *tmpl) {
1073 if (!strcmp(tmpl->proceduretype, "-pp"))
1074 return "type: preprocessor";
1075 if (!strcmp(tmpl->proceduretype, "-execute"))
1076 return "type: execution";
1077 if (!strcmp(tmpl->proceduretype, "-compile"))
1078 return "type: compile";
1079 if (!strcmp(tmpl->proceduretype, "-diagnostic"))
1080 return "type: diagnostic";
1081 return "type: fail";
1085 * This schedualizes all tasks and actually runs them individually
1086 * this is generally easy for just -compile variants. For compile and
1087 * execution this takes more work since a task needs to be generated
1088 * from thin air and executed INLINE.
1091 static size_t task_schedualize(size_t *pad) {
1093 bool execute = false;
1095 char **match = NULL;
1101 platform_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1103 for (; i < vec_size(task_tasks); i++) {
1104 memset(space[1], 0, sizeof(space[1]));
1105 platform_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1107 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1110 * Generate a task from thin air if it requires execution in
1114 /* diagnostic is not executed, but compare tested instead, like preproessor */
1115 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1116 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp")) ||
1117 (!strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"));
1120 * We assume it compiled before we actually compiled :). On error
1121 * we change the value
1123 task_tasks[i].compiled = true;
1126 * Read data from stdout first and pipe that stuff into a log file
1127 * then we do the same for stderr.
1129 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1130 fs_file_puts(task_tasks[i].stdoutlog, data);
1132 if (strstr(data, "failed to open file")) {
1133 task_tasks[i].compiled = false;
1137 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1139 * If a string contains an error we just dissalow execution
1142 * TODO: make this more percise, e.g if we print a warning
1143 * that refers to a variable named error, or something like
1144 * that .. then this will blowup :P
1146 if (strstr(data, "error") && strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic")) {
1148 task_tasks[i].compiled = false;
1151 fs_file_puts (task_tasks[i].stderrlog, data);
1152 fs_file_flush(task_tasks[i].stderrlog); /* fast flush for read */
1155 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1156 con_out("failure: `%s` %*s %*s\n",
1157 task_tasks[i].tmpl->description,
1158 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1159 task_tasks[i].tmpl->rulesfile,
1160 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1161 "(failed to compile)"
1167 if (task_pclose(task_tasks[i].runhandles) != EXIT_SUCCESS && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1168 con_out("failure: `%s` %*s %*s\n",
1169 task_tasks[i].tmpl->description,
1170 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1171 task_tasks[i].tmpl->rulesfile,
1172 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(compiler didn't return exit success)") - pad[2]),
1173 "(compiler didn't return exit success)"
1180 con_out("succeeded: `%s` %*s %*s\n",
1181 task_tasks[i].tmpl->description,
1182 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1183 task_tasks[i].tmpl->rulesfile,
1184 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1185 task_type(task_tasks[i].tmpl)
1192 * If we made it here that concludes the task is to be executed
1193 * in the virtual machine (or the preprocessor output needs to
1196 if (!task_trymatch(i, &match)) {
1199 con_out("failure: `%s` %*s %*s\n",
1200 task_tasks[i].tmpl->description,
1201 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1202 task_tasks[i].tmpl->rulesfile,
1203 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1204 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1205 ? "(invalid results from execution)"
1206 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1207 ? "(invalid results from preprocessing)"
1208 : "(invalid results from compiler diagnsotics)"
1210 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1211 ? "(invalid results from execution)"
1212 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1213 ? "(invalid results from preprocessing)"
1214 : "(invalid results from compiler diagnsotics)"
1218 * Print nicely formatted expected match lists to console error
1219 * handler for the all the given matches in the template file and
1220 * what was actually returned from executing.
1222 con_out(" Expected From %u Matches: (got %u Matches)\n",
1223 vec_size(task_tasks[i].tmpl->comparematch),
1226 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1227 char *select = task_tasks[i].tmpl->comparematch[d];
1228 size_t length = 60 - strlen(select);
1230 con_out(" Expected: \"%s\"", select);
1233 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1237 * Print the non-expected out (since we are simply not expecting it)
1238 * This will help track down bugs in template files that fail to match
1241 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1242 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1243 con_out(" Expected: Nothing | Got: \"%s\"\n",
1244 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1250 for (j = 0; j < vec_size(match); j++)
1257 for (j = 0; j < vec_size(match); j++)
1261 con_out("succeeded: `%s` %*s %*s\n",
1262 task_tasks[i].tmpl->description,
1263 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1264 task_tasks[i].tmpl->rulesfile,
1265 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1266 task_type(task_tasks[i].tmpl)
1275 * This is the heart of the whole test-suite process. This cleans up
1276 * any existing temporary files left behind as well as log files left
1277 * behind. Then it propagates a list of tests from `curdir` by scaning
1278 * it for template files and compiling them into tasks, in which it
1279 * schedualizes them (executes them) and actually reports errors and
1280 * what not. It then proceeds to destroy the tasks and return memory
1281 * it's the engine :)
1283 * It returns true of tests could be propagated, otherwise it returns
1286 * It expects con_init() was called before hand.
1288 static GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1289 size_t failed = false;
1290 static const char *default_defs = "defs.qh";
1293 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1298 * If the default definition file isn't set to anything. We will
1299 * use the default_defs here, which is "defs.qc"
1302 defs = default_defs;
1306 task_precleanup(curdir);
1307 if (!task_propagate(curdir, pad, defs)) {
1308 con_err("error: failed to propagate tasks\n");
1313 * If we made it here all tasks where propagated from their resultant
1314 * template file. So we can start the FILO scheduler, this has been
1315 * designed in the most thread-safe way possible for future threading
1316 * it's designed to prevent lock contention, and possible syncronization
1319 failed = task_schedualize(pad);
1321 con_out("%u out of %u tests failed\n", failed, vec_size(task_tasks));
1324 return (failed) ? false : true;
1328 * Fancy GCC-like LONG parsing allows things like --opt=param with
1329 * assignment operator. This is used for redirecting stdout/stderr
1330 * console to specific files of your choice.
1332 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1334 char **argv = *argv_;
1336 size_t len = strlen(optname);
1338 if (strncmp(argv[0]+ds, optname, len))
1341 /* it's --optname, check how the parameter is supplied */
1342 if (argv[0][ds+len] == '=') {
1343 *out = argv[0]+ds+len+1;
1347 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1350 /* using --opt param */
1357 int main(int argc, char **argv) {
1358 bool succeed = false;
1359 char *redirout = (char*)stdout;
1360 char *redirerr = (char*)stderr;
1364 OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = 16;
1367 * Command line option parsing commences now We only need to support
1368 * a few things in the test suite.
1374 if (argv[0][0] == '-') {
1375 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1377 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1379 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1382 con_change(redirout, redirerr);
1384 if (!strcmp(argv[0]+1, "debug")) {
1385 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1388 if (!strcmp(argv[0]+1, "memchk")) {
1389 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1392 if (!strcmp(argv[0]+1, "nocolor")) {
1397 con_err("invalid argument %s\n", argv[0]+1);
1401 con_change(redirout, redirerr);
1402 succeed = test_perform("tests", defs);
1405 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;