2 * Copyright (C) 2012, 2013, 2014
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
23 #define GMQCC_PLATFORM_HEADER /* TODO: eliminate! */
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>
56 fs_file_t *handles[3];
64 static fs_file_t **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] = (fs_file_t*)fdopen(inhandle [1], "w");
107 data->handles[1] = (fs_file_t*)fdopen(outhandle[0], mode);
108 data->handles[2] = (fs_file_t*)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(fs_file_t **handles) {
141 popen_t *data = (popen_t*)handles;
144 close(data->pipes[0]); /* stdin */
145 close(data->pipes[1]); /* stdout */
146 close(data->pipes[2]); /* stderr */
148 waitpid(data->pid, &status, 0);
155 #include <sys/stat.h>
157 fs_file_t *handles[3];
158 char name_err[L_tmpnam];
159 char name_out[L_tmpnam];
162 static fs_file_t **task_popen(const char *command, const char *mode) {
164 popen_t *open = (popen_t*)mem_a(sizeof(popen_t));
166 tmpnam(open->name_err);
167 tmpnam(open->name_out);
169 (void)mode; /* excluded */
171 util_asprintf(&cmd, "%s -redirout=%s -redirerr=%s", command, open->name_out, open->name_err);
173 system(cmd); /* HACK */
174 open->handles[0] = NULL;
175 open->handles[1] = fs_file_open(open->name_out, "r");
176 open->handles[2] = fs_file_open(open->name_err, "r");
180 return open->handles;
183 static int task_pclose(fs_file_t **files) {
184 popen_t *open = ((popen_t*)files);
186 fs_file_close(files[1]);
187 fs_file_close(files[2]);
189 remove(open->name_err);
190 remove(open->name_out);
196 # define popen _popen
197 # define pclose _pclose
200 #define TASK_COMPILE 0
201 #define TASK_EXECUTE 1
203 * Task template system:
204 * templates are rules for a specific test, used to create a "task" that
205 * is executed with those set of rules (arguments, and what not). Tests
206 * that don't have a template with them cannot become tasks, since without
207 * the information for that test there is no way to properly "test" them.
208 * Rules for these templates are described in a template file, using a
209 * task template language.
211 * The language is a basic finite statemachine, top-down single-line
212 * description language.
214 * The languge is composed entierly of "tags" which describe a string of
215 * text for a task. Think of it much like a configuration file. Except
216 * it's been designed to allow flexibility and future support for prodecual
219 * The following "tags" are suported by the language
222 * Used to set a description of the current test, this must be
223 * provided, this tag is NOT optional.
226 * Used to set the procedure for the given task, there are two
229 * This simply performs compilation only
231 * This will perform compilation and execution
233 * This will perform compilation, but requires
234 * the compilation to fail in order to succeed.
236 * This must be provided, this tag is NOT optional.
239 * Used to set the compilation flags for the given task, this
240 * must be provided, this tag is NOT optional.
242 * F: Used to set some test suite flags, currently the only option
243 * is -no-defs (to including of defs.qh)
246 * Used to set the execution flags for the given task. This tag
247 * must be provided if T == -execute, otherwise it's erroneous
248 * as compilation only takes place.
251 * Used to describe a string of text that should be matched from
252 * the output of executing the task. If this doesn't match the
253 * task fails. This tag must be provided if T == -execute, otherwise
254 * it's erroneous as compilation only takes place.
257 * Used to specify the INPUT source file to operate on, this must be
258 * provided, this tag is NOT optional
262 * These tags have one-time use, using them more than once will result
263 * in template compilation errors.
265 * Lines beginning with # or // in the template file are comments and
266 * are ignored by the template parser.
268 * Whitespace is optional, with exception to the colon ':' between the
269 * tag and it's assignment value/
271 * The template compiler will detect erronrous tags (optional tags
272 * that need not be set), as well as missing tags, and error accordingly
273 * this will result in the task failing.
288 * This is very much like a compiler code generator :-). This generates
289 * a value from some data observed from the compiler.
291 static bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
294 char **destval = NULL;
300 case 'D': destval = &tmpl->description; break;
301 case 'T': destval = &tmpl->proceduretype; break;
302 case 'C': destval = &tmpl->compileflags; break;
303 case 'E': destval = &tmpl->executeflags; break;
304 case 'I': destval = &tmpl->sourcefile; break;
305 case 'F': destval = &tmpl->testflags; break;
307 con_printmsg(LVL_ERROR, __FILE__, __LINE__, 0, "internal error",
308 "invalid tag `%c:` during code generation\n",
315 * Ensure if for the given tag, there already exists a
319 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "compile error",
320 "tag `%c:` already assigned value: %s\n",
327 * Strip any whitespace that might exist in the value for assignments
330 if (value && *value && (*value == ' ' || *value == '\t'))
336 * Value will contain a newline character at the end, we need to strip
337 * this otherwise kaboom, seriously, kaboom :P
339 if (strchr(value, '\n'))
340 *strrchr(value, '\n')='\0';
343 * Now allocate and set the actual value for the specific tag. Which
344 * was properly selected and can be accessed with *destval.
346 *destval = util_strdup(value);
349 if (*destval == tmpl->description) {
351 * Create some padding for the description to align the
352 * printing of the rules file.
354 if ((desclen = strlen(tmpl->description)) > pad[0])
358 if ((filelen = strlen(file)) > pad[2])
364 static bool task_template_parse(const char *file, task_template_t *tmpl, fs_file_t *fp, size_t *pad) {
373 /* top down parsing */
374 while (fs_file_getline(&back, &size, fp) != FS_FILE_EOF) {
375 /* skip whitespace */
377 if (*data && (*data == ' ' || *data == '\t'))
382 * Handle comments inside task tmpl files. We're strict
383 * about the language for fun :-)
386 if (data[1] != '/') {
387 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
388 "invalid character `/`, perhaps you meant `//` ?");
397 * Empty newlines are acceptable as well, so we handle that here
398 * despite being just odd since there should't be that many
399 * empty lines to begin with.
407 * Now begin the actual "tag" stuff. This works as you expect
416 if (data[1] != ':') {
417 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
418 "expected `:` after `%c`",
423 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
424 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl compile error",
425 "failed to generate for given task\n"
432 * Match requires it's own system since we allow multiple M's
433 * for multi-line matching.
437 char *value = &data[3];
438 if (data[1] != ':') {
439 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
440 "expected `:` after `%c`",
447 * Value will contain a newline character at the end, we need to strip
448 * this otherwise kaboom, seriously, kaboom :P
450 if (strrchr(value, '\n'))
451 *strrchr(value, '\n')='\0';
452 else /* cppcheck: possible null pointer dereference */
455 vec_push(tmpl->comparematch, util_strdup(value));
461 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
462 "invalid tag `%c`", *data
465 /* no break required */
468 /* update line and free old sata */
483 * Nullifies the template data: used during initialization of a new
486 static void task_template_nullify(task_template_t *tmpl) {
490 tmpl->description = NULL;
491 tmpl->proceduretype = NULL;
492 tmpl->compileflags = NULL;
493 tmpl->executeflags = NULL;
494 tmpl->comparematch = NULL;
495 tmpl->sourcefile = NULL;
496 tmpl->tempfilename = NULL;
497 tmpl->rulesfile = NULL;
498 tmpl->testflags = NULL;
501 static task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
502 /* a page should be enough */
505 fs_file_t *tempfile = NULL;
506 task_template_t *tmpl = NULL;
508 util_snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
510 tempfile = fs_file_open(fullfile, "r");
511 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
512 task_template_nullify(tmpl);
515 * Create some padding for the printing to align the
516 * printing of the rules file to the console.
518 if ((filepadd = strlen(fullfile)) > pad[1])
521 tmpl->rulesfile = util_strdup(fullfile);
524 * Esnure the file even exists for the task, this is pretty useless
528 con_err("template file: %s does not exist or invalid permissions\n",
534 if (!task_template_parse(file, tmpl, tempfile, pad)) {
535 con_err("template parse error: error during parsing\n");
540 * Regardless procedure type, the following tags must exist:
546 if (!tmpl->description) {
547 con_err("template compile error: %s missing `D:` tag\n", file);
550 if (!tmpl->proceduretype) {
551 con_err("template compile error: %s missing `T:` tag\n", file);
554 if (!tmpl->compileflags) {
555 con_err("template compile error: %s missing `C:` tag\n", file);
558 if (!tmpl->sourcefile) {
559 con_err("template compile error: %s missing `I:` tag\n", file);
564 * Now lets compile the template, compilation is really just
565 * the process of validating the input.
567 if (!strcmp(tmpl->proceduretype, "-compile")) {
568 if (tmpl->executeflags)
569 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
570 if (tmpl->comparematch)
571 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
573 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
574 if (!tmpl->executeflags) {
575 /* default to $null */
576 tmpl->executeflags = util_strdup("$null");
578 if (!tmpl->comparematch) {
579 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
582 } else if (!strcmp(tmpl->proceduretype, "-fail")) {
583 if (tmpl->executeflags)
584 con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
585 if (tmpl->comparematch)
586 con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
587 } else if (!strcmp(tmpl->proceduretype, "-diagnostic")) {
588 if (tmpl->executeflags)
589 con_err("template compile warning: %s erroneous tag `E:` when only diagnostic\n", file);
590 if (!tmpl->comparematch) {
591 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
594 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
595 if (tmpl->executeflags)
596 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
597 if (!tmpl->comparematch) {
598 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
602 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
607 fs_file_close(tempfile);
612 * The file might not exist and we jump here when that doesn't happen
613 * so the check to see if it's not null here is required.
616 fs_file_close(tempfile);
622 static void task_template_destroy(task_template_t *tmpl) {
626 if (tmpl->description) mem_d(tmpl->description);
627 if (tmpl->proceduretype) mem_d(tmpl->proceduretype);
628 if (tmpl->compileflags) mem_d(tmpl->compileflags);
629 if (tmpl->executeflags) mem_d(tmpl->executeflags);
630 if (tmpl->sourcefile) mem_d(tmpl->sourcefile);
631 if (tmpl->rulesfile) mem_d(tmpl->rulesfile);
632 if (tmpl->testflags) mem_d(tmpl->testflags);
635 * Delete all allocated string for task tmpl then destroy the
640 for (; i < vec_size(tmpl->comparematch); i++)
641 mem_d(tmpl->comparematch[i]);
643 vec_free(tmpl->comparematch);
647 * Nullify all the template members otherwise NULL comparision
648 * checks will fail if tmpl pointer is reused.
650 mem_d(tmpl->tempfilename);
655 * Now comes the task manager, this system allows adding tasks in and out
656 * of a task list. This is the executor of the tasks essentially as well.
659 task_template_t *tmpl;
660 fs_file_t **runhandles;
661 fs_file_t *stderrlog;
662 fs_file_t *stdoutlog;
668 static task_t *task_tasks = NULL;
671 * Read a directory and searches for all template files in it
672 * which is later used to run all tests.
674 static bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
678 struct stat directory;
681 char **directories = NULL;
682 char *claim = util_strdup(curdir);
685 vec_push(directories, claim);
686 dir = fs_dir_open(claim);
689 * Generate a list of subdirectories since we'll be checking them too
692 while ((files = fs_dir_read(dir))) {
693 util_asprintf(&claim, "%s/%s", curdir, files->d_name);
694 if (stat(claim, &directory) == -1) {
700 if (S_ISDIR(directory.st_mode) && files->d_name[0] != '.') {
701 vec_push(directories, claim);
710 * Now do all the work, by touching all the directories inside
711 * test as well and compile the task templates into data we can
712 * use to run the tests.
714 for (i = 0; i < vec_size(directories); i++) {
715 dir = fs_dir_open(directories[i]);
717 while ((files = fs_dir_read(dir))) {
718 util_snprintf(buffer, sizeof(buffer), "%s/%s", directories[i], files->d_name);
719 if (stat(buffer, &directory) == -1) {
720 con_err("internal error: stat failed, aborting\n");
724 if (S_ISDIR(directory.st_mode))
728 * We made it here, which concludes the file/directory is not
729 * actually a directory, so it must be a file :)
731 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
732 task_template_t *tmpl = task_template_compile(files->d_name, directories[i], pad);
733 char buf[4096]; /* one page should be enough */
734 const char *qcflags = NULL;
739 con_err("error compiling task template: %s\n", files->d_name);
744 * Generate a temportary file name for the output binary
745 * so we don't trample over an existing one.
747 tmpl->tempfilename = NULL;
748 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s.dat", directories[i], files->d_name);
751 * Additional QCFLAGS enviroment variable may be used
752 * to test compile flags for all tests. This needs to be
753 * BEFORE other flags (so that the .tmpl can override them)
755 qcflags = platform_getenv("QCFLAGS");
758 * Generate the command required to open a pipe to a process
759 * which will be refered to with a handle in the task for
760 * reading the data from the pipe.
762 if (strcmp(tmpl->proceduretype, "-pp")) {
764 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
765 util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
766 task_bins[TASK_COMPILE],
774 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
775 task_bins[TASK_COMPILE],
786 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
787 util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
788 task_bins[TASK_COMPILE],
795 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
796 task_bins[TASK_COMPILE],
807 /* Preprocessing (qcflags mean shit all here we don't allow them) */
808 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
809 util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
810 task_bins[TASK_COMPILE],
816 util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
817 task_bins[TASK_COMPILE],
828 * The task template was compiled, now lets create a task from
829 * the template data which has now been propagated.
832 if (!(task.runhandles = task_popen(buf, "r"))) {
833 con_err("error opening pipe to process for test: %s\n", tmpl->description);
839 * Open up some file desciptors for logging the stdout/stderr
842 util_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
843 task.stdoutlogfile = util_strdup(buf);
844 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
845 con_err("error opening %s for stdout\n", buf);
849 util_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
850 task.stderrlogfile = util_strdup(buf);
851 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
852 con_err("error opening %s for stderr\n", buf);
856 vec_push(task_tasks, task);
861 mem_d(directories[i]); /* free claimed memory */
863 vec_free(directories);
869 * Task precleanup removes any existing temporary files or log files
870 * left behind from a previous invoke of the test-suite.
872 static void task_precleanup(const char *curdir) {
877 dir = fs_dir_open(curdir);
879 while ((files = fs_dir_read(dir))) {
880 if (strstr(files->d_name, "TMP") ||
881 strstr(files->d_name, ".stdout") ||
882 strstr(files->d_name, ".stderr") ||
883 strstr(files->d_name, ".dat"))
885 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
887 con_err("error removing temporary file: %s\n", buffer);
894 static void task_destroy(void) {
896 * Free all the data in the task list and finally the list itself
897 * then proceed to cleanup anything else outside the program like
901 for (i = 0; i < vec_size(task_tasks); i++) {
903 * Close any open handles to files or processes here. It's mighty
904 * annoying to have to do all this cleanup work.
906 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
907 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
910 * Only remove the log files if the test actually compiled otherwise
911 * forget about it (or if it didn't compile, and the procedure type
912 * was set to -fail (meaning it shouldn't compile) .. stil remove)
914 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
915 if (remove(task_tasks[i].stdoutlogfile))
916 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
917 if (remove(task_tasks[i].stderrlogfile))
918 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
920 (void)!remove(task_tasks[i].tmpl->tempfilename);
923 /* free util_strdup data for log files */
924 mem_d(task_tasks[i].stdoutlogfile);
925 mem_d(task_tasks[i].stderrlogfile);
927 task_template_destroy(task_tasks[i].tmpl);
929 vec_free(task_tasks);
933 * This executes the QCVM task for a specificly compiled progs.dat
934 * using the template passed into it for call-flags and user defined
935 * messages IF the procedure type is -execute, otherwise it matches
936 * the preprocessor output.
938 static bool task_trymatch(size_t i, char ***line) {
941 int retval = EXIT_SUCCESS;
944 task_template_t *tmpl = task_tasks[i].tmpl;
946 memset (buffer,0,sizeof(buffer));
948 if (!strcmp(tmpl->proceduretype, "-execute")) {
950 * Drop the execution flags for the QCVM if none where
951 * actually specified.
953 if (!strcmp(tmpl->executeflags, "$null")) {
954 util_snprintf(buffer, sizeof(buffer), "%s %s",
955 task_bins[TASK_EXECUTE],
959 util_snprintf(buffer, sizeof(buffer), "%s %s %s",
960 task_bins[TASK_EXECUTE],
966 execute = (fs_file_t*)popen(buffer, "r");
969 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
971 * we're preprocessing, which means we need to read int
972 * the produced file and do some really weird shit.
974 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
980 * we're testing diagnostic output, which means it will be
981 * in runhandles[2] (stderr) since that is where the compiler
984 if (!(execute = fs_file_open(task_tasks[i].stderrlogfile, "r")))
991 * Now lets read the lines and compare them to the matches we expect
992 * and handle accordingly.
999 while (fs_file_getline(&data, &size, execute) != FS_FILE_EOF) {
1000 if (!strcmp(data, "No main function found\n")) {
1001 con_err("test failure: `%s` (No main function found) [%s]\n",
1006 fs_file_close(execute);
1008 pclose((FILE*)execute);
1013 * Trim newlines from data since they will just break our
1014 * ability to properly validate matches.
1016 if (strrchr(data, '\n'))
1017 *strrchr(data, '\n') = '\0';
1020 * We remove the file/directory and stuff from the error
1021 * match messages when testing diagnostics.
1023 if(!strcmp(tmpl->proceduretype, "-diagnostic")) {
1024 if (strstr(data, "there have been errors, bailing out"))
1025 continue; /* ignore it */
1026 if (strstr(data, ": error: ")) {
1027 char *claim = util_strdup(data + (strstr(data, ": error: ") - data) + 9);
1034 * We need to ignore null lines for when -pp is used (preprocessor), since
1035 * the preprocessor is likely to create empty newlines in certain macro
1036 * instantations, otherwise it's in the wrong nature to ignore empty newlines.
1038 if (!strcmp(tmpl->proceduretype, "-pp") && !*data)
1041 if (vec_size(tmpl->comparematch) > compare) {
1042 if (strcmp(data, tmpl->comparematch[compare++])) {
1050 * Copy to output vector for diagnostics if execution match
1053 vec_push(*line, data);
1060 if (compare != vec_size(tmpl->comparematch))
1068 retval = pclose((FILE*)execute);
1070 fs_file_close(execute);
1072 return success && retval == EXIT_SUCCESS;
1075 static const char *task_type(task_template_t *tmpl) {
1076 if (!strcmp(tmpl->proceduretype, "-pp"))
1077 return "type: preprocessor";
1078 if (!strcmp(tmpl->proceduretype, "-execute"))
1079 return "type: execution";
1080 if (!strcmp(tmpl->proceduretype, "-compile"))
1081 return "type: compile";
1082 if (!strcmp(tmpl->proceduretype, "-diagnostic"))
1083 return "type: diagnostic";
1084 return "type: fail";
1088 * This schedualizes all tasks and actually runs them individually
1089 * this is generally easy for just -compile variants. For compile and
1090 * execution this takes more work since a task needs to be generated
1091 * from thin air and executed INLINE.
1094 static size_t task_schedualize(size_t *pad) {
1096 bool execute = false;
1098 char **match = NULL;
1104 util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1106 for (; i < vec_size(task_tasks); i++) {
1107 memset(space[1], 0, sizeof(space[1]));
1108 util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1110 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1113 * Generate a task from thin air if it requires execution in
1117 /* diagnostic is not executed, but compare tested instead, like preproessor */
1118 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1119 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp")) ||
1120 (!strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"));
1123 * We assume it compiled before we actually compiled :). On error
1124 * we change the value
1126 task_tasks[i].compiled = true;
1129 * Read data from stdout first and pipe that stuff into a log file
1130 * then we do the same for stderr.
1132 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != FS_FILE_EOF) {
1133 fs_file_puts(task_tasks[i].stdoutlog, data);
1135 if (strstr(data, "failed to open file")) {
1136 task_tasks[i].compiled = false;
1140 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != FS_FILE_EOF) {
1142 * If a string contains an error we just dissalow execution
1145 * TODO: make this more percise, e.g if we print a warning
1146 * that refers to a variable named error, or something like
1147 * that .. then this will blowup :P
1149 if (strstr(data, "error") && strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic")) {
1151 task_tasks[i].compiled = false;
1154 fs_file_puts (task_tasks[i].stderrlog, data);
1155 fs_file_flush(task_tasks[i].stderrlog); /* fast flush for read */
1158 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1159 con_out("failure: `%s` %*s %*s\n",
1160 task_tasks[i].tmpl->description,
1161 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1162 task_tasks[i].tmpl->rulesfile,
1163 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1164 "(failed to compile)"
1170 if (task_pclose(task_tasks[i].runhandles) != EXIT_SUCCESS && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1171 con_out("failure: `%s` %*s %*s\n",
1172 task_tasks[i].tmpl->description,
1173 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1174 task_tasks[i].tmpl->rulesfile,
1175 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(compiler didn't return exit success)") - pad[2]),
1176 "(compiler didn't return exit success)"
1183 con_out("succeeded: `%s` %*s %*s\n",
1184 task_tasks[i].tmpl->description,
1185 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1186 task_tasks[i].tmpl->rulesfile,
1187 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1188 task_type(task_tasks[i].tmpl)
1195 * If we made it here that concludes the task is to be executed
1196 * in the virtual machine (or the preprocessor output needs to
1199 if (!task_trymatch(i, &match)) {
1202 con_out("failure: `%s` %*s %*s\n",
1203 task_tasks[i].tmpl->description,
1204 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1205 task_tasks[i].tmpl->rulesfile,
1206 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1207 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1208 ? "(invalid results from execution)"
1209 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1210 ? "(invalid results from preprocessing)"
1211 : "(invalid results from compiler diagnsotics)"
1213 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1214 ? "(invalid results from execution)"
1215 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1216 ? "(invalid results from preprocessing)"
1217 : "(invalid results from compiler diagnsotics)"
1221 * Print nicely formatted expected match lists to console error
1222 * handler for the all the given matches in the template file and
1223 * what was actually returned from executing.
1225 con_out(" Expected From %u Matches: (got %u Matches)\n",
1226 vec_size(task_tasks[i].tmpl->comparematch),
1229 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1230 char *select = task_tasks[i].tmpl->comparematch[d];
1231 size_t length = 60 - strlen(select);
1233 con_out(" Expected: \"%s\"", select);
1236 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1240 * Print the non-expected out (since we are simply not expecting it)
1241 * This will help track down bugs in template files that fail to match
1244 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1245 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1246 con_out(" Expected: Nothing | Got: \"%s\"\n",
1247 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1253 for (j = 0; j < vec_size(match); j++)
1260 for (j = 0; j < vec_size(match); j++)
1264 con_out("succeeded: `%s` %*s %*s\n",
1265 task_tasks[i].tmpl->description,
1266 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1267 task_tasks[i].tmpl->rulesfile,
1268 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1269 task_type(task_tasks[i].tmpl)
1278 * This is the heart of the whole test-suite process. This cleans up
1279 * any existing temporary files left behind as well as log files left
1280 * behind. Then it propagates a list of tests from `curdir` by scaning
1281 * it for template files and compiling them into tasks, in which it
1282 * schedualizes them (executes them) and actually reports errors and
1283 * what not. It then proceeds to destroy the tasks and return memory
1284 * it's the engine :)
1286 * It returns true of tests could be propagated, otherwise it returns
1289 * It expects con_init() was called before hand.
1291 static GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1292 size_t failed = false;
1293 static const char *default_defs = "defs.qh";
1296 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1301 * If the default definition file isn't set to anything. We will
1302 * use the default_defs here, which is "defs.qc"
1305 defs = default_defs;
1309 task_precleanup(curdir);
1310 if (!task_propagate(curdir, pad, defs)) {
1311 con_err("error: failed to propagate tasks\n");
1316 * If we made it here all tasks where propagated from their resultant
1317 * template file. So we can start the FILO scheduler, this has been
1318 * designed in the most thread-safe way possible for future threading
1319 * it's designed to prevent lock contention, and possible syncronization
1322 failed = task_schedualize(pad);
1324 con_out("%u out of %u tests failed\n", failed, vec_size(task_tasks));
1327 return (failed) ? false : true;
1331 * Fancy GCC-like LONG parsing allows things like --opt=param with
1332 * assignment operator. This is used for redirecting stdout/stderr
1333 * console to specific files of your choice.
1335 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1337 char **argv = *argv_;
1339 size_t len = strlen(optname);
1341 if (strncmp(argv[0]+ds, optname, len))
1344 /* it's --optname, check how the parameter is supplied */
1345 if (argv[0][ds+len] == '=') {
1346 *out = argv[0]+ds+len+1;
1350 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1353 /* using --opt param */
1360 int main(int argc, char **argv) {
1361 bool succeed = false;
1362 char *redirout = (char*)stdout;
1363 char *redirerr = (char*)stderr;
1367 OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = 16;
1370 * Command line option parsing commences now We only need to support
1371 * a few things in the test suite.
1377 if (argv[0][0] == '-') {
1378 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1380 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1382 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1385 con_change(redirout, redirerr);
1387 if (!strcmp(argv[0]+1, "debug")) {
1388 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1391 if (!strcmp(argv[0]+1, "memchk")) {
1392 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1395 if (!strcmp(argv[0]+1, "nocolor")) {
1400 con_err("invalid argument %s\n", argv[0]+1);
1404 con_change(redirout, redirerr);
1405 succeed = test_perform("tests", defs);
1408 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;