File: test_push.py

package info (click to toggle)
ostree-push 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 440 kB
  • sloc: python: 3,650; makefile: 10
file content (530 lines) | stat: -rw-r--r-- 20,980 bytes parent folder | download
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
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
from otpush import push

import argparse
from gi.repository import GLib, Gio
import logging
import json
import os
from pathlib import Path
import pytest
import re
import socket
import subprocess
from urllib.error import HTTPError
from urllib.request import urlopen

from .util import (
    TESTSDIR,
    needs_sshd,
    random_commit,
    TmpRepo,
)

logger = logging.getLogger(__name__)


class TestRepoServer:
    def populate_repo(self):
        self.repo.mkdir()
        sub = self.repo / 'sub'
        sub.mkdir()
        with open(self.repo / 'a', 'w') as f:
            f.write('foo')
        with open(sub / 'b', 'w') as f:
            f.write('bar')

    def check_server(self):
        assert self.server.path == self.repo
        assert self.server.proc.pid > 0
        assert self.server.address[0] == '127.0.0.1'
        assert self.server.address[1] > 0
        assert self.server.url.startswith('http://127.0.0.1:')
        with urlopen(f'{self.server.url}/a') as resp:
            assert resp.read().decode('utf-8') == 'foo'
        with urlopen(f'{self.server.url}/sub/b') as resp:
            assert resp.read().decode('utf-8') == 'bar'
        with pytest.raises(HTTPError) as excinfo:
            urlopen(f'{self.server.url}/missing')
        assert excinfo.value.getcode() == 404

    def test_missing(self, tmp_path):
        # Nonexistent directory should fail
        repo = tmp_path / 'repo'
        server = None
        with pytest.raises(ValueError) as excinfo:
            server = push.RepoServer(repo)
        assert str(excinfo.value) == f'{repo} is not a directory'
        assert server is None

    def test_non_context(self, tmp_path):
        # Without context manager
        self.repo = tmp_path / 'repo'
        self.populate_repo()

        self.server = push.RepoServer(self.repo)
        assert self.server.path == self.repo
        assert self.server.proc is None
        assert self.server.address is None
        assert self.server.url is None

        # This should do nothing
        self.server.stop()

        # Make sure to clean up so the tests don't hang if there are failures
        try:
            self.server.start()
            self.check_server()
            self.server.stop()
        finally:
            self.server.stop()

    def test_context(self, tmp_path):
        self.repo = tmp_path / 'repo'
        self.populate_repo()
        with push.RepoServer(self.repo) as self.server:
            self.check_server()

    def test_pull(self, tmp_path, tmp_files_path):
        local_repo = TmpRepo(tmp_path / 'local')
        remote_repo = TmpRepo(tmp_path / 'remote')
        random_commit(remote_repo, tmp_files_path, 'test')
        _, remote_refs = remote_repo.list_refs()

        with push.RepoServer(str(remote_repo.path)) as remote_server:
            repo_options = GLib.Variant('a{sv}', {
                'gpg-verify': GLib.Variant('b', False),
                'gpg-verify-summary': GLib.Variant('b', False),
            })
            local_repo.remote_add('origin', remote_server.url, repo_options)

            # Pulling a missing ref should fail
            pull_options = GLib.Variant('a{sv}', {
                'refs': GLib.Variant('as', ['missing']),
            })
            with pytest.raises(GLib.Error) as excinfo:
                local_repo.pull_with_options('origin', pull_options)
            assert excinfo.value.matches(Gio.io_error_quark(),
                                         Gio.IOErrorEnum.NOT_FOUND)
            _, local_refs = local_repo.list_refs()
            assert local_refs == {}

            # Pulling the existing ref should succeed
            pull_options = GLib.Variant('a{sv}', {
                'refs': GLib.Variant('as', ['test']),
            })
            local_repo.pull_with_options('origin', pull_options)
            _, local_refs = local_repo.list_refs()
            assert local_refs == {'origin:test': remote_refs['test']}

            # Pulling with all refs should fail because no branches were
            # setup in the configuration
            local_repo.set_ref_immediate('origin', 'test', None)
            _, local_refs = local_repo.list_refs()
            assert local_refs == {}
            pull_options = GLib.Variant('a{sv}', {})
            with pytest.raises(GLib.Error) as excinfo:
                local_repo.pull_with_options('origin', pull_options)
            assert excinfo.value.matches(Gio.io_error_quark(),
                                         Gio.IOErrorEnum.FAILED)
            assert ('No configured branches for remote origin'
                    in str(excinfo.value))
            assert local_refs == {}


