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
|
#!/usr/bin/env python3
#
# Copyright (C) VyOS Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# 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, see <http://www.gnu.org/licenses/>.
import os
import unittest
from base_vyostest_shim import VyOSUnitTestSHIM
from vyos.configsession import ConfigSessionError
from vyos.config_mgmt import ConfigMgmt
from vyos.config_mgmt import commit_hooks
from vyos.config_mgmt import commit_post_hook_dir
base_path = ['system', 'config-management']
archive_base = base_path + ['commit-archive', 'location']
archive_hook = os.path.join(commit_post_hook_dir, commit_hooks['commit_archive'])
class TestSystemConfigManagement(VyOSUnitTestSHIM.TestCase):
@classmethod
def setUpClass(cls):
super(TestSystemConfigManagement, cls).setUpClass()
# ensure we can also run this test on a live system - clean out any
# existing commit-archive configuration first
cls.cli_delete(cls, base_path)
def tearDown(self):
self.cli_delete(base_path)
self.cli_commit()
super().tearDown()
def test_01_commit_archive(self):
# The plain transports (scp/sftp/ssh/ftp/ftps/http/https/tftp) share the
# same URL builder, so a representative subset covers every branch:
# full auth+port+path, a bare server (no auth, default path), the
# git-specific 'git+<transport>' scheme with default and explicit
# transport, and an IPv6 literal. Each entry lists the set commands plus
# the URL it must produce
locations = {
# auth + port + explicit path
'scp-dest': (
[
['scp', 'authentication', 'username', 'bob'],
['scp', 'authentication', 'password', 's3cr3t'],
['scp', 'server', '192.0.2.1'],
['scp', 'port', '2222'],
['scp', 'path', '/backups'],
],
'scp://bob:s3cr3t@192.0.2.1:2222/backups',
),
# no auth, no port, default path
'tftp-dest': (
[['tftp', 'server', '192.0.2.8']],
'tftp://192.0.2.8/',
),
# ftp with a password but no username -> ':password@' (ftp falls
# back to anonymous/REMOTE_USERNAME for the user)
'ftp-passonly': (
[
['ftp', 'authentication', 'password', 's3cr3t'],
['ftp', 'server', '192.0.2.1'],
],
'ftp://:s3cr3t@192.0.2.1/',
),
# git, no transport -> defaults to git+https
'git-dest': (
[
['git', 'authentication', 'username', 'git'],
['git', 'authentication', 'password', 'token'],
['git', 'server', 'git.example.com'],
['git', 'path', '/repo.git'],
],
'git+https://git:token@git.example.com/repo.git',
),
# git with an explicit transport
'git-ssh-dest': (
[['git', 'transport', 'ssh'], ['git', 'server', 'git.example.com']],
'git+ssh://git.example.com/',
),
# IPv6 server literal -> bracketed in the netloc
'scp-ipv6': (
[
['scp', 'authentication', 'username', 'bob'],
['scp', 'server', '2001:db8::1'],
['scp', 'port', '22'],
['scp', 'path', '/backups'],
],
'scp://bob@[2001:db8::1]:22/backups',
),
# git to a local repository: file transport, path, no server
'git-file': (
[['git', 'transport', 'file'], ['git', 'path', '/srv/configs.git']],
'git+file:///srv/configs.git',
),
}
for name, (options, _) in locations.items():
for option in options:
self.cli_set(archive_base + [name] + option)
self.cli_commit()
# a configured commit-archive installs the post-commit hook
self.assertTrue(os.path.islink(archive_hook))
# check that the URLs are built correctly
mgmt = ConfigMgmt()
for name, (_, expected_url) in locations.items():
for proto, conf in mgmt.locations[name].items():
url = ConfigMgmt._build_archive_url(proto, conf)
self.assertEqual(url, expected_url)
# removing all locations removes the hook again
self.cli_delete(archive_base)
self.cli_commit()
self.assertFalse(os.path.islink(archive_hook))
def test_02_commit_archive_verify(self):
location = archive_base + ['archive']
# two transport protocols on one location -> rejected
self.cli_set(location + ['scp', 'path', '/a'])
self.cli_set(location + ['ftp', 'path', '/b'])
with self.assertRaises(ConfigSessionError):
self.cli_commit()
# one protocol now, but it has no server -> rejected
self.cli_delete(location + ['ftp'])
with self.assertRaises(ConfigSessionError):
self.cli_commit()
# server set, but a password without a username -> rejected
self.cli_set(location + ['scp', 'server', '192.0.2.1'])
self.cli_set(location + ['scp', 'authentication', 'password', 'p'])
with self.assertRaises(ConfigSessionError):
self.cli_commit()
# add the username -> should commit
self.cli_set(location + ['scp', 'authentication', 'username', 'u'])
self.cli_commit()
# a valid location was committed, so the archive hook is installed
self.assertTrue(os.path.islink(archive_hook))
def test_03_git_file_verify(self):
# git over file:// is a local repository: it needs a path and must not
# carry remote-only nodes (server/port/authentication)
location = archive_base + ['local']
# file transport without a path -> rejected
self.cli_set(location + ['git', 'transport', 'file'])
with self.assertRaises(ConfigSessionError):
self.cli_commit()
self.cli_set(location + ['git', 'path', '/srv/configs.git'])
# each remote-only node is meaningless for a local repository
for node in (
['server', '192.0.2.1'],
['port', '22'],
['authentication', 'username', 'u'],
):
self.cli_set(location + ['git'] + node)
with self.assertRaises(ConfigSessionError):
self.cli_commit()
self.cli_delete(location + ['git', node[0]])
# path only -> commits
self.cli_commit()
self.assertTrue(os.path.islink(archive_hook))
if __name__ == '__main__':
unittest.main(verbosity=2)
|
