heptapod.py 8.59 KB
Newer Older
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
from io import BytesIO
import logging
from pathlib import Path
import requests
import selenium.webdriver
import subprocess
import sys
import tarfile
import time
from urllib.parse import urlparse

from tests.utils.user import User
from tests.utils import docker
from tests.utils import session

logger = logging.getLogger(__name__)

INITIAL_TIMEOUT = 300  # seconds

BRANCH_PROTECTIONS = dict(none=0,
                          dev_can_push=1,
                          full=2,
                          dev_can_merge=3,
                          )


class Heptapod:

    def __init__(self, url, ssh_port):
        self.parsed_url = urlparse(url)
        self.url = url
        self.ssh_port = ssh_port
        self.users = {}
        self.dead = None

    @property
    def host(self):
        return self.parsed_url.netloc.rsplit(':', 1)[0]

    @property
    def api_url(self):
        return '/'.join((self.url, 'api', 'v4'))

    @property
    def root_token_headers(self):
        return {'Private-Token': self.users['root']['token']}

    @property
    def basic_user_token_headers(self):
        return {'Private-Token': self.users['test_basic']['token']}

    def prepare(self, root_password):
        """Make all preparations for the Heptapod instance to be testable.

        This currently amounts to

        - defining the root password
        - activating and retrieving a root API token
        - creating a persistent `test_basic` user
        - activating and retrieving an API token for `test_basic`
        - keeping a logged in webdriver for each persistent user
        """
        dead_msg = ("Heptapod server did not "
                    "respond in %s seconds" % INITIAL_TIMEOUT)
        assert not self.dead, dead_msg

        if self.dead is None:
            start = time.time()
            while True:
                if time.time() > start + INITIAL_TIMEOUT:
                    self.dead = True
                    raise AssertionError(dead_msg)
                try:
                    resp = requests.get(self.url, allow_redirects=False)
                except IOError:
                    resp = None
                if resp is None:
                    logger.debug("Couldn't reach Heptapod")
                elif resp.status_code >= 400:
                    logger.debug("Heptapod response code %r", resp.status_code)
                else:
                    logger.info("Heptapod is up, proceeding with tests.\n")
                    self.dead = False
                    break

                duration = 1
                logger.debug("Retrying in %.1f seconds", duration)
                time.sleep(duration)

        root = self.users['root'] = {}
        options = selenium.webdriver.ChromeOptions()
        options.add_argument('--headless')
        driver = selenium.webdriver.Chrome(options=options)
        # guaranteeing driver to be available for teardown as soon as created
        root['webdriver'] = driver
        session.login_as_root(driver, self, root_password)
        self.set_application_settings(
            default_branch_protection=BRANCH_PROTECTIONS['none'])
        basic, driver = session.ensure_user(self, 'test_basic',
                                            fullname='Bäsîc Test',
                                            password='test_basic')
        self.users[basic.name]['id'] = basic.id
        self.users[basic.name]['webdriver'] = driver
        self.load_ssh_keys()
        self.upload_ssh_pub_keys()
        subprocess.call((
            'ssh-keygen',
            '-R', '[{host}]:{port}'.format(
                host=self.host, port=self.ssh_port)))

    def set_application_settings(self, **settings):
        resp = requests.put(
            self.api_url + '/application/settings',
            headers=self.root_token_headers,
            data=settings,
        )
        assert resp.status_code == 200

    def load_ssh_keys(self):
        """Load client-side information to use SSH keys

        Also makes sure the keys are actually usable (perms)
        """
        ssh_dir = Path(__file__).parent.parent / 'data' / 'ssh'
        for name, info in self.users.items():
            base_fname = 'id_rsa_heptapod_' + name
            priv = ssh_dir / base_fname
            pub = ssh_dir / (base_fname + '.pub')

            # VCSes tend not to preserve non-executable perm bits
            priv.chmod(0o600)
            info['ssh'] = dict(priv=str(priv), pub=pub.read_text())

    def upload_ssh_pub_keys(self):
        """Upload SSH public keys for all users to Heptapod."""
        # it's really time to put the actual user object in our `self.users`
        for name, info in self.users.items():
            user = User.search(self, name)
            user.ensure_ssh_pub_key(info['ssh']['pub'])

    def close(self):
        if self.dead is not False:
            return
        for user in self.users.values():
            driver = user.get('webdriver')
            if driver is not None:
                driver.close()


