tests/clar_libgit2.h

   1 #ifndef __CLAR_LIBGIT2__
   2 #define __CLAR_LIBGIT2__
   3
   4 #include "clar.h"
   5 #include <git2.h>
   6 #include <posix.h>
   7 #include "common.h"
   8
   9 /**
  10  * Replace for `clar_must_pass` that passes the last library error as the
  11  * test failure message.
  12  *
  13  * Use this wrapper around all `git_` library calls that return error codes!
  14  */
  15 #define cl_git_pass(expr) cl_git_expect((expr), 0, __FILE__, __LINE__)
  16
  17 #define cl_git_fail_with(error, expr) cl_git_expect((expr), error, __FILE__, __LINE__)
  18
  19 #define cl_git_expect(expr, expected, file, line) do { \
  20         int _lg2_error; \
  21         giterr_clear(); \
  22         if ((_lg2_error = (expr)) != expected) \
  23                 cl_git_report_failure(_lg2_error, expected, file, line, "Function call failed: " #expr); \
  24         } while (0)
  25
  26 /**
  27  * Wrapper for `clar_must_fail` -- this one is
  28  * just for consistency. Use with `git_` library
  29  * calls that are supposed to fail!
  30  */
  31 #define cl_git_fail(expr) do { \
  32         giterr_clear(); \
  33         if ((expr) == 0) \
  34                 cl_git_report_failure(0, 0, __FILE__, __LINE__, "Function call succeeded: " #expr); \
  35         } while (0)
  36
  37 /**
  38  * Like cl_git_pass, only for Win32 error code conventions
  39  */
  40 #define cl_win32_pass(expr) do { \
  41         int _win32_res; \
  42         if ((_win32_res = (expr)) == 0) { \
  43                 giterr_set(GITERR_OS, "Returned: %d, system error code: %d", _win32_res, GetLastError()); \
  44                 cl_git_report_failure(_win32_res, 0, __FILE__, __LINE__, "System call failed: " #expr); \
  45         } \
  46         } while(0)
  47
  48 /**
  49  * Thread safe assertions; you cannot use `cl_git_report_failure` from a
  50  * child thread since it will try to `longjmp` to abort and "the effect of
  51  * a call to longjmp() where initialization of the jmp_buf structure was
  52  * not performed in the calling thread is undefined."
  53  *
  54  * Instead, callers can provide a clar thread error context to a thread,
  55  * which will populate and return it on failure.  Callers can check the
  56  * status with `cl_git_thread_check`.
  57  */
  58 typedef struct {
  59         int error;
  60         const char *file;
  61         int line;
  62         const char *expr;
  63         char error_msg[4096];
  64 } cl_git_thread_err;
  65
  66 #ifdef GIT_THREADS
  67 # define cl_git_thread_pass(threaderr, expr) cl_git_thread_pass_(threaderr, (expr), __FILE__, __LINE__)
  68 #else
  69 # define cl_git_thread_pass(threaderr, expr) cl_git_pass(expr)
  70 #endif
  71
  72 #define cl_git_thread_pass_(__threaderr, __expr, __file, __line) do { \
  73         giterr_clear(); \
  74         if ((((cl_git_thread_err *)__threaderr)->error = (__expr)) != 0) { \
  75                 const git_error *_last = giterr_last(); \
  76                 ((cl_git_thread_err *)__threaderr)->file = __file; \
  77                 ((cl_git_thread_err *)__threaderr)->line = __line; \
  78                 ((cl_git_thread_err *)__threaderr)->expr = "Function call failed: " #__expr; \
  79                 p_snprintf(((cl_git_thread_err *)__threaderr)->error_msg, 4096, "thread 0x%" PRIxZ " - error %d - %s", \
  80                         git_thread_currentid(), ((cl_git_thread_err *)__threaderr)->error, \
  81                         _last ? _last->message : "<no message>"); \
  82                 git_thread_exit(__threaderr); \
  83         } \
  84         } while (0)
  85
  86 GIT_INLINE(void) cl_git_thread_check(void *data)
  87 {
  88         cl_git_thread_err *threaderr = (cl_git_thread_err *)data;
  89         if (threaderr->error != 0)
  90                 clar__assert(0, threaderr->file, threaderr->line, threaderr->expr, threaderr->error_msg, 1);
  91 }
  92
  93 void cl_git_report_failure(int, int, const char *, int, const char *);
  94
  95 #define cl_assert_at_line(expr,file,line) \
  96         clar__assert((expr) != 0, file, line, "Expression is not true: " #expr, NULL, 1)
  97
  98 GIT_INLINE(void) clar__assert_in_range(
  99         int lo, int val, int hi,
 100         const char *file, int line, const char *err, int should_abort)
 101 {
 102         if (lo > val || hi < val) {
 103                 char buf[128];
 104                 p_snprintf(buf, sizeof(buf), "%d not in [%d,%d]", val, lo, hi);
 105                 clar__fail(file, line, err, buf, should_abort);
 106         }
 107 }
 108
 109 #define cl_assert_equal_sz(sz1,sz2) do { \
 110         size_t __sz1 = (size_t)(sz1), __sz2 = (size_t)(sz2); \
 111         clar__assert_equal(__FILE__,__LINE__,#sz1 " != " #sz2, 1, "%"PRIuZ, __sz1, __sz2); \
 112 } while (0)
 113
 114 #define cl_assert_in_range(L,V,H) \
 115         clar__assert_in_range((L),(V),(H),__FILE__,__LINE__,"Range check: " #V " in [" #L "," #H "]", 1)
 116
 117 #define cl_assert_equal_file(DATA,SIZE,PATH) \
 118         clar__assert_equal_file(DATA,SIZE,0,PATH,__FILE__,(int)__LINE__)
 119
 120 #define cl_assert_equal_file_ignore_cr(DATA,SIZE,PATH) \
 121         clar__assert_equal_file(DATA,SIZE,1,PATH,__FILE__,(int)__LINE__)
 122
 123 void clar__assert_equal_file(
 124         const char *expected_data,
 125         size_t expected_size,
 126         int ignore_cr,
 127         const char *path,
 128         const char *file,
 129         int line);
 130
 131 GIT_INLINE(void) clar__assert_equal_oid(
 132         const char *file, int line, const char *desc,
 133         const git_oid *one, const git_oid *two)
 134 {
 135         if (git_oid_cmp(one, two)) {
 136                 char err[] = "\"........................................\" != \"........................................\"";
 137
 138                 git_oid_fmt(&err[1], one);
 139                 git_oid_fmt(&err[47], two);
 140
 141                 clar__fail(file, line, desc, err, 1);
 142         }
 143 }
 144
 145 #define cl_assert_equal_oid(one, two) \
 146         clar__assert_equal_oid(__FILE__, __LINE__, \
 147                 "OID mismatch: " #one " != " #two, (one), (two))
 148
 149 /*
 150  * Some utility macros for building long strings
 151  */
 152 #define REP4(STR)        STR STR STR STR
 153 #define REP15(STR)       REP4(STR) REP4(STR) REP4(STR) STR STR STR
 154 #define REP16(STR)       REP4(REP4(STR))
 155 #define REP256(STR)  REP16(REP16(STR))
 156 #define REP1024(STR) REP4(REP256(STR))
 157
 158 /* Write the contents of a buffer to disk */
 159 void cl_git_mkfile(const char *filename, const char *content);
 160 void cl_git_append2file(const char *filename, const char *new_content);
 161 void cl_git_rewritefile(const char *filename, const char *new_content);
 162 void cl_git_write2file(const char *path, const char *data,
 163         size_t datalen, int flags, unsigned int mode);
 164 void cl_git_rmfile(const char *filename);
 165
 166 bool cl_toggle_filemode(const char *filename);
 167 bool cl_is_chmod_supported(void);
 168
 169 /* Environment wrappers */
 170 char *cl_getenv(const char *name);
 171 bool cl_is_env_set(const char *name);
 172 int cl_setenv(const char *name, const char *value);
 173
 174 /* Reliable rename */
 175 int cl_rename(const char *source, const char *dest);
 176
 177 /* Git sandbox setup helpers */
 178
 179 git_repository *cl_git_sandbox_init(const char *sandbox);
 180 git_repository *cl_git_sandbox_init_new(const char *name);
 181 void cl_git_sandbox_cleanup(void);
 182 git_repository *cl_git_sandbox_reopen(void);
 183
 184 /* Local-repo url helpers */
 185 const char* cl_git_fixture_url(const char *fixturename);
 186 const char* cl_git_path_url(const char *path);
 187
 188 /* Test repository cleaner */
 189 int cl_git_remove_placeholders(const char *directory_path, const char *filename);
 190
 191 /* commit creation helpers */
 192 void cl_repo_commit_from_index(
 193         git_oid *out,
 194         git_repository *repo,
 195         git_signature *sig,
 196         git_time_t time,
 197         const char *msg);
 198
 199 /* config setting helpers */
 200 void cl_repo_set_bool(git_repository *repo, const char *cfg, int value);
 201 int cl_repo_get_bool(git_repository *repo, const char *cfg);
 202
 203 void cl_repo_set_string(git_repository *repo, const char *cfg, const char *value);
 204
 205 /* set up a fake "home" directory and set libgit2 GLOBAL search path.
 206  *
 207  * automatically configures cleanup function to restore the regular search
 208  * path, although you can call it explicitly if you wish (with NULL).
 209  */
 210 void cl_fake_home(void);
 211 void cl_fake_home_cleanup(void *);
 212
 213 void cl_sandbox_set_search_path_defaults(void);
 214
 215 #ifdef GIT_WIN32
 216 bool cl_sandbox_supports_8dot3(void);
 217 #endif
 218
 219 #endif