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
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);
156 fs_file_t *handles[3];
157 char name_err[L_tmpnam];
158 char name_out[L_tmpnam];
161 static fs_file_t **task_popen(const char *command, const char *mode) {
163 popen_t *open = (popen_t*)mem_a(sizeof(popen_t));
165 util_tmpnam(open->name_err);
166 util_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 int task_pclose(fs_file_t **files) {
183 popen_t *open = ((popen_t*)files);
185 fs_file_close(files[1]);
186 fs_file_close(files[2]);
188 remove(open->name_err);
189 remove(open->name_out);
195 # define popen _popen
196 # define pclose _pclose
199 #define TASK_COMPILE 0
200 #define TASK_EXECUTE 1
202 * Task template system:
203 * templates are rules for a specific test, used to create a "task" that
204 * is executed with those set of rules (arguments, and what not). Tests
205 * that don't have a template with them cannot become tasks, since without
206 * the information for that test there is no way to properly "test" them.
207 * Rules for these templates are described in a template file, using a
208 * task template language.
210 * The language is a basic finite statemachine, top-down single-line
211 * description language.
213 * The languge is composed entierly of "tags" which describe a string of
214 * text for a task. Think of it much like a configuration file. Except
215 * it's been designed to allow flexibility and future support for prodecual
218 * The following "tags" are suported by the language
221 * Used to set a description of the current test, this must be
222 * provided, this tag is NOT optional.
225 * Used to set the procedure for the given task, there are two
228 * This simply performs compilation only
230 * This will perform compilation and execution
232 * This will perform compilation, but requires
233 * the compilation to fail in order to succeed.
235 * This must be provided, this tag is NOT optional.
238 * Used to set the compilation flags for the given task, this
239 * must be provided, this tag is NOT optional.
241 * F: Used to set some test suite flags, currently the only option
242 * is -no-defs (to including of defs.qh)
245 * Used to set the execution flags for the given task. This tag
246 * must be provided if T == -execute, otherwise it's erroneous
247 * as compilation only takes place.
250 * Used to describe a string of text that should be matched from
251 * the output of executing the task. If this doesn't match the
252 * task fails. This tag must be provided if T == -execute, otherwise
253 * it's erroneous as compilation only takes place.
256 * Used to specify the INPUT source file to operate on, this must be
257 * provided, this tag is NOT optional
261 * These tags have one-time use, using them more than once will result
262 * in template compilation errors.
264 * Lines beginning with # or // in the template file are comments and
265 * are ignored by the template parser.
267 * Whitespace is optional, with exception to the colon ':' between the
268 * tag and it's assignment value/
270 * The template compiler will detect erronrous tags (optional tags
271 * that need not be set), as well as missing tags, and error accordingly
272 * this will result in the task failing.
287 * This is very much like a compiler code generator :-). This generates
288 * a value from some data observed from the compiler.
290 static bool task_template_generate(task_template_t *tmpl, char tag, const char *file, size_t line, char *value, size_t *pad) {
293 char **destval = NULL;
299 case 'D': destval = &tmpl->description; break;
300 case 'T': destval = &tmpl->proceduretype; break;
301 case 'C': destval = &tmpl->compileflags; break;
302 case 'E': destval = &tmpl->executeflags; break;
303 case 'I': destval = &tmpl->sourcefile; break;
304 case 'F': destval = &tmpl->testflags; break;
306 con_printmsg(LVL_ERROR, __FILE__, __LINE__, 0, "internal error",
307 "invalid tag `%c:` during code generation\n",
314 * Ensure if for the given tag, there already exists a
318 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "compile error",
319 "tag `%c:` already assigned value: %s\n",
326 * Strip any whitespace that might exist in the value for assignments
329 if (value && *value && (*value == ' ' || *value == '\t'))
335 * Value will contain a newline character at the end, we need to strip
336 * this otherwise kaboom, seriously, kaboom :P
338 if (strchr(value, '\n'))
339 *strrchr(value, '\n')='\0';
342 * Now allocate and set the actual value for the specific tag. Which
343 * was properly selected and can be accessed with *destval.
345 *destval = util_strdup(value);
348 if (*destval == tmpl->description) {
350 * Create some padding for the description to align the
351 * printing of the rules file.
353 if ((desclen = strlen(tmpl->description)) > pad[0])
357 if ((filelen = strlen(file)) > pad[2])
363 static bool task_template_parse(const char *file, task_template_t *tmpl, fs_file_t *fp, size_t *pad) {
372 /* top down parsing */
373 while (fs_file_getline(&back, &size, fp) != FS_FILE_EOF) {
374 /* skip whitespace */
376 if (*data && (*data == ' ' || *data == '\t'))
381 * Handle comments inside task tmpl files. We're strict
382 * about the language for fun :-)
385 if (data[1] != '/') {
386 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
387 "invalid character `/`, perhaps you meant `//` ?");
396 * Empty newlines are acceptable as well, so we handle that here
397 * despite being just odd since there should't be that many
398 * empty lines to begin with.
406 * Now begin the actual "tag" stuff. This works as you expect
415 if (data[1] != ':') {
416 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
417 "expected `:` after `%c`",
422 if (!task_template_generate(tmpl, *data, file, line, &data[3], pad)) {
423 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl compile error",
424 "failed to generate for given task\n"
431 * Match requires it's own system since we allow multiple M's
432 * for multi-line matching.
436 char *value = &data[3];
437 if (data[1] != ':') {
438 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
439 "expected `:` after `%c`",
446 * Value will contain a newline character at the end, we need to strip
447 * this otherwise kaboom, seriously, kaboom :P
449 if (strrchr(value, '\n'))
450 *strrchr(value, '\n')='\0';
451 else /* cppcheck: possible null pointer dereference */
454 vec_push(tmpl->comparematch, util_strdup(value));
460 con_printmsg(LVL_ERROR, file, line, 0, /*TODO: column for match*/ "tmpl parse error",
461 "invalid tag `%c`", *data
464 /* no break required */
467 /* update line and free old sata */
482 * Nullifies the template data: used during initialization of a new
485 static void task_template_nullify(task_template_t *tmpl) {
489 tmpl->description = NULL;
490 tmpl->proceduretype = NULL;
491 tmpl->compileflags = NULL;
492 tmpl->executeflags = NULL;
493 tmpl->comparematch = NULL;
494 tmpl->sourcefile = NULL;
495 tmpl->tempfilename = NULL;
496 tmpl->rulesfile = NULL;
497 tmpl->testflags = NULL;
500 static task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
501 /* a page should be enough */
504 fs_file_t *tempfile = NULL;
505 task_template_t *tmpl = NULL;
507 util_snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
509 tempfile = fs_file_open(fullfile, "r");
510 tmpl = (task_template_t*)mem_a(sizeof(task_template_t));
511 task_template_nullify(tmpl);
514 * Create some padding for the printing to align the
515 * printing of the rules file to the console.
517 if ((filepadd = strlen(fullfile)) > pad[1])
520 tmpl->rulesfile = util_strdup(fullfile);
523 * Esnure the file even exists for the task, this is pretty useless
527 con_err("template file: %s does not exist or invalid permissions\n",
533 if (!task_template_parse(file, tmpl, tempfile, pad)) {
534 con_err("template parse error: error during parsing\n");
539 * Regardless procedure type, the following tags must exist:
545 if (!tmpl->description) {
546 con_err("template compile error: %s missing `D:` tag\n", file);
549 if (!tmpl->proceduretype) {
550 con_err("template compile error: %s missing `T:` tag\n", file);
553 if (!tmpl->compileflags) {
554 con_err("template compile error: %s missing `C:` tag\n", file);
557 if (!tmpl->sourcefile) {
558 con_err("template compile error: %s missing `I:` tag\n", file);
563 * Now lets compile the template, compilation is really just
564 * the process of validating the input.
566 if (!strcmp(tmpl->proceduretype, "-compile")) {
567 if (tmpl->executeflags)
568 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
569 if (tmpl->comparematch)
570 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
572 } else if (!strcmp(tmpl->proceduretype, "-execute")) {
573 if (!tmpl->executeflags) {
574 /* default to $null */
575 tmpl->executeflags = util_strdup("$null");
577 if (!tmpl->comparematch) {
578 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
581 } else if (!strcmp(tmpl->proceduretype, "-fail")) {
582 if (tmpl->executeflags)
583 con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
584 if (tmpl->comparematch)
585 con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
586 } else if (!strcmp(tmpl->proceduretype, "-diagnostic")) {
587 if (tmpl->executeflags)
588 con_err("template compile warning: %s erroneous tag `E:` when only diagnostic\n", file);
589 if (!tmpl->comparematch) {
590 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
593 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
594 if (tmpl->executeflags)
595 con_err("template compile warning: %s erroneous tag `E:` when only preprocessing\n", file);
596 if (!tmpl->comparematch) {
597 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
601 con_err("template compile error: %s invalid procedure type: %s\n", file, tmpl->proceduretype);
606 fs_file_close(tempfile);
611 * The file might not exist and we jump here when that doesn't happen
612 * so the check to see if it's not null here is required.
615 fs_file_close(tempfile);
621 static void task_template_destroy(task_template_t *tmpl) {
625 if (tmpl->description) mem_d(tmpl->description);
626 if (tmpl->proceduretype) mem_d(tmpl->proceduretype);
627 if (tmpl->compileflags) mem_d(tmpl->compileflags);
628 if (tmpl->executeflags) mem_d(tmpl->executeflags);
629 if (tmpl->sourcefile) mem_d(tmpl->sourcefile);
630 if (tmpl->rulesfile) mem_d(tmpl->rulesfile);
631 if (tmpl->testflags) mem_d(tmpl->testflags);
634 * Delete all allocated string for task tmpl then destroy the
639 for (; i < vec_size(tmpl->comparematch); i++)
640 mem_d(tmpl->comparematch[i]);
642 vec_free(tmpl->comparematch);
646 * Nullify all the template members otherwise NULL comparision
647 * checks will fail if tmpl pointer is reused.
649 mem_d(tmpl->tempfilename);
654 * Now comes the task manager, this system allows adding tasks in and out
655 * of a task list. This is the executor of the tasks essentially as well.
658 task_template_t *tmpl;
659 fs_file_t **runhandles;
660 fs_file_t *stderrlog;
661 fs_file_t *stdoutlog;
667 static task_t *task_tasks = NULL;
670 * Read a directory and searches for all template files in it
671 * which is later used to run all tests.
673 static bool task_propagate(const char *curdir, size_t *pad, const char *defs) {
677 struct stat directory;
680 char **directories = NULL;
681 char *claim = util_strdup(curdir);
684 vec_push(directories, claim);
685 dir = fs_dir_open(claim);
688 * Generate a list of subdirectories since we'll be checking them too
691 while ((files = fs_dir_read(dir))) {
692 util_asprintf(&claim, "%s/%s", curdir, files->d_name);
693 if (stat(claim, &directory) == -1) {
699 if (S_ISDIR(directory.st_mode) && files->d_name[0] != '.') {
700 vec_push(directories, claim);
709 * Now do all the work, by touching all the directories inside
710 * test as well and compile the task templates into data we can
711 * use to run the tests.
713 for (i = 0; i < vec_size(directories); i++) {
714 dir = fs_dir_open(directories[i]);
716 while ((files = fs_dir_read(dir))) {
717 util_snprintf(buffer, sizeof(buffer), "%s/%s", directories[i], files->d_name);
718 if (stat(buffer, &directory) == -1) {
719 con_err("internal error: stat failed, aborting\n");
723 if (S_ISDIR(directory.st_mode))
727 * We made it here, which concludes the file/directory is not
728 * actually a directory, so it must be a file :)
730 if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
731 task_template_t *tmpl = task_template_compile(files->d_name, directories[i], pad);
732 char buf[4096]; /* one page should be enough */
733 const char *qcflags = NULL;
738 con_err("error compiling task template: %s\n", files->d_name);
743 * Generate a temportary file name for the output binary
744 * so we don't trample over an existing one.
746 tmpl->tempfilename = NULL;
747 util_asprintf(&tmpl->tempfilename, "%s/TMPDAT.%s", directories[i], files->d_name);
750 * Additional QCFLAGS enviroment variable may be used
751 * to test compile flags for all tests. This needs to be
752 * BEFORE other flags (so that the .tmpl can override them)
754 qcflags = platform_getenv("QCFLAGS");
757 * Generate the command required to open a pipe to a process
758 * which will be refered to with a handle in the task for
759 * reading the data from the pipe.
761 if (strcmp(tmpl->proceduretype, "-pp")) {
763 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
764 util_snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
765 task_bins[TASK_COMPILE],
773 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s %s -o %s",
774 task_bins[TASK_COMPILE],
785 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
786 util_snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
787 task_bins[TASK_COMPILE],
794 util_snprintf(buf, sizeof(buf), "%s %s/%s %s/%s %s -o %s",
795 task_bins[TASK_COMPILE],
806 /* Preprocessing (qcflags mean shit all here we don't allow them) */
807 if (tmpl->testflags && !strcmp(tmpl->testflags, "-no-defs")) {
808 util_snprintf(buf, sizeof(buf), "%s -E %s/%s -o %s",
809 task_bins[TASK_COMPILE],
815 util_snprintf(buf, sizeof(buf), "%s -E %s/%s %s/%s -o %s",
816 task_bins[TASK_COMPILE],
827 * The task template was compiled, now lets create a task from
828 * the template data which has now been propagated.
831 if (!(task.runhandles = task_popen(buf, "r"))) {
832 con_err("error opening pipe to process for test: %s\n", tmpl->description);
838 * Open up some file desciptors for logging the stdout/stderr
841 util_snprintf(buf, sizeof(buf), "%s.stdout", tmpl->tempfilename);
842 task.stdoutlogfile = util_strdup(buf);
843 if (!(task.stdoutlog = fs_file_open(buf, "w"))) {
844 con_err("error opening %s for stdout\n", buf);
848 util_snprintf(buf, sizeof(buf), "%s.stderr", tmpl->tempfilename);
849 task.stderrlogfile = util_strdup(buf);
850 if (!(task.stderrlog = fs_file_open(buf, "w"))) {
851 con_err("error opening %s for stderr\n", buf);
855 vec_push(task_tasks, task);
860 mem_d(directories[i]); /* free claimed memory */
862 vec_free(directories);
868 * Task precleanup removes any existing temporary files or log files
869 * left behind from a previous invoke of the test-suite.
871 static void task_precleanup(const char *curdir) {
876 dir = fs_dir_open(curdir);
878 while ((files = fs_dir_read(dir))) {
879 if (strstr(files->d_name, "TMP") ||
880 strstr(files->d_name, ".stdout") ||
881 strstr(files->d_name, ".stderr"))
883 util_snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
885 con_err("error removing temporary file: %s\n", buffer);
892 static void task_destroy(void) {
894 * Free all the data in the task list and finally the list itself
895 * then proceed to cleanup anything else outside the program like
899 for (i = 0; i < vec_size(task_tasks); i++) {
901 * Close any open handles to files or processes here. It's mighty
902 * annoying to have to do all this cleanup work.
904 if (task_tasks[i].stdoutlog) fs_file_close (task_tasks[i].stdoutlog);
905 if (task_tasks[i].stderrlog) fs_file_close (task_tasks[i].stderrlog);
908 * Only remove the log files if the test actually compiled otherwise
909 * forget about it (or if it didn't compile, and the procedure type
910 * was set to -fail (meaning it shouldn't compile) .. stil remove)
912 if (task_tasks[i].compiled || !strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
913 if (remove(task_tasks[i].stdoutlogfile))
914 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
915 if (remove(task_tasks[i].stderrlogfile))
916 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
918 (void)!remove(task_tasks[i].tmpl->tempfilename);
921 /* free util_strdup data for log files */
922 mem_d(task_tasks[i].stdoutlogfile);
923 mem_d(task_tasks[i].stderrlogfile);
925 task_template_destroy(task_tasks[i].tmpl);
927 vec_free(task_tasks);
931 * This executes the QCVM task for a specificly compiled progs.dat
932 * using the template passed into it for call-flags and user defined
933 * messages IF the procedure type is -execute, otherwise it matches
934 * the preprocessor output.
936 static bool task_trymatch(size_t i, char ***line) {
939 int retval = EXIT_SUCCESS;
942 task_template_t *tmpl = task_tasks[i].tmpl;
944 memset (buffer,0,sizeof(buffer));
946 if (!strcmp(tmpl->proceduretype, "-execute")) {
948 * Drop the execution flags for the QCVM if none where
949 * actually specified.
951 if (!strcmp(tmpl->executeflags, "$null")) {
952 util_snprintf(buffer, sizeof(buffer), "%s %s",
953 task_bins[TASK_EXECUTE],
957 util_snprintf(buffer, sizeof(buffer), "%s %s %s",
958 task_bins[TASK_EXECUTE],
964 execute = (fs_file_t*)popen(buffer, "r");
967 } else if (!strcmp(tmpl->proceduretype, "-pp")) {
969 * we're preprocessing, which means we need to read int
970 * the produced file and do some really weird shit.
972 if (!(execute = fs_file_open(tmpl->tempfilename, "r")))
978 * we're testing diagnostic output, which means it will be
979 * in runhandles[2] (stderr) since that is where the compiler
982 if (!(execute = fs_file_open(task_tasks[i].stderrlogfile, "r")))
989 * Now lets read the lines and compare them to the matches we expect
990 * and handle accordingly.
997 while (fs_file_getline(&data, &size, execute) != FS_FILE_EOF) {
998 if (!strcmp(data, "No main function found\n")) {
999 con_err("test failure: `%s` (No main function found) [%s]\n",
1004 fs_file_close(execute);
1006 pclose((FILE*)execute);
1011 * Trim newlines from data since they will just break our
1012 * ability to properly validate matches.
1014 if (strrchr(data, '\n'))
1015 *strrchr(data, '\n') = '\0';
1018 * We remove the file/directory and stuff from the error
1019 * match messages when testing diagnostics.
1021 if(!strcmp(tmpl->proceduretype, "-diagnostic")) {
1022 if (strstr(data, "there have been errors, bailing out"))
1023 continue; /* ignore it */
1024 if (strstr(data, ": error: ")) {
1025 char *claim = util_strdup(data + (strstr(data, ": error: ") - data) + 9);
1032 * We need to ignore null lines for when -pp is used (preprocessor), since
1033 * the preprocessor is likely to create empty newlines in certain macro
1034 * instantations, otherwise it's in the wrong nature to ignore empty newlines.
1036 if (!strcmp(tmpl->proceduretype, "-pp") && !*data)
1039 if (vec_size(tmpl->comparematch) > compare) {
1040 if (strcmp(data, tmpl->comparematch[compare++])) {
1048 * Copy to output vector for diagnostics if execution match
1051 vec_push(*line, data);
1058 if (compare != vec_size(tmpl->comparematch))
1066 retval = pclose((FILE*)execute);
1068 fs_file_close(execute);
1070 return success && retval == EXIT_SUCCESS;
1073 static const char *task_type(task_template_t *tmpl) {
1074 if (!strcmp(tmpl->proceduretype, "-pp"))
1075 return "type: preprocessor";
1076 if (!strcmp(tmpl->proceduretype, "-execute"))
1077 return "type: execution";
1078 if (!strcmp(tmpl->proceduretype, "-compile"))
1079 return "type: compile";
1080 if (!strcmp(tmpl->proceduretype, "-diagnostic"))
1081 return "type: diagnostic";
1082 return "type: fail";
1086 * This schedualizes all tasks and actually runs them individually
1087 * this is generally easy for just -compile variants. For compile and
1088 * execution this takes more work since a task needs to be generated
1089 * from thin air and executed INLINE.
1092 static size_t task_schedualize(size_t *pad) {
1094 bool execute = false;
1096 char **match = NULL;
1102 util_snprintf(space[0], sizeof(space[0]), "%d", (int)vec_size(task_tasks));
1104 for (; i < vec_size(task_tasks); i++) {
1105 memset(space[1], 0, sizeof(space[1]));
1106 util_snprintf(space[1], sizeof(space[1]), "%d", (int)(i + 1));
1108 con_out("test #%u %*s", i + 1, strlen(space[0]) - strlen(space[1]), "");
1111 * Generate a task from thin air if it requires execution in
1115 /* diagnostic is not executed, but compare tested instead, like preproessor */
1116 execute = !! (!strcmp(task_tasks[i].tmpl->proceduretype, "-execute")) ||
1117 (!strcmp(task_tasks[i].tmpl->proceduretype, "-pp")) ||
1118 (!strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"));
1121 * We assume it compiled before we actually compiled :). On error
1122 * we change the value
1124 task_tasks[i].compiled = true;
1127 * Read data from stdout first and pipe that stuff into a log file
1128 * then we do the same for stderr.
1130 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[1]) != FS_FILE_EOF) {
1131 fs_file_puts(task_tasks[i].stdoutlog, data);
1133 if (strstr(data, "failed to open file")) {
1134 task_tasks[i].compiled = false;
1138 while (fs_file_getline(&data, &size, task_tasks[i].runhandles[2]) != FS_FILE_EOF) {
1140 * If a string contains an error we just dissalow execution
1143 * TODO: make this more percise, e.g if we print a warning
1144 * that refers to a variable named error, or something like
1145 * that .. then this will blowup :P
1147 if (strstr(data, "error") && strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic")) {
1149 task_tasks[i].compiled = false;
1152 fs_file_puts (task_tasks[i].stderrlog, data);
1153 fs_file_flush(task_tasks[i].stderrlog); /* fast flush for read */
1156 if (!task_tasks[i].compiled && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1157 con_out("failure: `%s` %*s %*s\n",
1158 task_tasks[i].tmpl->description,
1159 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1160 task_tasks[i].tmpl->rulesfile,
1161 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(failed to compile)") - pad[2]),
1162 "(failed to compile)"
1168 if (task_pclose(task_tasks[i].runhandles) != EXIT_SUCCESS && strcmp(task_tasks[i].tmpl->proceduretype, "-fail")) {
1169 con_out("failure: `%s` %*s %*s\n",
1170 task_tasks[i].tmpl->description,
1171 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1172 task_tasks[i].tmpl->rulesfile,
1173 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen("(compiler didn't return exit success)") - pad[2]),
1174 "(compiler didn't return exit success)"
1181 con_out("succeeded: `%s` %*s %*s\n",
1182 task_tasks[i].tmpl->description,
1183 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1184 task_tasks[i].tmpl->rulesfile,
1185 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl)) - pad[2]),
1186 task_type(task_tasks[i].tmpl)
1193 * If we made it here that concludes the task is to be executed
1194 * in the virtual machine (or the preprocessor output needs to
1197 if (!task_trymatch(i, &match)) {
1200 con_out("failure: `%s` %*s %*s\n",
1201 task_tasks[i].tmpl->description,
1202 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1203 task_tasks[i].tmpl->rulesfile,
1204 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(
1205 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1206 ? "(invalid results from execution)"
1207 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1208 ? "(invalid results from preprocessing)"
1209 : "(invalid results from compiler diagnsotics)"
1211 (strcmp(task_tasks[i].tmpl->proceduretype, "-pp"))
1212 ? "(invalid results from execution)"
1213 : (strcmp(task_tasks[i].tmpl->proceduretype, "-diagnostic"))
1214 ? "(invalid results from preprocessing)"
1215 : "(invalid results from compiler diagnsotics)"
1219 * Print nicely formatted expected match lists to console error
1220 * handler for the all the given matches in the template file and
1221 * what was actually returned from executing.
1223 con_out(" Expected From %u Matches: (got %u Matches)\n",
1224 vec_size(task_tasks[i].tmpl->comparematch),
1227 for (; d < vec_size(task_tasks[i].tmpl->comparematch); d++) {
1228 char *select = task_tasks[i].tmpl->comparematch[d];
1229 size_t length = 60 - strlen(select);
1231 con_out(" Expected: \"%s\"", select);
1234 con_out("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
1238 * Print the non-expected out (since we are simply not expecting it)
1239 * This will help track down bugs in template files that fail to match
1242 if (vec_size(match) > vec_size(task_tasks[i].tmpl->comparematch)) {
1243 for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].tmpl->comparematch); d++) {
1244 con_out(" Expected: Nothing | Got: \"%s\"\n",
1245 match[d + vec_size(task_tasks[i].tmpl->comparematch)]
1251 for (j = 0; j < vec_size(match); j++)
1258 for (j = 0; j < vec_size(match); j++)
1262 con_out("succeeded: `%s` %*s %*s\n",
1263 task_tasks[i].tmpl->description,
1264 (pad[0] + pad[1] - strlen(task_tasks[i].tmpl->description)) + (strlen(task_tasks[i].tmpl->rulesfile) - pad[1]),
1265 task_tasks[i].tmpl->rulesfile,
1266 (pad[1] + pad[2] - strlen(task_tasks[i].tmpl->rulesfile)) + (strlen(task_type(task_tasks[i].tmpl))- pad[2]),
1267 task_type(task_tasks[i].tmpl)
1276 * This is the heart of the whole test-suite process. This cleans up
1277 * any existing temporary files left behind as well as log files left
1278 * behind. Then it propagates a list of tests from `curdir` by scaning
1279 * it for template files and compiling them into tasks, in which it
1280 * schedualizes them (executes them) and actually reports errors and
1281 * what not. It then proceeds to destroy the tasks and return memory
1282 * it's the engine :)
1284 * It returns true of tests could be propagated, otherwise it returns
1287 * It expects con_init() was called before hand.
1289 static GMQCC_WARN bool test_perform(const char *curdir, const char *defs) {
1290 size_t failed = false;
1291 static const char *default_defs = "defs.qh";
1294 /* test ### [succeed/fail]: `description` [tests/template.tmpl] [type] */
1299 * If the default definition file isn't set to anything. We will
1300 * use the default_defs here, which is "defs.qc"
1303 defs = default_defs;
1307 task_precleanup(curdir);
1308 if (!task_propagate(curdir, pad, defs)) {
1309 con_err("error: failed to propagate tasks\n");
1314 * If we made it here all tasks where propagated from their resultant
1315 * template file. So we can start the FILO scheduler, this has been
1316 * designed in the most thread-safe way possible for future threading
1317 * it's designed to prevent lock contention, and possible syncronization
1320 failed = task_schedualize(pad);
1322 con_out("%u out of %u tests failed\n", failed, vec_size(task_tasks));
1325 return (failed) ? false : true;
1329 * Fancy GCC-like LONG parsing allows things like --opt=param with
1330 * assignment operator. This is used for redirecting stdout/stderr
1331 * console to specific files of your choice.
1333 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1335 char **argv = *argv_;
1337 size_t len = strlen(optname);
1339 if (strncmp(argv[0]+ds, optname, len))
1342 /* it's --optname, check how the parameter is supplied */
1343 if (argv[0][ds+len] == '=') {
1344 *out = argv[0]+ds+len+1;
1348 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1351 /* using --opt param */
1358 int main(int argc, char **argv) {
1359 bool succeed = false;
1360 char *redirout = (char*)stdout;
1361 char *redirerr = (char*)stderr;
1365 OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = 16;
1368 * Command line option parsing commences now We only need to support
1369 * a few things in the test suite.
1375 if (argv[0][0] == '-') {
1376 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1378 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1380 if (parsecmd("defs", &argc, &argv, &defs, 1, false))
1383 con_change(redirout, redirerr);
1385 if (!strcmp(argv[0]+1, "debug")) {
1386 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
1389 if (!strcmp(argv[0]+1, "memchk")) {
1390 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
1393 if (!strcmp(argv[0]+1, "nocolor")) {
1398 con_err("invalid argument %s\n", argv[0]+1);
1402 con_change(redirout, redirerr);
1403 succeed = test_perform("tests", defs);
1406 return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;