@needs_sshd
class TestSSHMultiplexer:
    def test_socket_exists(self, sshd, ssh_options, ssh_socket):
        ssh = push.SSHMultiplexer(sshd.address, ssh_socket, ssh_options,
                                  port=sshd.port)
        with open(ssh_socket, 'w'):
            pass
        with pytest.raises(push.OTPushError) as excinfo:
            ssh.start()
        assert str(excinfo.value) == f'Socket {ssh_socket} already exists'

    def test_master_non_context(self, sshd, ssh_options, ssh_socket):
        ssh = push.SSHMultiplexer(sshd.address, ssh_socket, ssh_options,
                                  port=sshd.port)

        # Stopping without starting should do nothing
        assert ssh.master_proc is None
        assert not os.path.exists(ssh_socket)
        ssh.stop()

        try:
            ssh.start()
            assert ssh.master_proc.pid > 0
            assert os.path.exists(ssh_socket)

            with pytest.raises(push.OTPushError) as excinfo:
                ssh.start()
            assert str(excinfo.value).startswith(
                'SSH master process already running')
        finally:
            ssh.stop()

    def test_master_context(self, sshd, ssh_options, ssh_socket):
        with push.SSHMultiplexer(sshd.address, ssh_socket, ssh_options,
                                 port=sshd.port) as ssh:
            assert ssh.master_proc.pid > 0
            assert os.path.exists(ssh_socket)

    def test_forward_port(self, sshd, ssh_options, ssh_socket):
        sock1 = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0)
        sock1.bind(('127.0.0.1', 0))
        sock1_port = sock1.getsockname()[1]
        assert sock1_port > 0

        ssh = push.SSHMultiplexer(sshd.address, ssh_socket, ssh_options,
                                  port=sshd.port)
        with pytest.raises(push.OTPushError) as excinfo:
            ssh.forward_port(sock1_port)
        assert str(excinfo.value) == 'SSH master process not running'
        assert ssh.master_proc is None

        with push.SSHMultiplexer(sshd.address, ssh_socket, ssh_options,
                                 port=sshd.port) as ssh:
            sock2_port = ssh.forward_port(sock1_port)
            assert sock2_port > 0

            sock3 = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0)
            sock3.connect(('127.0.0.1', sock2_port))

    def test_run(self, tmp_path, sshd, ssh_options, ssh_socket):
        ssh = push.SSHMultiplexer(sshd.address, ssh_socket, ssh_options,
                                  port=sshd.port)
        with pytest.raises(push.OTPushError) as excinfo:
            ssh.run(['true'])
        assert str(excinfo.value) == 'SSH master process not running'
        assert ssh.master_proc is None

        with push.SSHMultiplexer(sshd.address, ssh_socket, ssh_options,
                                 port=sshd.port) as ssh:
            test_file = tmp_path / 'test_file'
            assert not os.path.exists(test_file)
            ssh.run(['touch', str(test_file)])
            assert os.path.exists(test_file)

            with pytest.raises(subprocess.CalledProcessError,
                               match='returned non-zero exit status 1'):
                ssh.run(['rmdir', str(tmp_path)])


