summaryrefslogtreecommitdiff
path: root/lorrycontroller/gitano.py
blob: 06039b06f700cfec2b763690d9d714a9c43915ed (plain)
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
# Copyright (C) 2014-2019  Codethink Limited
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


import collections
import logging
import re
import urllib.request, urllib.error, urllib.parse

import cliapp
import requests

import lorrycontroller
from . import hosts


class GitanoCommandFailure(Exception):

    def __init__(self, trovehost, command, stderr):
        Exception.__init__(
            self,
            'Failed to run "%s" on Gitano on %s\n%s' %
            (command, trovehost, stderr))


class GitanoCommand(object):

    '''Run a Gitano command on a Trove.'''

    def __init__(self, trovehost, protocol, username, password):
        self.trovehost = trovehost
        self.protocol = protocol
        self.username = username
        self.password = password

        if protocol == 'ssh':
            self._command = self._ssh_command
        elif protocol in ('http', 'https'):
            self._command = self._http_command
        else:
            raise GitanoCommandFailure(
                self.trovehost, '__init__', 'unknown protocol %s' % protocol)

    def whoami(self):
        return self._command(['whoami'])

    def create(self, repo_path):
        self._command(['create', repo_path])

    def get_gitano_config(self, repo_path):
        stdout = self._command(['config', repo_path, 'show'])

        # "config REPO show" outputs a sequence of lines of the form "key: value".
        # Extract those into a collections.defaultdict.

        result = collections.defaultdict(str)
        for line in stdout.splitlines():
            m = re.match(r'^([^:])+:\s*(.*)$', line)
            if m:
                result[m.group(0)] = m.group(1).strip()

        return result

    def set_gitano_config(self, path, key, value):
        self._command(['config', path, 'set', key, value])

    def ls(self):
        return self._command(['ls'])

    def _ssh_command(self, gitano_args):
        quoted_args = [cliapp.shell_quote(x) for x in gitano_args]

        base_argv = [
            'ssh',
            '-oStrictHostKeyChecking=no',
            '-oBatchMode=yes',
             'git@%s' % self.trovehost,
            ]

        exit, stdout, stderr = cliapp.runcmd_unchecked(
            base_argv + quoted_args)
        if isinstance(stdout, bytes):
            stdout = stdout.decode('utf-8', errors='replace')
            stderr = stderr.decode('utf-8', errors='replace')

        if exit != 0:
            logging.error(
                'Failed to run "%s" for %s:\n%s',
                quoted_args, self.trovehost, stdout + stderr)
            raise GitanoCommandFailure(
                self.trovehost,
                ' '.join(gitano_args),
                stdout + stderr)

        return stdout

    def _http_command(self, gitano_args):
        quoted_args = urllib.parse.quote(' '.join(gitano_args))
        url = urllib.parse.urlunsplit((
            self.protocol,
            self.trovehost,
            '/gitano-command.cgi',
            'cmd=%s' % quoted_args,
            ''))
        logging.debug('url=%r', url)

        try:
            if self.username and self.password:
                response = requests.get(url, auth=(self.username,
                                                   self.password))
            else:
                response = requests.get(url)
        except (requests.exceptions.RequestException) as e:
            raise GitanoCommandFailure(
                self.trovehost, ' '.join(gitano_args), str(e))

        return response.text


class LocalTroveGitanoCommand(GitanoCommand):

    '''Run commands on the local Trove's Gitano.

    This is a version of the GitanoCommand class specifically for
    accessing the local Trove's Gitano.

    '''

    def __init__(self):
        GitanoCommand.__init__(self, 'localhost', 'ssh', '', '')



def new_gitano_command(statedb, trovehost):
    trove_info = statedb.get_trove_info(trovehost)
    return lorrycontroller.GitanoCommand(
        trovehost,
        trove_info['protocol'],
        trove_info['username'],
        trove_info['password'])


class GitanoDownstream(hosts.DownstreamHost):
    def __init__(self, app_settings):
        self._gitano = LocalTroveGitanoCommand()

    def prepare_repo(self, repo_path, metadata):
        # Create repository on local Trove. If it fails, assume
        # it failed because the repository already existed, and
        # ignore the failure (but log message).

        try:
            self._gitano.create(repo_path)
        except GitanoCommandFailure as e:
            logging.debug(
                'Ignoring error creating %s on local Trove: %s',
                repo_path, e)
        else:
            logging.info('Created %s on local repo', repo_path)

        try:
            local_config = self._gitano.get_gitano_config(repo_path)
            if 'head' in metadata \
               and metadata['head'] != local_config['project.head']:
                self._gitano.set_gitano_config(repo_path,
                                               'project.head',
                                               metadata['head'])
            if 'description' in metadata \
               and metadata['description'] != \
                   local_config['project.description']:
                self._gitano.set_gitano_config(repo_path,
                                               'project.description',
                                               metadata['description'])
        except GitanoCommandFailure as e:
            logging.error('ERROR: %s' % str(e))
            # FIXME: We need a good way to report these errors to the
            # user. However, we probably don't want to fail the
            # request, so that's not the way to do this. Needs
            # thinking.