#include <sys/stat.h>
#include <dirent.h>
-bool opts_memchk = false;
-bool opts_debug = false;
+opts_cmd_t opts;
+
char *task_bins[] = {
"./gmqcc",
"./qcvm"
* this implements a unique bi-directional popen-like function that
* allows reading data from both stdout and stderr. And writing to
* stdin :)
- *
+ *
* Example of use:
* FILE *handles[3] = task_popen("ls", "-l", "r");
* if (!handles) { perror("failed to open stdin/stdout/stderr to ls");
* // handles[0] = stdin
* // handles[1] = stdout
* // handles[2] = stderr
- *
+ *
* task_pclose(handles); // to close
*/
#ifndef _WIN32
#include <sys/types.h>
#include <sys/wait.h>
-
#include <unistd.h>
typedef struct {
FILE *handles[3];
int pipes [3];
-
+
int stderr_fd;
int stdout_fd;
int pid;
int outhandle [2];
int errhandle [2];
int trypipe;
-
+
popen_t *data = mem_a(sizeof(popen_t));
-
+
/*
* Parse the command now into a list for execv, this is a pain
* in the ass.
char *line = (char*)command;
char **argv = NULL;
{
-
+
while (*line != '\0') {
while (*line == ' ' || *line == '\t' || *line == '\n')
*line++ = '\0';
vec_push(argv, line);
-
+
while (*line != '\0' && *line != ' ' &&
*line != '\t' && *line != '\n') line++;
}
vec_push(argv, '\0');
}
-
-
+
+
if ((trypipe = pipe(inhandle)) < 0) goto task_popen_error_0;
if ((trypipe = pipe(outhandle)) < 0) goto task_popen_error_1;
if ((trypipe = pipe(errhandle)) < 0) goto task_popen_error_2;
-
+
if ((data->pid = fork()) > 0) {
/* parent */
close(inhandle [0]);
close(outhandle [1]);
close(errhandle [1]);
-
+
data->pipes [0] = inhandle [1];
data->pipes [1] = outhandle[0];
data->pipes [2] = errhandle[0];
data->handles[0] = fdopen(inhandle [1], "w");
data->handles[1] = fdopen(outhandle[0], mode);
data->handles[2] = fdopen(errhandle[0], mode);
-
+
/* sigh */
if (argv)
vec_free(argv);
close(inhandle [1]);
close(outhandle[0]);
close(errhandle[0]);
-
+
/* see piping documentation for this sillyness :P */
close(0), dup(inhandle [0]);
close(1), dup(outhandle[1]);
close(2), dup(errhandle[1]);
-
+
execvp(*argv, argv);
exit(1);
} else {
/* fork failed */
goto task_popen_error_3;
}
-
+
if (argv)
vec_free(argv);
return data->handles;
-
+
task_popen_error_3: close(errhandle[0]), close(errhandle[1]);
task_popen_error_2: close(outhandle[0]), close(outhandle[1]);
task_popen_error_1: close(inhandle [0]), close(inhandle [1]);
int task_pclose(FILE **handles) {
popen_t *data = (popen_t*)handles;
int status = 0;
-
+
close(data->pipes[0]); /* stdin */
close(data->pipes[1]); /* stdout */
close(data->pipes[2]); /* stderr */
-
+
waitpid(data->pid, &status, 0);
-
+
mem_d(data);
-
+
return status;
}
#else
-
+#error "There is no support for windows yet ... this is not a FTBFS bug"
#endif
#define TASK_COMPILE 0
* the information for that test there is no way to properly "test" them.
* Rules for these templates are described in a template file, using a
* task template language.
- *
+ *
* The language is a basic finite statemachine, top-down single-line
* description language.
- *
+ *
* The languge is composed entierly of "tags" which describe a string of
* text for a task. Think of it much like a configuration file. Except
* it's been designed to allow flexibility and future support for prodecual
* semantics.
- *
+ *
* The following "tags" are suported by the language
- *
+ *
* D:
* Used to set a description of the current test, this must be
* provided, this tag is NOT optional.
- *
+ *
* F:
* Used to set a failure message, this message will be displayed
* if the test fails, this tag is optional
- *
+ *
* S:
* Used to set a success message, this message will be displayed
* if the test succeeds, this tag is optional.
- *
+ *
* T:
* Used to set the procedure for the given task, there are two
* options for this:
* This simply performs compilation only
* -execute
* This will perform compilation and execution
- *
+ * -fail
+ * This will perform compilation, but requires
+ * the compilation to fail in order to succeed.
+ *
* This must be provided, this tag is NOT optional.
- *
+ *
* C:
* Used to set the compilation flags for the given task, this
* must be provided, this tag is NOT optional.
- *
+ *
* E:
* Used to set the execution flags for the given task. This tag
* must be provided if T == -execute, otherwise it's erroneous
- * as compilation only takes place.
- *
+ * as compilation only takes place.
+ *
* M:
* Used to describe a string of text that should be matched from
* the output of executing the task. If this doesn't match the
* task fails. This tag must be provided if T == -execute, otherwise
* it's erroneous as compilation only takes place.
- *
+ *
* I:
* Used to specify the INPUT source file to operate on, this must be
* provided, this tag is NOT optional
*
- *
+ *
* Notes:
* These tags have one-time use, using them more than once will result
* in template compilation errors.
- *
+ *
* Lines beginning with # or // in the template file are comments and
* are ignored by the template parser.
- *
+ *
* Whitespace is optional, with exception to the colon ':' between the
* tag and it's assignment value/
- *
+ *
* The template compiler will detect erronrous tags (optional tags
* that need not be set), as well as missing tags, and error accordingly
* this will result in the task failing.
*/
bool task_template_generate(task_template_t *template, char tag, const char *file, size_t line, const char *value) {
char **destval = NULL;
-
+
if (!template)
return false;
-
+
switch(tag) {
case 'D': destval = &template->description; break;
case 'F': destval = &template->failuremessage; break;
);
return false;
}
-
+
/*
* Ensure if for the given tag, there already exists a
* assigned value.
);
return false;
}
-
+
/*
* Strip any whitespace that might exist in the value for assignments
* like "D: foo"
*/
if (value && *value && (*value == ' ' || *value == '\t'))
value++;
-
+
/*
* Value will contain a newline character at the end, we need to strip
* this otherwise kaboom, seriously, kaboom :P
*/
*strrchr(value, '\n')='\0';
-
+
/*
* Now allocate and set the actual value for the specific tag. Which
* was properly selected and can be accessed with *destval.
*/
*destval = util_strdup(value);
-
+
return true;
}
char *back = NULL;
size_t size = 0;
size_t line = 1;
-
+
if (!template)
return false;
-
+
/* top down parsing */
while (util_getline(&back, &size, fp) != EOF) {
/* skip whitespace */
data = back;
if (*data && (*data == ' ' || *data == '\t'))
data++;
-
+
switch (*data) {
/*
* Handle comments inside task template files. We're strict
if (data[1] != '/') {
con_printmsg(LVL_ERROR, file, line, "template parse error",
"invalid character `/`, perhaps you meant `//` ?");
-
+
mem_d(back);
return false;
}
case '#':
break;
-
+
/*
* Empty newlines are acceptable as well, so we handle that here
* despite being just odd since there should't be that many
case '\r':
case '\n':
break;
-
-
+
+
/*
* Now begin the actual "tag" stuff. This works as you expect
* it to.
goto failure;
}
break;
-
+
/*
* Match requires it's own system since we allow multiple M's
* for multi-line matching.
);
goto failure;
}
-
+
if (value && *value && (*value == ' ' || *value == '\t'))
value++;
-
+
/*
* Value will contain a newline character at the end, we need to strip
* this otherwise kaboom, seriously, kaboom :P
*/
*strrchr(value, '\n')='\0';
-
+
vec_push(template->comparematch, util_strdup(value));
-
+
break;
}
-
+
default:
con_printmsg(LVL_ERROR, file, line, "template parse error",
"invalid tag `%c`", *data
goto failure;
/* no break required */
}
-
+
/* update line and free old sata */
line++;
mem_d(back);
if (back)
mem_d(back);
return true;
-
+
failure:
if (back)
mem_d (back);
void task_template_nullify(task_template_t *template) {
if (!template)
return;
-
+
template->description = NULL;
template->failuremessage = NULL;
template->successmessage = NULL;
char fullfile[4096];
FILE *tempfile = NULL;
task_template_t *template = NULL;
-
+
memset (fullfile, 0, sizeof(fullfile));
snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
-
+
tempfile = fopen(fullfile, "r");
template = mem_a(sizeof(task_template_t));
task_template_nullify(template);
-
+
/*
* Esnure the file even exists for the task, this is pretty useless
* to even do.
);
goto failure;
}
-
+
if (!task_template_parse(file, template, tempfile)) {
con_err("template parse error: error during parsing\n");
goto failure;
}
-
+
/*
* Regardless procedure type, the following tags must exist:
* D
con_err("template compile error: %s missing `I:` tag\n", file);
goto failure;
}
-
+
/*
* Now lets compile the template, compilation is really just
* the process of validating the input.
con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
goto failure;
}
+ } else if (!strcmp(template->proceduretype, "-fail")) {
+ if (template->executeflags)
+ con_err("template compile warning: %s erroneous tag `E:` when only failing\n", file);
+ if (template->comparematch)
+ con_err("template compile warning: %s erroneous tag `M:` when only failing\n", file);
+ goto success;
} else {
con_err("template compile error: %s invalid procedure type: %s\n", file, template->proceduretype);
goto failure;
}
-
+
success:
fclose(tempfile);
return template;
-
+
failure:
/*
* The file might not exist and we jump here when that doesn't happen
if (tempfile)
fclose(tempfile);
mem_d (template);
-
+
return NULL;
}
void task_template_destroy(task_template_t **template) {
if (!template)
return;
-
+
if ((*template)->description) mem_d((*template)->description);
if ((*template)->failuremessage) mem_d((*template)->failuremessage);
if ((*template)->successmessage) mem_d((*template)->successmessage);
if ((*template)->compileflags) mem_d((*template)->compileflags);
if ((*template)->executeflags) mem_d((*template)->executeflags);
if ((*template)->sourcefile) mem_d((*template)->sourcefile);
-
+
/*
* Delete all allocated string for task template then destroy the
* main vector.
size_t i = 0;
for (; i < vec_size((*template)->comparematch); i++)
mem_d((*template)->comparematch[i]);
-
+
vec_free((*template)->comparematch);
}
-
+
/*
* Nullify all the template members otherwise NULL comparision
* checks will fail if template pointer is reused.
struct stat directory;
char buffer[4096];
size_t found = 0;
-
+
dir = opendir(curdir);
-
+
while ((files = readdir(dir))) {
memset (buffer, 0,sizeof(buffer));
snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
-
+
if (stat(buffer, &directory) == -1) {
con_err("internal error: stat failed, aborting\n");
abort();
}
-
+
/* skip directories */
if (S_ISDIR(directory.st_mode))
continue;
-
+
/*
* We made it here, which concludes the file/directory is not
* actually a directory, so it must be a file :)
task_template_t *template = task_template_compile(files->d_name, curdir);
char buf[4096]; /* one page should be enough */
task_t task;
-
+
util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
found ++;
if (!template) {
* so we don't trample over an existing one.
*/
template->tempfilename = tempnam(curdir, "TMPDAT");
-
+
/*
* Generate the command required to open a pipe to a process
* which will be refered to with a handle in the task for
template->compileflags,
template->tempfilename
);
-
+
/*
* The task template was compiled, now lets create a task from
* the template data which has now been propagated.
success = false;
continue;
}
-
+
util_debug("TEST", "executing test: `%s` [%s]\n", template->description, buf);
-
+
/*
* Open up some file desciptors for logging the stdout/stderr
* to our own.
con_err("error opening %s for stdout\n", buf);
continue;
}
-
+
memset (buf,0,sizeof(buf));
snprintf(buf, sizeof(buf), "%s.stderr", template->tempfilename);
task.stderrlogfile = util_strdup(buf);
con_err("error opening %s for stderr\n", buf);
continue;
}
-
+
vec_push(task_tasks, task);
}
}
-
+
util_debug("TEST", "compiled %d task template files out of %d\n",
vec_size(task_tasks),
found
);
-
+
closedir(dir);
return success;
}
char buffer[4096];
dir = opendir(curdir);
-
+
while ((files = readdir(dir))) {
memset(buffer, 0, sizeof(buffer));
if (strstr(files->d_name, "TMP")) {
util_debug("TEST", "removed temporary file: %s\n", buffer);
}
}
-
+
closedir(dir);
}
char buffer[4096];
dir = opendir(curdir);
-
+
while ((files = readdir(dir))) {
memset(buffer, 0, sizeof(buffer));
if (strstr(files->d_name, "TMP") ||
util_debug("TEST", "removed temporary file: %s\n", buffer);
}
}
-
+
closedir(dir);
}
if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
if (task_tasks[i].stdoutlog) fclose (task_tasks[i].stdoutlog);
if (task_tasks[i].stderrlog) fclose (task_tasks[i].stderrlog);
-
+
/*
* Only remove the log files if the test actually compiled otherwise
- * forget about it.
+ * forget about it (or if it didn't compile, and the procedure type
+ * was set to -fail (meaning it shouldn't compile) .. stil remove)
*/
- if (task_tasks[i].compiled) {
+ if (task_tasks[i].compiled || !strcmp(task_tasks[i].template->proceduretype, "-fail")) {
if (remove(task_tasks[i].stdoutlogfile))
con_err("error removing stdout log file: %s\n", task_tasks[i].stdoutlogfile);
else
util_debug("TEST", "removed stdout log file: %s\n", task_tasks[i].stdoutlogfile);
-
+
if (remove(task_tasks[i].stderrlogfile))
con_err("error removing stderr log file: %s\n", task_tasks[i].stderrlogfile);
else
util_debug("TEST", "removed stderr log file: %s\n", task_tasks[i].stderrlogfile);
}
-
+
/* free util_strdup data for log files */
mem_d(task_tasks[i].stdoutlogfile);
mem_d(task_tasks[i].stderrlogfile);
-
+
task_template_destroy(&task_tasks[i].template);
}
vec_free(task_tasks);
-
+
/*
* Cleanup outside stuff like temporary files.
*/
* using the template passed into it for call-flags and user defined
* messages.
*/
-bool task_execute(task_template_t *template) {
- bool success = false;
+bool task_execute(task_template_t *template, char ***line) {
+ bool success = true;
FILE *execute;
char buffer[4096];
memset (buffer,0,sizeof(buffer));
-
+
/*
* Drop the execution flags for the QCVM if none where
* actually specified.
template->tempfilename
);
}
-
+
util_debug("TEST", "executing qcvm: `%s` [%s]\n",
template->description,
buffer
);
-
+
execute = popen(buffer, "r");
if (!execute)
return false;
-
+
/*
* Now lets read the lines and compare them to the matches we expect
* and handle accordingly.
pclose(execute);
return false;
}
-
- /*
+
+ /*
* Trim newlines from data since they will just break our
* ability to properly validate matches.
*/
if (strrchr(data, '\n'))
*strrchr(data, '\n') = '\0';
-
-
+
+ if (vec_size(template->comparematch) > compare) {
+ if (strcmp(data, template->comparematch[compare++]))
+ success = false;
+ } else {
+ success = false;
+ }
+
/*
- * We only care about the last line from the output for now
- * implementing multi-line match is TODO.
- */
- success = !!!(strcmp(data, template->comparematch[compare++]));
+ * Copy to output vector for diagnostics if execution match
+ * fails.
+ */
+ vec_push(*line, data);
+
+ /* reset */
+ data = NULL;
+ size = 0;
}
mem_d(data);
data = NULL;
void task_schedualize() {
bool execute = false;
char *data = NULL;
+ char **match = NULL;
size_t size = 0;
size_t i;
-
+ size_t j;
+
util_debug("TEST", "found %d tasks, preparing to execute\n", vec_size(task_tasks));
-
+
for (i = 0; i < vec_size(task_tasks); i++) {
util_debug("TEST", "executing task: %d: %s\n", i, task_tasks[i].template->description);
/*
* Generate a task from thin air if it requires execution in
* the QCVM.
*/
- if (!strcmp(task_tasks[i].template->proceduretype, "-execute"))
- execute = true;
-
+ execute = !!(!strcmp(task_tasks[i].template->proceduretype, "-execute"));
+
/*
* We assume it compiled before we actually compiled :). On error
* we change the value
*/
task_tasks[i].compiled = true;
-
+
/*
* Read data from stdout first and pipe that stuff into a log file
* then we do the same for stderr.
- */
+ */
while (util_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
fputs(data, task_tasks[i].stdoutlog);
-
- if (strstr(data, "failed to open file"))
- execute = false;
-
+
+ if (strstr(data, "failed to open file")) {
+ task_tasks[i].compiled = false;
+ execute = false;
+ }
+
fflush(task_tasks[i].stdoutlog);
}
while (util_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
/*
* If a string contains an error we just dissalow execution
* of it in the vm.
- *
+ *
* TODO: make this more percise, e.g if we print a warning
* that refers to a variable named error, or something like
* that .. then this will blowup :P
execute = false;
task_tasks[i].compiled = false;
}
-
+
fputs(data, task_tasks[i].stderrlog);
fflush(task_tasks[i].stdoutlog);
}
-
- /*
- * If we made it here that concludes the task is to be executed
- * in the virtual machine.
- */
- if (!execute || !task_execute(task_tasks[i].template)) {
- con_err("test failure: `%s` [%s] see %s.stdout and %s.stderr\n",
+
+ if (!task_tasks[i].compiled && strcmp(task_tasks[i].template->proceduretype, "-fail")) {
+ con_err("test failure: `%s` [%s] (failed to compile) see %s.stdout and %s.stderr\n",
task_tasks[i].template->description,
(task_tasks[i].template->failuremessage) ?
task_tasks[i].template->failuremessage : "unknown",
);
continue;
}
-
+
+ if (!execute) {
+ con_out("test succeeded: `%s` [%s]\n",
+ task_tasks[i].template->description,
+ (task_tasks[i].template->successmessage) ?
+ task_tasks[i].template->successmessage : "unknown"
+ );
+ continue;
+ }
+
+ /*
+ * If we made it here that concludes the task is to be executed
+ * in the virtual machine.
+ */
+ if (!task_execute(task_tasks[i].template, &match)) {
+ size_t d = 0;
+
+ con_err("test failure: `%s` [%s] (invalid results from execution)\n",
+ task_tasks[i].template->description,
+ (task_tasks[i].template->failuremessage) ?
+ task_tasks[i].template->failuremessage : "unknown"
+ );
+
+ /*
+ * Print nicely formatted expected match lists to console error
+ * handler for the all the given matches in the template file and
+ * what was actually returned from executing.
+ */
+ con_err(" Expected From %u Matches: (got %u Matches)\n",
+ vec_size(task_tasks[i].template->comparematch),
+ vec_size(match)
+ );
+ for (; d < vec_size(task_tasks[i].template->comparematch); d++) {
+ char *select = task_tasks[i].template->comparematch[d];
+ size_t length = 40 - strlen(select);
+
+ con_err(" Expected: \"%s\"", select);
+ while (length --)
+ con_err(" ");
+ con_err("| Got: \"%s\"\n", (d >= vec_size(match)) ? "<<nothing else to compare>>" : match[d]);
+ }
+
+ /*
+ * Print the non-expected out (since we are simply not expecting it)
+ * This will help track down bugs in template files that fail to match
+ * something.
+ */
+ if (vec_size(match) > vec_size(task_tasks[i].template->comparematch)) {
+ for (d = 0; d < vec_size(match) - vec_size(task_tasks[i].template->comparematch); d++) {
+ con_err(" Expected: Nothing | Got: \"%s\"\n",
+ match[d + vec_size(task_tasks[i].template->comparematch)]
+ );
+ }
+ }
+
+
+ for (j = 0; j < vec_size(match); j++)
+ mem_d(match[j]);
+ vec_free(match);
+ continue;
+ }
+ for (j = 0; j < vec_size(match); j++)
+ mem_d(match[j]);
+ vec_free(match);
+
con_out("test succeeded: `%s` [%s]\n",
- task_tasks[i].template->description,
+ task_tasks[i].template->description,
(task_tasks[i].template->successmessage) ?
- task_tasks[i].template->successmessage : "unknown"
+ task_tasks[i].template->successmessage : "unknown"
);
}
mem_d(data);
* schedualizes them (executes them) and actually reports errors and
* what not. It then proceeds to destroy the tasks and return memory
* it's the engine :)
- *
+ *
* It returns true of tests could be propagated, otherwise it returns
* false.
- *
+ *
* It expects con_init() was called before hand.
*/
bool test_perform(const char *curdir) {
*/
task_schedualize();
task_destroy(curdir);
-
+
return true;
}
int main(int argc, char **argv) {
char *redirout = (char*)stdout;
char *redirerr = (char*)stderr;
-
+
con_init();
-
+
/*
* Command line option parsing commences now We only need to support
* a few things in the test suite.
continue;
if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
continue;
-
+
con_change(redirout, redirerr);
if (!strcmp(argv[0]+1, "debug")) {
- opts_debug = true;
+ opts.debug = true;
continue;
}
if (!strcmp(argv[0]+1, "memchk")) {
- opts_memchk = true;
+ opts.memchk = true;
continue;
}
if (!strcmp(argv[0]+1, "nocolor")) {
con_color(0);
continue;
}
-
+
con_err("invalid argument %s\n", argv[0]+1);
return -1;
}
projects / xonotic / gmqcc.git / blobdiff