Provide mechanism to let CLAR globally setup git_trace()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 81dc4c2..03724b6 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -465,7 +465,7 @@ IF (BUILD_CLAR)
INCLUDE_DIRECTORIES(${CLAR_PATH})
FILE(GLOB_RECURSE SRC_TEST ${CLAR_PATH}/*/*.c ${CLAR_PATH}/*/*.h)
- SET(SRC_CLAR "${CLAR_PATH}/main.c" "${CLAR_PATH}/clar_libgit2.c" "${CLAR_PATH}/clar.c")
+ SET(SRC_CLAR "${CLAR_PATH}/main.c" "${CLAR_PATH}/clar_libgit2.c" "${CLAR_PATH}/clar_libgit2_trace.c" "${CLAR_PATH}/clar.c")
ADD_CUSTOM_COMMAND(
OUTPUT ${CLAR_PATH}/clar.suite
diff --git a/tests/clar_libgit2_trace.c b/tests/clar_libgit2_trace.c
new file mode 100644
index 0000000..5fabe99
--- /dev/null
+++ b/tests/clar_libgit2_trace.c
@@ -0,0 +1,209 @@
+#include "clar_libgit2.h"
+#include "clar_libgit2_trace.h"
+#include "trace.h"
+
+
+struct method {
+ const char *name;
+ void (*git_trace_cb)(git_trace_level_t level, const char *msg);
+ void (*close)(void);
+};
+
+
+#if defined(GIT_TRACE)
+static void _git_trace_cb__printf(git_trace_level_t level, const char *msg)
+{
+ /* TODO Use level to print a per-message prefix. */
+ GIT_UNUSED(level);
+
+ printf("%s\n", msg);
+}
+
+#if defined(GIT_WIN32)
+static void _git_trace_cb__debug(git_trace_level_t level, const char *msg)
+{
+ /* TODO Use level to print a per-message prefix. */
+ GIT_UNUSED(level);
+
+ OutputDebugString(msg);
+ OutputDebugString("\n");
+
+ printf("%s\n", msg);
+}
+#else
+#define _git_trace_cb__debug _git_trace_cb__printf
+#endif
+
+
+static void _trace_printf_close(void)
+{
+ fflush(stdout);
+}
+
+#define _trace_debug_close _trace_printf_close
+
+
+static struct method s_methods[] = {
+ { "printf", _git_trace_cb__printf, _trace_printf_close },
+ { "debug", _git_trace_cb__debug, _trace_debug_close },
+ /* TODO add file method */
+ {0},
+};
+
+
+static int s_trace_loaded = 0;
+static int s_trace_level = GIT_TRACE_NONE;
+static struct method *s_trace_method = NULL;
+
+
+static int set_method(const char *name)
+{
+ int k;
+
+ if (!name || !*name)
+ name = "printf";
+
+ for (k=0; (s_methods[k].name); k++) {
+ if (strcmp(name, s_methods[k].name) == 0) {
+ s_trace_method = &s_methods[k];
+ return 0;
+ }
+ }
+ fprintf(stderr, "Unknown CLAR_TRACE_METHOD: '%s'\n", name);
+ return -1;
+}
+
+
+/**
+ * Lookup CLAR_TRACE_LEVEL and CLAR_TRACE_METHOD from
+ * the environment and set the above s_trace_* fields.
+ *
+ * If CLAR_TRACE_LEVEL is not set, we disable tracing.
+ *
+ * TODO If set, we assume GIT_TRACE_TRACE level, which
+ * logs everything. Later, we may want to parse the
+ * value of the environment variable and set a specific
+ * level.
+ *
+ * We assume the "printf" method. This can be changed
+ * with the CLAR_TRACE_METHOD environment variable.
+ * Currently, this is only needed on Windows for a "debug"
+ * version which also writes to the debug output window
+ * in Visual Studio.
+ *
+ * TODO add a "file" method that would open and write
+ * to a well-known file. This would help keep trace
+ * output and clar output separate.
+ *
+ */
+static void _load_trace_params(void)
+{
+ char *sz_level;
+ char *sz_method;
+
+ s_trace_loaded = 1;
+
+ sz_level = cl_getenv("CLAR_TRACE_LEVEL");
+ if (!sz_level || !*sz_level) {
+ s_trace_level = GIT_TRACE_NONE;
+ s_trace_method = NULL;
+ return;
+ }
+
+ /* TODO Parse sz_level and set s_trace_level. */
+ s_trace_level = GIT_TRACE_TRACE;
+
+ sz_method = cl_getenv("CLAR_TRACE_METHOD");
+ if (set_method(sz_method) < 0)
+ set_method(NULL);
+}
+
+#define HR "================================================================"
+
+void _cl_trace_cb__event_handler(
+ cl_trace_event ev,
+ const char *suite_name,
+ const char *test_name,
+ void *payload)
+{
+ GIT_UNUSED(payload);
+
+ switch (ev) {
+ case CL_TRACE__SUITE_BEGIN:
+ git_trace(GIT_TRACE_TRACE, "\n\n%s\nBegin Suite: %s", HR, suite_name);
+ break;
+
+ case CL_TRACE__SUITE_END:
+ git_trace(GIT_TRACE_TRACE, "\n\nEnd Suite: %s\n%s", suite_name, HR);
+ break;
+
+ case CL_TRACE__TEST__BEGIN:
+ git_trace(GIT_TRACE_TRACE, "\n%s / %s: Beginning", suite_name, test_name);
+ break;
+
+ case CL_TRACE__TEST__END:
+ git_trace(GIT_TRACE_TRACE, "%s / %s: Finishing", suite_name, test_name);
+ break;
+
+ case CL_TRACE__TEST__RUN_BEGIN:
+ git_trace(GIT_TRACE_TRACE, "%s / %s: Run Started", suite_name, test_name);
+ break;
+
+ case CL_TRACE__TEST__RUN_END:
+ git_trace(GIT_TRACE_TRACE, "%s / %s: Run Ended", suite_name, test_name);
+ break;
+
+ case CL_TRACE__TEST__LONGJMP:
+ git_trace(GIT_TRACE_TRACE, "%s / %s: Aborted", suite_name, test_name);
+ break;
+
+ default:
+ break;
+ }
+}
+
+#endif /*GIT_TRACE*/
+
+/**
+ * Setup/Enable git_trace() based upon settings user's environment.
+ *
+ */
+void cl_global_trace_register(void)
+{
+#if defined(GIT_TRACE)
+ if (!s_trace_loaded)
+ _load_trace_params();
+
+ if (s_trace_level == GIT_TRACE_NONE)
+ return;
+ if (s_trace_method == NULL)
+ return;
+ if (s_trace_method->git_trace_cb == NULL)
+ return;
+
+ git_trace_set(s_trace_level, s_trace_method->git_trace_cb);
+ cl_trace_register(_cl_trace_cb__event_handler, NULL);
+#endif
+}
+
+/**
+ * If we turned on git_trace() earlier, turn it off.
+ *
+ * This is intended to let us close/flush any buffered
+ * IO if necessary.
+ *
+ */
+void cl_global_trace_disable(void)
+{
+#if defined(GIT_TRACE)
+ cl_trace_register(NULL, NULL);
+ git_trace_set(GIT_TRACE_NONE, NULL);
+ if (s_trace_method && s_trace_method->close)
+ s_trace_method->close();
+
+ /* Leave s_trace_ vars set so they can restart tracing
+ * since we only want to hit the environment variables
+ * once.
+ */
+#endif
+}
diff --git a/tests/clar_libgit2_trace.h b/tests/clar_libgit2_trace.h
new file mode 100644
index 0000000..09d1e05
--- /dev/null
+++ b/tests/clar_libgit2_trace.h
@@ -0,0 +1,7 @@
+#ifndef __CLAR_LIBGIT2_TRACE__
+#define __CLAR_LIBGIT2_TRACE__
+
+void cl_global_trace_register(void);
+void cl_global_trace_disable(void);
+
+#endif
diff --git a/tests/main.c b/tests/main.c
index a092b8b..cc13230 100644
--- a/tests/main.c
+++ b/tests/main.c
@@ -1,4 +1,5 @@
#include "clar_libgit2.h"
+#include "clar_libgit2_trace.h"
#ifdef _WIN32
int __cdecl main(int argc, char *argv[])
@@ -11,6 +12,7 @@ int main(int argc, char *argv[])
clar_test_init(argc, argv);
git_libgit2_init();
+ cl_global_trace_register();
cl_sandbox_set_search_path_defaults();
/* Run the test suite */
@@ -19,6 +21,7 @@ int main(int argc, char *argv[])
clar_test_shutdown();
giterr_clear();
+ cl_global_trace_disable();
git_libgit2_shutdown();
return res;
diff --git a/tests/trace/trace.c b/tests/trace/trace.c
index 87b3253..097208b 100644
--- a/tests/trace/trace.c
+++ b/tests/trace/trace.c
@@ -1,4 +1,5 @@
#include "clar_libgit2.h"
+#include "clar_libgit2_trace.h"
#include "trace.h"
static int written = 0;
@@ -14,6 +15,9 @@ static void trace_callback(git_trace_level_t level, const char *message)
void test_trace_trace__initialize(void)
{
+ /* If global tracing is enabled, disable for the duration of this test. */
+ cl_global_trace_disable();
+
git_trace_set(GIT_TRACE_INFO, trace_callback);
written = 0;
}
@@ -21,12 +25,17 @@ void test_trace_trace__initialize(void)
void test_trace_trace__cleanup(void)
{
git_trace_set(GIT_TRACE_NONE, NULL);
+
+ /* If global tracing was enabled, restart it. */
+ cl_global_trace_register();
}
void test_trace_trace__sets(void)
{
#ifdef GIT_TRACE
cl_assert(git_trace_level() == GIT_TRACE_INFO);
+#else
+ cl_skip();
#endif
}
@@ -42,6 +51,8 @@ void test_trace_trace__can_reset(void)
git_trace(GIT_TRACE_ERROR, "Hello %s!", "world");
cl_assert(written == 1);
+#else
+ cl_skip();
#endif
}
@@ -56,6 +67,8 @@ void test_trace_trace__can_unset(void)
cl_assert(written == 0);
git_trace(GIT_TRACE_FATAL, "Hello %s!", "world");
cl_assert(written == 0);
+#else
+ cl_skip();
#endif
}
@@ -65,6 +78,8 @@ void test_trace_trace__skips_higher_level(void)
cl_assert(written == 0);
git_trace(GIT_TRACE_DEBUG, "Hello %s!", "world");
cl_assert(written == 0);
+#else
+ cl_skip();
#endif
}
@@ -74,6 +89,8 @@ void test_trace_trace__writes(void)
cl_assert(written == 0);
git_trace(GIT_TRACE_INFO, "Hello %s!", "world");
cl_assert(written == 1);
+#else
+ cl_skip();
#endif
}
@@ -83,5 +100,7 @@ void test_trace_trace__writes_lower_level(void)
cl_assert(written == 0);
git_trace(GIT_TRACE_ERROR, "Hello %s!", "world");
cl_assert(written == 1);
+#else
+ cl_skip();
#endif
}