@needs_sshd
class TestPushRefs:
    DUMPENV_PATH = os.path.join(TESTSDIR, 'dumpenv')

    def push_refs(self, source_repo, dest_repo, sshd, ssh_options, capfd,
                  refs=None, dry_run=False):
        """Run push.push_refs and check the remote command is correct"""
        dest = push.PushDest(host=sshd.address, port=sshd.port,
                             repo=str(dest_repo.path), user=None)
        push.push_refs(source_repo, dest, refs=refs, dry_run=dry_run,
                       ssh_options=ssh_options, commands=['dumpenv'])

        out, _ = capfd.readouterr()
        data = json.loads(out)
        args = data['args']

        num_args = len(args)
        num_refs = len(refs) if refs else 0
        expected_num_args = num_refs + 3
        if dry_run:
            expected_num_args += 1
        assert num_args == expected_num_args

        args_iter = iter(args)
        assert next(args_iter) == self.DUMPENV_PATH
        if dry_run:
            assert next(args_iter) == '-n'
        assert next(args_iter) == str(dest_repo.path)
        assert next(args_iter).startswith('http://127.0.0.1:')
        remaining = list(args_iter)
        if refs:
            assert remaining == refs
        else:
            assert remaining == []

    def test_no_refs(self, source_repo, dest_repo, sshd, ssh_options,
                     tmp_files_path, capfd):
        self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd,
                       refs=None)

        self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd,
                       refs=[])

    def test_refs(self, source_repo, dest_repo, sshd, ssh_options,
                  tmp_files_path, capfd):
        random_commit(source_repo, tmp_files_path, 'test1')
        random_commit(source_repo, tmp_files_path, 'test2')
        self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd,
                       refs=['test1'])
        self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd,
                       refs=['test2'])
        self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd,
                       refs=['test1', 'test2'])

    def test_missing_ref(self, source_repo, dest_repo, sshd, ssh_options,
                         tmp_files_path, capfd):
        random_commit(source_repo, tmp_files_path, 'test')
        with pytest.raises(push.OTPushError) as excinfo:
            self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd,
                           refs=['missing'])
        assert str(excinfo.value) == \
            f'Refs missing not found in {source_repo.path}'
        with pytest.raises(push.OTPushError) as excinfo:
            self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd,
                           refs=['test', 'missing'])
        assert str(excinfo.value) == \
            f'Refs missing not found in {source_repo.path}'

    def test_summary(self, source_repo, dest_repo, sshd, ssh_options,
                     tmp_files_path, capfd):
        summary = Path(source_repo.path) / 'summary'
        random_commit(source_repo, tmp_files_path, 'test')

        # Delete the summary file and check that it gets generated.
        summary.unlink()
        self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd)
        assert summary.exists()

        # Set the summary mtime behind the repo and check that it gets
        # regenerated.
        repo_mtime = os.path.getmtime(source_repo.path)
        os.utime(summary, (repo_mtime - 1, repo_mtime - 1))
        orig_summary_mtime = summary.stat().st_mtime
        assert orig_summary_mtime < repo_mtime
        self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd)
        assert summary.exists()
        new_summary_mtime = summary.stat().st_mtime
        assert new_summary_mtime > orig_summary_mtime

    def test_dry_run(self, source_repo, dest_repo, sshd, ssh_options,
                     tmp_files_path, capfd):
        self.push_refs(source_repo, dest_repo, sshd, ssh_options, capfd,
                       dry_run=True)

    def test_commands(self, source_repo, dest_repo, sshd, ssh_options,
                      tmp_path):
        dest = push.PushDest(
            host=sshd.address,
            port=sshd.port,
            repo=str(dest_repo.path),
            user=None,
        )
        nonexistent = str(tmp_path / 'nonexistent')

        # Only specifying missing commands should fail.
        with pytest.raises(push.OTPushError) as excinfo:
            push.push_refs(
                source_repo,
                dest,
                ssh_options=ssh_options,
                commands=[nonexistent],
            )
        assert str(excinfo.value) == (
            f'Could not find commands {nonexistent} on server'
        )

        # Specifying a successful command as a fallback should succeed.
        push.push_refs(
            source_repo,
            dest,
            ssh_options=ssh_options,
            commands=[nonexistent, 'dumpenv'],
        )


class TestParseDest:
    def test_bad_scheme(self):
        for scheme in ('http', 'ftp', 'scp', 'blah'):
            with pytest.raises(
                    ValueError,
                    match=f'Destination scheme "{scheme}" not allowed'):
                push.parse_dest(f'{scheme}://host/repo')

    def test_missing_repo(self):
        for dest in ('ssh://', 'http://', 'host:', 'user@host:'):
            with pytest.raises(ValueError, match='Destination repo missing'):
                push.parse_dest('host:')

    def test_empty_dest(self):
        with pytest.raises(ValueError,
                           match='Destination not in form "host:repo"'):
            push.parse_dest('')

    def test_missing_host(self):
        for dest in (':', ':repo', ':/path/:/repo'):
            with pytest.raises(ValueError, match='Destination host missing'):
                push.parse_dest(dest)

    def test_invalid_host(self):
        for dest in ('@:repo', '@host:repo', 'user@:repo'):
            with pytest.raises(ValueError, match='Invalid destination host'):
                push.parse_dest(dest)

    def test_invalid_port(self):
        match = re.compile(
            r'(Port could not be cast to integer|invalid literal for int)'
        )
        for dest in ('ssh://host:port/repo', 'ssh://host:$/repo'):
            with pytest.raises(ValueError, match=match):
                push.parse_dest(dest)

    def test_good_dest(self):
        cases = (
            ('ssh://host/repo',
             push.PushDest(host='host', repo='/repo', user=None, port=None)),
            ('ssh://host.example.com/repo',
             push.PushDest(host='host.example.com', repo='/repo', user=None,
                           port=None)),
            ('ssh://host/path/to/repo/',
             push.PushDest(host='host', repo='/path/to/repo/', user=None,
                           port=None)),
            ('ssh://host/path/:/repo',
             push.PushDest(host='host', repo='/path/:/repo', user=None,
                           port=None)),
            ('ssh://user@host/repo',
             push.PushDest(host='host', user='user', repo='/repo', port=None)),
            ('ssh://host:22/repo',
             push.PushDest(host='host', port=22, repo='/repo', user=None)),
            ('host:repo',
             push.PushDest(host='host', repo='repo', user=None, port=None)),
            ('host:path/to/repo',
             push.PushDest(host='host', repo='path/to/repo', user=None,
                           port=None)),
            ('host:/repo',
             push.PushDest(host='host', repo='/repo', user=None, port=None)),
            ('host:/path/:/repo',
             push.PushDest(host='host', repo='/path/:/repo', user=None,
                           port=None)),
            ('user@host:repo',
             push.PushDest(host='host', user='user', repo='repo', port=None)),
            ('user@host.example.com:path/to/repo',
             push.PushDest(host='host.example.com', user='user',
                           repo='path/to/repo', port=None)),
        )

        for arg, expected in cases:
            dest = push.parse_dest(arg)
            assert dest == expected


