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 'M': destval = &template->comparematch; break;
271 case 'I': destval = &template->sourcefile; break;
273 con_printmsg(LVL_ERROR, __FILE__, __LINE__, "internal error",
274 "invalid tag `%c:` during code generation\n",
281 * Ensure if for the given tag, there already exists a
285 con_printmsg(LVL_ERROR, file, line, "compile error",
286 "tag `%c:` already assigned value: %s\n",
293 * Strip any whitespace that might exist in the value for assignments
296 if (value && *value && (*value == ' ' || *value == '\t'))
300 * Value will contain a newline character at the end, we need to strip
301 * this otherwise kaboom, seriously, kaboom :P
303 *strrchr(value, '\n')='\0';
306 * Now allocate and set the actual value for the specific tag. Which
307 * was properly selected and can be accessed with *destval.
309 *destval = util_strdup(value);
314 bool task_template_parse(const char *file, task_template_t *template, FILE *fp) {
323 /* top down parsing */
324 while (util_getline(&back, &size, fp) != EOF) {
325 /* skip whitespace */
327 if (*data && (*data == ' ' || *data == '\t'))
332 * Handle comments inside task template files. We're strict
333 * about the language for fun :-)
336 if (data[1] != '/') {
337 con_printmsg(LVL_ERROR, file, line, "template parse error",
338 "invalid character `/`, perhaps you meant `//` ?");
347 * Empty newlines are acceptable as well, so we handle that here
348 * despite being just odd since there should't be that many
349 * empty lines to begin with.
357 * Now begin the actual "tag" stuff. This works as you expect
368 if (data[1] != ':') {
369 con_printmsg(LVL_ERROR, file, line, "template parse error",
370 "expected `:` after `%c`",
375 if (!task_template_generate(template, *data, file, line, &data[3])) {
376 con_printmsg(LVL_ERROR, file, line, "template compile error",
377 "failed to generate for given task\n"
384 con_printmsg(LVL_ERROR, file, line, "template parse error",
385 "invalid tag `%c`", *data
388 /* no break required */
391 /* update line and free old sata */
407 * Nullifies the template data: used during initialization of a new
410 void task_template_nullify(task_template_t *template) {
414 template->description = NULL;
415 template->failuremessage = NULL;
416 template->successmessage = NULL;
417 template->proceduretype = NULL;
418 template->compileflags = NULL;
419 template->executeflags = NULL;
420 template->comparematch = NULL;
421 template->sourcefile = NULL;
422 template->tempfilename = NULL;
425 task_template_t *task_template_compile(const char *file, const char *dir) {
426 /* a page should be enough */
428 FILE *tempfile = NULL;
429 task_template_t *template = NULL;
431 memset (fullfile, 0, sizeof(fullfile));
432 snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
434 tempfile = fopen(fullfile, "r");
435 template = mem_a(sizeof(task_template_t));
436 task_template_nullify(template);
439 * Esnure the file even exists for the task, this is pretty useless
443 con_err("template file: %s does not exist or invalid permissions\n",
449 if (!task_template_parse(file, template, tempfile)) {
450 con_err("template parse error: error during parsing\n");
455 * Regardless procedure type, the following tags must exist:
461 if (!template->description) {
462 con_err("template compile error: %s missing `D:` tag\n", file);
465 if (!template->proceduretype) {
466 con_err("template compile error: %s missing `T:` tag\n", file);
469 if (!template->compileflags) {
470 con_err("template compile error: %s missing `C:` tag\n", file);
473 if (!template->sourcefile) {
474 con_err("template compile error: %s missing `I:` tag\n", file);
479 * Now lets compile the template, compilation is really just
480 * the process of validating the input.
482 if (!strcmp(template->proceduretype, "-compile")) {
483 if (template->executeflags)
484 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
485 if (template->comparematch)
486 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
488 } else if (!strcmp(template->proceduretype, "-execute")) {
489 if (!template->executeflags) {
490 con_err("template compile error: %s missing `E:` tag (use `$null` for exclude)\n", file);
493 if (!template->comparematch) {
494 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
498 con_err("template compile error: %s invalid procedure type: %s\n", file, template->proceduretype);
508 * The file might not exist and we jump here when that doesn't happen
509 * so the check to see if it's not null here is required.
518 void task_template_destroy(task_template_t **template) {
522 if ((*template)->description) mem_d((*template)->description);
523 if ((*template)->failuremessage) mem_d((*template)->failuremessage);
524 if ((*template)->successmessage) mem_d((*template)->successmessage);
525 if ((*template)->proceduretype) mem_d((*template)->proceduretype);
526 if ((*template)->compileflags) mem_d((*template)->compileflags);
527 if ((*template)->executeflags) mem_d((*template)->executeflags);
528 if ((*template)->comparematch) mem_d((*template)->comparematch);
529 if ((*template)->sourcefile) mem_d((*template)->sourcefile);
532 * Nullify all the template members otherwise NULL comparision
533 * checks will fail if template pointer is reused.
536 task_template_nullify(*template);
541 * Now comes the task manager, this system allows adding tasks in and out
542 * of a task list. This is the executor of the tasks essentially as well.
545 task_template_t *template;
554 task_t *task_tasks = NULL;
557 * Read a directory and searches for all template files in it
558 * which is later used to run all tests.
560 bool task_propogate(const char *curdir) {
563 struct dirent *files;
564 struct stat directory;
567 dir = opendir(curdir);
569 while ((files = readdir(dir))) {
570 memset (buffer, 0,sizeof(buffer));
571 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
573 if (stat(buffer, &directory) == -1) {
574 con_err("internal error: stat failed, aborting\n");
578 /* skip directories */
579 if (S_ISDIR(directory.st_mode))
583 * We made it here, which concludes the file/directory is not
584 * actually a directory, so it must be a file :)
586 if (strstr(files->d_name, ".tmpl")) {
587 con_out("compiling task template: %s/%s\n", curdir, files->d_name);
588 task_template_t *template = task_template_compile(files->d_name, curdir);
590 con_err("error compiling task template: %s\n", files->d_name);
595 * Generate a temportary file name for the output binary
596 * so we don't trample over an existing one.
598 template->tempfilename = tempnam(curdir, "TMPDAT");
601 * Generate the command required to open a pipe to a process
602 * which will be refered to with a handle in the task for
603 * reading the data from the pipe.
605 char buf[4096]; /* one page should be enough */
606 memset (buf,0,sizeof(buf));
607 snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
608 task_bins[TASK_COMPILE],
610 template->sourcefile,
611 template->compileflags,
612 template->tempfilename
616 * The task template was compiled, now lets create a task from
617 * the template data which has now been propogated.
620 task.template = template;
621 if (!(task.runhandles = task_popen(buf, "r"))) {
622 con_err("error opening pipe to process for test: %s\n", template->description);
627 con_out("executing test: `%s` [%s]\n", template->description, buf);
630 * Open up some file desciptors for logging the stdout/stderr
633 memset (buf,0,sizeof(buf));
634 snprintf(buf, sizeof(buf), "%s/%s.stdout", curdir, template->sourcefile);
635 task.stdoutlogfile = util_strdup(buf);
636 task.stdoutlog = fopen(buf, "w");
638 memset (buf,0,sizeof(buf));
639 snprintf(buf, sizeof(buf), "%s/%s.stderr", curdir, template->sourcefile);
640 task.stderrlogfile = util_strdup(buf);
641 task.stderrlog = fopen(buf, "w");
643 vec_push(task_tasks, task);
652 * Removes all temporary 'progs.dat' files created during compilation
655 void task_cleanup(const char *curdir) {
657 struct dirent *files;
660 dir = opendir(curdir);
662 while ((files = readdir(dir))) {
663 memset(buffer, 0, sizeof(buffer));
664 if (strstr(files->d_name, "TMP")) {
665 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
667 con_err("error removing temporary file: %s\n", buffer);
669 con_out("removed temporary file: %s\n", buffer);
677 * Task precleanup removes any existing temporary files or log files
678 * left behind from a previous invoke of the test-suite.
680 void task_precleanup(const char *curdir) {
682 struct dirent *files;
685 dir = opendir(curdir);
687 while ((files = readdir(dir))) {
688 memset(buffer, 0, sizeof(buffer));
689 if (strstr(files->d_name, "TMP") ||
690 strstr(files->d_name, ".stdout") ||
691 strstr(files->d_name, ".stderr"))
693 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
695 con_err("error removing temporary file: %s\n", buffer);
697 con_out("removed temporary file: %s\n", buffer);
704 void task_destroy(const char *curdir) {
706 * Free all the data in the task list and finally the list itself
707 * then proceed to cleanup anything else outside the program like
711 for (i = 0; i < vec_size(task_tasks); i++) {
713 * Close any open handles to files or processes here. It's mighty
714 * annoying to have to do all this cleanup work.
716 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
717 if (task_tasks[i].stdoutlog) fclose (task_tasks[i].stdoutlog);
718 if (task_tasks[i].stderrlog) fclose (task_tasks[i].stderrlog);
721 * Only remove the log files if the test actually compiled otherwise
724 if (task_tasks[i].compiled) {
725 if (remove(task_tasks[i].stdoutlogfile))
726 con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
728 con_out("removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
730 if (remove(task_tasks[i].stderrlogfile))
731 con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
733 con_out("removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
736 /* free util_strdup data for log files */
737 mem_d(task_tasks[i].stdoutlogfile);
738 mem_d(task_tasks[i].stderrlogfile);
740 task_template_destroy(&task_tasks[i].template);
742 vec_free(task_tasks);
745 * Cleanup outside stuff like temporary files.
747 task_cleanup(curdir);
751 * This executes the QCVM task for a specificly compiled progs.dat
752 * using the template passed into it for call-flags and user defined
755 bool task_execute(task_template_t *template) {
756 bool success = false;
759 memset (buffer,0,sizeof(buffer));
762 * Drop the execution flags for the QCVM if none where
763 * actually specified.
765 if (!strcmp(template->executeflags, "$null")) {
766 snprintf(buffer, sizeof(buffer), "%s %s",
767 task_bins[TASK_EXECUTE],
768 template->tempfilename
771 snprintf(buffer, sizeof(buffer), "%s %s %s",
772 task_bins[TASK_EXECUTE],
773 template->executeflags,
774 template->tempfilename
778 con_out("executing qcvm: `%s` [%s]\n",
779 template->description,
783 execute = popen(buffer, "r");
788 * Now lets read the lines and compare them to the matches we expect
789 * and handle accordingly.
794 while (util_getline(&data, &size, execute) != EOF) {}
796 if (!strcmp(data, "No main function found\n")) {
797 con_err("test failure: `%s` [%s] (No main function found)\n",
798 template->description,
799 (template->failuremessage) ?
800 template->failuremessage : "unknown"
807 * Trim newlines from data since they will just break our
808 * ability to properly validate matches.
810 if (strrchr(data, '\n'))
811 *strrchr(data, '\n') = '\0';
814 if (!strcmp(template->comparematch, "$null"))
818 * We only care about the last line from the output for now
819 * implementing multi-line match is TODO.
821 if (!strcmp(data, template->comparematch))
829 * This schedualizes all tasks and actually runs them individually
830 * this is generally easy for just -compile variants. For compile and
831 * execution this takes more work since a task needs to be generated
832 * from thin air and executed INLINE.
834 void task_schedualize(const char *curdir) {
835 bool execute = false;
841 for (i = 0; i < vec_size(task_tasks); i++) {
843 * Generate a task from thin air if it requires execution in
846 if (!strcmp(task_tasks[i].template->proceduretype, "-execute"))
850 * We assume it compiled before we actually compiled :). On error
851 * we change the value
853 task_tasks[i].compiled = true;
856 * Read data from stdout first and pipe that stuff into a log file
857 * then we do the same for stderr.
859 while (util_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
861 fputs(data, task_tasks[i].stdoutlog);
862 fflush(task_tasks[i].stdoutlog);
864 while (util_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
867 * If a string contains an error we just dissalow execution
870 * TODO: make this more percise, e.g if we print a warning
871 * that refers to a variable named error, or something like
872 * that .. then this will blowup :P
874 if (strstr(data, "error")) {
876 task_tasks[i].compiled = false;
879 fputs(data, task_tasks[i].stderrlog);
880 fflush(task_tasks[i].stdoutlog);
887 * If we can execute we do so after all data has been read and
888 * this paticular task has coupled execution in its procedure type
894 * If we made it here that concludes the task is to be executed
895 * in the virtual machine.
897 if (!task_execute(task_tasks[i].template)) {
898 con_err("test failure: `%s` [%s]\n",
899 task_tasks[i].template->description,
900 (task_tasks[i].template->failuremessage) ?
901 task_tasks[i].template->failuremessage : "unknown"
906 con_out("test succeed: `%s` [%s]\n",
907 task_tasks[i].template->description,
908 (task_tasks[i].template->successmessage) ?
909 task_tasks[i].template->successmessage : "unknown"
917 * This is the heart of the whole test-suite process. This cleans up
918 * any existing temporary files left behind as well as log files left
919 * behind. Then it propogates a list of tests from `curdir` by scaning
920 * it for template files and compiling them into tasks, in which it
921 * schedualizes them (executes them) and actually reports errors and
922 * what not. It then proceeds to destroy the tasks and return memory
925 * It returns true of tests could be propogated, otherwise it returns
928 * It expects con_init() was called before hand.
930 bool test_perform(const char *curdir) {
931 task_precleanup(curdir);
932 if (!task_propogate(curdir)) {
933 con_err("error: failed to propogate tasks\n");
934 task_destroy(curdir);
938 * If we made it here all tasks where propogated from their resultant
939 * template file. So we can start the FILO scheduler, this has been
940 * designed in the most thread-safe way possible for future threading
941 * it's designed to prevent lock contention, and possible syncronization
944 task_schedualize(curdir);
945 task_destroy(curdir);
951 * Fancy GCC-like LONG parsing allows things like --opt=param with
952 * assignment operator. This is used for redirecting stdout/stderr
953 * console to specific files of your choice.
955 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
957 char **argv = *argv_;
959 size_t len = strlen(optname);
961 if (strncmp(argv[0]+ds, optname, len))
964 /* it's --optname, check how the parameter is supplied */
965 if (argv[0][ds+len] == '=') {
966 *out = argv[0]+ds+len+1;
970 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
973 /* using --opt param */
980 int main(int argc, char **argv) {
981 char *redirout = (char*)stdout;
982 char *redirerr = (char*)stderr;
986 * Command line option parsing commences now We only need to support
987 * a few things in the test suite.
993 if (argv[0][0] == '-') {
994 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
996 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
999 con_change(redirout, redirerr);
1001 if (!strcmp(argv[0]+1, "debug")) {
1005 if (!strcmp(argv[0]+1, "memchk")) {
1009 if (!strcmp(argv[0]+1, "nocolor")) {
1014 con_err("invalid argument %s\n", argv[0]+1);
1018 con_change(redirout, redirerr);
1019 test_perform("tests");