/*
- * Copyright (C) 2012
+ * Copyright (C) 2012, 2013
* Dale Weiler
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
#include "gmqcc.h"
#include <sys/types.h>
#include <sys/stat.h>
-#include <dirent.h>
-cmd_options opts;
+opts_cmd_t opts;
char *task_bins[] = {
"./gmqcc",
#ifndef _WIN32
#include <sys/types.h>
#include <sys/wait.h>
-
+#include <dirent.h>
#include <unistd.h>
typedef struct {
FILE *handles[3];
close(2), dup(errhandle[1]);
execvp(*argv, argv);
- exit(1);
+ exit(EXIT_FAILURE);
} 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]);
return status;
}
#else
+# define _WIN32_LEAN_AND_MEAN
+# define popen _popen
+# define pclose _pclose
+# include <windows.h>
+# include <io.h>
+# include <fcntl.h>
+ /*
+ * Bidirectional piping implementation for windows using CreatePipe and DuplicateHandle +
+ * other hacks.
+ */
+
+ typedef struct {
+ int __dummy;
+ /* TODO: implement */
+ } popen_t;
+
+ FILE **task_popen(const char *command, const char *mode) {
+ (void)command;
+ (void)mode;
+
+ /* TODO: implement */
+ return NULL;
+ }
+
+ void task_pclose(FILE **files) {
+ /* TODO: implement */
+ (void)files;
+ return;
+ }
+
+# ifdef __MINGW32__
+ /* mingw32 has dirent.h */
+# include <dirent.h>
+# elif defined (_WIN32)
+ /*
+ * visual studio lacks dirent.h it's a posix thing
+ * so we emulate it with the WinAPI.
+ */
+
+ struct dirent {
+ long d_ino;
+ unsigned short d_reclen;
+ unsigned short d_namlen;
+ char d_name[FILENAME_MAX];
+ };
+
+ typedef struct {
+ struct _finddata_t dd_dta;
+ struct dirent dd_dir;
+ long dd_handle;
+ int dd_stat;
+ char dd_name[1];
+ } DIR;
+
+ DIR *opendir(const char *name) {
+ DIR *dir = (DIR*)mem_a(sizeof(DIR) + strlen(name));
+ if (!dir)
+ return NULL;
+
+ strcpy(dir->dd_name, name);
+ return dir;
+ }
+
+ int closedir(DIR *dir) {
+ FindClose((HANDLE)dir->dd_handle);
+ mem_d ((void*)dir);
+ return 0;
+ }
+
+ struct dirent *readdir(DIR *dir) {
+ WIN32_FIND_DATA info;
+ struct dirent *data;
+ int rets;
+
+ if (!dir->dd_handle) {
+ char *dirname;
+ if (*dir->dd_name) {
+ size_t n = strlen(dir->dd_name);
+ if ((dirname = (char*)mem_a(n + 5) /* 4 + 1 */)) {
+ strcpy(dirname, dir->dd_name);
+ strcpy(dirname + n, "\\*.*"); /* 4 + 1 */
+ }
+ } else {
+ if (!(dirname = util_strdup("\\*.*")))
+ return NULL;
+ }
+
+ dir->dd_handle = (long)FindFirstFile(dirname, &info);
+ mem_d(dirname);
+ rets = !(!dir->dd_handle);
+ } else if (dir->dd_handle != -11) {
+ rets = FindNextFile ((HANDLE)dir->dd_handle, &info);
+ } else {
+ rets = 0;
+ }
+
+ if (!rets)
+ return NULL;
+
+ if ((data = (struct dirent*)mem_a(sizeof(struct dirent)))) {
+ strncpy(data->d_name, info.cFileName, FILENAME_MAX - 1);
+ data->d_name[FILENAME_MAX - 1] = '\0'; /* terminate */
+ data->d_namlen = strlen(data->d_name);
+ }
+ return data;
+ }
+ /*
+ * Visual studio also lacks S_ISDIR for sys/stat.h, so we emulate this as well
+ * which is not hard at all.
+ */
+# undef S_ISDIR /* undef just incase */
+# define S_ISDIR(X) ((X)&_S_IFDIR)
+# endif
#endif
#define TASK_COMPILE 0
* 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.
*
*/
typedef struct {
char *description;
- char *failuremessage;
- char *successmessage;
char *compileflags;
char *executeflags;
char *proceduretype;
char *sourcefile;
char *tempfilename;
char **comparematch;
+ char *rulesfile;
} task_template_t;
/*
* This is very much like a compiler code generator :-). This generates
* a value from some data observed from the compiler.
*/
-bool task_template_generate(task_template_t *template, char tag, const char *file, size_t line, const char *value) {
+bool task_template_generate(task_template_t *template, char tag, const char *file, size_t line, const char *value, size_t *pad) {
+ size_t desclen = 0;
char **destval = NULL;
if (!template)
switch(tag) {
case 'D': destval = &template->description; break;
- case 'F': destval = &template->failuremessage; break;
- case 'S': destval = &template->successmessage; break;
case 'T': destval = &template->proceduretype; break;
case 'C': destval = &template->compileflags; break;
case 'E': destval = &template->executeflags; break;
* Value will contain a newline character at the end, we need to strip
* this otherwise kaboom, seriously, kaboom :P
*/
- *strrchr(value, '\n')='\0';
+ if (strchr(value, '\n'))
+ *strrchr(value, '\n')='\0';
+ else /* cppcheck: possible nullpointer dereference */
+ abort();
/*
* Now allocate and set the actual value for the specific tag. Which
*/
*destval = util_strdup(value);
+
+ if (*destval == template->description) {
+ /*
+ * Create some padding for the description to align the
+ * printing of the rules file.
+ */
+ if ((desclen = strlen(template->description)) > pad[0])
+ pad[0] = desclen;
+ }
+
return true;
}
-bool task_template_parse(const char *file, task_template_t *template, FILE *fp) {
+bool task_template_parse(const char *file, task_template_t *template, FILE *fp, size_t *pad) {
char *data = NULL;
char *back = NULL;
size_t size = 0;
return false;
/* top down parsing */
- while (util_getline(&back, &size, fp) != EOF) {
+ while (file_getline(&back, &size, fp) != EOF) {
/* skip whitespace */
data = back;
if (*data && (*data == ' ' || *data == '\t'))
* it to.
*/
case 'D':
- case 'F':
- case 'S':
case 'T':
case 'C':
case 'E':
);
goto failure;
}
- if (!task_template_generate(template, *data, file, line, &data[3])) {
+ if (!task_template_generate(template, *data, file, line, &data[3], pad)) {
con_printmsg(LVL_ERROR, file, line, "template compile error",
"failed to generate for given task\n"
);
* Value will contain a newline character at the end, we need to strip
* this otherwise kaboom, seriously, kaboom :P
*/
- *strrchr(value, '\n')='\0';
+ if (strrchr(value, '\n'))
+ *strrchr(value, '\n')='\0';
+ else /* cppcheck: possible null pointer dereference */
+ abort();
vec_push(template->comparematch, util_strdup(value));
return;
template->description = NULL;
- template->failuremessage = NULL;
- template->successmessage = NULL;
template->proceduretype = NULL;
template->compileflags = NULL;
template->executeflags = NULL;
template->comparematch = NULL;
template->sourcefile = NULL;
template->tempfilename = NULL;
+ template->rulesfile = NULL;
}
-task_template_t *task_template_compile(const char *file, const char *dir) {
+task_template_t *task_template_compile(const char *file, const char *dir, size_t *pad) {
/* a page should be enough */
char fullfile[4096];
+ size_t filepadd = 0;
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));
+ tempfile = file_open(fullfile, "r");
+ template = mem_a(sizeof(task_template_t));
task_template_nullify(template);
+ /*
+ * Create some padding for the printing to align the
+ * printing of the rules file to the console.
+ */
+ if ((filepadd = strlen(fullfile)) > pad[1])
+ pad[1] = filepadd;
+
+ template->rulesfile = util_strdup(fullfile);
+
/*
* Esnure the file even exists for the task, this is pretty useless
* to even do.
goto failure;
}
- if (!task_template_parse(file, template, tempfile)) {
+ if (!task_template_parse(file, template, tempfile, pad)) {
con_err("template parse error: error during parsing\n");
goto failure;
}
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);
+ file_close(tempfile);
return template;
failure:
* so the check to see if it's not null here is required.
*/
if (tempfile)
- fclose(tempfile);
+ file_close(tempfile);
mem_d (template);
return NULL;
return;
if ((*template)->description) mem_d((*template)->description);
- if ((*template)->failuremessage) mem_d((*template)->failuremessage);
- if ((*template)->successmessage) mem_d((*template)->successmessage);
if ((*template)->proceduretype) mem_d((*template)->proceduretype);
if ((*template)->compileflags) mem_d((*template)->compileflags);
if ((*template)->executeflags) mem_d((*template)->executeflags);
if ((*template)->sourcefile) mem_d((*template)->sourcefile);
+ if ((*template)->rulesfile) mem_d((*template)->rulesfile);
/*
* Delete all allocated string for task template then destroy the
* Read a directory and searches for all template files in it
* which is later used to run all tests.
*/
-bool task_propagate(const char *curdir) {
+bool task_propagate(const char *curdir, size_t *pad) {
bool success = true;
DIR *dir;
struct dirent *files;
* actually a directory, so it must be a file :)
*/
if (strcmp(files->d_name + strlen(files->d_name) - 5, ".tmpl") == 0) {
- task_template_t *template = task_template_compile(files->d_name, curdir);
+ task_template_t *template = task_template_compile(files->d_name, curdir, pad);
char buf[4096]; /* one page should be enough */
+ char *qcflags = NULL;
task_t task;
util_debug("TEST", "compiling task template: %s/%s\n", curdir, files->d_name);
*/
template->tempfilename = tempnam(curdir, "TMPDAT");
+ /*
+ * Additional QCFLAGS enviroment variable may be used
+ * to test compile flags for all tests. This needs to be
+ * BEFORE other flags (so that the .tmpl can override them)
+ */
+ qcflags = getenv("QCFLAGS");
+
/*
* Generate the command required to open a pipe to a process
* which will be refered to with a handle in the task for
* reading the data from the pipe.
*/
- memset (buf,0,sizeof(buf));
- snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
- task_bins[TASK_COMPILE],
- curdir,
- template->sourcefile,
- template->compileflags,
- template->tempfilename
- );
+ memset (buf,0,sizeof(buf));
+ if (qcflags) {
+ snprintf(buf, sizeof(buf), "%s %s/%s %s %s -o %s",
+ task_bins[TASK_COMPILE],
+ curdir,
+ template->sourcefile,
+ qcflags,
+ template->compileflags,
+ template->tempfilename
+ );
+ } else {
+ snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
+ task_bins[TASK_COMPILE],
+ curdir,
+ template->sourcefile,
+ template->compileflags,
+ template->tempfilename
+ );
+ }
/*
* The task template was compiled, now lets create a task from
memset (buf,0,sizeof(buf));
snprintf(buf, sizeof(buf), "%s.stdout", template->tempfilename);
task.stdoutlogfile = util_strdup(buf);
- if (!(task.stdoutlog = fopen(buf, "w"))) {
+ if (!(task.stdoutlog = file_open(buf, "w"))) {
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);
- if (!(task.stderrlog = fopen(buf, "w"))) {
+ if (!(task.stderrlog = file_open(buf, "w"))) {
con_err("error opening %s for stderr\n", buf);
continue;
}
return success;
}
-/*
- * Removes all temporary 'progs.dat' files created during compilation
- * of all tests'
- */
-void task_cleanup(const char *curdir) {
- DIR *dir;
- struct dirent *files;
- char buffer[4096];
-
- dir = opendir(curdir);
-
- while ((files = readdir(dir))) {
- memset(buffer, 0, sizeof(buffer));
- if (strstr(files->d_name, "TMP")) {
- snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
- if (remove(buffer))
- con_err("error removing temporary file: %s\n", buffer);
- else
- util_debug("TEST", "removed temporary file: %s\n", buffer);
- }
- }
-
- closedir(dir);
-}
-
/*
* Task precleanup removes any existing temporary files or log files
* left behind from a previous invoke of the test-suite.
closedir(dir);
}
-void task_destroy(const char *curdir) {
+void task_destroy(void) {
/*
* Free all the data in the task list and finally the list itself
* then proceed to cleanup anything else outside the program like
* annoying to have to do all this cleanup work.
*/
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);
+ if (task_tasks[i].stdoutlog) file_close (task_tasks[i].stdoutlog);
+ if (task_tasks[i].stderrlog) file_close (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);
+
+ remove(task_tasks[i].template->tempfilename);
}
/* free util_strdup data for log files */
task_template_destroy(&task_tasks[i].template);
}
vec_free(task_tasks);
-
- /*
- * Cleanup outside stuff like temporary files.
- */
- task_cleanup(curdir);
}
/*
char *data = NULL;
size_t size = 0;
size_t compare = 0;
- while (util_getline(&data, &size, execute) != EOF) {
+ while (file_getline(&data, &size, execute) != EOF) {
if (!strcmp(data, "No main function found\n")) {
- con_err("test failure: `%s` [%s] (No main function found)\n",
+ con_err("test failure: `%s` (No main function found) [%s]\n",
template->description,
- (template->failuremessage) ?
- template->failuremessage : "unknown"
+ template->rulesfile
);
pclose(execute);
return false;
if (strrchr(data, '\n'))
*strrchr(data, '\n') = '\0';
- if (strcmp(data, template->comparematch[compare++]))
- success = false;
+ if (vec_size(template->comparematch) > compare) {
+ if (strcmp(data, template->comparematch[compare++]))
+ success = false;
+ } else {
+ success = false;
+ }
/*
* Copy to output vector for diagnostics if execution match
* execution this takes more work since a task needs to be generated
* from thin air and executed INLINE.
*/
-void task_schedualize() {
+void task_schedualize(size_t *pad) {
bool execute = false;
char *data = NULL;
char **match = NULL;
* 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);
+ while (file_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
+ file_puts(task_tasks[i].stdoutlog, data);
if (strstr(data, "failed to open file")) {
task_tasks[i].compiled = false;
fflush(task_tasks[i].stdoutlog);
}
- while (util_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
+ while (file_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
/*
* If a string contains an error we just dissalow execution
* of it in the vm.
task_tasks[i].compiled = false;
}
- fputs(data, task_tasks[i].stderrlog);
+ file_puts(task_tasks[i].stderrlog, data);
fflush(task_tasks[i].stdoutlog);
}
- if (!task_tasks[i].compiled) {
- con_err("test failure: `%s` [%s] (failed to compile) see %s.stdout and %s.stderr\n",
+ if (!task_tasks[i].compiled && strcmp(task_tasks[i].template->proceduretype, "-fail")) {
+ con_err("test failure: `%s` (failed to compile) see %s.stdout and %s.stderr [%s]\n",
task_tasks[i].template->description,
- (task_tasks[i].template->failuremessage) ?
- task_tasks[i].template->failuremessage : "unknown",
task_tasks[i].template->tempfilename,
- task_tasks[i].template->tempfilename
+ task_tasks[i].template->tempfilename,
+ task_tasks[i].template->rulesfile
);
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"
+ con_out("test succeeded: `%s` %*s\n",
+ task_tasks[i].template->description,
+ (pad[0] + pad[1] - strlen(task_tasks[i].template->description)) +
+ (strlen(task_tasks[i].template->rulesfile) - pad[1]),
+ task_tasks[i].template->rulesfile
+
);
continue;
}
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"
+ con_err("test failure: `%s` (invalid results from execution) [%s]\n",
+ task_tasks[i].template->description,
+ task_tasks[i].template->rulesfile
);
/*
* handler for the all the given matches in the template file and
* what was actually returned from executing.
*/
- con_err(" Expected From %u Matches:\n", vec_size(task_tasks[i].template->comparematch));
+ 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(" ");
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);
mem_d(match[j]);
vec_free(match);
- con_out("test succeeded: `%s` [%s]\n",
- task_tasks[i].template->description,
- (task_tasks[i].template->successmessage) ?
- task_tasks[i].template->successmessage : "unknown"
+ con_out("test succeeded: `%s` %*s\n",
+ task_tasks[i].template->description,
+ (pad[0] + pad[1] - strlen(task_tasks[i].template->description)) +
+ (strlen(task_tasks[i].template->rulesfile) - pad[1]),
+ task_tasks[i].template->rulesfile
+
);
}
mem_d(data);
*
* It expects con_init() was called before hand.
*/
-bool test_perform(const char *curdir) {
+GMQCC_WARN bool test_perform(const char *curdir) {
+ size_t pad[] = {
+ 0, 0
+ };
+
task_precleanup(curdir);
- if (!task_propagate(curdir)) {
+ if (!task_propagate(curdir, pad)) {
con_err("error: failed to propagate tasks\n");
- task_destroy(curdir);
+ task_destroy();
return false;
}
/*
* it's designed to prevent lock contention, and possible syncronization
* issues.
*/
- task_schedualize();
- task_destroy(curdir);
+ task_schedualize(pad);
+ task_destroy();
return true;
}
}
int main(int argc, char **argv) {
+ bool succeed = false;
char *redirout = (char*)stdout;
char *redirerr = (char*)stderr;
con_change(redirout, redirerr);
if (!strcmp(argv[0]+1, "debug")) {
- opts.debug = true;
+ OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
continue;
}
if (!strcmp(argv[0]+1, "memchk")) {
- opts.memchk = true;
+ OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
continue;
}
if (!strcmp(argv[0]+1, "nocolor")) {
}
}
con_change(redirout, redirerr);
- test_perform("tests");
+ succeed = test_perform("tests");
util_meminfo();
- return 0;
+
+
+ return (succeed) ? EXIT_SUCCESS : EXIT_FAILURE;
}