heptapod.py 18.6 KB
Newer Older
1
import contextlib
2
import json
3
4
from io import BytesIO
import logging
5
import os
6
7
8
from pathlib import Path
import requests
import selenium.webdriver
9
import shutil
10
11
12
13
14
15
16
17
18
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
19
from .constants import DATA_DIR
20
21
22

logger = logging.getLogger(__name__)

23
INITIAL_TIMEOUT = 600  # seconds
24
25
26
27
28
29
30
31
32

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


class Heptapod:
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
    """Base class and minimum common control of Heptapod server.

    This is used directly in case `--heptapod-remote` is selected.
    """

    fs_access = False
    """True if manipulation of files is possible.

    Implies :attr:`repositories_root` not to be None.
    """

    shell_access = False
    """True if running arbitrary commands as in a shell is possible."""

    repositories_root = None
    """Path to the repositories, from the Heptapod server point of view.

    This is potentially not meaningful on the system that runs the test,
    see :class:`DockerHeptapod` for an example.
    """
53

54
55
56
57
    reverse_call_host = None
    """Network address for the system running these tests, seen from Heptapod.
    """

58
59
60
    webdriver_remote_url = None
    """URL for a Selenium RemoteWebDriver."""

61
62
63
64
    wait_after_first_response = 0
    """Time to wait after we've had a first non error HTTP response.
    """

65
66
    def __init__(self, url, ssh_user, ssh_port,
                 reverse_call_host=None,
67
                 wait_after_first_response=0,
68
                 webdriver_remote_url=None):
69
70
71
        self.parsed_url = urlparse(url)
        self.url = url
        self.ssh_port = ssh_port
72
        self.ssh_user = ssh_user
73
        self.users = {}
74
75
        if reverse_call_host is not None:
            self.reverse_call_host = reverse_call_host
76
        self.dead = None
77
        self.webdriver_remote_url = webdriver_remote_url
78
        self.wait_after_first_response = wait_after_first_response
79
        self.settings = {}
80

81
82
83
84
    @property
    def heptapod(self):
        return self

85
86
    @property
    def ssh_url(self):
87
        return 'ssh://{user}@{host}:{port}'.format(
88
            host=self.host,
89
            user=self.ssh_user,
90
91
92
            port=self.ssh_port,
        )

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
    @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']}

109
110
111
112
113
114
115
116
117
118
119
    def new_webdriver(self):
        options = selenium.webdriver.ChromeOptions()
        options.add_argument('--headless')
        if self.webdriver_remote_url:
            return selenium.webdriver.Remote(
                command_executor=self.webdriver_remote_url,
                options=options
            )
        else:
            return selenium.webdriver.Chrome(options=options)

120
121
122
    def get_user_webdriver(self, user_name):
        return self.users[user_name]['webdriver']

123
124
125
126
127
128
129
130
131
132
133
    def wait_startup(self, first_response_timeout=INITIAL_TIMEOUT,
                     wait_after_first_response=None):
        """Wait for Heptapod to be ready after startup.

        We have to take into account that the server may have just started
        (that's frequent in development and it's annoying for a human to
        wait) or could even be starting from scratch, configuring itself,
        creating the DB schema etc. (typical of CI).
        In that latter case, an amount of extra wait after the first successful
        HTTP response is often needed.
        """
134
        logger.info("Waiting for Heptapod to answer requests")
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
        dead_msg = ("Heptapod server did not "
                    "respond in %s seconds" % first_response_timeout)
        start = time.time()
        while time.time() < start + first_response_timeout:
            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")
                self.dead = False
                if wait_after_first_response:
                    logger.info("Waiting additional %d seconds "
                                "after first successful HTTP call",
                                wait_after_first_response)
                    time.sleep(wait_after_first_response)
                return

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

        self.dead = True
        raise AssertionError(dead_msg)

165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
    def instance_cache_file(self):
        return os.path.join(DATA_DIR, 'instance.cache')

    def load_instance_cache(self):
        path = self.instance_cache_file()
        try:
            with open(path) as cachef:
                cached = json.load(cachef)

        except Exception:
            logger.info("Cache file %r not available or not readable. "
                        "Heptapod instance info will be retrieved "
                        "or initialized", path)
        else:
            for name, info in cached['users'].items():
                self.users[name] = dict(name=name,
                                        token=info['token'])

    def update_instance_cache(self):
        users = {name: dict(token=info['token'])
                 for name, info in self.users.items()}
        with open(self.instance_cache_file(), 'w') as cachef:
            json.dump(dict(users=users), cachef)

