Added feature: automagical configuration of the tool

- handles getting the authorization token from the service
- adds the alias in the configuration

Author: guyzmo

git_repo/repo.py

@@ -25,6 +25,8 @@
     {self} [--path=<path>] [-v...] <target> gist fetch <gist> [<gist_file>]
     {self} [--path=<path>] [-v...] <target> gist create [--secret] <description> [<gist_path> <gist_path>...]
     {self} [--path=<path>] [-v...] <target> gist delete <gist> [-f]
+    {self} [--path=<path>] [-v...] <target> config [--config=<gitconfig>]
+    {self} [-v...] config [--config=<gitconfig>]
     {self} --help
 
 Tool for managing remote repository services.
@@ -38,6 +40,7 @@
     gist                     Manages gist files
     request                  Handles requests for merge
     open                     Open the given or current repository in a browser
+    config                   Run authentication process and configure the tool
 
 Options:
     <user>/<repo>            Repository to work with
@@ -239,6 +242,10 @@ def set_name(self, name):
     def set_gist_ref(self, gist):
         self.gist_ref = gist
 
+    @store_parameter('--config')
+    def store_gitconfig(self, val):
+        self.config = val or os.path.join(os.environ['HOME'], '.gitconfig')
+
     '''Actions'''
 
     @register_action('add')
@@ -410,6 +417,58 @@ def do_gist_delete(self):
         log.info('Successfully deleted gist!')
         return 0
 
+    @register_action('config')
+    def do_config(self):
+        from getpass import getpass
+
+        def loop_input(*args, method=input, **kwarg):
+            out = ''
+            while len(out) == 0:
+                out = method(*args, **kwarg)
+            return out
+
+        def setup_service(service):
+            conf = service.get_config(self.config)
+            if 'token' in conf:
+                raise Exception('A token has been generated for this service. Please revoke and delete before proceeding.')
+
+            print('Please enter your credentials to connect to the service:')
+            username = loop_input('username> ')
+            password = loop_input('password> ', method=getpass)
+
+            token = service.get_auth_token(username, password)
+            print('Great! You\'ve been identified 🍻')
+
+            print('Do you want to give a custom name for this service\'s remote?')
+            if 'y' in input('    [yN]> ').lower():
+                print('Enter the remote\'s name:')
+                loop_input('[{}]> '.format(service.name))
+
+            print('Do you want to configure a git alias?')
+            print('N.B.: instead of typing `git repo {0}` you\'ll be able to type `git {0}`'.format(service.command))
+            if 'n' in input('    [Yn]> ').lower():
+                set_alias = False
+            else:
+                set_alias = True
+
+            service.store_config(self.config, token=token)
+            if set_alias:
+                service.set_alias(self.config)
+
+        if self.target:
+            services = [self.get_service(lookup_repository=False)]
+        else:
+            services = RepositoryService.service_map.values()
+
+        for service in services:
+            print('Do you want to configure the {} service?'.format(service.name))
+            if 'n' in input('    [Yn]> ').lower():
+                continue
+            setup_service(service)
+
+        print('🍻 The configuration is done!')
+        return 0
+
 
 def main(args):
     try:

git_repo/services/ext/bitbucket.py

@@ -154,6 +154,11 @@ def get_repository(self, user, repo):
                 return r
         #raise ResourceNotFoundError('Cannot retrieve repository: {}/{} does not exists.'.format(user, repo))
 
+    @classmethod
+    def get_auth_token(cls, login, password):
+        log.warn("/!\\ Due to API limitations, the bitbucket login/password is stored as plaintext in configuration.")
+        return "{}:{}".format(login, password)
+
     @property
     def user(self):
         ret, user = self.bb.get_user()

git_repo/services/ext/github.py

@@ -202,6 +202,15 @@ def request_fetch(self, user, repo, request, pull=False):
                 raise ResourceNotFoundError('Could not find opened request #{}'.format(request)) from err
             raise err
 
+    @classmethod
+    def get_auth_token(cls, login, password):
+        import platform
+        auth = github3.GitHub().authorize(login, password,
+                scopes=[ 'repo', 'delete_repo', 'gist' ],
+                note='git-repo token used on {}'.format(platform.node()),
+                note_url='https://github.com/guyzmo/git-repo')
+        return auth.token
+
     @property
     def user(self):
         return self.gh.user().name

git_repo/services/ext/gitlab.py

