]> git.proxmox.com Git - libgit2.git/blobdiff - tests/clar_libgit2.h
New upstream version 1.4.3+dfsg.1
[libgit2.git] / tests / clar_libgit2.h
index 3de80bfa07a51c4db2d88bd5c12964660b18452f..da3f415245812c3abfeb8a4679a2b748d94a1c79 100644 (file)
@@ -4,6 +4,7 @@
 #include "clar.h"
 #include <git2.h>
 #include "common.h"
+#include "posix.h"
 
 /**
  * Replace for `clar_must_pass` that passes the last library error as the
  *
  * Use this wrapper around all `git_` library calls that return error codes!
  */
-#define cl_git_pass(expr) cl_git_pass_(expr, __FILE__, __LINE__)
+#define cl_git_pass(expr) cl_git_expect((expr), 0, __FILE__, __func__, __LINE__)
 
-#define cl_git_pass_(expr, file, line) do { \
+#define cl_git_fail_with(error, expr) cl_git_expect((expr), error, __FILE__, __func__, __LINE__)
+
+#define cl_git_expect(expr, expected, file, func, line) do { \
        int _lg2_error; \
-       giterr_clear(); \
-       if ((_lg2_error = (expr)) != 0) \
-               cl_git_report_failure(_lg2_error, file, line, "Function call failed: " #expr); \
+       git_error_clear(); \
+       if ((_lg2_error = (expr)) != expected) \
+               cl_git_report_failure(_lg2_error, expected, file, func, line, "Function call failed: " #expr); \
        } while (0)
 
 /**
  * just for consistency. Use with `git_` library
  * calls that are supposed to fail!
  */
-#define cl_git_fail(expr) cl_must_fail(expr)
+#define cl_git_fail(expr) do { \
+       if ((expr) == 0) \
+               git_error_clear(), \
+               cl_git_report_failure(0, 0, __FILE__, __func__, __LINE__, "Function call succeeded: " #expr); \
+       } while (0)
+
+/**
+ * Like cl_git_pass, only for Win32 error code conventions
+ */
+#define cl_win32_pass(expr) do { \
+       int _win32_res; \
+       if ((_win32_res = (expr)) == 0) { \
+               git_error_set(GIT_ERROR_OS, "Returned: %d, system error code: %lu", _win32_res, GetLastError()); \
+               cl_git_report_failure(_win32_res, 0, __FILE__, __func__, __LINE__, "System call failed: " #expr); \
+       } \
+       } while(0)
+
+/**
+ * Thread safe assertions; you cannot use `cl_git_report_failure` from a
+ * child thread since it will try to `longjmp` to abort and "the effect of
+ * a call to longjmp() where initialization of the jmp_buf structure was
+ * not performed in the calling thread is undefined."
+ *
+ * Instead, callers can provide a clar thread error context to a thread,
+ * which will populate and return it on failure.  Callers can check the
+ * status with `cl_git_thread_check`.
+ */
+typedef struct {
+       int error;
+       const char *file;
+       const char *func;
+       int line;
+       const char *expr;
+       char error_msg[4096];
+} cl_git_thread_err;
+
+#ifdef GIT_THREADS
+# define cl_git_thread_pass(threaderr, expr) cl_git_thread_pass_(threaderr, (expr), __FILE__, __func__, __LINE__)
+#else
+# define cl_git_thread_pass(threaderr, expr) cl_git_pass(expr)
+#endif
+
+#define cl_git_thread_pass_(__threaderr, __expr, __file, __func, __line) do { \
+       git_error_clear(); \
+       if ((((cl_git_thread_err *)__threaderr)->error = (__expr)) != 0) { \
+               const git_error *_last = git_error_last(); \
+               ((cl_git_thread_err *)__threaderr)->file = __file; \
+               ((cl_git_thread_err *)__threaderr)->func = __func; \
+               ((cl_git_thread_err *)__threaderr)->line = __line; \
+               ((cl_git_thread_err *)__threaderr)->expr = "Function call failed: " #__expr; \
+               p_snprintf(((cl_git_thread_err *)__threaderr)->error_msg, 4096, "thread 0x%" PRIxZ " - error %d - %s", \
+                       git_thread_currentid(), ((cl_git_thread_err *)__threaderr)->error, \
+                       _last ? _last->message : "<no message>"); \
+               git_thread_exit(__threaderr); \
+       } \
+       } while (0)
 
-#define cl_git_fail_with(expr, error) cl_assert_equal_i(error,expr)
+GIT_INLINE(void) cl_git_thread_check(void *data)
+{
+       cl_git_thread_err *threaderr = (cl_git_thread_err *)data;
+       if (threaderr->error != 0)
+               clar__assert(0, threaderr->file, threaderr->func, threaderr->line, threaderr->expr, threaderr->error_msg, 1);
+}
 
-void cl_git_report_failure(int, const char *, int, const char *);
+void cl_git_report_failure(int, int, const char *, const char *, int, const char *);
 
