Adding support for git remote set-url/get-url API to Remote

Both commands enable handling of a little known feature of git, which is to support multiple URL for one remote. You can add multiple url using the `set_url` subcommand of `git remote`. As listing them is also handy, there's a nice method to do it, using `get_url`. * adding set_url method that maps to the git remote set-url command¶ * can be used to set an URL, or replace an URL with optional positional arg¶ * can be used to add, delete URL with kwargs (matching set-url options)¶ * adding add_url, delete_url methods that wraps around set_url for conveniency¶ * adding urls property that yields an iterator over the setup urls for a remote¶ * adding a test suite that checks all use case scenarii of this added API.¶ Signed-off-by: Guyzmo <[email protected]>

Author: guyzmo

git/remote.py

@@ -434,6 +434,54 @@ def iter_items(cls, repo):
 yieldRemote(repo, section[lbound+1:rbound])
 # END for each configuration section
 
+defset_url(self, new_url, old_url=None, **kwargs):
+"""Configure URLs on current remote (cf command git remote set_url)
+
+ This command manages URLs on the remote.
+
+ :param new_url: string being the URL to add as an extra remote URL
+ :param old_url: when set, replaces this URL with new_url for the remote
+ :return: self
+ """
+scmd='set-url'
+kwargs['insert_kwargs_after'] =scmd
+ifold_url:
+self.repo.git.remote(scmd, self.name, old_url, new_url, **kwargs)
+else:
+self.repo.git.remote(scmd, self.name, new_url, **kwargs)
+returnself
+
+defadd_url(self, url, **kwargs):
+"""Adds a new url on current remote (special case of git remote set_url)
+
+ This command adds new URLs to a given remote, making it possible to have
+ multiple URLs for a single remote.
+
+ :param url: string being the URL to add as an extra remote URL
+ :return: self
+ """
+returnself.set_url(url, add=True)
+
+defdelete_url(self, url, **kwargs):
+"""Deletes a new url on current remote (special case of git remote set_url)
+
+ This command deletes new URLs to a given remote, making it possible to have
+ multiple URLs for a single remote.
+
+ :param url: string being the URL to delete from the remote
+ :return: self
+ """
+returnself.set_url(url, delete=True)
+
+@property
+defurls(self):
+""":return: Iterator yielding all configured URL targets on a remote
+ as strings"""
+scmd='get-url'
+kwargs={'insert_kwargs_after': scmd}
+forurlinself.repo.git.remote(scmd, self.name, all=True, **kwargs).split('\n'):
+yieldurl
+
 @property
 defrefs(self):
 """

git/test/test_remote.py

@@ -9,7 +9,8 @@
 with_rw_repo,
 with_rw_and_rw_remote_repo,
 fixture,
-GIT_DAEMON_PORT
+GIT_DAEMON_PORT,
+assert_raises
 )
 fromgitimport (
 RemoteProgress,
@@ -62,7 +63,7 @@ def update(self, op_code, cur_count, max_count=None, message=''):
 # check each stage only comes once
 op_id=op_code&self.OP_MASK
 assertop_idin (self.COUNTING, self.COMPRESSING, self.WRITING)
-
+
 ifop_code&self.WRITING>0:
 ifop_code&self.BEGIN>0:
 assertnotmessage, 'should not have message when remote begins writing'
@@ -568,3 +569,47 @@ def test_uncommon_branch_names(self):
 assertres[0].remote_ref_path=='refs/pull/1/head'
 assertres[0].ref.path=='refs/heads/pull/1/head'
 assertisinstance(res[0].ref, Head)
+
+@with_rw_repo('HEAD', bare=False)
+deftest_multiple_urls(self, rw_repo):
+# test addresses
+test1='https://github.com/gitpython-developers/GitPython'
+test2='https://github.com/gitpython-developers/gitdb'
+test3='https://github.com/gitpython-developers/smmap'
+
+remote=rw_repo.remotes[0]
+# Testing setting a single URL
+remote.set_url(test1)
+assertlist(remote.urls) == [test1]
+
+# Testing replacing that single URL
+remote.set_url(test1)
+assertlist(remote.urls) == [test1]
+# Testing adding new URLs
+remote.set_url(test2, add=True)
+assertlist(remote.urls) == [test1, test2]
+remote.set_url(test3, add=True)
+assertlist(remote.urls) == [test1, test2, test3]
+# Testing removing an URL
+remote.set_url(test2, delete=True)
+assertlist(remote.urls) == [test1, test3]
+# Testing changing an URL
+remote.set_url(test3, test2)
+assertlist(remote.urls) == [test1, test2]
+
+# will raise: fatal: --add --delete doesn't make sense
+assert_raises(GitCommandError, remote.set_url, test2, add=True, delete=True)
+
+# Testing on another remote, with the add/delete URL
+remote=rw_repo.create_remote('another', url=test1)
+remote.add_url(test2)
+assertlist(remote.urls) == [test1, test2]
+remote.add_url(test3)
+assertlist(remote.urls) == [test1, test2, test3]
+# Testing removing all the URLs
+remote.delete_url(test2)
+assertlist(remote.urls) == [test1, test3]
+remote.delete_url(test1)
+assertlist(remote.urls) == [test3]
+# will raise fatal: Will not delete all non-push URLs
+assert_raises(GitCommandError, remote.delete_url, test3)