Make repo config loading automatic or completely explicit git_repository_config wants to take the global and system paths again so that one can be explicit if needed. The git_repository_config_autoload function is provided for the cases when it's good enough for the library to guess where those files are located. Signed-off-by: Carlos Martín Nieto <carlos@cmartin.tk>
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
diff --git a/include/git2/repository.h b/include/git2/repository.h
index d12cfbe..b1fb5db 100644
--- a/include/git2/repository.h
+++ b/include/git2/repository.h
@@ -284,14 +284,11 @@ GIT_EXTERN(int) git_repository_is_bare(git_repository *repo);
/**
* Retrieve the relevant configuration for a repository
*
- * By default he returned `git_config` instance contains the two most
- * common configuration files, the `config' file that may be found
- * inside the repository, and the `$HOME/.gitconfig' "global"
- * configuration file.
- *
- * If the `system_config_path` variable is not NULL, the given config
- * file will be also included in the configuration set. On most UNIX
- * systems, this file may be found on `$PREFIX/etc/gitconfig`.
+ * If either the `global_config_path` or `system_config_path`
+ * variables are not NULL, the given config files will be also
+ * included in the configuration set. The global configuration file is
+ * located in $HOME/.gitconfig. On most UNIX systems, the system
+ * config file file may be found on `$sysconfdir/gitconfig`.
*
* The resulting `git_config` instance will query the files in the following
* order:
@@ -300,20 +297,37 @@ GIT_EXTERN(int) git_repository_is_bare(git_repository *repo);
* - Global configuration file
* - System configuration file
*
- * The method will fail if any of the passed system config file found
- * or accessed.
+ * The method will fail if any of the given config files can't be
+ * found or accessed.
*
* The returned `git_config` instance is owned by the caller and must
* be manually free'd once it's no longer on use.
*
* @param out the repository's configuration
* @param repo the repository for which to get the config
+ * @param system_config_path Path to the global config file
* @param system_config_path Path to the system-wide config file
*/
+
GIT_EXTERN(int) git_repository_config(git_config **out,
git_repository *repo,
+ const char *global_config_path,
const char *system_config_path);
+/**
+ * Automatically load the configuration files
+ *
+ * A wrapper around `git_repository_config` that tries to guess where
+ * the global and system config files are located. No error is
+ * reported if either of these files
+ *
+ * @param out the repository's configuration
+ * @param repo the repository for which to get the config
+ */
+int git_repository_config_autoload(
+ git_config **out,
+ git_repository *repo);
+
/** @} */
GIT_END_DECL
#endif
diff --git a/src/repository.c b/src/repository.c
index a39ccb6..328bc0d 100644
--- a/src/repository.c
+++ b/src/repository.c
@@ -270,6 +270,7 @@ cleanup:
int git_repository_config(
git_config **out,
git_repository *repo,
+ const char *global_config_path,
const char *system_config_path)
{
char config_path[GIT_PATH_MAX];
@@ -286,9 +287,10 @@ int git_repository_config(
if (error < GIT_SUCCESS)
goto cleanup;
- error = git_config_find_global(config_path);
- if (error == GIT_SUCCESS) {
- error = git_config_add_file_ondisk(*out, config_path, 2);
+ if (global_config_path != NULL) {
+ error = git_config_add_file_ondisk(*out, global_config_path, 2);
+ if (error < GIT_SUCCESS)
+ goto cleanup;
}
if (system_config_path != NULL) {
@@ -305,6 +307,24 @@ cleanup:
return error;
}
+int git_repository_config_autoload(
+ git_config **out,
+ git_repository *repo)
+{
+ char global[GIT_PATH_MAX], system[GIT_PATH_MAX];
+ char *global_path, *system_path;
+ int error;
+
+
+ error = git_config_find_global(global);
+ global_path = error < GIT_SUCCESS ? NULL : global;
+
+ error = git_config_find_system(system);
+ system_path = error < GIT_SUCCESS ? NULL : system;
+
+ return git_repository_config(out, repo, global_path, system_path);
+}
+
static int discover_repository_dirs(git_repository *repo, const char *path)
{
int error;
diff --git a/tests-clay/network/remotes.c b/tests-clay/network/remotes.c
index ae8d89f..a7cc742 100644
--- a/tests-clay/network/remotes.c
+++ b/tests-clay/network/remotes.c
@@ -11,7 +11,7 @@ void test_network_remotes__initialize(void)
{
cl_fixture_sandbox(REPOSITORY_FOLDER);
cl_git_pass(git_repository_open(&repo, REPOSITORY_FOLDER));
- cl_git_pass(git_repository_config(&cfg, repo, NULL));
+ cl_git_pass(git_repository_config(&cfg, repo, NULL, NULL));
cl_git_pass(git_remote_get(&remote, cfg, "test"));
refspec = git_remote_fetchspec(remote);
cl_assert(refspec != NULL);
diff --git a/tests/t15-config.c b/tests/t15-config.c
index ac2d79c..40c4eb9 100644
--- a/tests/t15-config.c
+++ b/tests/t15-config.c
@@ -30,6 +30,7 @@
#include "filebuf.h"
#define CONFIG_BASE TEST_RESOURCES "/config"
+#define GLOBAL_CONFIG CONFIG_BASE "/.gitconfig"
/*
* This one is so we know the code isn't completely broken
@@ -233,40 +234,26 @@ BEGIN_TEST(config10, "a repo's config overrides the global config")
git_repository *repo;
git_config *cfg;
int version;
- char *old_home;
-
- old_home = git__strdup(getenv("HOME"));
- p_setenv("HOME", CONFIG_BASE, 1);
must_pass(git_repository_open(&repo, REPOSITORY_FOLDER));
- must_pass(git_repository_config(&cfg, repo, NULL));
+ must_pass(git_repository_config(&cfg, repo, GLOBAL_CONFIG, NULL));
must_pass(git_config_get_int(cfg, "core.repositoryformatversion", &version));
must_be_true(version == 0);
git_config_free(cfg);
git_repository_free(repo);
-
- p_setenv("HOME", old_home, 1);
- free(old_home);
END_TEST
BEGIN_TEST(config11, "fall back to the global config")
git_repository *repo;
git_config *cfg;
int num;
- char *old_home;
-
- old_home = git__strdup(getenv("HOME"));
- p_setenv("HOME", CONFIG_BASE, 1);
must_pass(git_repository_open(&repo, REPOSITORY_FOLDER));
- must_pass(git_repository_config(&cfg, repo, NULL));
+ must_pass(git_repository_config(&cfg, repo, GLOBAL_CONFIG, NULL));
must_pass(git_config_get_int(cfg, "core.something", &num));
must_be_true(num == 2);
git_config_free(cfg);
git_repository_free(repo);
-
- p_setenv("HOME", old_home, 1);
- free(old_home);
END_TEST
BEGIN_TEST(config12, "delete a value")
diff --git a/tests/t16-remotes.c b/tests/t16-remotes.c
index af54f29..ac98bdf 100644
--- a/tests/t16-remotes.c
+++ b/tests/t16-remotes.c
@@ -32,13 +32,9 @@ BEGIN_TEST(remotes0, "remote parsing works")
git_remote *remote;
git_repository *repo;
git_config *cfg;
- char *old_home;
-
- old_home = git__strdup(getenv("HOME"));
- p_setenv("HOME", "/dev/null", 1);
must_pass(git_repository_open(&repo, REPOSITORY_FOLDER));
- must_pass(git_repository_config(&cfg, repo, NULL));
+ must_pass(git_repository_config(&cfg, repo, NULL, NULL));
must_pass(git_remote_get(&remote, cfg, "test"));
must_be_true(!strcmp(git_remote_name(remote), "test"));
must_be_true(!strcmp(git_remote_url(remote), "git://github.com/libgit2/libgit2"));
@@ -46,9 +42,6 @@ BEGIN_TEST(remotes0, "remote parsing works")
git_remote_free(remote);
git_config_free(cfg);
git_repository_free(repo);
-
- p_setenv("HOME", old_home, 1);
- free(old_home);
END_TEST
BEGIN_TEST(refspec0, "remote with refspec works")
@@ -56,13 +49,9 @@ BEGIN_TEST(refspec0, "remote with refspec works")
git_repository *repo;
git_config *cfg;
const git_refspec *refspec = NULL;
- char *old_home;
-
- old_home = git__strdup(getenv("HOME"));
- p_setenv("HOME", "/dev/null", 1);
must_pass(git_repository_open(&repo, REPOSITORY_FOLDER));
- must_pass(git_repository_config(&cfg, repo, NULL));
+ must_pass(git_repository_config(&cfg, repo, NULL, NULL));
must_pass(git_remote_get(&remote, cfg, "test"));
refspec = git_remote_fetchspec(remote);
must_be_true(refspec != NULL);
@@ -71,9 +60,6 @@ BEGIN_TEST(refspec0, "remote with refspec works")
git_remote_free(remote);
git_config_free(cfg);
git_repository_free(repo);
-
- p_setenv("HOME", old_home, 1);
- free(old_home);
END_TEST
BEGIN_TEST(refspec1, "remote fnmatch works as expected")
@@ -81,13 +67,9 @@ BEGIN_TEST(refspec1, "remote fnmatch works as expected")
git_repository *repo;
git_config *cfg;
const git_refspec *refspec = NULL;
- char *old_home;
-
- old_home = git__strdup(getenv("HOME"));
- p_setenv("HOME", "/dev/null", 1);
must_pass(git_repository_open(&repo, REPOSITORY_FOLDER));
- must_pass(git_repository_config(&cfg, repo, NULL));
+ must_pass(git_repository_config(&cfg, repo, NULL, NULL));
must_pass(git_remote_get(&remote, cfg, "test"));
refspec = git_remote_fetchspec(remote);
must_be_true(refspec != NULL);
@@ -96,9 +78,6 @@ BEGIN_TEST(refspec1, "remote fnmatch works as expected")
git_remote_free(remote);
git_config_free(cfg);
git_repository_free(repo);
-
- p_setenv("HOME", old_home, 1);
- free(old_home);
END_TEST
BEGIN_TEST(refspec2, "refspec transform")
@@ -107,13 +86,9 @@ BEGIN_TEST(refspec2, "refspec transform")
git_config *cfg;
const git_refspec *refspec = NULL;
char ref[1024] = {0};
- char *old_home;
-
- old_home = git__strdup(getenv("HOME"));
- p_setenv("HOME", "/dev/null", 1);
must_pass(git_repository_open(&repo, REPOSITORY_FOLDER));
- must_pass(git_repository_config(&cfg, repo, NULL));
+ must_pass(git_repository_config(&cfg, repo, NULL, NULL));
must_pass(git_remote_get(&remote, cfg, "test"));
refspec = git_remote_fetchspec(remote);
must_be_true(refspec != NULL);
@@ -122,9 +97,6 @@ BEGIN_TEST(refspec2, "refspec transform")
git_remote_free(remote);
git_config_free(cfg);
git_repository_free(repo);
-
- p_setenv("HOME", old_home, 1);
- free(old_home);
END_TEST
BEGIN_SUITE(remotes)