-#define cl_assert_at_line(expr,file,line) \
-       clar__assert((expr) != 0, file, line, "Expression is not true: " #expr, NULL, 1)
+#define cl_assert_at_line(expr,file,func,line) \
+       clar__assert((expr) != 0, file, func, line, "Expression is not true: " #expr, NULL, 1)
 
 GIT_INLINE(void) clar__assert_in_range(
        int lo, int val, int hi,
-       const char *file, int line, const char *err, int should_abort)
+       const char *file, const char *func, int line,
+       const char *err, int should_abort)
 {
        if (lo > val || hi < val) {
                char buf[128];
-               snprintf(buf, sizeof(buf), "%d not in [%d,%d]", val, lo, hi);
-               clar__fail(file, line, err, buf, should_abort);
+               p_snprintf(buf, sizeof(buf), "%d not in [%d,%d]", val, lo, hi);
+               clar__fail(file, func, line, err, buf, should_abort);
        }
 }
 
 #define cl_assert_equal_sz(sz1,sz2) do { \
        size_t __sz1 = (size_t)(sz1), __sz2 = (size_t)(sz2); \
-       clar__assert_equal(__FILE__,__LINE__,#sz1 " != " #sz2, 1, "%"PRIuZ, __sz1, __sz2); \
+       clar__assert_equal(__FILE__,__func__,__LINE__,#sz1 " != " #sz2, 1, "%"PRIuZ, __sz1, __sz2); \
 } while (0)
 
 #define cl_assert_in_range(L,V,H) \
-       clar__assert_in_range((L),(V),(H),__FILE__,__LINE__,"Range check: " #V " in [" #L "," #H "]", 1)
+       clar__assert_in_range((L),(V),(H),__FILE__,__func__,__LINE__,"Range check: " #V " in [" #L "," #H "]", 1)
 
 #define cl_assert_equal_file(DATA,SIZE,PATH) \
-       clar__assert_equal_file(DATA,SIZE,0,PATH,__FILE__,(int)__LINE__)
+       clar__assert_equal_file(DATA,SIZE,0,PATH,__FILE__,__func__,(int)__LINE__)
 
 #define cl_assert_equal_file_ignore_cr(DATA,SIZE,PATH) \
-       clar__assert_equal_file(DATA,SIZE,1,PATH,__FILE__,(int)__LINE__)
+       clar__assert_equal_file(DATA,SIZE,1,PATH,__FILE__,__func__,(int)__LINE__)
 
 void clar__assert_equal_file(
        const char *expected_data,
@@ -65,8 +129,27 @@ void clar__assert_equal_file(
        int ignore_cr,
        const char *path,
        const char *file,
+       const char *func,
        int line);
 
+GIT_INLINE(void) clar__assert_equal_oid(
+       const char *file, const char *func, int line, const char *desc,
+       const git_oid *one, const git_oid *two)
+{
+       if (git_oid_cmp(one, two)) {
+               char err[] = "\"........................................\" != \"........................................\"";
+
+               git_oid_fmt(&err[1], one);
+               git_oid_fmt(&err[47], two);
+
+               clar__fail(file, func, line, desc, err, 1);
+       }
+}
+
+#define cl_assert_equal_oid(one, two) \
+       clar__assert_equal_oid(__FILE__, __func__, __LINE__, \
+               "OID mismatch: " #one " != " #two, (one), (two))
+
 /*
  * Some utility macros for building long strings
  */
@@ -82,12 +165,14 @@ void cl_git_append2file(const char *filename, const char *new_content);
 void cl_git_rewritefile(const char *filename, const char *new_content);
 void cl_git_write2file(const char *path, const char *data,
        size_t datalen, int flags, unsigned int mode);
+void cl_git_rmfile(const char *filename);
 
 bool cl_toggle_filemode(const char *filename);
 bool cl_is_chmod_supported(void);
 
 /* Environment wrappers */
 char *cl_getenv(const char *name);
+bool cl_is_env_set(const char *name);
 int cl_setenv(const char *name, const char *value);
 
 /* Reliable rename */
@@ -96,9 +181,17 @@ int cl_rename(const char *source, const char *dest);
 /* Git sandbox setup helpers */
 
 git_repository *cl_git_sandbox_init(const char *sandbox);
+git_repository *cl_git_sandbox_init_new(const char *name);
 void cl_git_sandbox_cleanup(void);
 git_repository *cl_git_sandbox_reopen(void);
 
+/*
+ * build a sandbox-relative from path segments
+ * is_dir will add a trailing slash
+ * vararg must be a NULL-terminated char * list
+ */
+const char *cl_git_sandbox_path(int is_dir, ...);
+
 /* Local-repo url helpers */
 const char* cl_git_fixture_url(const char *fixturename);
 const char* cl_git_path_url(const char *path);
@@ -120,4 +213,25 @@ int cl_repo_get_bool(git_repository *repo, const char *cfg);
 
 void cl_repo_set_string(git_repository *repo, const char *cfg, const char *value);
 
+/* set up a fake "home" directory and set libgit2 GLOBAL search path.
+ *
+ * automatically configures cleanup function to restore the regular search
+ * path, although you can call it explicitly if you wish (with NULL).
+ */
+void cl_fake_home(void);
+void cl_fake_home_cleanup(void *);
+
+void cl_sandbox_set_search_path_defaults(void);
+void cl_sandbox_disable_ownership_validation(void);
+
+#ifdef GIT_WIN32
+# define cl_msleep(x) Sleep(x)
+#else
+# define cl_msleep(x) usleep(1000 * (x))
+#endif
+
+#ifdef GIT_WIN32
+bool cl_sandbox_supports_8dot3(void);
+#endif
+
 #endif