tests/repo/discover.c

   1 #include "clar_libgit2.h"
   2
   3 #include "odb.h"
   4 #include "futils.h"
   5 #include "repository.h"
   6
   7 #define TEMP_REPO_FOLDER "temprepo/"
   8 #define DISCOVER_FOLDER TEMP_REPO_FOLDER "discover.git"
   9
  10 #define SUB_REPOSITORY_FOLDER_NAME "sub_repo"
  11 #define SUB_REPOSITORY_FOLDER DISCOVER_FOLDER "/" SUB_REPOSITORY_FOLDER_NAME
  12 #define SUB_REPOSITORY_GITDIR SUB_REPOSITORY_FOLDER "/.git"
  13 #define SUB_REPOSITORY_FOLDER_SUB SUB_REPOSITORY_FOLDER "/sub"
  14 #define SUB_REPOSITORY_FOLDER_SUB_SUB SUB_REPOSITORY_FOLDER_SUB "/subsub"
  15 #define SUB_REPOSITORY_FOLDER_SUB_SUB_SUB SUB_REPOSITORY_FOLDER_SUB_SUB "/subsubsub"
  16
  17 #define REPOSITORY_ALTERNATE_FOLDER DISCOVER_FOLDER "/alternate_sub_repo"
  18 #define REPOSITORY_ALTERNATE_FOLDER_SUB REPOSITORY_ALTERNATE_FOLDER "/sub"
  19 #define REPOSITORY_ALTERNATE_FOLDER_SUB_SUB REPOSITORY_ALTERNATE_FOLDER_SUB "/subsub"
  20 #define REPOSITORY_ALTERNATE_FOLDER_SUB_SUB_SUB REPOSITORY_ALTERNATE_FOLDER_SUB_SUB "/subsubsub"
  21
  22 #define ALTERNATE_MALFORMED_FOLDER1 DISCOVER_FOLDER "/alternate_malformed_repo1"
  23 #define ALTERNATE_MALFORMED_FOLDER2 DISCOVER_FOLDER "/alternate_malformed_repo2"
  24 #define ALTERNATE_MALFORMED_FOLDER3 DISCOVER_FOLDER "/alternate_malformed_repo3"
  25 #define ALTERNATE_NOT_FOUND_FOLDER DISCOVER_FOLDER "/alternate_not_found_repo"
  26
  27 static void ensure_repository_discover(const char *start_path,
  28                                        const char *ceiling_dirs,
  29                                        const char *expected_path)
  30 {
  31         git_buf found_path = GIT_BUF_INIT;
  32         git_str resolved = GIT_STR_INIT;
  33
  34         git_str_attach(&resolved, p_realpath(expected_path, NULL), 0);
  35         cl_assert(resolved.size > 0);
  36         cl_git_pass(git_fs_path_to_dir(&resolved));
  37         cl_git_pass(git_repository_discover(&found_path, start_path, 1, ceiling_dirs));
  38
  39         cl_assert_equal_s(found_path.ptr, resolved.ptr);
  40
  41         git_str_dispose(&resolved);
  42         git_buf_dispose(&found_path);
  43 }
  44
  45 static void write_file(const char *path, const char *content)
  46 {
  47         git_file file;
  48         int error;
  49
  50         if (git_fs_path_exists(path)) {
  51                 cl_git_pass(p_unlink(path));
  52         }
  53
  54         file = git_futils_creat_withpath(path, 0777, 0666);
  55         cl_assert(file >= 0);
  56
  57         error = p_write(file, content, strlen(content) * sizeof(char));
  58         p_close(file);
  59         cl_git_pass(error);
  60 }
  61
  62 /*no check is performed on ceiling_dirs length, so be sure it's long enough */
  63 static void append_ceiling_dir(git_str *ceiling_dirs, const char *path)
  64 {
  65         git_str pretty_path = GIT_STR_INIT;
  66         char ceiling_separator[2] = { GIT_PATH_LIST_SEPARATOR, '\0' };
  67
  68         cl_git_pass(git_fs_path_prettify_dir(&pretty_path, path, NULL));
  69
  70         if (ceiling_dirs->size > 0)
  71                 git_str_puts(ceiling_dirs, ceiling_separator);
  72
  73         git_str_puts(ceiling_dirs, pretty_path.ptr);
  74
  75         git_str_dispose(&pretty_path);
  76         cl_assert(git_str_oom(ceiling_dirs) == 0);
  77 }
  78
  79 static git_buf discovered;
  80 static git_str ceiling_dirs;
  81
  82 void test_repo_discover__initialize(void)
  83 {
  84         git_repository *repo;
  85         const mode_t mode = 0777;
  86         git_futils_mkdir_r(DISCOVER_FOLDER, mode);
  87
  88         git_str_init(&ceiling_dirs, 0);
  89         append_ceiling_dir(&ceiling_dirs, TEMP_REPO_FOLDER);
  90
  91         cl_git_pass(git_repository_init(&repo, DISCOVER_FOLDER, 1));
  92         git_repository_free(repo);
  93
  94         cl_git_pass(git_repository_init(&repo, SUB_REPOSITORY_FOLDER, 0));
  95         cl_git_pass(git_futils_mkdir_r(SUB_REPOSITORY_FOLDER_SUB_SUB_SUB, mode));
  96         cl_git_pass(git_futils_mkdir_r(SUB_REPOSITORY_FOLDER_SUB_SUB_SUB, mode));
  97
  98         cl_git_pass(git_futils_mkdir_r(REPOSITORY_ALTERNATE_FOLDER_SUB_SUB_SUB, mode));
  99         write_file(REPOSITORY_ALTERNATE_FOLDER "/" DOT_GIT, "gitdir: ../" SUB_REPOSITORY_FOLDER_NAME "/" DOT_GIT);
 100         write_file(REPOSITORY_ALTERNATE_FOLDER_SUB_SUB "/" DOT_GIT, "gitdir: ../../../" SUB_REPOSITORY_FOLDER_NAME "/" DOT_GIT);
 101         write_file(REPOSITORY_ALTERNATE_FOLDER_SUB_SUB_SUB "/" DOT_GIT, "gitdir: ../../../../");
 102
 103         cl_git_pass(git_futils_mkdir_r(ALTERNATE_MALFORMED_FOLDER1, mode));
 104         write_file(ALTERNATE_MALFORMED_FOLDER1 "/" DOT_GIT, "Anything but not gitdir:");
 105         cl_git_pass(git_futils_mkdir_r(ALTERNATE_MALFORMED_FOLDER2, mode));
 106         write_file(ALTERNATE_MALFORMED_FOLDER2 "/" DOT_GIT, "gitdir:");
 107         cl_git_pass(git_futils_mkdir_r(ALTERNATE_MALFORMED_FOLDER3, mode));
 108         write_file(ALTERNATE_MALFORMED_FOLDER3 "/" DOT_GIT, "gitdir: \n\n\n");
 109         cl_git_pass(git_futils_mkdir_r(ALTERNATE_NOT_FOUND_FOLDER, mode));
 110         write_file(ALTERNATE_NOT_FOUND_FOLDER "/" DOT_GIT, "gitdir: a_repository_that_surely_does_not_exist");
 111
 112         git_repository_free(repo);
 113 }
 114
 115 void test_repo_discover__cleanup(void)
 116 {
 117         git_buf_dispose(&discovered);
 118         git_str_dispose(&ceiling_dirs);
 119         cl_git_pass(git_futils_rmdir_r(TEMP_REPO_FOLDER, NULL, GIT_RMDIR_REMOVE_FILES));
 120 }
 121
 122 void test_repo_discover__discovering_repo_with_exact_path_succeeds(void)
 123 {
 124         cl_git_pass(git_repository_discover(&discovered, DISCOVER_FOLDER, 0, ceiling_dirs.ptr));
 125         cl_git_pass(git_repository_discover(&discovered, SUB_REPOSITORY_FOLDER, 0, ceiling_dirs.ptr));
 126 }
 127
 128 void test_repo_discover__discovering_nonexistent_dir_fails(void)
 129 {
 130         cl_assert_equal_i(GIT_ENOTFOUND, git_repository_discover(&discovered, DISCOVER_FOLDER "-nonexistent", 0, NULL));
 131 }
 132
 133 void test_repo_discover__discovering_repo_with_subdirectory_succeeds(void)
 134 {
 135         ensure_repository_discover(SUB_REPOSITORY_FOLDER_SUB, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 136         ensure_repository_discover(SUB_REPOSITORY_FOLDER_SUB_SUB, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 137         ensure_repository_discover(SUB_REPOSITORY_FOLDER_SUB_SUB_SUB, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 138 }
 139
 140 void test_repo_discover__discovering_repository_with_alternative_gitdir_succeeds(void)
 141 {
 142         ensure_repository_discover(REPOSITORY_ALTERNATE_FOLDER, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 143         ensure_repository_discover(REPOSITORY_ALTERNATE_FOLDER_SUB, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 144         ensure_repository_discover(REPOSITORY_ALTERNATE_FOLDER_SUB_SUB, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 145         ensure_repository_discover(REPOSITORY_ALTERNATE_FOLDER_SUB_SUB_SUB, ceiling_dirs.ptr, DISCOVER_FOLDER);
 146 }
 147
 148 void test_repo_discover__discovering_repository_with_malformed_alternative_gitdir_fails(void)
 149 {
 150         cl_git_fail(git_repository_discover(&discovered, ALTERNATE_MALFORMED_FOLDER1, 0, ceiling_dirs.ptr));
 151         cl_git_fail(git_repository_discover(&discovered, ALTERNATE_MALFORMED_FOLDER2, 0, ceiling_dirs.ptr));
 152         cl_git_fail(git_repository_discover(&discovered, ALTERNATE_MALFORMED_FOLDER3, 0, ceiling_dirs.ptr));
 153         cl_assert_equal_i(GIT_ENOTFOUND, git_repository_discover(&discovered, ALTERNATE_NOT_FOUND_FOLDER, 0, ceiling_dirs.ptr));
 154 }
 155
 156 void test_repo_discover__discovering_repository_with_ceiling(void)
 157 {
 158         append_ceiling_dir(&ceiling_dirs, SUB_REPOSITORY_FOLDER_SUB);
 159
 160         /* this must pass as ceiling_directories cannot prevent the current
 161          * working directory to be checked */
 162         ensure_repository_discover(SUB_REPOSITORY_FOLDER, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 163
 164         ensure_repository_discover(SUB_REPOSITORY_FOLDER_SUB, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 165         cl_assert_equal_i(GIT_ENOTFOUND, git_repository_discover(&discovered, SUB_REPOSITORY_FOLDER_SUB_SUB, 0, ceiling_dirs.ptr));
 166         cl_assert_equal_i(GIT_ENOTFOUND, git_repository_discover(&discovered, SUB_REPOSITORY_FOLDER_SUB_SUB_SUB, 0, ceiling_dirs.ptr));
 167 }
 168
 169 void test_repo_discover__other_ceiling(void)
 170 {
 171         append_ceiling_dir(&ceiling_dirs, SUB_REPOSITORY_FOLDER);
 172
 173         /* this must pass as ceiling_directories cannot predent the current
 174          * working directory to be checked */
 175         ensure_repository_discover(SUB_REPOSITORY_FOLDER, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 176
 177         cl_assert_equal_i(GIT_ENOTFOUND, git_repository_discover(&discovered, SUB_REPOSITORY_FOLDER_SUB, 0, ceiling_dirs.ptr));
 178         cl_assert_equal_i(GIT_ENOTFOUND, git_repository_discover(&discovered, SUB_REPOSITORY_FOLDER_SUB_SUB, 0, ceiling_dirs.ptr));
 179         cl_assert_equal_i(GIT_ENOTFOUND, git_repository_discover(&discovered, SUB_REPOSITORY_FOLDER_SUB_SUB_SUB, 0, ceiling_dirs.ptr));
 180 }
 181
 182 void test_repo_discover__ceiling_should_not_affect_gitdir_redirection(void)
 183 {
 184         append_ceiling_dir(&ceiling_dirs, SUB_REPOSITORY_FOLDER);
 185
 186         /* gitfile redirection should not be affected by ceiling directories */
 187         ensure_repository_discover(REPOSITORY_ALTERNATE_FOLDER, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 188         ensure_repository_discover(REPOSITORY_ALTERNATE_FOLDER_SUB, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 189         ensure_repository_discover(REPOSITORY_ALTERNATE_FOLDER_SUB_SUB, ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 190         ensure_repository_discover(REPOSITORY_ALTERNATE_FOLDER_SUB_SUB_SUB, ceiling_dirs.ptr, DISCOVER_FOLDER);
 191 }
 192
 193 void test_repo_discover__discovery_starting_at_file_succeeds(void)
 194 {
 195         int fd;
 196
 197         cl_assert((fd = p_creat(SUB_REPOSITORY_FOLDER "/file", 0600)) >= 0);
 198         cl_assert(p_close(fd) == 0);
 199
 200         ensure_repository_discover(SUB_REPOSITORY_FOLDER "/file", ceiling_dirs.ptr, SUB_REPOSITORY_GITDIR);
 201 }
 202
 203 void test_repo_discover__discovery_starting_at_system_root_causes_no_hang(void)
 204 {
 205 #ifdef GIT_WIN32
 206         git_buf out = GIT_BUF_INIT;
 207         cl_git_fail(git_repository_discover(&out, "C:/", 0, NULL));
 208         cl_git_fail(git_repository_discover(&out, "//localhost/", 0, NULL));
 209 #endif
 210 }