@@ -77,6 +77,12 @@ def get_repository(self, user, repo):
             if err.response_code == 404:
                 raise ResourceNotFoundError("Cannot delete: repository {}/{} does not exists.".format(user, repo)) from err
 
+    @classmethod
+    def get_auth_token(cls, login, password):
+        gl = gitlab.Gitlab(url='https://{}'.format(cls.fqdn), email=login, password=password)
+        gl.auth()
+        return gl.user.private_token
+
     @property
     def user(self):
         return self.gl.user.username

git_repo/services/service.py

@@ -54,6 +54,33 @@ class RepositoryService:
     # this symbol is made available for testing purposes
     _current = None
 
+    config_options = ['type', 'token', 'alias', 'fqdn']
+
+    @classmethod
+    def get_config(cls, config):
+        out = {}
+        with git_config.GitConfigParser(config, read_only=True) as config:
+            section = 'gitrepo "{}"'.format(cls.name)
+            if config.has_section(section):
+                for option in cls.config_options:
+                    if config.has_option(section, option):
+                        out[option] = config.get(section, option)
+        return out
+
+    @classmethod
+    def store_config(cls, config, **kwarg):
+        with git_config.GitConfigParser(config, read_only=False) as config:
+            section = 'gitrepo "{}"'.format(cls.name)
+            for option, value in kwarg.items():
+                if option not in cls.config_options:
+                    raise ArgumentError('Option {} is invalid and cannot be setup.')
+                config.set_value(section, option, value)
+
+    @classmethod
+    def set_alias(cls, config):
+        with git_config.GitConfigParser(config, read_only=False) as config:
+            config.set_value('alias', cls.command, 'repo {}'.format(cls.command))
+
     @classmethod
     def get_service(cls, repository, command):
         '''Accessor for a repository given a command
@@ -94,6 +121,10 @@ def get_service(cls, repository, command):
         cls._current = service(repository, config)
         return cls._current
 
+    @classmethod
+    def get_auth_token(cls, login, password):
+        raise NotImplementedError
+
     def __init__(self, r=None, c=None):
         '''
         :param r: git-python repository instance

tests/helpers.py

@@ -15,6 +15,8 @@
 from git_repo.repo import RepositoryService, main
 
 class RepositoryMockup(RepositoryService):
+    name = 'test_name'
+    command = 'test_command'
     fqdn = 'http://example.org'
     def __init__(self, *args, **kwarg):
         super(RepositoryMockup, self).__init__(*args, **kwarg)
@@ -117,6 +119,10 @@ def request_create(self, *args, **kwarg):
             raise Exception('bad branch to request!')
         return 42
 
+    @classmethod
+    def get_auth_token(cls, login, password):
+        return '{}:{}'.format(login, password)
+
     @property
     def user(self):
         self._did_user = True
@@ -315,6 +321,14 @@ def main_open(self, repo=None, rc=0, args={}):
         }, args)), "Non {} result for open".format(rc)
         return RepositoryService._current._did_open
 
+    def main_config(self, target, rc=0, args={}):
+        assert rc == main(self.setup_args({
+            'config': True,
+            '--config': os.path.join(self.tempdir.name, 'gitconfig')
+        }, args)), "Non {} result for config".format(rc)
+        with open(os.path.join(self.tempdir.name, 'gitconfig')) as f:
+            return f.readlines()
+
     def main_noop(self, repo, rc=1, args={}):
         assert rc == main(self.setup_args({
             '<user>/<repo>': repo,
@@ -696,4 +710,3 @@ def action_open(self, cassette_name, namespace, repository):
         with Replace('subprocess.Popen', self.Popen):
             self.service.open(user=namespace, repo=repository)
 
-

tests/integration/test_main.py

@@ -474,6 +474,16 @@ def test_request_create__no_repo_slug(self, capsys, caplog):
         assert out == ''
         assert 'Successfully created request of `pr-test` onto `guyzmo/git-repo`, with id `42`!' in caplog.text
 
+    def test_config(self, capsys, caplog):
+        import sys, io, getpass
+        getpass.getpass = input
+        sys.stdin = io.StringIO('\n'.join(['y', 'user', 'pass', 'y', 'fubar', 'y']))
+        #
+        conf = self.main_config(target='hub', rc=0)
+        assert ['[gitrepo "github"]\n',
+                '\ttoken = user:pass\n',
+                '[alias]\n',
+                '\ttest_command = repo test_command\n'] == conf
 
     def test_z_noop(self):
         self.main_noop('guyzmo/git-repo', 1)