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
24 #include <sys/types.h>
28 bool opts_memchk = false;
29 bool opts_debug = false;
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 FILE ** task_popen(const char *command, const char *mode) {
70 popen_t *data = 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];
105 data->handles[0] = fdopen(inhandle [1], "w");
106 data->handles[1] = fdopen(outhandle[0], mode);
107 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 close(0), dup(inhandle [0]);
121 close(1), dup(outhandle[1]);
122 close(2), dup(errhandle[1]);
128 goto task_popen_error_3;
133 return data->handles;
135 task_popen_error_3: close(errhandle[0]), close(errhandle[1]);
136 task_popen_error_2: close(outhandle[0]), close(outhandle[1]);
137 task_popen_error_1: close(inhandle [0]), close(inhandle [1]);
145 int task_pclose(FILE **handles) {
146 popen_t *data = (popen_t*)handles;
149 close(data->pipes[0]); /* stdin */
150 close(data->pipes[1]); /* stdout */
151 close(data->pipes[2]); /* stderr */
153 waitpid(data->pid, &status, 0);
163 #define TASK_COMPILE 0
164 #define TASK_EXECUTE 1
167 * Task template system:
168 * templates are rules for a specific test, used to create a "task" that
169 * is executed with those set of rules (arguments, and what not). Tests
170 * that don't have a template with them cannot become tasks, since without
171 * the information for that test there is no way to properly "test" them.
172 * Rules for these templates are described in a template file, using a
173 * task template language.
175 * The language is a basic finite statemachine, top-down single-line
176 * description language.
178 * The languge is composed entierly of "tags" which describe a string of
179 * text for a task. Think of it much like a configuration file. Except
180 * it's been designed to allow flexibility and future support for prodecual
183 * The following "tags" are suported by the language
186 * Used to set a description of the current test, this must be
187 * provided, this tag is NOT optional.
190 * Used to set a failure message, this message will be displayed
191 * if the test fails, this tag is optional
194 * Used to set a success message, this message will be displayed
195 * if the test succeeds, this tag is optional.
198 * Used to set the procedure for the given task, there are two
201 * This simply performs compilation only
203 * This will perform compilation and execution
205 * This must be provided, this tag is NOT optional.
208 * Used to set the compilation flags for the given task, this
209 * must be provided, this tag is NOT optional.
212 * Used to set the execution flags for the given task. This tag
213 * must be provided if T == -execute, otherwise it's erroneous
214 * as compilation only takes place.
217 * Used to describe a string of text that should be matched from
218 * the output of executing the task. If this doesn't match the
219 * task fails. This tag must be provided if T == -execute, otherwise
220 * it's erroneous as compilation only takes place.
223 * Used to specify the INPUT source file to operate on, this must be
224 * provided, this tag is NOT optional
228 * These tags have one-time use, using them more than once will result
229 * in template compilation errors.
231 * Lines beginning with # or // in the template file are comments and
232 * are ignored by the template parser.
234 * Whitespace is optional, with exception to the colon ':' between the
235 * tag and it's assignment value/
237 * The template compiler will detect erronrous tags (optional tags
238 * that need not be set), as well as missing tags, and error accordingly
239 * this will result in the task failing.
243 char *failuremessage;
244 char *successmessage;
254 * This is very much like a compiler code generator :-). This generates
255 * a value from some data observed from the compiler.
257 bool task_template_generate(task_template_t *template, char tag, const char *file, size_t line, const char *value) {
258 char **destval = NULL;
264 case 'D': destval = &template->description; break;
265 case 'F': destval = &template->failuremessage; break;
266 case 'S': destval = &template->successmessage; break;
267 case 'T': destval = &template->proceduretype; break;
268 case 'C': destval = &template->compileflags; break;
269 case 'E': destval = &template->executeflags; break;
270 case 'I': destval = &template->sourcefile; break;
272 con_printmsg(LVL_ERROR, __FILE__, __LINE__, "internal error",
273 "invalid tag `%c:` during code generation\n",
280 * Ensure if for the given tag, there already exists a
284 con_printmsg(LVL_ERROR, file, line, "compile error",
285 "tag `%c:` already assigned value: %s\n",
292 * Strip any whitespace that might exist in the value for assignments
295 if (value && *value && (*value == ' ' || *value == '\t'))
299 * Value will contain a newline character at the end, we need to strip
300 * this otherwise kaboom, seriously, kaboom :P
302 *strrchr(value, '\n')='\0';
305 * Now allocate and set the actual value for the specific tag. Which
306 * was properly selected and can be accessed with *destval.
308 *destval = util_strdup(value);
313 bool task_template_parse(const char *file, task_template_t *template, FILE *fp) {
322 /* top down parsing */
323 while (util_getline(&back, &size, fp) != EOF) {
324 /* skip whitespace */
326 if (*data && (*data == ' ' || *data == '\t'))
331 * Handle comments inside task template files. We're strict
332 * about the language for fun :-)
335 if (data[1] != '/') {
336 con_printmsg(LVL_ERROR, file, line, "template parse error",
337 "invalid character `/`, perhaps you meant `//` ?");
346 * Empty newlines are acceptable as well, so we handle that here
347 * despite being just odd since there should't be that many
348 * empty lines to begin with.
356 * Now begin the actual "tag" stuff. This works as you expect
366 if (data[1] != ':') {
367 con_printmsg(LVL_ERROR, file, line, "template parse error",
368 "expected `:` after `%c`",
373 if (!task_template_generate(template, *data, file, line, &data[3])) {
374 con_printmsg(LVL_ERROR, file, line, "template compile error",
375 "failed to generate for given task\n"
382 * Match requires it's own system since we allow multiple M's
383 * for multi-line matching.
387 char *value = &data[3];
388 if (data[1] != ':') {
389 con_printmsg(LVL_ERROR, file, line, "template parse error",
390 "expected `:` after `%c`",
396 if (value && *value && (*value == ' ' || *value == '\t'))
400 * Value will contain a newline character at the end, we need to strip
401 * this otherwise kaboom, seriously, kaboom :P
403 *strrchr(value, '\n')='\0';
405 vec_push(template->comparematch, util_strdup(value));
411 con_printmsg(LVL_ERROR, file, line, "template parse error",
412 "invalid tag `%c`", *data
415 /* no break required */
418 /* update line and free old sata */
434 * Nullifies the template data: used during initialization of a new
437 void task_template_nullify(task_template_t *template) {
441 template->description = NULL;
442 template->failuremessage = NULL;
443 template->successmessage = NULL;
444 template->proceduretype = NULL;
445 template->compileflags = NULL;
446 template->executeflags = NULL;
447 template->comparematch = NULL;
448 template->sourcefile = NULL;
449 template->tempfilename = NULL;
452 task_template_t *task_template_compile(const char *file, const char *dir) {
453 /* a page should be enough */
455 FILE *tempfile = NULL;
456 task_template_t *template = NULL;
458 memset (fullfile, 0, sizeof(fullfile));
459 snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
461 tempfile = fopen(fullfile, "r");
462 template = mem_a(sizeof(task_template_t));
463 task_template_nullify(template);
466 * Esnure the file even exists for the task, this is pretty useless
470 con_err("template file: %s does not exist or invalid permissions\n",
476 if (!task_template_parse(file, template, tempfile)) {
477 con_err("template parse error: error during parsing\n");
482 * Regardless procedure type, the following tags must exist:
488 if (!template->description) {
489 con_err("template compile error: %s missing `D:` tag\n", file);
492 if (!template->proceduretype) {
493 con_err("template compile error: %s missing `T:` tag\n", file);
496 if (!template->compileflags) {
497 con_err("template compile error: %s missing `C:` tag\n", file);
500 if (!template->sourcefile) {
501 con_err("template compile error: %s missing `I:` tag\n", file);
506 * Now lets compile the template, compilation is really just
507 * the process of validating the input.
509 if (!strcmp(template->proceduretype, "-compile")) {
510 if (template->executeflags)
511 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
512 if (template->comparematch)
513 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
515 } else if (!strcmp(template->proceduretype, "-execute")) {
516 if (!template->executeflags) {
517 /* default to $null */
518 template->executeflags = util_strdup("$null");
520 if (!template->comparematch) {
521 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
525 con_err("template compile error: %s invalid procedure type: %s\n", file, template->proceduretype);
535 * The file might not exist and we jump here when that doesn't happen
536 * so the check to see if it's not null here is required.
545 void task_template_destroy(task_template_t **template) {
549 if ((*template)->description) mem_d((*template)->description);
550 if ((*template)->failuremessage) mem_d((*template)->failuremessage);
551 if ((*template)->successmessage) mem_d((*template)->successmessage);
552 if ((*template)->proceduretype) mem_d((*template)->proceduretype);
553 if ((*template)->compileflags) mem_d((*template)->compileflags);
554 if ((*template)->executeflags) mem_d((*template)->executeflags);
555 if ((*template)->sourcefile) mem_d((*template)->sourcefile);
558 * Delete all allocated string for task template then destroy the
563 for (; i < vec_size((*template)->comparematch); i++)
564 mem_d((*template)->comparematch[i]);
566 vec_free((*template)->comparematch);
570 * Nullify all the template members otherwise NULL comparision
571 * checks will fail if template pointer is reused.
574 task_template_nullify(*template);
579 * Now comes the task manager, this system allows adding tasks in and out
580 * of a task list. This is the executor of the tasks essentially as well.
583 task_template_t *template;
592 task_t *task_tasks = NULL;
595 * Read a directory and searches for all template files in it
596 * which is later used to run all tests.
598 bool task_propogate(const char *curdir) {
601 struct dirent *files;
602 struct stat directory;
605 dir = opendir(curdir);
607 while ((files = readdir(dir))) {
608 memset (buffer, 0,sizeof(buffer));
609 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
611 if (stat(buffer, &directory) == -1) {
612 con_err("internal error: stat failed, aborting\n");
616 /* skip directories */
617 if (S_ISDIR(directory.st_mode))
621 * We made it here, which concludes the file/directory is not
622 * actually a directory, so it must be a file :)
624 if (strstr(files->d_name, ".tmpl") == &files->d_name[strlen(files->d_name) - (sizeof(".tmpl") - 1)]) {
625 util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
626 task_template_t *template = task_template_compile(files->d_name, curdir);
628 con_err("error compiling task template: %s\n", files->d_name);
633 * Generate a temportary file name for the output binary
634 * so we don't trample over an existing one.
636 template->tempfilename = tempnam(curdir, "TMPDAT");
639 * Generate the command required to open a pipe to a process
640 * which will be refered to with a handle in the task for
641 * reading the data from the pipe.
643 char buf[4096]; /* one page should be enough */
644 memset (buf,0,sizeof(buf));
645 snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
646 task_bins[TASK_COMPILE],
648 template->sourcefile,
649 template->compileflags,
650 template->tempfilename
654 * The task template was compiled, now lets create a task from
655 * the template data which has now been propogated.
658 task.template = template;
659 if (!(task.runhandles = task_popen(buf, "r"))) {
660 con_err("error opening pipe to process for test: %s\n", template->description);
665 util_debug("TEST", "executing test: `%s` [%s]\n", template->description, buf);
668 * Open up some file desciptors for logging the stdout/stderr
671 memset (buf,0,sizeof(buf));
672 snprintf(buf, sizeof(buf), "%s.stdout", template->tempfilename);
673 task.stdoutlogfile = util_strdup(buf);
674 if (!(task.stdoutlog = fopen(buf, "w"))) {
675 con_err("error opening %s for stdout\n", buf);
679 memset (buf,0,sizeof(buf));
680 snprintf(buf, sizeof(buf), "%s.stderr", template->tempfilename);
681 task.stderrlogfile = util_strdup(buf);
682 if (!(task.stderrlog = fopen(buf, "w"))) {
683 con_err("error opening %s for stderr\n", buf);
687 vec_push(task_tasks, task);
696 * Removes all temporary 'progs.dat' files created during compilation
699 void task_cleanup(const char *curdir) {
701 struct dirent *files;
704 dir = opendir(curdir);
706 while ((files = readdir(dir))) {
707 memset(buffer, 0, sizeof(buffer));
708 if (strstr(files->d_name, "TMP")) {
709 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
711 con_err("error removing temporary file: %s\n", buffer);
713 util_debug("TEST", "removed temporary file: %s\n", buffer);
721 * Task precleanup removes any existing temporary files or log files
722 * left behind from a previous invoke of the test-suite.
724 void task_precleanup(const char *curdir) {
726 struct dirent *files;
729 dir = opendir(curdir);
731 while ((files = readdir(dir))) {
732 memset(buffer, 0, sizeof(buffer));
733 if (strstr(files->d_name, "TMP") ||
734 strstr(files->d_name, ".stdout") ||
735 strstr(files->d_name, ".stderr"))
737 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
739 con_err("error removing temporary file: %s\n", buffer);
741 util_debug("TEST", "removed temporary file: %s\n", buffer);
748 void task_destroy(const char *curdir) {
750 * Free all the data in the task list and finally the list itself
751 * then proceed to cleanup anything else outside the program like
755 for (i = 0; i < vec_size(task_tasks); i++) {
757 * Close any open handles to files or processes here. It's mighty
758 * annoying to have to do all this cleanup work.
760 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
761 if (task_tasks[i].stdoutlog) fclose (task_tasks[i].stdoutlog);
762 if (task_tasks[i].stderrlog) fclose (task_tasks[i].stderrlog);
765 * Only remove the log files if the test actually compiled otherwise
768 if (task_tasks[i].compiled) {
769 if (remove(task_tasks[i].stdoutlogfile))
770 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
772 util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
774 if (remove(task_tasks[i].stderrlogfile))
775 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
777 util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
780 /* free util_strdup data for log files */
781 mem_d(task_tasks[i].stdoutlogfile);
782 mem_d(task_tasks[i].stderrlogfile);
784 task_template_destroy(&task_tasks[i].template);
786 vec_free(task_tasks);
789 * Cleanup outside stuff like temporary files.
791 task_cleanup(curdir);
795 * This executes the QCVM task for a specificly compiled progs.dat
796 * using the template passed into it for call-flags and user defined
799 bool task_execute(task_template_t *template) {
800 bool success = false;
803 memset (buffer,0,sizeof(buffer));
806 * Drop the execution flags for the QCVM if none where
807 * actually specified.
809 if (!strcmp(template->executeflags, "$null")) {
810 snprintf(buffer, sizeof(buffer), "%s %s",
811 task_bins[TASK_EXECUTE],
812 template->tempfilename
815 snprintf(buffer, sizeof(buffer), "%s %s %s",
816 task_bins[TASK_EXECUTE],
817 template->executeflags,
818 template->tempfilename
822 util_debug("TEST", "executing qcvm: `%s` [%s]\n",
823 template->description,
827 execute = popen(buffer, "r");
832 * Now lets read the lines and compare them to the matches we expect
833 * and handle accordingly.
839 while (util_getline(&data, &size, execute) != EOF) {
840 if (!strcmp(data, "No main function found\n")) {
841 con_err("test failure: `%s` [%s] (No main function found)\n",
842 template->description,
843 (template->failuremessage) ?
844 template->failuremessage : "unknown"
851 * Trim newlines from data since they will just break our
852 * ability to properly validate matches.
854 if (strrchr(data, '\n'))
855 *strrchr(data, '\n') = '\0';
859 * We only care about the last line from the output for now
860 * implementing multi-line match is TODO.
862 success = !!!(strcmp(data, template->comparematch[compare++]));
870 * This schedualizes all tasks and actually runs them individually
871 * this is generally easy for just -compile variants. For compile and
872 * execution this takes more work since a task needs to be generated
873 * from thin air and executed INLINE.
875 void task_schedualize(const char *curdir) {
876 bool execute = false;
882 for (i = 0; i < vec_size(task_tasks); i++) {
884 * Generate a task from thin air if it requires execution in
887 if (!strcmp(task_tasks[i].template->proceduretype, "-execute"))
891 * We assume it compiled before we actually compiled :). On error
892 * we change the value
894 task_tasks[i].compiled = true;
897 * Read data from stdout first and pipe that stuff into a log file
898 * then we do the same for stderr.
900 while (util_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
902 fputs(data, task_tasks[i].stdoutlog);
903 fflush(task_tasks[i].stdoutlog);
905 while (util_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
908 * If a string contains an error we just dissalow execution
911 * TODO: make this more percise, e.g if we print a warning
912 * that refers to a variable named error, or something like
913 * that .. then this will blowup :P
915 if (strstr(data, "error")) {
917 task_tasks[i].compiled = false;
920 fputs(data, task_tasks[i].stderrlog);
921 fflush(task_tasks[i].stdoutlog);
928 * If we can execute we do so after all data has been read and
929 * this paticular task has coupled execution in its procedure type
935 * If we made it here that concludes the task is to be executed
936 * in the virtual machine.
938 if (!task_execute(task_tasks[i].template)) {
939 con_err("test failure: `%s` [%s] see %s.stdout and %s.stderr\n",
940 task_tasks[i].template->description,
941 (task_tasks[i].template->failuremessage) ?
942 task_tasks[i].template->failuremessage : "unknown",
943 task_tasks[i].template->tempfilename,
944 task_tasks[i].template->tempfilename
949 con_out("test succeed: `%s` [%s]\n",
950 task_tasks[i].template->description,
951 (task_tasks[i].template->successmessage) ?
952 task_tasks[i].template->successmessage : "unknown"
960 * This is the heart of the whole test-suite process. This cleans up
961 * any existing temporary files left behind as well as log files left
962 * behind. Then it propogates a list of tests from `curdir` by scaning
963 * it for template files and compiling them into tasks, in which it
964 * schedualizes them (executes them) and actually reports errors and
965 * what not. It then proceeds to destroy the tasks and return memory
968 * It returns true of tests could be propogated, otherwise it returns
971 * It expects con_init() was called before hand.
973 bool test_perform(const char *curdir) {
974 task_precleanup(curdir);
975 if (!task_propogate(curdir)) {
976 con_err("error: failed to propogate tasks\n");
977 task_destroy(curdir);
981 * If we made it here all tasks where propogated from their resultant
982 * template file. So we can start the FILO scheduler, this has been
983 * designed in the most thread-safe way possible for future threading
984 * it's designed to prevent lock contention, and possible syncronization
987 task_schedualize(curdir);
988 task_destroy(curdir);
994 * Fancy GCC-like LONG parsing allows things like --opt=param with
995 * assignment operator. This is used for redirecting stdout/stderr
996 * console to specific files of your choice.
998 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
1000 char **argv = *argv_;
1002 size_t len = strlen(optname);
1004 if (strncmp(argv[0]+ds, optname, len))
1007 /* it's --optname, check how the parameter is supplied */
1008 if (argv[0][ds+len] == '=') {
1009 *out = argv[0]+ds+len+1;
1013 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
1016 /* using --opt param */
1023 int main(int argc, char **argv) {
1024 char *redirout = (char*)stdout;
1025 char *redirerr = (char*)stderr;
1029 * Command line option parsing commences now We only need to support
1030 * a few things in the test suite.
1036 if (argv[0][0] == '-') {
1037 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
1039 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
1042 con_change(redirout, redirerr);
1044 if (!strcmp(argv[0]+1, "debug")) {
1048 if (!strcmp(argv[0]+1, "memchk")) {
1052 if (!strcmp(argv[0]+1, "nocolor")) {
1057 con_err("invalid argument %s\n", argv[0]+1);
1061 con_change(redirout, redirerr);
1062 test_perform("tests");