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>
63 static 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];
105 data->handles[0] = fdopen(inhandle [1], "w");
106 data->handles[1] = fdopen(outhandle[0], mode);
107 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 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(FILE **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);
156 char name_err[L_tmpnam];
157 char name_out[L_tmpnam];
160 static FILE **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(FILE **files) {
182 popen_t *open = ((popen_t*)files);
183 fs_file_close(files[1]);
184 fs_file_close(files[2]);
185 remove(open->name_err);
186 remove(open->name_out);
192 # define popen _popen
193 # define pclose _pclose
196 #define TASK_COMPILE 0
197 #define TASK_EXECUTE 1
199 * Task template system:
200 * templates are rules for a specific test, used to create a "task" that
201 * is executed with those set of rules (arguments, and what not). Tests
202 * that don't have a template with them cannot become tasks, since without
203 * the information for that test there is no way to properly "test" them.
204 * Rules for these templates are described in a template file, using a
205 * task template language.
207 * The language is a basic finite statemachine, top-down single-line
208 * description language.
210 * The languge is composed entierly of "tags" which describe a string of
211 * text for a task. Think of it much like a configuration file. Except
212 * it's been designed to allow flexibility and future support for prodecual
215 * The following "tags" are suported by the language
218 * Used to set a description of the current test, this must be
219 * provided, this tag is NOT optional.
222 * Used to set the procedure for the given task, there are two
225 * This simply performs compilation only
227 * This will perform compilation and execution
229 * This will perform compilation, but requires
230 * the compilation to fail in order to succeed.
232 * This must be provided, this tag is NOT optional.
235 * Used to set the compilation flags for the given task, this
236 * must be provided, this tag is NOT optional.
238 * F: Used to set some test suite flags, currently the only option
239 * is -no-defs (to including of defs.qh)
242 * Used to set the execution flags for the given task. This tag
243 * must be provided if T == -execute, otherwise it's erroneous
244 * as compilation only takes place.
247 * Used to describe a string of text that should be matched from
248 * the output of executing the task. If this doesn't match the
249 * task fails. This tag must be provided if T == -execute, otherwise
250 * it's erroneous as compilation only takes place.
253 * Used to specify the INPUT source file to operate on, this must be
254 * provided, this tag is NOT optional
258 * These tags have one-time use, using them more than once will result
259 * in template compilation errors.
261 * Lines beginning with # or // in the template file are comments and
262 * are ignored by the template parser.
264 * Whitespace is optional, with exception to the colon ':' between the
265 * tag and it's assignment value/
267 * The template compiler will detect erronrous tags (optional tags
268 * that need not be set), as well as missing tags, and error accordingly
269 * this will result in the task failing.
284 * This is very much like a compiler code generator :-). This generates
285 * a value from some data observed from the compiler.
287 static bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
290 char **destval = NULL;
296 case 'D': destval = &tmpl->description; break;
297 case 'T': destval = &tmpl->proceduretype; break;
298 case 'C': destval = &tmpl->compileflags; break;
299 case 'E': destval = &tmpl->executeflags; break;
300 case 'I': destval = &tmpl->sourcefile; break;
301 case 'F': destval = &tmpl->testflags; break;
303 con_printmsg(LVL_ERROR, __FILE__, __LINE__, 0, "internal error",
304 "invalid tag `%c:` during code generation\n",
311 * Ensure if for the given tag, there already exists a
315 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "compile error",
316 "tag `%c:` already assigned value: %s\n",
323 * Strip any whitespace that might exist in the value for assignments
326 if (value && *value && (*value == ' ' || *value == '\t'))
332 * Value will contain a newline character at the end, we need to strip
333 * this otherwise kaboom, seriously, kaboom :P
335 if (strchr(value, '\n'))
336 *strrchr(value, '\n')='\0';
339 * Now allocate and set the actual value for the specific tag. Which
340 * was properly selected and can be accessed with *destval.
342 *destval = util_strdup(value);
345 if (*destval == tmpl->description) {
347 * Create some padding for the description to align the
348 * printing of the rules file.
350 if ((desclen = strlen(tmpl->description)) > pad[0])
354 if ((filelen = strlen(file)) > pad[2])
360 static bool task_template_parse(const char *file, task_template_t *tmpl, FILE *fp, size_t *pad) {
369 /* top down parsing */
370 while (fs_file_getline(&back, &size, fp) != EOF) {
371 /* skip whitespace */
373 if (*data && (*data == ' ' || *data == '\t'))
378 * Handle comments inside task tmpl files. We're strict
379 * about the language for fun :-)
382 if (data[1] != '/') {
383 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
384 "invalid character `/`, perhaps you meant `//` ?");
393 * Empty newlines are acceptable as well, so we handle that here
394 * despite being just odd since there should't be that many
395 * empty lines to begin with.
403 * Now begin the actual "tag" stuff. This works as you expect
412 if (data[1] != ':') {
413 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
414 "expected `:` after `%c`",
419 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
420 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl compile error",
421 "failed to generate for given task\n"
428 * Match requires it's own system since we allow multiple M's
429 * for multi-line matching.
433 char *value = &data[3];
434 if (data[1] != ':') {
435 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
436 "expected `:` after `%c`",
443 * Value will contain a newline character at the end, we need to strip
444 * this otherwise kaboom, seriously, kaboom :P
446 if (strrchr(value, '\n'))
447 *strrchr(value, '\n')='\0';
448 else /* cppcheck: possible null pointer dereference */
451 vec_push(tmpl->comparematch, util_strdup(value));
457 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
458 "invalid tag `%c`", *data
461 /* no break required */
464 /* update line and free old sata */
479 * Nullifies the template data: used during initialization of a new
482 static void task_template_nullify(task_template_t *tmpl) {
486 tmpl->description = NULL;
487 tmpl->proceduretype = NULL;
488 tmpl->compileflags = NULL;
489 tmpl->executeflags = NULL;
490 tmpl->comparematch = NULL;
491 tmpl->sourcefile = NULL;
492 tmpl->tempfilename = NULL;
493 tmpl->rulesfile = NULL;
494 tmpl->testflags = NULL;
497 static task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
498 /* a page should be enough */
501 FILE *tempfile = NULL;
502 task_template_t *tmpl = NULL;
504 platform_snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
506 tempfile = fs_file_open(fullfile, "r");
507 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
508 task_template_nullify(tmpl);
511 * Create some padding for the printing to align the
512 * printing of the rules file to the console.
514 if ((filepadd = strlen(fullfile)) > pad[1])
517 tmpl->rulesfile = util_strdup(fullfile);
520 * Esnure the file even exists for the task, this is pretty useless
524 con_err("template file: %s does not exist or invalid permissions\n",
530 if (!task_template_parse(file, tmpl, tempfile, pad)) {
531 con_err("template parse error: error during parsing\n");
536 * Regardless procedure type, the following tags must exist:
542 if (!tmpl->description) {
543 con_err("template compile error: %s missing `D:` tag\n", file);
546 if (!tmpl->proceduretype) {
547 con_err("template compile error: %s missing `T:` tag\n", file);
550 if (!tmpl->compileflags) {
551 con_err("template compile error: %s missing `C:` tag\n", file);
554 if (!tmpl->sourcefile) {
555 con_err("template compile error: %s missing `I:` tag\n", file);
560 * Now lets compile the template, compilation is really just
561 * the process of validating the input.
563 if (!strcmp(tmpl->proceduretype, "-compile")) {
564 if (tmpl->executeflags)
565 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
566 if (tmpl->comparematch)
567 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
569 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
570 if (!tmpl->executeflags) {
571 /* default to $null */
572 tmpl->executeflags = util_strdup("$null");
574 if (!tmpl->comparematch) {
575 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
578 } else if (!strcmp(tmpl->proceduretype, "-fail")) {
579 if (tmpl->executeflags)
580 con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
581 if (tmpl->comparematch)
582 con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
583 } else if (!strcmp(tmpl->proceduretype, "-diagnostic")) {
584 if (tmpl->executeflags)
585 con_err("template compile warning: %s erroneous tag `E:` when only diagnostic\n", file);
586 if (!tmpl->comparematch) {
587 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
590 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
591 if (tmpl->executeflags)
592 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
593 if (!tmpl->comparematch) {
594 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
598 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
603 fs_file_close(tempfile);
608 * The file might not exist and we jump here when that doesn't happen
609 * so the check to see if it's not null here is required.
612 fs_file_close(tempfile);
618 static void task_template_destroy(task_template_t *tmpl) {
622 if (tmpl->description) mem_d(tmpl->description);
623 if (tmpl->proceduretype) mem_d(tmpl->proceduretype);
624 if (tmpl->compileflags) mem_d(tmpl->compileflags);
625 if (tmpl->executeflags) mem_d(tmpl->executeflags);
626 if (tmpl->sourcefile) mem_d(tmpl->sourcefile);
627 if (tmpl->rulesfile) mem_d(tmpl->rulesfile);
628 if (tmpl->testflags) mem_d(tmpl->testflags);
631 * Delete all allocated string for task tmpl then destroy the
636 for (; i < vec_size(tmpl->comparematch); i++)
637 mem_d(tmpl->comparematch[i]);
639 vec_free(tmpl->comparematch);
643 * Nullify all the template members otherwise NULL comparision
644 * checks will fail if tmpl pointer is reused.
646 mem_d(tmpl->tempfilename);
651 * Now comes the task manager, this system allows adding tasks in and out
652 * of a task list. This is the executor of the tasks essentially as well.
655 task_template_t *tmpl;
664 static task_t *task_tasks = NULL;
667 * Read a directory and searches for all template files in it
668 * which is later used to run all tests.
670 static bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
673 struct dirent *files;
674 struct stat directory;
677 char **directories = NULL;
678 char *claim = util_strdup(curdir);
681 vec_push(directories, claim);
682 dir = fs_dir_open(claim);
685 * Generate a list of subdirectories since we'll be checking them too
688 while ((files = fs_dir_read(dir))) {
689 util_asprintf(&claim, "%s/%s", curdir, files->d_name);
690 if (stat(claim, &directory) == -1) {
696 if (S_ISDIR(directory.st_mode) && files->d_name[0] != '.') {
697 vec_push(directories, claim);
706 * Now do all the work, by touching all the directories inside
707 * test as well and compile the task templates into data we can
708 * use to run the tests.
710 for (i = 0; i < vec_size(directories); i++) {
711 dir = fs_dir_open(directories[i]);
713 while ((files = fs_dir_read(dir))) {
714 platform_snprintf(buffer, sizeof(buffer), "%s/%s", directories[i], files->d_name);
715 if (stat(buffer, &directory) == -1) {
716 con_err("internal error: stat failed, aborting\n");
720 if (S_ISDIR(directory.st_mode))
724 * We made it here, which concludes the file/directory is not
725 * actually a directory, so it must be a file :)
727 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
728 task_template_t *tmpl = task_template_compile(files->d_name, directories[i], pad);
729 char buf[4096]; /* one page should be enough */
730 const char *qcflags = NULL;
735 con_err("error compiling task template: %s\n", files->d_name);
740 * Generate a temportary file name for the output binary
741 * so we don't trample over an existing one.
743 tmpl->tempfilename = NULL;
744 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", directories[i], files->d_name);
747 * Additional QCFLAGS enviroment variable may be used
748 * to test compile flags for all tests. This needs to be
749 * BEFORE other flags (so that the .tmpl can override them)
751 qcflags = platform_getenv("QCFLAGS");
754 * Generate the command required to open a pipe to a process
755 * which will be refered to with a handle in the task for
756 * reading the data from the pipe.
758 if (strcmp(tmpl->proceduretype, "-pp")) {
760 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
761 platform_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
762 task_bins[TASK_COMPILE],
770 platform_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
771 task_bins[TASK_COMPILE],
782 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
783 platform_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
784 task_bins[TASK_COMPILE],
791 platform_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
792 task_bins[TASK_COMPILE],
803 /* Preprocessing (qcflags mean shit all here we don't allow them) */
804 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
805 platform_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
806 task_bins[TASK_COMPILE],
812 platform_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
813 task_bins[TASK_COMPILE],
824 * The task template was compiled, now lets create a task from
825 * the template data which has now been propagated.
828 if (!(task.runhandles = task_popen(buf, "r"))) {
829 con_err("error opening pipe to process for test: %s\n", tmpl->description);
835 * Open up some file desciptors for logging the stdout/stderr
838 platform_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
839 task.stdoutlogfile = util_strdup(buf);
840 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
841 con_err("error opening %s for stdout\n", buf);
845 platform_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
846 task.stderrlogfile = util_strdup(buf);
847 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
848 con_err("error opening %s for stderr\n", buf);
852 vec_push(task_tasks, task);
857 mem_d(directories[i]); /* free claimed memory */
859 vec_free(directories);
865 * Task precleanup removes any existing temporary files or log files
866 * left behind from a previous invoke of the test-suite.
868 static void task_precleanup(const char *curdir) {
870 struct dirent *files;
873 dir = fs_dir_open(curdir);
875 while ((files = fs_dir_read(dir))) {
876 if (strstr(files->d_name, "TMP") ||
877 strstr(files->d_name, ".stdout") ||
878 strstr(files->d_name, ".stderr"))
880 platform_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
882 con_err("error removing temporary file: %s\n", buffer);
889 static void task_destroy(void) {
891 * Free all the data in the task list and finally the list itself
892 * then proceed to cleanup anything else outside the program like
896 for (i = 0; i < vec_size(task_tasks); i++) {
898 * Close any open handles to files or processes here. It's mighty
899 * annoying to have to do all this cleanup work.
901 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
902 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
905 * Only remove the log files if the test actually compiled otherwise
906 * forget about it (or if it didn't compile, and the procedure type
907 * was set to -fail (meaning it shouldn't compile) .. stil remove)
909 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
910 if (remove(task_tasks[i].stdoutlogfile))
911 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
912 if (remove(task_tasks[i].stderrlogfile))
913 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
915 (void)!remove(task_tasks[i].tmpl->tempfilename);
918 /* free util_strdup data for log files */
919 mem_d(task_tasks[i].stdoutlogfile);
920 mem_d(task_tasks[i].stderrlogfile);
922 task_template_destroy(task_tasks[i].tmpl);
924 vec_free(task_tasks);
928 * This executes the QCVM task for a specificly compiled progs.dat
929 * using the template passed into it for call-flags and user defined
930 * messages IF the procedure type is -execute, otherwise it matches
931 * the preprocessor output.
933 static bool task_trymatch(size_t i, char ***line) {
936 int retval = EXIT_SUCCESS;
939 task_template_t *tmpl = task_tasks[i].tmpl;
941 memset (buffer,0,sizeof(buffer));
943 if (!strcmp(tmpl->proceduretype, "-execute")) {
945 * Drop the execution flags for the QCVM if none where
946 * actually specified.
948 if (!strcmp(tmpl->executeflags, "$null")) {
949 platform_snprintf(buffer, sizeof(buffer), "%s %s",
950 task_bins[TASK_EXECUTE],
954 platform_snprintf(buffer, sizeof(buffer), "%s %s %s",
955 task_bins[TASK_EXECUTE],
961 execute = popen(buffer, "r");
964 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
966 * we're preprocessing, which means we need to read int
967 * the produced file and do some really weird shit.
969 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
975 * we're testing diagnostic output, which means it will be
976 * in runhandles[2] (stderr) since that is where the compiler
979 if (!(execute = fs_file_open(task_tasks[i].stderrlogfile, "r")))
986 * Now lets read the lines and compare them to the matches we expect
987 * and handle accordingly.
994 while (fs_file_getline(&data, &size, execute) != EOF) {
995 if (!strcmp(data, "No main function found\n")) {
996 con_err("test failure: `%s` (No main function found) [%s]\n",
1001 fs_file_close(execute);
1008 * Trim newlines from data since they will just break our
1009 * ability to properly validate matches.
1011 if (strrchr(data, '\n'))
1012 *strrchr(data, '\n') = '\0';
1015 * We remove the file/directory and stuff from the error
1016 * match messages when testing diagnostics.
1018 if(!strcmp(tmpl->proceduretype, "-diagnostic")) {
1019 if (strstr(data, "there have been errors, bailing out"))
1020 continue; /* ignore it */
1021 if (strstr(data, ": error: ")) {
1022 char *claim = util_strdup(data + (strstr(data, ": error: ") - data) + 9);
1029 * We need to ignore null lines for when -pp is used (preprocessor), since
1030 * the preprocessor is likely to create empty newlines in certain macro
1031 * instantations, otherwise it's in the wrong nature to ignore empty newlines.
1033 if (!strcmp(tmpl->proceduretype, "-pp") && !*data)
1036 if (vec_size(tmpl->comparematch) > compare) {
1037 if (strcmp(data, tmpl->comparematch[compare++])) {
1045 * Copy to output vector for diagnostics if execution match
1048 vec_push(*line, data);
1055 if (compare != vec_size(tmpl->comparematch))
1063 retval = pclose(execute);
1065 fs_file_close(execute);
1067 return success && retval == EXIT_SUCCESS;
1070 static const char *task_type(task_template_t *tmpl) {
1071 if (!strcmp(tmpl->proceduretype, "-pp"))
1072 return "type: preprocessor";
1073 if (!strcmp(tmpl->proceduretype, "-execute"))
1074 return "type: execution";
1075 if (!strcmp(tmpl->proceduretype, "-compile"))
1076 return "type: compile";
1077 if (!strcmp(tmpl->proceduretype, "-diagnostic"))
1078 return "type: diagnostic";
1079 return "type: fail";
1083 * This schedualizes all tasks and actually runs them individually
1084 * this is generally easy for just -compile variants. For compile and
1085 * execution this takes more work since a task needs to be generated
1086 * from thin air and executed INLINE.
1089 static size_t task_schedualize(size_t *pad) {
1091 bool execute = false;
1093 char **match = NULL;
1099 platform_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1101 for (; i < vec_size(task_tasks); i++) {
1102 memset(space[1], 0, sizeof(space[1]));
1103 platform_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1105 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1108 * Generate a task from thin air if it requires execution in
1112 /* diagnostic is not executed, but compare tested instead, like preproessor */
1113 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1114 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp")) ||
1115 (!strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"));
1118 * We assume it compiled before we actually compiled :). On error
1119 * we change the value
1121 task_tasks[i].compiled = true;
1124 * Read data from stdout first and pipe that stuff into a log file
1125 * then we do the same for stderr.
1127 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1128 fs_file_puts(task_tasks[i].stdoutlog, data);
1130 if (strstr(data, "failed to open file")) {
1131 task_tasks[i].compiled = false;
1135 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1137 * If a string contains an error we just dissalow execution
1140 * TODO: make this more percise, e.g if we print a warning
1141 * that refers to a variable named error, or something like
1142 * that .. then this will blowup :P
1144 if (strstr(data, "error") && strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic")) {
1146 task_tasks[i].compiled = false;
1149 fs_file_puts (task_tasks[i].stderrlog, data);
1150 fflush(task_tasks[i].stderrlog); /* fast flush for read */
1153 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1154 con_out("failure: `%s` %*s %*s\n",
1155 task_tasks[i].tmpl->description,
1156 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1157 task_tasks[i].tmpl->rulesfile,
1158 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1159 "(failed to compile)"
1165 if (task_pclose(task_tasks[i].runhandles) != EXIT_SUCCESS && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1166 con_out("failure: `%s` %*s %*s\n",
1167 task_tasks[i].tmpl->description,
1168 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1169 task_tasks[i].tmpl->rulesfile,
1170 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(compiler didn't return exit success)") - pad[2]),
1171 "(compiler didn't return exit success)"
1178 con_out("succeeded: `%s` %*s %*s\n",
1179 task_tasks[i].tmpl->description,
1180 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1181 task_tasks[i].tmpl->rulesfile,
1182 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1183 task_type(task_tasks[i].tmpl)
1190 * If we made it here that concludes the task is to be executed
1191 * in the virtual machine (or the preprocessor output needs to
1194 if (!task_trymatch(i, &match)) {
1197 con_out("failure: `%s` %*s %*s\n",
1198 task_tasks[i].tmpl->description,
1199 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1200 task_tasks[i].tmpl->rulesfile,
1201 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1202 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1203 ? "(invalid results from execution)"
1204 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1205 ? "(invalid results from preprocessing)"
1206 : "(invalid results from compiler diagnsotics)"
1208 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1209 ? "(invalid results from execution)"
1210 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1211 ? "(invalid results from preprocessing)"
1212 : "(invalid results from compiler diagnsotics)"
1216 * Print nicely formatted expected match lists to console error
1217 * handler for the all the given matches in the template file and
1218 * what was actually returned from executing.
1220 con_out(" Expected From %u Matches: (got %u Matches)\n",
1221 vec_size(task_tasks[i].tmpl->comparematch),
1224 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1225 char *select = task_tasks[i].tmpl->comparematch[d];
1226 size_t length = 60 - strlen(select);
1228 con_out(" Expected: \"%s\"", select);
1231 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1235 * Print the non-expected out (since we are simply not expecting it)
1236 * This will help track down bugs in template files that fail to match
1239 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1240 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1241 con_out(" Expected: Nothing | Got: \"%s\"\n",
1242 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1248 for (j = 0; j < vec_size(match); j++)
1255 for (j = 0; j < vec_size(match); j++)
1259 con_out("succeeded: `%s` %*s %*s\n",
1260 task_tasks[i].tmpl->description,
1261 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1262 task_tasks[i].tmpl->rulesfile,
1263 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1264 task_type(task_tasks[i].tmpl)
1273 * This is the heart of the whole test-suite process. This cleans up
1274 * any existing temporary files left behind as well as log files left
1275 * behind. Then it propagates a list of tests from `curdir` by scaning
1276 * it for template files and compiling them into tasks, in which it
1277 * schedualizes them (executes them) and actually reports errors and
1278 * what not. It then proceeds to destroy the tasks and return memory
1279 * it's the engine :)
1281 * It returns true of tests could be propagated, otherwise it returns
1284 * It expects con_init() was called before hand.
1286 static GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1287 size_t failed = false;
1288 static const char *default_defs = "defs.qh";
1291 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1296 * If the default definition file isn't set to anything. We will
1297 * use the default_defs here, which is "defs.qc"
1300 defs = default_defs;
1304 task_precleanup(curdir);
1305 if (!task_propagate(curdir, pad, defs)) {
1306 con_err("error: failed to propagate tasks\n");
1311 * If we made it here all tasks where propagated from their resultant
1312 * template file. So we can start the FILO scheduler, this has been
1313 * designed in the most thread-safe way possible for future threading
1314 * it's designed to prevent lock contention, and possible syncronization
1317 failed = task_schedualize(pad);
1319 con_out("%u out of %u tests failed\n", failed, vec_size(task_tasks));
1322 return (failed) ? false : true;
1326 * Fancy GCC-like LONG parsing allows things like --opt=param with
1327 * assignment operator. This is used for redirecting stdout/stderr
1328 * console to specific files of your choice.
1330 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1332 char **argv = *argv_;
1334 size_t len = strlen(optname);
1336 if (strncmp(argv[0]+ds, optname, len))
1339 /* it's --optname, check how the parameter is supplied */
1340 if (argv[0][ds+len] == '=') {
1341 *out = argv[0]+ds+len+1;
1345 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1348 /* using --opt param */
1355 int main(int argc, char **argv) {
1356 bool succeed = false;
1357 char *redirout = (char*)stdout;
1358 char *redirerr = (char*)stderr;
1362 OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = 16;
1365 * Command line option parsing commences now We only need to support
1366 * a few things in the test suite.
1372 if (argv[0][0] == '-') {
1373 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1375 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1377 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1380 con_change(redirout, redirerr);
1382 if (!strcmp(argv[0]+1, "debug")) {
1383 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1386 if (!strcmp(argv[0]+1, "memchk")) {
1387 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1390 if (!strcmp(argv[0]+1, "nocolor")) {
1395 con_err("invalid argument %s\n", argv[0]+1);
1399 con_change(redirout, redirerr);
1400 succeed = test_perform("tests", defs);
1403 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;