class DockerHeptapod(Heptapod):

    repositories_root = '/var/opt/gitlab/git-data/repositories'

    def __init__(self, docker_container, **kw):
        super(DockerHeptapod, self).__init__(**kw)
        self.docker_container = docker_container

    @property
    def ssh_url(self):
        return 'ssh://git@{host}:{port}'.format(
            host=self.host,
            port=self.ssh_port,
        )

    def execute(self, command, user='root'):
        return docker.heptapod_exec(self.docker_container, command, user=user)

    def run_shell(self, command):
        return docker.heptapod_run_shell(self.docker_container, command)

    def put_archive(self, dest, path, owner='git'):
        res = docker.heptapod_put_archive(self.docker_container, dest, path)
        self.run_shell(['chown', '-R', 'git:root', dest])
        return res

    def put_archive_bin(self, dest, fobj):
        return docker.heptapod_put_archive_bin(
            self.docker_container, dest, fobj)

    def get_archive(self, path, tarf):
        return docker.heptapod_get_archive(self.docker_container, path, tarf)

    def put_file_lines(self, path, lines, uid=998, gid=998):
        dirpath, filename = path.rsplit('/', 1)
        tar_buf = BytesIO()
        tarf = tarfile.open(mode='w:', fileobj=tar_buf)

        tinfo = tarfile.TarInfo(name='hgrc')
        contents_buf = BytesIO()
        contents_buf.writelines(l.encode() for l in lines)
        tinfo.size = contents_buf.tell()
        tinfo.uid, tinfo.gid = uid, gid
        contents_buf.seek(0)
        tarf.addfile(tinfo, fileobj=contents_buf)

        tar_buf.seek(0)
        self.put_archive_bin(dirpath, tar_buf)

    def get_file_lines(self, path):
        dirname, filename = path.rsplit('/', 1)
        buf = BytesIO()
        self.get_archive(path, buf)
        buf.seek(0)
        tarf = tarfile.open(mode='r:', fileobj=buf)
        return [l.decode() for l in tarf.extractfile(filename).readlines()]


class SourceHeptapod(Heptapod):

    @property
    def ssh_url(self):
        return 'ssh://{host}:{port}'.format(
            host=self.host,
            port=self.ssh_port,
        )

    def __init__(self, repositories_root, **kw):
        super(SourceHeptapod, self).__init__(**kw)
        self.repositories_root = repositories_root

    def execute(self, command, user='git'):
        if user != 'git':
            raise NotImplementedError(
                "On source Heptapod, only same user as for Rails and HgServe "
                "is allowed")
        process = subprocess.Popen(command,
                                   stdout=subprocess.PIPE,
                                   stderr=subprocess.PIPE)
        out, err = [o.decode() for o in process.communicate()]
        retcode = process.poll()

        if out:
            sys.stdout.write(out)
        if err:
            sys.stderr.write(err)
        return retcode, out

    def run_shell(self, command):
        exit_code, output = self.execute(command)
        if exit_code != 0:
            raise RuntimeError(
                ('Heptapod command {command} returned a non-zero '
                 'exit code {exit_code}').format(
                     command=command,
                     exit_code=exit_code,
                 ))

    def put_archive(self, dest, path, owner='git'):
        if owner != 'git':
            raise NotImplementedError(
                "On source Heptapod, only same owner as for Rails and HgServe "
                "is allowed")
        subprocess.check_call(['tar', 'xf', path], cwd=dest)

    def get_file_lines(self, path):
        with open(path, 'r') as fobj:
            return fobj.readlines()

    def put_file_lines(self, path, lines):
        with open(path, 'w') as fobj:
            fobj.writelines(lines)