189
190
191
192
193
194
195
196
197
198
199
    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
        """
200
        assert not self.dead, "Heptapod server marked dead by previous test."
201
202

        if self.dead is None:
203
204
            self.wait_startup(
                wait_after_first_response=self.wait_after_first_response)
205
206
        self.load_instance_cache()

207
        logger.info("Preparing root user.")
208
        start = time.time()
209
        root = self.users.setdefault('root', {})
210
        driver = self.new_webdriver()
211
212
213
        # guaranteeing driver to be available for teardown as soon as created
        root['webdriver'] = driver
        session.login_as_root(driver, self, root_password)
214

215
        logger.info("Preparing application settings.")
216
217
218
219
        # necessary if we want to listen to web hooks from these tests
        # in GitLab v12.2.0, this is deprecated for ...from_web_hooks...
        self.set_application_settings(
            allow_local_requests_from_hooks_and_services="true")
220
221

        logger.info("Preparing basic user.")
222
223
224
225
        basic, driver = session.ensure_user(self, 'test_basic',
                                            fullname='Bäsîc Test',
                                            password='test_basic')
        self.users[basic.name]['webdriver'] = driver
226
227

        logger.info("Uploading users SSH keys.")
228
229
230
231
232
233
        self.load_ssh_keys()
        self.upload_ssh_pub_keys()
        subprocess.call((
            'ssh-keygen',
            '-R', '[{host}]:{port}'.format(
                host=self.host, port=self.ssh_port)))
234
        self.update_instance_cache()
235
236
        logger.info("All preparations done in %.2f seconds. "
                    "Proceeding with tests.", time.time() - start)
237

238
239
    def restart_rails(self):
        logger.info("Restarting the Rails application.")
240
        self.ctl_services('restart', self.RAILS_SERVICES)
241
242
        self.wait_startup()

243
    def set_application_settings(self, **settings):
244
        """Change GitLab application settings and update :attr:`settings`."""
245
246
247
248
249
250
        resp = requests.put(
            self.api_url + '/application/settings',
            headers=self.root_token_headers,
            data=settings,
        )
        assert resp.status_code == 200
251
252
253
254
255
256
257
258
259
260
        self.settings = resp.json()

    def sync_application_settings(self):
        """Update :attr:`settings` for current values"""
        resp = requests.get(
            self.api_url + '/application/settings',
            headers=self.root_token_headers,
        )
        assert resp.status_code == 200
        self.settings = resp.json()
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291

    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()

292
    def run_shell(self, command, **kw):
293
294
295
296
297
298
299
        raise NotImplementedError('run_shell')

    def force_remove_route(self, route_path, source_type='Project'):
        logger.error("Attempt to force-remove route %r, not implemented "
                     "for %r", route_path, self.__class__)
        raise NotImplementedError('force_remove_route')

300
301
302
    def rake(self, *args):
        """Call GitLab Rake"""
        raise NotImplementedError('rake')
303

304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
    def remove_all_backups(self):
        """Remove all existing backups with no impediment for new backups.
        """
        raise NotImplementedError('remove_all_backups')

    def backup_create(self, clean_previous=True):
        """Create a new backup

        :param bool clean_previous: if true, any previously existing backups
            are removed. This is handy so that the restore rake task knows
            which one to restore without any need to tell it.
        """
        if clean_previous:
            self.remove_all_backups()
        self.rake('gitlab:backup:create')

    @contextlib.contextmanager
321
    def backup_restore(self):
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
        """Context manager for backups restoration.

        This is a context manager as a way to provide resuming of the
        tests session on errors, in a convenient way for the caller.
        That means ensuring as much as possible that the server is running,
        maybe wait again for it, reinitialize passwords and tokens…
        """
        try:
            self.ctl_services('stop', self.RAILS_SERVICES)
            self.rake('gitlab:backup:restore', 'force=yes')
            self.ctl_services('start', self.RAILS_SERVICES)

            self.wait_startup()
            yield

        except Exception:
            # these are idempotent
            self.ctl_services('start', self.RAILS_SERVICES)

            # Worst case scenario, we lost all our data. We need to
            # reprepare the server for subsequent tests
            self.prepare(self.users['root']['password'])
            raise
345

346
347
348

class DockerHeptapod(Heptapod):

349
350
351
352
    fs_access = True

    shell_access = True

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

355
356
    RAILS_SERVICES = ('unicorn', 'sidekiq')

357
358
359
    def __init__(self, docker_container, **kw):
        super(DockerHeptapod, self).__init__(**kw)
        self.docker_container = docker_container
360
361
        if self.reverse_call_host is None:
            self.reverse_call_host = docker.host_address(docker_container)
362
363
364
365

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

366
367
    def run_shell(self, command, **kw):
        return docker.heptapod_run_shell(self.docker_container, command, **kw)
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404

    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()]

405
406
407
408
409
410
411
412
413
414
415
416
417
    def force_remove_route(self, route_path, source_type='Project'):
        """Delete a route from the database.

        Sometimes GitLab fails to clean Project routes after failed tests.
        """
        logger.warn("Cleaning up leftover route at %r", route_path)
        self.run_shell([
            'gitlab-psql', 'gitlabhq_production',
            '-c', "DELETE FROM routes "
            "WHERE source_type='%s' "
            "  AND path='%s'" % (source_type, route_path)
        ])

418
419
420
421
    def rake(self, *args):
        cmd = ['gitlab-rake']
        cmd.extend(args)
        self.run_shell(cmd, user='git')
422

423
    def remove_all_backups(self):
424
425
426
427
428
        # using find in order not to rely on shell expansion for *.tar
        self.run_shell(('find', '/var/opt/gitlab/backups',
                        '-name', '*.tar',
                        '-delete'))

429
430
431
    def ctl_services(self, command, services):
        for service in services:
            self.run_shell(('gitlab-ctl', command, service))
432

433
434
435
436
437
438
439
440
441
442
443
444
    def apply_hashed_storage_setting(self, hashed_storage):
        # TODO it would be tempting not to restart if the setting is already
        # at the wished value, but this currently cannot take into account
        # rollbacked values that aren't followed by a restart. This will
        # be more complicated and take more time than we can afford right now
        # to really make work.
        self.set_application_settings(hashed_storage_enabled=hashed_storage)
        self.restart_rails()
        # recheck that the setting is applied
        self.sync_application_settings()
        assert self.settings['hashed_storage_enabled'] is hashed_storage

445
446

class SourceHeptapod(Heptapod):
447
448
449
450
451
452
453
454
455
    """An Heptapod server installed from source on the same system.

    Same system means without using any container technology (Docker or
    otherwise) that would insulate the tests from the server.
    """

    fs_access = True

    shell_access = True
456

457
458
    reverse_call_host = 'localhost'

459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
    @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

487
488
    def run_shell(self, command, **kw):
        exit_code, output = self.execute(command, **kw)
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
        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)
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550


class GdkHeptapod(SourceHeptapod):
    """An Heptapod server running with the GDK.
    """

    fs_access = True

    shell_access = True

    reverse_call_host = 'localhost'

    RAILS_SERVICES = ('rails-web', 'rails-background-jobs')

    def __init__(self, gdk_root, **kw):
        self.gdk_root = gdk_root
        self.rails_root = os.path.join(gdk_root, 'gitlab')
        super(GdkHeptapod, self).__init__(
            repositories_root=os.path.join(gdk_root, 'repositories'),
            **kw)

    @property
    def backups_dir(self):
        return os.path.join(self.rails_root, 'tmp', 'backups')

    def remove_all_backups(self):
        if os.path.exists(self.backups_dir):
            shutil.rmtree(self.backups_dir)
        # as of GitLab 12.10, parent dir is always present
        os.mkdir(self.backups_dir)

    def rake(self, *args):
        cmd = ['bundle', 'exec', 'rake']
        cmd.extend(args)
        subprocess.check_call(cmd, cwd=self.rails_root)

    def ctl_services(self, command, services):
        for service in services:
            subprocess.check_call(('gdk', command, service),
                                  cwd=self.rails_root)