diff --git a/examples/network/clone.c b/examples/network/clone.c index 7596523c2..fd82f449b 100644 --- a/examples/network/clone.c +++ b/examples/network/clone.c @@ -47,9 +47,25 @@ static void checkout_progress(const char *path, size_t cur, size_t tot, void *pa print_progress(pd); } +static int cred_acquire(git_cred **out, const char *url, unsigned int allowed_types, void *payload) +{ + char username[128] = {0}; + char password[128] = {0}; + + printf("Username: "); + scanf("%s", username); + + /* Yup. Right there on your terminal. Careful where you copy/paste output. */ + printf("Password: "); + scanf("%s", password); + + return git_cred_userpass_plaintext_new(out, username, password); +} + int do_clone(git_repository *repo, int argc, char **argv) { progress_data pd; + git_remote *origin = NULL; git_repository *cloned_repo = NULL; git_checkout_opts checkout_opts = GIT_CHECKOUT_OPTS_INIT; const char *url = argv[1]; @@ -65,14 +81,24 @@ int do_clone(git_repository *repo, int argc, char **argv) } // Set up options - memset(&checkout_opts, 0, sizeof(checkout_opts)); checkout_opts.checkout_strategy = GIT_CHECKOUT_SAFE; checkout_opts.progress_cb = checkout_progress; memset(&pd, 0, sizeof(pd)); checkout_opts.progress_payload = &pd; + // Create the origin remote, and set up for auth + error = git_remote_new(&origin, NULL, "origin", url, GIT_REMOTE_DEFAULT_FETCH); + if (error != 0) { + const git_error *err = giterr_last(); + if (err) printf("ERROR %d: %s\n", err->klass, err->message); + else printf("ERROR %d: no detailed info\n", error); + return error; + } + git_remote_set_cred_acquire_cb(origin, cred_acquire, NULL); + // Do the clone - error = git_clone(&cloned_repo, url, path, &checkout_opts, &fetch_progress, &pd); + error = git_clone(&cloned_repo, origin, path, &checkout_opts, &fetch_progress, &pd); + git_remote_free(origin); printf("\n"); if (error != 0) { const git_error *err = giterr_last(); diff --git a/include/git2/clone.h b/include/git2/clone.h index 2a0272339..8de8e0e29 100644 --- a/include/git2/clone.h +++ b/include/git2/clone.h @@ -27,7 +27,7 @@ GIT_BEGIN_DECL * HEAD. * * @param out pointer that will receive the resulting repository object - * @param origin_url repository to clone from + * @param origin_remote a remote which will act as the initial fetch source * @param workdir_path local directory to clone to * @param fetch_progress_cb optional callback for fetch progress. Be aware that * this is called inline with network and indexing operations, so performance @@ -40,7 +40,7 @@ GIT_BEGIN_DECL */ GIT_EXTERN(int) git_clone( git_repository **out, - const char *origin_url, + git_remote *origin_remote, const char *workdir_path, git_checkout_opts *checkout_opts, git_transfer_progress_callback fetch_progress_cb, @@ -50,7 +50,7 @@ GIT_EXTERN(int) git_clone( * Create a bare clone of a remote repository. * * @param out pointer that will receive the resulting repository object - * @param origin_url repository to clone from + * @param origin_remote a remote which will act as the initial fetch source * @param dest_path local directory to clone to * @param fetch_progress_cb optional callback for fetch progress. Be aware that * this is called inline with network and indexing operations, so performance @@ -60,7 +60,7 @@ GIT_EXTERN(int) git_clone( */ GIT_EXTERN(int) git_clone_bare( git_repository **out, - const char *origin_url, + git_remote *origin_remote, const char *dest_path, git_transfer_progress_callback fetch_progress_cb, void *fetch_progress_payload); diff --git a/include/git2/remote.h b/include/git2/remote.h index 82aff385d..f3b0a9443 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -24,6 +24,14 @@ */ GIT_BEGIN_DECL +/** + * Use this when creating a remote with git_remote_new to get the default fetch + * behavior produced by git_remote_add. It corresponds to this fetchspec (note + * the spaces between '/' and '*' to avoid C compiler errors): + * "+refs/heads/ *:refs/remotes// *" + */ +#define GIT_REMOTE_DEFAULT_FETCH "" + typedef int (*git_remote_rename_problem_cb)(const char *problematic_refspec, void *payload); /* * TODO: This functions still need to be implemented: @@ -43,14 +51,24 @@ typedef int (*git_remote_rename_problem_cb)(const char *problematic_refspec, voi * See `git_tag_create()` for rules about valid names. * * @param out pointer to the new remote object - * @param repo the associated repository - * @param name the optional remote's name + * @param repo the associated repository. May be NULL for a "dangling" remote. + * @param name the optional remote's name. May be NULL. * @param url the remote repository's URL - * @param fetch the fetch refspec to use for this remote + * @param fetch the fetch refspec to use for this remote. May be NULL for defaults. * @return 0, GIT_EINVALIDSPEC or an error code */ GIT_EXTERN(int) git_remote_new(git_remote **out, git_repository *repo, const char *name, const char *url, const char *fetch); +/** + * Sets the owning repository for the remote. This is only allowed on + * dangling remotes. + * + * @param remote the remote to configure + * @param repo the repository that will own the remote + * @return 0 or an error code + */ +GIT_EXTERN(int) git_remote_set_repository(git_remote *remote, git_repository *repo); + /** * Get the information for a particular remote * diff --git a/src/clone.c b/src/clone.c index 7d49b398b..aa6c43f86 100644 --- a/src/clone.c +++ b/src/clone.c @@ -262,15 +262,14 @@ cleanup: static int setup_remotes_and_fetch( git_repository *repo, - const char *origin_url, + git_remote *origin, git_transfer_progress_callback progress_cb, void *progress_payload) { int retcode = GIT_ERROR; - git_remote *origin = NULL; - /* Create the "origin" remote */ - if (!git_remote_add(&origin, repo, GIT_REMOTE_ORIGIN, origin_url)) { + /* Add the origin remote */ + if (!git_remote_set_repository(origin, repo) && !git_remote_save(origin)) { /* * Don't write FETCH_HEAD, we'll check out the remote tracking * branch ourselves based on the server's default. @@ -290,7 +289,6 @@ static int setup_remotes_and_fetch( } git_remote_disconnect(origin); } - git_remote_free(origin); } return retcode; @@ -325,7 +323,7 @@ static bool should_checkout( static int clone_internal( git_repository **out, - const char *origin_url, + git_remote *origin_remote, const char *path, git_transfer_progress_callback fetch_progress_cb, void *fetch_progress_payload, @@ -340,7 +338,7 @@ static int clone_internal( } if (!(retcode = git_repository_init(&repo, path, is_bare))) { - if ((retcode = setup_remotes_and_fetch(repo, origin_url, + if ((retcode = setup_remotes_and_fetch(repo, origin_remote, fetch_progress_cb, fetch_progress_payload)) < 0) { /* Failed to fetch; clean up */ git_repository_free(repo); @@ -359,16 +357,16 @@ static int clone_internal( int git_clone_bare( git_repository **out, - const char *origin_url, + git_remote *origin_remote, const char *dest_path, git_transfer_progress_callback fetch_progress_cb, void *fetch_progress_payload) { - assert(out && origin_url && dest_path); + assert(out && origin_remote && dest_path); return clone_internal( out, - origin_url, + origin_remote, dest_path, fetch_progress_cb, fetch_progress_payload, @@ -379,17 +377,17 @@ int git_clone_bare( int git_clone( git_repository **out, - const char *origin_url, + git_remote *origin_remote, const char *workdir_path, git_checkout_opts *checkout_opts, git_transfer_progress_callback fetch_progress_cb, void *fetch_progress_payload) { - assert(out && origin_url && workdir_path); + assert(out && origin_remote && workdir_path); return clone_internal( out, - origin_url, + origin_remote, workdir_path, fetch_progress_cb, fetch_progress_payload, diff --git a/src/remote.c b/src/remote.c index 670904b17..28ce88a93 100644 --- a/src/remote.c +++ b/src/remote.c @@ -86,9 +86,11 @@ cleanup: int git_remote_new(git_remote **out, git_repository *repo, const char *name, const char *url, const char *fetch) { git_remote *remote; + git_buf fetchbuf = GIT_BUF_INIT; + int error = -1; /* name is optional */ - assert(out && repo && url); + assert(out && url); remote = git__calloc(1, sizeof(git_remote)); GITERR_CHECK_ALLOC(remote); @@ -98,20 +100,26 @@ int git_remote_new(git_remote **out, git_repository *repo, const char *name, con remote->update_fetchhead = 1; if (git_vector_init(&remote->refs, 32, NULL) < 0) - return -1; + goto on_error; remote->url = git__strdup(url); GITERR_CHECK_ALLOC(remote->url); if (name != NULL) { - int error; if ((error = ensure_remote_name_is_valid(name)) < 0) { - git_remote_free(remote); - return error; + error = GIT_EINVALIDSPEC; + goto on_error; } remote->name = git__strdup(name); GITERR_CHECK_ALLOC(remote->name); + + /* An empty name indicates to use a sensible default for the fetchspec. */ + if (fetch && !(*fetch)) { + if (git_buf_printf(&fetchbuf, "+refs/heads/*:refs/remotes/%s/*", remote->name) < 0) + goto on_error; + fetch = git_buf_cstr(&fetchbuf); + } } if (fetch != NULL) { @@ -125,11 +133,26 @@ int git_remote_new(git_remote **out, git_repository *repo, const char *name, con } *out = remote; + git_buf_free(&fetchbuf); return 0; on_error: git_remote_free(remote); - return -1; + git_buf_free(&fetchbuf); + return error; +} + +int git_remote_set_repository(git_remote *remote, git_repository *repo) +{ + assert(repo); + + if (remote->repo) { + giterr_set(GITERR_INVALID, "Remotes can't change repositiories."); + return GIT_ERROR; + } + + remote->repo = repo; + return 0; } int git_remote_load(git_remote **out, git_repository *repo, const char *name) @@ -289,6 +312,11 @@ int git_remote_save(const git_remote *remote) assert(remote); + if (!remote->repo) { + giterr_set(GITERR_INVALID, "Can't save a dangling remote."); + return GIT_ERROR; + } + if ((error = ensure_remote_name_is_valid(remote->name)) < 0) return error; @@ -543,7 +571,7 @@ int git_remote__get_http_proxy(git_remote *remote, bool use_ssl, char **proxy_ur assert(remote); - if (!proxy_url) + if (!proxy_url || !remote->repo) return -1; *proxy_url = NULL; @@ -745,6 +773,11 @@ int git_remote_update_tips(git_remote *remote) assert(remote); + if (!remote->repo) { + giterr_set(GITERR_INVALID, "Can't update tips on a dangling remote."); + return GIT_ERROR; + } + spec = &remote->fetch; if (git_repository_odb__weakptr(&odb, remote->repo) < 0) @@ -1293,50 +1326,52 @@ int git_remote_rename( assert(remote && new_name); - if ((error = ensure_remote_doesnot_exist(remote->repo, new_name)) < 0) - return error; - if ((error = ensure_remote_name_is_valid(new_name)) < 0) return error; - if (!remote->name) { + if (remote->repo) { + if ((error = ensure_remote_doesnot_exist(remote->repo, new_name)) < 0) + return error; + + if (!remote->name) { + if ((error = rename_fetch_refspecs( + remote, + new_name, + callback, + payload)) < 0) + return error; + + remote->name = git__strdup(new_name); + + return git_remote_save(remote); + } + + if ((error = rename_remote_config_section( + remote->repo, + remote->name, + new_name)) < 0) + return error; + + if ((error = update_branch_remote_config_entry( + remote->repo, + remote->name, + new_name)) < 0) + return error; + + if ((error = rename_remote_references( + remote->repo, + remote->name, + new_name)) < 0) + return error; + if ((error = rename_fetch_refspecs( remote, new_name, callback, payload)) < 0) return error; - - remote->name = git__strdup(new_name); - - return git_remote_save(remote); } - if ((error = rename_remote_config_section( - remote->repo, - remote->name, - new_name)) < 0) - return error; - - if ((error = update_branch_remote_config_entry( - remote->repo, - remote->name, - new_name)) < 0) - return error; - - if ((error = rename_remote_references( - remote->repo, - remote->name, - new_name)) < 0) - return error; - - if ((error = rename_fetch_refspecs( - remote, - new_name, - callback, - payload)) < 0) - return error; - git__free(remote->name); remote->name = git__strdup(new_name); diff --git a/tests-clar/clone/network.c b/tests-clar/clone/network.c index d519e458b..15ad95b37 100644 --- a/tests-clar/clone/network.c +++ b/tests-clar/clone/network.c @@ -5,14 +5,22 @@ CL_IN_CATEGORY("network") -#define LIVE_REPO_URL "git://github.com/libgit2/TestGitRepository" -#define LIVE_EMPTYREPO_URL "git://github.com/libgit2/TestEmptyRepository" +#define LIVE_REPO_URL "http://github.com/libgit2/TestGitRepository" +#define LIVE_EMPTYREPO_URL "http://github.com/libgit2/TestEmptyRepository" static git_repository *g_repo; +static git_remote *g_origin; void test_clone_network__initialize(void) { g_repo = NULL; + cl_git_pass(git_remote_new(&g_origin, NULL, "origin", LIVE_REPO_URL, GIT_REMOTE_DEFAULT_FETCH)); +} + +void test_clone_network__cleanup(void) +{ + git_remote_free(g_origin); + g_origin = NULL; } static void cleanup_repository(void *path) @@ -31,7 +39,7 @@ void test_clone_network__network_full(void) cl_set_cleanup(&cleanup_repository, "./test2"); - cl_git_pass(git_clone(&g_repo, LIVE_REPO_URL, "./test2", NULL, NULL, NULL)); + cl_git_pass(git_clone(&g_repo, g_origin, "./test2", NULL, NULL, NULL)); cl_assert(!git_repository_is_bare(g_repo)); cl_git_pass(git_remote_load(&origin, g_repo, "origin")); @@ -45,7 +53,7 @@ void test_clone_network__network_bare(void) cl_set_cleanup(&cleanup_repository, "./test"); - cl_git_pass(git_clone_bare(&g_repo, LIVE_REPO_URL, "./test", NULL, NULL)); + cl_git_pass(git_clone_bare(&g_repo, g_origin, "./test", NULL, NULL)); cl_assert(git_repository_is_bare(g_repo)); cl_git_pass(git_remote_load(&origin, g_repo, "origin")); @@ -57,7 +65,7 @@ void test_clone_network__cope_with_already_existing_directory(void) cl_set_cleanup(&cleanup_repository, "./foo"); p_mkdir("./foo", GIT_DIR_MODE); - cl_git_pass(git_clone(&g_repo, LIVE_REPO_URL, "./foo", NULL, NULL, NULL)); + cl_git_pass(git_clone(&g_repo, g_origin, "./foo", NULL, NULL, NULL)); git_repository_free(g_repo); g_repo = NULL; } @@ -67,7 +75,10 @@ void test_clone_network__empty_repository(void) cl_set_cleanup(&cleanup_repository, "./empty"); - cl_git_pass(git_clone(&g_repo, LIVE_EMPTYREPO_URL, "./empty", NULL, NULL, NULL)); + git_remote_free(g_origin); + cl_git_pass(git_remote_new(&g_origin, NULL, "origin", LIVE_EMPTYREPO_URL, GIT_REMOTE_DEFAULT_FETCH)); + + cl_git_pass(git_clone(&g_repo, g_origin, "./empty", NULL, NULL, NULL)); cl_assert_equal_i(true, git_repository_is_empty(g_repo)); cl_assert_equal_i(true, git_repository_head_orphan(g_repo)); @@ -85,7 +96,7 @@ void test_clone_network__can_prevent_the_checkout_of_a_standard_repo(void) cl_set_cleanup(&cleanup_repository, "./no-checkout"); - cl_git_pass(git_clone(&g_repo, LIVE_REPO_URL, "./no-checkout", NULL, NULL, NULL)); + cl_git_pass(git_clone(&g_repo, g_origin, "./no-checkout", NULL, NULL, NULL)); cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_repo), "master.txt")); cl_assert_equal_i(false, git_path_isfile(git_buf_cstr(&path))); @@ -121,7 +132,7 @@ void test_clone_network__can_checkout_a_cloned_repo(void) cl_set_cleanup(&cleanup_repository, "./default-checkout"); - cl_git_pass(git_clone(&g_repo, LIVE_REPO_URL, "./default-checkout", &opts, + cl_git_pass(git_clone(&g_repo, g_origin, "./default-checkout", &opts, &fetch_progress, &fetch_progress_cb_was_called)); cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_repo), "master.txt")); diff --git a/tests-clar/clone/nonetwork.c b/tests-clar/clone/nonetwork.c index 84327081e..17a7a36ad 100644 --- a/tests-clar/clone/nonetwork.c +++ b/tests-clar/clone/nonetwork.c @@ -6,10 +6,18 @@ #define LIVE_REPO_URL "git://github.com/libgit2/TestGitRepository" static git_repository *g_repo; +static git_remote *g_origin = NULL; void test_clone_nonetwork__initialize(void) { g_repo = NULL; + cl_git_pass(git_remote_new(&g_origin, NULL, "origin", cl_git_fixture_url("testrepo.git"), GIT_REMOTE_DEFAULT_FETCH)); +} + +void test_clone_nonetwork__cleanup(void) +{ + git_remote_free(g_origin); + g_origin = NULL; } static void cleanup_repository(void *path) @@ -25,18 +33,20 @@ static void cleanup_repository(void *path) void test_clone_nonetwork__bad_url(void) { /* Clone should clean up the mess if the URL isn't a git repository */ - cl_git_fail(git_clone(&g_repo, "not_a_repo", "./foo", NULL, NULL, NULL)); + git_remote_free(g_origin); + cl_git_pass(git_remote_new(&g_origin, NULL, "origin", "not_a_repo", GIT_REMOTE_DEFAULT_FETCH)); + + cl_git_fail(git_clone(&g_repo, g_origin, "./foo", NULL, NULL, NULL)); cl_assert(!git_path_exists("./foo")); - cl_git_fail(git_clone_bare(&g_repo, "not_a_repo", "./foo.git", NULL, NULL)); + cl_git_fail(git_clone_bare(&g_repo, g_origin, "./foo.git", NULL, NULL)); cl_assert(!git_path_exists("./foo.git")); } void test_clone_nonetwork__local(void) { - const char *src = cl_git_fixture_url("testrepo.git"); cl_set_cleanup(&cleanup_repository, "./local"); - cl_git_pass(git_clone(&g_repo, src, "./local", NULL, NULL, NULL)); + cl_git_pass(git_clone(&g_repo, g_origin, "./local", NULL, NULL, NULL)); } void test_clone_nonetwork__local_absolute_path(void) @@ -49,10 +59,9 @@ void test_clone_nonetwork__local_absolute_path(void) void test_clone_nonetwork__local_bare(void) { - const char *src = cl_git_fixture_url("testrepo.git"); cl_set_cleanup(&cleanup_repository, "./local.git"); - cl_git_pass(git_clone_bare(&g_repo, src, "./local.git", NULL, NULL)); + cl_git_pass(git_clone_bare(&g_repo, g_origin, "./local.git", NULL, NULL)); } void test_clone_nonetwork__fail_when_the_target_is_a_file(void) @@ -60,7 +69,7 @@ void test_clone_nonetwork__fail_when_the_target_is_a_file(void) cl_set_cleanup(&cleanup_repository, "./foo"); cl_git_mkfile("./foo", "Bar!"); - cl_git_fail(git_clone(&g_repo, LIVE_REPO_URL, "./foo", NULL, NULL, NULL)); + cl_git_fail(git_clone(&g_repo, g_origin, "./foo", NULL, NULL, NULL)); } void test_clone_nonetwork__fail_with_already_existing_but_non_empty_directory(void) @@ -69,5 +78,5 @@ void test_clone_nonetwork__fail_with_already_existing_but_non_empty_directory(vo p_mkdir("./foo", GIT_DIR_MODE); cl_git_mkfile("./foo/bar", "Baz!"); - cl_git_fail(git_clone(&g_repo, LIVE_REPO_URL, "./foo", NULL, NULL, NULL)); + cl_git_fail(git_clone(&g_repo, g_origin, "./foo", NULL, NULL, NULL)); } diff --git a/tests-clar/fetchhead/network.c b/tests-clar/fetchhead/network.c index 46cb977e0..aed5b5ad8 100644 --- a/tests-clar/fetchhead/network.c +++ b/tests-clar/fetchhead/network.c @@ -10,10 +10,17 @@ CL_IN_CATEGORY("network") #define LIVE_REPO_URL "git://github.com/libgit2/TestGitRepository" static git_repository *g_repo; +static git_remote *g_origin; void test_fetchhead_network__initialize(void) { g_repo = NULL; + cl_git_pass(git_remote_new(&g_origin, NULL, "origin", LIVE_REPO_URL, GIT_REMOTE_DEFAULT_FETCH)); +} + +void test_fetchhead_network__cleanup(void) +{ + g_origin = NULL; } static void cleanup_repository(void *path) @@ -31,7 +38,7 @@ static void fetchhead_test_clone(void) { cl_set_cleanup(&cleanup_repository, "./test1"); - cl_git_pass(git_clone(&g_repo, LIVE_REPO_URL, "./test1", NULL, NULL, NULL)); + cl_git_pass(git_clone(&g_repo, g_origin, "./test1", NULL, NULL, NULL)); } static void fetchhead_test_fetch(const char *fetchspec, const char *expected_fetchhead) diff --git a/tests-clar/network/fetch.c b/tests-clar/network/fetch.c index a5e2c02a7..246435b1b 100644 --- a/tests-clar/network/fetch.c +++ b/tests-clar/network/fetch.c @@ -89,7 +89,8 @@ void test_network_fetch__doesnt_retrieve_a_pack_when_the_repository_is_up_to_dat git_remote *remote; bool invoked = false; - cl_git_pass(git_clone_bare(&_repository, "https://github.com/libgit2/TestGitRepository.git", "./fetch/lg2", NULL, NULL)); + cl_git_pass(git_remote_new(&remote, NULL, "origin", "https://github.com/libgit2/TestGitRepository.git", GIT_REMOTE_DEFAULT_FETCH)); + cl_git_pass(git_clone_bare(&_repository, remote, "./fetch/lg2", NULL, NULL)); git_repository_free(_repository); cl_git_pass(git_repository_open(&_repository, "./fetch/lg2")); diff --git a/tests-clar/network/remotes.c b/tests-clar/network/remotes.c index 70df001e7..b2ed8e7f2 100644 --- a/tests-clar/network/remotes.c +++ b/tests-clar/network/remotes.c @@ -326,3 +326,17 @@ void test_network_remotes__check_structure_version(void) err = giterr_last(); cl_assert_equal_i(GITERR_INVALID, err->klass); } + +void test_network_remotes__dangling(void) +{ + cl_git_pass(git_remote_new(&_remote, NULL, "upstream", "git://github.com/libgit2/libgit2", NULL)); + + cl_git_pass(git_remote_rename(_remote, "newname", NULL, NULL)); + cl_assert_equal_s(git_remote_name(_remote), "newname"); + + cl_git_fail(git_remote_save(_remote)); + cl_git_fail(git_remote_update_tips(_remote)); + + cl_git_pass(git_remote_set_repository(_remote, _repo)); + cl_git_pass(git_remote_save(_remote)); +}