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_pass_((expr), __FILE__, __LINE__)
  16
  17 #define cl_git_pass_(expr, file, line) do { \
  18         int _lg2_error; \
  19         giterr_clear(); \
  20         if ((_lg2_error = (expr)) != 0) \
  21                 cl_git_report_failure(_lg2_error, file, line, "Function call failed: " #expr); \
  22         } while (0)
  23
  24 /**
  25  * Wrapper for `clar_must_fail` -- this one is
  26  * just for consistency. Use with `git_` library
  27  * calls that are supposed to fail!
  28  */
  29 #define cl_git_fail(expr) cl_must_fail(expr)
  30
  31 #define cl_git_fail_with(expr, error) cl_assert_equal_i(error,expr)
  32
  33 /**
  34  * Like cl_git_pass, only for Win32 error code conventions
  35  */
  36 #define cl_win32_pass(expr) do { \
  37         int _win32_res; \
  38         if ((_win32_res = (expr)) == 0) { \
  39                 giterr_set(GITERR_OS, "Returned: %d, system error code: %d", _win32_res, GetLastError()); \
  40                 cl_git_report_failure(_win32_res, __FILE__, __LINE__, "System call failed: " #expr); \
  41         } \
  42         } while(0)
  43
  44 void cl_git_report_failure(int, const char *, int, const char *);
  45
  46 #define cl_assert_at_line(expr,file,line) \
  47         clar__assert((expr) != 0, file, line, "Expression is not true: " #expr, NULL, 1)
  48
  49 GIT_INLINE(void) clar__assert_in_range(
  50         int lo, int val, int hi,
  51         const char *file, int line, const char *err, int should_abort)
  52 {
  53         if (lo > val || hi < val) {
  54                 char buf[128];
  55                 p_snprintf(buf, sizeof(buf), "%d not in [%d,%d]", val, lo, hi);
  56                 clar__fail(file, line, err, buf, should_abort);
  57         }
  58 }
  59
  60 #define cl_assert_equal_sz(sz1,sz2) do { \
  61         size_t __sz1 = (size_t)(sz1), __sz2 = (size_t)(sz2); \
  62         clar__assert_equal(__FILE__,__LINE__,#sz1 " != " #sz2, 1, "%"PRIuZ, __sz1, __sz2); \
  63 } while (0)
  64
  65 #define cl_assert_in_range(L,V,H) \
  66         clar__assert_in_range((L),(V),(H),__FILE__,__LINE__,"Range check: " #V " in [" #L "," #H "]", 1)
  67
  68 #define cl_assert_equal_file(DATA,SIZE,PATH) \
  69         clar__assert_equal_file(DATA,SIZE,0,PATH,__FILE__,(int)__LINE__)
  70
  71 #define cl_assert_equal_file_ignore_cr(DATA,SIZE,PATH) \
  72         clar__assert_equal_file(DATA,SIZE,1,PATH,__FILE__,(int)__LINE__)
  73
  74 void clar__assert_equal_file(
  75         const char *expected_data,
  76         size_t expected_size,
  77         int ignore_cr,
  78         const char *path,
  79         const char *file,
  80         int line);
  81
  82 GIT_INLINE(void) clar__assert_equal_oid(
  83         const char *file, int line, const char *desc,
  84         const git_oid *one, const git_oid *two)
  85 {
  86         if (git_oid_cmp(one, two)) {
  87                 char err[] = "\"........................................\" != \"........................................\"";
  88
  89                 git_oid_fmt(&err[1], one);
  90                 git_oid_fmt(&err[47], two);
  91
  92                 clar__fail(file, line, desc, err, 1);
  93         }
  94 }
  95
  96 #define cl_assert_equal_oid(one, two) \
  97         clar__assert_equal_oid(__FILE__, __LINE__, \
  98                 "OID mismatch: " #one " != " #two, (one), (two))
  99
 100 /*
 101  * Some utility macros for building long strings
 102  */
 103 #define REP4(STR)        STR STR STR STR
 104 #define REP15(STR)       REP4(STR) REP4(STR) REP4(STR) STR STR STR
 105 #define REP16(STR)       REP4(REP4(STR))
 106 #define REP256(STR)  REP16(REP16(STR))
 107 #define REP1024(STR) REP4(REP256(STR))
 108
 109 /* Write the contents of a buffer to disk */
 110 void cl_git_mkfile(const char *filename, const char *content);
 111 void cl_git_append2file(const char *filename, const char *new_content);
 112 void cl_git_rewritefile(const char *filename, const char *new_content);
 113 void cl_git_write2file(const char *path, const char *data,
 114         size_t datalen, int flags, unsigned int mode);
 115 void cl_git_rmfile(const char *filename);
 116
 117 bool cl_toggle_filemode(const char *filename);
 118 bool cl_is_chmod_supported(void);
 119
 120 /* Environment wrappers */
 121 char *cl_getenv(const char *name);
 122 int cl_setenv(const char *name, const char *value);
 123
 124 /* Reliable rename */
 125 int cl_rename(const char *source, const char *dest);
 126
 127 /* Git sandbox setup helpers */
 128
 129 git_repository *cl_git_sandbox_init(const char *sandbox);
 130 git_repository *cl_git_sandbox_init_new(const char *name);
 131 void cl_git_sandbox_cleanup(void);
 132 git_repository *cl_git_sandbox_reopen(void);
 133
 134 /* Local-repo url helpers */
 135 const char* cl_git_fixture_url(const char *fixturename);
 136 const char* cl_git_path_url(const char *path);
 137
 138 /* Test repository cleaner */
 139 int cl_git_remove_placeholders(const char *directory_path, const char *filename);
 140
 141 /* commit creation helpers */
 142 void cl_repo_commit_from_index(
 143         git_oid *out,
 144         git_repository *repo,
 145         git_signature *sig,
 146         git_time_t time,
 147         const char *msg);
 148
 149 /* config setting helpers */
 150 void cl_repo_set_bool(git_repository *repo, const char *cfg, int value);
 151 int cl_repo_get_bool(git_repository *repo, const char *cfg);
 152
 153 void cl_repo_set_string(git_repository *repo, const char *cfg, const char *value);
 154
 155 /* set up a fake "home" directory and set libgit2 GLOBAL search path.
 156  *
 157  * automatically configures cleanup function to restore the regular search
 158  * path, although you can call it explicitly if you wish (with NULL).
 159  */
 160 void cl_fake_home(void);
 161 void cl_fake_home_cleanup(void *);
 162
 163 void cl_sandbox_set_search_path_defaults(void);
 164
 165 #ifdef GIT_WIN32
 166 bool cl_sandbox_supports_8dot3(void);
 167 #endif
 168
 169 #endif