class TestArgParser:
    def test_no_dest(self, capsys):
        ap = push.OTPushArgParser()
        with pytest.raises(SystemExit) as excinfo:
            ap.parse_args([])
        assert excinfo.value.code == 2
        out, err = capsys.readouterr()
        assert out == ''
        assert err.endswith('error: the following arguments are required: '
                            'DEST\n')

    def test_defaults(self):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['host:repo'])
        assert args == argparse.Namespace(
            commands=None,
            dest=push.PushDest(host='host', repo='repo', user=None, port=None),
            dry_run=False,
            log_level=logging.INFO,
            port=None,
            refs=[],
            repo=None,
            ssh_options=[],
        )

    def test_dest(self):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['host:repo'])
        assert args.dest == push.PushDest(host='host', repo='repo',
                                          user=None, port=None)
        args = ap.parse_args(['user@host:repo'])
        assert args.dest == push.PushDest(host='host', user='user',
                                          repo='repo', port=None)
        args = ap.parse_args(['ssh://user@host/repo'])
        assert args.dest == push.PushDest(host='host', user='user',
                                          repo='/repo', port=None)
        args = ap.parse_args(['ssh://user@host:1234/repo'])
        assert args.dest == push.PushDest(host='host', user='user',
                                          port=1234, repo='/repo')

    def test_refs(self):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['host:repo', 'foo'])
        assert args.refs == ['foo']
        args = ap.parse_args(['host:repo', 'foo', 'bar', 'baz'])
        assert args.refs == ['foo', 'bar', 'baz']

    def test_port(self, capsys):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['-p', '22', 'host:repo'])
        assert args.port == 22

        with pytest.raises(SystemExit) as excinfo:
            ap.parse_args(['-p', 'foo', 'host:repo'])
        assert excinfo.value.code == 2
        out, err = capsys.readouterr()
        assert out == ''
        assert err.endswith("invalid int value: 'foo'\n")

    def test_port_and_dest_port(self):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['-p', '22', 'ssh://host:2200/repo'])
        assert args.port == 22
        assert args.dest.port == 22

    def test_dry_run(self):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['-n', 'host:repo'])
        assert args.dry_run is True
        args = ap.parse_args(['--dry-run', 'host:repo'])
        assert args.dry_run is True

    def test_log_level(self):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['-v', 'host:repo'])
        assert args.log_level == logging.DEBUG
        args = ap.parse_args(['--verbose', 'host:repo'])
        assert args.log_level == logging.DEBUG
        args = ap.parse_args(['-q', 'host:repo'])
        assert args.log_level == logging.WARNING
        args = ap.parse_args(['--quiet', 'host:repo'])
        assert args.log_level == logging.WARNING

    def test_repo(self):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['--repo', '/repo', 'host:repo'])
        assert args.repo == '/repo'

    def test_commands(self):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['--command=ls', 'host:repo'])
        assert args.commands == ['ls']
        args = ap.parse_args(['--command=ostree-receive', 'host:repo'])
        assert args.commands == ['ostree-receive']
        args = ap.parse_args(['--command', '/path/to/ostree-receive',
                              'host:repo'])
        assert args.commands == ['/path/to/ostree-receive']
        args = ap.parse_args(['--command=foo', '--command=bar', 'host:repo'])
        assert args.commands == ['foo', 'bar']

    def test_ssh_options(self, capsys):
        ap = push.OTPushArgParser()
        args = ap.parse_args(['-ifoo', 'host:repo'])
        assert args.ssh_options == ['-i', 'foo']
        args = ap.parse_args(['-i', 'foo', 'host:repo'])
        assert args.ssh_options == ['-i', 'foo']
        args = ap.parse_args(['-o', 'Foo=yes', 'host:repo'])
        assert args.ssh_options == ['-o', 'Foo=yes']
        args = ap.parse_args(['-o', 'Foo=yes', '-o', 'Bar=no',
                              'host:repo'])
        assert args.ssh_options == ['-o', 'Foo=yes', '-o', 'Bar=no']

        with pytest.raises(SystemExit) as excinfo:
            ap.parse_args(['-ifoo', '-ibar', 'host:repo'])
        assert excinfo.value.code == 2
        out, err = capsys.readouterr()
        assert out == ''
        assert err.endswith('Option -i can only be specified once\n')