Fixed interface of the request create command

- added explicit choice of both local and remote branches
- added better guessing of branches when not given

Author: guyzmo

git_repo/repo.py

@@ -15,11 +15,13 @@
     {self} [--path=<path>] [-v...] <target> request (list|ls)
     {self} [--path=<path>] [-v...] <target> request fetch <request>
     {self} [--path=<path>] [-v...] <target> request create <title> [--message=<message>]
-    {self} [--path=<path>] [-v...] <target> request create <branch> <title> [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request create <local_branch> <title> [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request create <remote_branch> <local_branch> <title> [--message=<message>]
     {self} [--path=<path>] [-v...] <target> request <user>/<repo> (list|ls)
     {self} [--path=<path>] [-v...] <target> request <user>/<repo> fetch <request>
-    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <title> [--message=<message>]
-    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <branch> <title> [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <title> [--branch=<remote>] [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <local_branch> <title> [--branch=<remote>] [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <remote_branch> <local_branch> <title> [--branch=<remote>] [--message=<message>]
     {self} [--path=<path>] [-v...] <target> gist (list|ls) [<gist>]
     {self} [--path=<path>] [-v...] <target> gist clone <gist>
     {self} [--path=<path>] [-v...] <target> gist fetch <gist> [<gist_file>]
@@ -348,13 +350,13 @@ def do_request_create(self):
         service = self.get_service()
         new_request = service.request_create(self.user_name,
                 self.repo_name,
-                self.branch,
+                self.local_branch,
+                self.remote_branch,
                 self.title,
                 self.message)
-        log.info('Successfully created request of `{}` onto `{}`, with id `{}`!'.format(
-            self.branch,
+        log.info('Successfully created request of `{local}` onto `{}:{remote}`, with id `{ref}`!'.format(
             '/'.join([self.user_name, self.repo_name]),
-            new_request)
+            **new_request)
         )
         return 0
 

git_repo/services/ext/github.py

@@ -151,17 +151,18 @@ def gist_delete(self, gist_id):
             raise ResourceNotFoundError('Could not find gist')
         gist.delete()
 
-    def request_create(self, user, repo, branch, title, description=None):
+    def request_create(self, user, repo, local_branch, remote_branch, title, description=None):
         repository = self.gh.repository(user, repo)
         if not repository:
             raise ResourceNotFoundError('Could not find repository `{}/{}`!'.format(user, repo))
-        if not branch:
-            branch = self.repository.active_branch.name
-        base = repository.master_branch if repository.master_branch else 'master'
+        if not local_branch:
+            remote_branch = self.repository.active_branch.name or self.repository.active_branch.name
+        if not remote_branch:
+            local_branch = repository.master_branch or 'master'
         try:
             request = repository.create_pull(title,
-                    base=base,
-                    head=':'.join([user, branch]),
+                    base=local_branch,
+                    head=':'.join([user, remote_branch]),
                     body=description)
         except github3.models.GitHubError as err:
             if err.code == 422:
@@ -175,7 +176,7 @@ def request_create(self, user, repo, branch, title, description=None):
                 raise ResourceError("Unhandled formatting error: {}".format(err.errors))
 
 
-        return request.number
+        return {'local': local_branch, 'remote': remote_branch, 'ref': request.number}
 
     def request_list(self, user, repo):
         repository = self.gh.repository(user, repo)

tests/helpers.py

@@ -115,9 +115,11 @@ def request_fetch(self, *args, **kwarg):
 
     def request_create(self, *args, **kwarg):
         self._did_request_create = (args, kwarg)
-        if args[2] == 'bad':
+        if args[2] == 'bad' or args[3] == 'bad':
             raise Exception('bad branch to request!')
-        return 42
+        local = args[2] or 'pr-test'
+        remote = args[3] or 'base-test'
+        return {'local': local, 'remote': remote, 'ref': 42}
 
     @classmethod
     def get_auth_token(cls, login, password):
@@ -184,6 +186,8 @@ def setup_args(self, d, args={}):
             '<gist_path>': [],
             'request': False,
             '<request>': None,
+            '<local_branch>': None,
+            '<remote_branch>': None,
             '<user>/<repo>': None,
         }
         cli_args.update(d)

tests/integration/test_github.py

@@ -331,7 +331,7 @@ def test_32_request_create(self):
                 branch='pr-test',
                 title='PR test',
                 description='PR description')
-        assert r == 1
+        assert r == {'local': 'pr-test', 'ref': 1, 'remote': 'PR test'}
 
     def test_32_request_create__bad_branch(self):
         with pytest.raises(ResourceError):

tests/integration/test_main.py

@@ -361,45 +361,94 @@ def test_request_create(self, capsys, caplog):
         call(['git', 'init', '-q', self.tempdir.name])
         seen_args, extra_args = self.main_request_create('guyzmo/test', 0,
                 args={
-                    '<branch>': 'pr-test',
+                    '<local_branch>': 'pr-test',
+                    '<remote_branch>': 'base-test',
                     '<title>': 'This is a test',
                     '--message': 'This is a test'
                     })
         out, err = capsys.readouterr()
-        assert ('guyzmo', 'test', 'pr-test', 'This is a test', 'This is a test') == seen_args
+        assert ('guyzmo', 'test', 'pr-test', 'base-test', 'This is a test', 'This is a test') == seen_args
         assert {} == extra_args
         assert out == ''
-        assert 'Successfully created request of `pr-test` onto `guyzmo/test`, with id `42`!' in caplog.text
+        assert 'Successfully created request of `pr-test` onto `guyzmo/test:base-test`, with id `42`!' in caplog.text
 
     def test_request_create__no_description(self, capsys, caplog):
         from subprocess import call
         call(['git', 'init', '-q', self.tempdir.name])
         seen_args, extra_args = self.main_request_create('guyzmo/test', 0,
                 args={
-                    '<branch>': 'pr-test',
+                    '<local_branch>': 'pr-test',
+                    '<remote_branch>': 'base-test',
                     '<title>': 'This is a test',
                     })
         out, err = capsys.readouterr()
-        assert ('guyzmo', 'test', 'pr-test', 'This is a test', None) == seen_args
+        assert ('guyzmo', 'test', 'pr-test', 'base-test', 'This is a test', None) == seen_args
         assert {} == extra_args
         assert out == ''
-        assert 'Successfully created request of `pr-test` onto `guyzmo/test`, with id `42`!' in caplog.text
+        assert 'Successfully created request of `pr-test` onto `guyzmo/test:base-test`, with id `42`!' in caplog.text
 
-    def test_request_create__bad_branch(self, capsys, caplog):
+    def test_request_create__bad_local_branch(self, capsys, caplog):
         from subprocess import call
         call(['git', 'init', '-q', self.tempdir.name])
         seen_args, extra_args = self.main_request_create('guyzmo/test', 2,
                 args={
-                    '<branch>': 'bad',
+                    '<local_branch>': 'bad',
+                    '<remote_branch>': 'base-test',
                     '<title>': 'This is a test',
                     '--message': 'This is a test'
                     })
         out, err = capsys.readouterr()
-        assert ('guyzmo', 'test', 'bad', 'This is a test', 'This is a test') == seen_args
+        assert ('guyzmo', 'test', 'bad', 'base-test', 'This is a test', 'This is a test') == seen_args
         assert {} == extra_args
         assert out == ''
         assert 'Fatal error: bad branch to request!' in caplog.text
 
+    def test_request_create__bad_remote_branch(self, capsys, caplog):
+        from subprocess import call
+        call(['git', 'init', '-q', self.tempdir.name])
+        seen_args, extra_args = self.main_request_create('guyzmo/test', 2,
+                args={
+                    '<local_branch>': 'pr-test',
+                    '<remote_branch>': 'bad',
+                    '<title>': 'This is a test',
+                    '--message': 'This is a test'
+                    })
+        out, err = capsys.readouterr()
+        assert ('guyzmo', 'test', 'pr-test', 'bad', 'This is a test', 'This is a test') == seen_args
+        assert {} == extra_args
+        assert out == ''
+        assert 'Fatal error: bad branch to request!' in caplog.text
+
+    def test_request_create__no_local_branch(self, capsys, caplog):
+        from subprocess import call
+        call(['git', 'init', '-q', self.tempdir.name])
+        seen_args, extra_args = self.main_request_create('guyzmo/test', 0,
+                args={
+                    '<remote_branch>': 'base-test',
+                    '<title>': 'This is a test',
+                    '--message': 'This is a test'
+                    })
+        out, err = capsys.readouterr()
+        assert ('guyzmo', 'test', None, 'base-test', 'This is a test', 'This is a test') == seen_args
+        assert {} == extra_args
+        assert out == ''
+        assert 'Successfully created request of `pr-test` onto `guyzmo/test:base-test`, with id `42`!' in caplog.text
+
+    def test_request_create__no_remote_branch(self, capsys, caplog):
+        from subprocess import call
+        call(['git', 'init', '-q', self.tempdir.name])
+        seen_args, extra_args = self.main_request_create('guyzmo/test', 0,
+                args={
+                    '<local_branch>': 'pr-test',
+                    '<title>': 'This is a test',
+                    '--message': 'This is a test'
+                    })
+        out, err = capsys.readouterr()
+        assert ('guyzmo', 'test', 'pr-test', None, 'This is a test', 'This is a test') == seen_args
+        assert {} == extra_args
+        assert out == ''
+        assert 'Successfully created request of `pr-test` onto `guyzmo/test:base-test`, with id `42`!' in caplog.text
+
     def test_open(self):
         repo_slug, seen_args = self.main_open('guyzmo/git-repo', 0)
         assert ('guyzmo', 'git-repo') == repo_slug
@@ -464,15 +513,16 @@ def test_request_create__no_repo_slug(self, capsys, caplog):
         self._create_repository()
         seen_args, extra_args = self.main_request_create(rc=0,
                 args={
-                    '<branch>': 'pr-test',
+                    '<local_branch>': 'pr-test',
+                    '<remote_branch>': 'base-test',
                     '<title>': 'This is a test',
                     '--message': 'This is a test'
                     })
         out, err = capsys.readouterr()
-        assert ('guyzmo', 'git-repo', 'pr-test', 'This is a test', 'This is a test') == seen_args
+        assert ('guyzmo', 'git-repo', 'pr-test', 'base-test', 'This is a test', 'This is a test') == seen_args
         assert {} == extra_args
         assert out == ''
-        assert 'Successfully created request of `pr-test` onto `guyzmo/git-repo`, with id `42`!' in caplog.text
+        assert 'Successfully created request of `pr-test` onto `guyzmo/git-repo:base-test`, with id `42`!' in caplog.text
 
     def test_config(self, capsys, caplog):
         import sys, io, getpass