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));
165 tmpnam(open->name_err);
166 tmpnam(open->name_out);
168 (void)mode; /* excluded */
170 util_asprintf(&cmd, "%s -redirout=%s -redirerr=%s", command, open->name_out, open->name_err);
172 system(cmd); /* HACK */
173 open->handles[0] = NULL;
174 open->handles[1] = fs_file_open(open->name_out, "r");
175 open->handles[2] = fs_file_open(open->name_err, "r");
179 return open->handles;
182 static void task_pclose(FILE **files) {
183 popen_t *open = ((popen_t*)files);
184 fs_file_close(files[1]);
185 fs_file_close(files[2]);
186 remove(open->name_err);
187 remove(open->name_out);
193 #define TASK_COMPILE 0
194 #define TASK_EXECUTE 1
196 * Task template system:
197 * templates are rules for a specific test, used to create a "task" that
198 * is executed with those set of rules (arguments, and what not). Tests
199 * that don't have a template with them cannot become tasks, since without
200 * the information for that test there is no way to properly "test" them.
201 * Rules for these templates are described in a template file, using a
202 * task template language.
204 * The language is a basic finite statemachine, top-down single-line
205 * description language.
207 * The languge is composed entierly of "tags" which describe a string of
208 * text for a task. Think of it much like a configuration file. Except
209 * it's been designed to allow flexibility and future support for prodecual
212 * The following "tags" are suported by the language
215 * Used to set a description of the current test, this must be
216 * provided, this tag is NOT optional.
219 * Used to set the procedure for the given task, there are two
222 * This simply performs compilation only
224 * This will perform compilation and execution
226 * This will perform compilation, but requires
227 * the compilation to fail in order to succeed.
229 * This must be provided, this tag is NOT optional.
232 * Used to set the compilation flags for the given task, this
233 * must be provided, this tag is NOT optional.
235 * F: Used to set some test suite flags, currently the only option
236 * is -no-defs (to including of defs.qh)
239 * Used to set the execution flags for the given task. This tag
240 * must be provided if T == -execute, otherwise it's erroneous
241 * as compilation only takes place.
244 * Used to describe a string of text that should be matched from
245 * the output of executing the task. If this doesn't match the
246 * task fails. This tag must be provided if T == -execute, otherwise
247 * it's erroneous as compilation only takes place.
250 * Used to specify the INPUT source file to operate on, this must be
251 * provided, this tag is NOT optional
255 * These tags have one-time use, using them more than once will result
256 * in template compilation errors.
258 * Lines beginning with # or // in the template file are comments and
259 * are ignored by the template parser.
261 * Whitespace is optional, with exception to the colon ':' between the
262 * tag and it's assignment value/
264 * The template compiler will detect erronrous tags (optional tags
265 * that need not be set), as well as missing tags, and error accordingly
266 * this will result in the task failing.
281 * This is very much like a compiler code generator :-). This generates
282 * a value from some data observed from the compiler.
284 static bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
287 char **destval = NULL;
293 case 'D': destval = &tmpl->description; break;
294 case 'T': destval = &tmpl->proceduretype; break;
295 case 'C': destval = &tmpl->compileflags; break;
296 case 'E': destval = &tmpl->executeflags; break;
297 case 'I': destval = &tmpl->sourcefile; break;
298 case 'F': destval = &tmpl->testflags; break;
300 con_printmsg(LVL_ERROR, __FILE__, __LINE__, 0, "internal error",
301 "invalid tag `%c:` during code generation\n",
308 * Ensure if for the given tag, there already exists a
312 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "compile error",
313 "tag `%c:` already assigned value: %s\n",
320 * Strip any whitespace that might exist in the value for assignments
323 if (value && *value && (*value == ' ' || *value == '\t'))
329 * Value will contain a newline character at the end, we need to strip
330 * this otherwise kaboom, seriously, kaboom :P
332 if (strchr(value, '\n'))
333 *strrchr(value, '\n')='\0';
336 * Now allocate and set the actual value for the specific tag. Which
337 * was properly selected and can be accessed with *destval.
339 *destval = util_strdup(value);
342 if (*destval == tmpl->description) {
344 * Create some padding for the description to align the
345 * printing of the rules file.
347 if ((desclen = strlen(tmpl->description)) > pad[0])
351 if ((filelen = strlen(file)) > pad[2])
357 static bool task_template_parse(const char *file, task_template_t *tmpl, FILE *fp, size_t *pad) {
366 /* top down parsing */
367 while (fs_file_getline(&back, &size, fp) != EOF) {
368 /* skip whitespace */
370 if (*data && (*data == ' ' || *data == '\t'))
375 * Handle comments inside task tmpl files. We're strict
376 * about the language for fun :-)
379 if (data[1] != '/') {
380 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
381 "invalid character `/`, perhaps you meant `//` ?");
390 * Empty newlines are acceptable as well, so we handle that here
391 * despite being just odd since there should't be that many
392 * empty lines to begin with.
400 * Now begin the actual "tag" stuff. This works as you expect
409 if (data[1] != ':') {
410 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
411 "expected `:` after `%c`",
416 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
417 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl compile error",
418 "failed to generate for given task\n"
425 * Match requires it's own system since we allow multiple M's
426 * for multi-line matching.
430 char *value = &data[3];
431 if (data[1] != ':') {
432 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
433 "expected `:` after `%c`",
439 if (value && (*value == ' ' || *value == '\t'))
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 util_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 util_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 char *qcflags = NULL;
733 util_debug("TEST", "compiling task template: %s/%s\n", directories[i], files->d_name);
736 con_err("error compiling task template: %s\n", files->d_name);
741 * Generate a temportary file name for the output binary
742 * so we don't trample over an existing one.
744 tmpl->tempfilename = NULL;
745 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", directories[i], files->d_name);
748 * Additional QCFLAGS enviroment variable may be used
749 * to test compile flags for all tests. This needs to be
750 * BEFORE other flags (so that the .tmpl can override them)
756 getenv_s(&size, buffer, sizeof(buffer), "QCFLAGS");
760 qcflags = getenv("QCFLAGS");
764 * Generate the command required to open a pipe to a process
765 * which will be refered to with a handle in the task for
766 * reading the data from the pipe.
768 if (strcmp(tmpl->proceduretype, "-pp")) {
770 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
771 util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
772 task_bins[TASK_COMPILE],
780 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
781 task_bins[TASK_COMPILE],
792 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
793 util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
794 task_bins[TASK_COMPILE],
801 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
802 task_bins[TASK_COMPILE],
813 /* Preprocessing (qcflags mean shit all here we don't allow them) */
814 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
815 util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
816 task_bins[TASK_COMPILE],
822 util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
823 task_bins[TASK_COMPILE],
834 * The task template was compiled, now lets create a task from
835 * the template data which has now been propagated.
838 if (!(task.runhandles = task_popen(buf, "r"))) {
839 con_err("error opening pipe to process for test: %s\n", tmpl->description);
844 util_debug("TEST", "executing test: `%s` [%s]\n", tmpl->description, buf);
847 * Open up some file desciptors for logging the stdout/stderr
850 util_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
851 task.stdoutlogfile = util_strdup(buf);
852 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
853 con_err("error opening %s for stdout\n", buf);
857 util_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
858 task.stderrlogfile = util_strdup(buf);
859 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
860 con_err("error opening %s for stderr\n", buf);
864 vec_push(task_tasks, task);
869 mem_d(directories[i]); /* free claimed memory */
871 vec_free(directories);
873 util_debug("TEST", "compiled %d task template files out of %d\n",
874 vec_size(task_tasks),
882 * Task precleanup removes any existing temporary files or log files
883 * left behind from a previous invoke of the test-suite.
885 static void task_precleanup(const char *curdir) {
887 struct dirent *files;
890 dir = fs_dir_open(curdir);
892 while ((files = fs_dir_read(dir))) {
893 if (strstr(files->d_name, "TMP") ||
894 strstr(files->d_name, ".stdout") ||
895 strstr(files->d_name, ".stderr"))
897 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
899 con_err("error removing temporary file: %s\n", buffer);
901 util_debug("TEST", "removed temporary file: %s\n", buffer);
908 static void task_destroy(void) {
910 * Free all the data in the task list and finally the list itself
911 * then proceed to cleanup anything else outside the program like
915 for (i = 0; i < vec_size(task_tasks); i++) {
917 * Close any open handles to files or processes here. It's mighty
918 * annoying to have to do all this cleanup work.
920 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
921 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
922 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
925 * Only remove the log files if the test actually compiled otherwise
926 * forget about it (or if it didn't compile, and the procedure type
927 * was set to -fail (meaning it shouldn't compile) .. stil remove)
929 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
930 if (remove(task_tasks[i].stdoutlogfile))
931 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
933 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
934 if (remove(task_tasks[i].stderrlogfile))
935 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
937 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
939 (void)!remove(task_tasks[i].tmpl->tempfilename);
942 /* free util_strdup data for log files */
943 mem_d(task_tasks[i].stdoutlogfile);
944 mem_d(task_tasks[i].stderrlogfile);
946 task_template_destroy(&task_tasks[i].tmpl);
948 vec_free(task_tasks);
952 * This executes the QCVM task for a specificly compiled progs.dat
953 * using the template passed into it for call-flags and user defined
954 * messages IF the procedure type is -execute, otherwise it matches
955 * the preprocessor output.
957 static bool task_trymatch(size_t i, char ***line) {
962 task_template_t *tmpl = task_tasks[i].tmpl;
964 memset (buffer,0,sizeof(buffer));
966 if (!strcmp(tmpl->proceduretype, "-execute")) {
968 * Drop the execution flags for the QCVM if none where
969 * actually specified.
971 if (!strcmp(tmpl->executeflags, "$null")) {
972 util_snprintf(buffer, sizeof(buffer), "%s %s",
973 task_bins[TASK_EXECUTE],
977 util_snprintf(buffer, sizeof(buffer), "%s %s %s",
978 task_bins[TASK_EXECUTE],
984 util_debug("TEST", "executing qcvm: `%s` [%s]\n",
989 execute = popen(buffer, "r");
992 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
994 * we're preprocessing, which means we need to read int
995 * the produced file and do some really weird shit.
997 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
1003 * we're testing diagnostic output, which means it will be
1004 * in runhandles[2] (stderr) since that is where the compiler
1007 if (!(execute = fs_file_open(task_tasks[i].stderrlogfile, "r")))
1014 * Now lets read the lines and compare them to the matches we expect
1015 * and handle accordingly.
1022 while (fs_file_getline(&data, &size, execute) != EOF) {
1023 if (!strcmp(data, "No main function found\n")) {
1024 con_err("test failure: `%s` (No main function found) [%s]\n",
1029 fs_file_close(execute);
1036 * Trim newlines from data since they will just break our
1037 * ability to properly validate matches.
1039 if (strrchr(data, '\n'))
1040 *strrchr(data, '\n') = '\0';
1043 * We remove the file/directory and stuff from the error
1044 * match messages when testing diagnostics.
1046 if(!strcmp(tmpl->proceduretype, "-diagnostic")) {
1047 if (strstr(data, "there have been errors, bailing out"))
1048 continue; /* ignore it */
1049 if (strstr(data, ": error: ")) {
1050 char *claim = util_strdup(data + (strstr(data, ": error: ") - data) + 9);
1057 * If data is just null now, that means the line was an empty
1058 * one and for that, we just ignore it.
1063 if (vec_size(tmpl->comparematch) > compare) {
1064 if (strcmp(data, tmpl->comparematch[compare++])) {
1072 * Copy to output vector for diagnostics if execution match
1075 vec_push(*line, data);
1088 fs_file_close(execute);
1093 static const char *task_type(task_template_t *tmpl) {
1094 if (!strcmp(tmpl->proceduretype, "-pp"))
1095 return "type: preprocessor";
1096 if (!strcmp(tmpl->proceduretype, "-execute"))
1097 return "type: execution";
1098 if (!strcmp(tmpl->proceduretype, "-compile"))
1099 return "type: compile";
1100 if (!strcmp(tmpl->proceduretype, "-diagnostic"))
1101 return "type: diagnostic";
1102 return "type: fail";
1106 * This schedualizes all tasks and actually runs them individually
1107 * this is generally easy for just -compile variants. For compile and
1108 * execution this takes more work since a task needs to be generated
1109 * from thin air and executed INLINE.
1112 static size_t task_schedualize(size_t *pad) {
1114 bool execute = false;
1116 char **match = NULL;
1122 util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1124 for (; i < vec_size(task_tasks); i++) {
1125 memset(space[1], 0, sizeof(space[1]));
1126 util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1128 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1130 util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].tmpl->description);
1132 * Generate a task from thin air if it requires execution in
1136 /* diagnostic is not executed, but compare tested instead, like preproessor */
1137 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1138 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp")) ||
1139 (!strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"));
1142 * We assume it compiled before we actually compiled :). On error
1143 * we change the value
1145 task_tasks[i].compiled = true;
1148 * Read data from stdout first and pipe that stuff into a log file
1149 * then we do the same for stderr.
1151 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
1152 fs_file_puts(task_tasks[i].stdoutlog, data);
1154 if (strstr(data, "failed to open file")) {
1155 task_tasks[i].compiled = false;
1159 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
1161 * If a string contains an error we just dissalow execution
1164 * TODO: make this more percise, e.g if we print a warning
1165 * that refers to a variable named error, or something like
1166 * that .. then this will blowup :P
1168 if (strstr(data, "error") && strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic")) {
1170 task_tasks[i].compiled = false;
1173 fs_file_puts (task_tasks[i].stderrlog, data);
1174 fflush(task_tasks[i].stderrlog); /* fast flush for read */
1177 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1178 con_out("failure: `%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("(failed to compile)") - pad[2]),
1183 "(failed to compile)"
1190 con_out("succeeded: `%s` %*s %*s\n",
1191 task_tasks[i].tmpl->description,
1192 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1193 task_tasks[i].tmpl->rulesfile,
1194 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1195 task_type(task_tasks[i].tmpl)
1202 * If we made it here that concludes the task is to be executed
1203 * in the virtual machine (or the preprocessor output needs to
1206 if (!task_trymatch(i, &match)) {
1209 con_out("failure: `%s` %*s %*s\n",
1210 task_tasks[i].tmpl->description,
1211 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1212 task_tasks[i].tmpl->rulesfile,
1213 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1214 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1215 ? "(invalid results from execution)"
1216 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1217 ? "(invalid results from preprocessing)"
1218 : "(invalid results from compiler diagnsotics)"
1220 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1221 ? "(invalid results from execution)"
1222 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1223 ? "(invalid results from preprocessing)"
1224 : "(invalid results from compiler diagnsotics)"
1228 * Print nicely formatted expected match lists to console error
1229 * handler for the all the given matches in the template file and
1230 * what was actually returned from executing.
1232 con_out(" Expected From %u Matches: (got %u Matches)\n",
1233 vec_size(task_tasks[i].tmpl->comparematch),
1236 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1237 char *select = task_tasks[i].tmpl->comparematch[d];
1238 size_t length = 60 - strlen(select);
1240 con_out(" Expected: \"%s\"", select);
1243 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1247 * Print the non-expected out (since we are simply not expecting it)
1248 * This will help track down bugs in template files that fail to match
1251 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1252 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1253 con_out(" Expected: Nothing | Got: \"%s\"\n",
1254 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1260 for (j = 0; j < vec_size(match); j++)
1267 for (j = 0; j < vec_size(match); j++)
1271 con_out("succeeded: `%s` %*s %*s\n",
1272 task_tasks[i].tmpl->description,
1273 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1274 task_tasks[i].tmpl->rulesfile,
1275 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1276 task_type(task_tasks[i].tmpl)
1285 * This is the heart of the whole test-suite process. This cleans up
1286 * any existing temporary files left behind as well as log files left
1287 * behind. Then it propagates a list of tests from `curdir` by scaning
1288 * it for template files and compiling them into tasks, in which it
1289 * schedualizes them (executes them) and actually reports errors and
1290 * what not. It then proceeds to destroy the tasks and return memory
1291 * it's the engine :)
1293 * It returns true of tests could be propagated, otherwise it returns
1296 * It expects con_init() was called before hand.
1298 static GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1299 size_t failed = false;
1300 static const char *default_defs = "defs.qh";
1303 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1308 * If the default definition file isn't set to anything. We will
1309 * use the default_defs here, which is "defs.qc"
1312 defs = default_defs;
1316 task_precleanup(curdir);
1317 if (!task_propagate(curdir, pad, defs)) {
1318 con_err("error: failed to propagate tasks\n");
1323 * If we made it here all tasks where propagated from their resultant
1324 * template file. So we can start the FILO scheduler, this has been
1325 * designed in the most thread-safe way possible for future threading
1326 * it's designed to prevent lock contention, and possible syncronization
1329 failed = task_schedualize(pad);
1331 con_out("%u out of %u tests failed\n", failed, vec_size(task_tasks));
1334 return (failed) ? false : true;
1338 * Fancy GCC-like LONG parsing allows things like --opt=param with
1339 * assignment operator. This is used for redirecting stdout/stderr
1340 * console to specific files of your choice.
1342 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1344 char **argv = *argv_;
1346 size_t len = strlen(optname);
1348 if (strncmp(argv[0]+ds, optname, len))
1351 /* it's --optname, check how the parameter is supplied */
1352 if (argv[0][ds+len] == '=') {
1353 *out = argv[0]+ds+len+1;
1357 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1360 /* using --opt param */
1367 int main(int argc, char **argv) {
1368 bool succeed = false;
1369 char *redirout = (char*)stdout;
1370 char *redirerr = (char*)stderr;
1374 OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = 16;
1377 * Command line option parsing commences now We only need to support
1378 * a few things in the test suite.
1384 if (argv[0][0] == '-') {
1385 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1387 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1389 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1392 con_change(redirout, redirerr);
1394 if (!strcmp(argv[0]+1, "debug")) {
1395 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1398 if (!strcmp(argv[0]+1, "memchk")) {
1399 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1402 if (!strcmp(argv[0]+1, "nocolor")) {
1407 con_err("invalid argument %s\n", argv[0]+1);
1411 con_change(redirout, redirerr);
1412 succeed = test_perform("tests", defs);
1416 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;