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
|
"""Tests for assess_proxy module."""
from argparse import Namespace
import logging
from mock import (
call,
Mock,
patch,
)
import os
import StringIO
import subprocess
import assess_proxy
from fakejuju import fake_juju_client
from tests import (
parse_error,
TestCase,
)
from utility import temp_dir
class TestParseArgs(TestCase):
def test_common_args(self):
with temp_dir() as log_dir:
args = assess_proxy.parse_args(
["an-env", "/bin/juju", log_dir, "an-env-mod", 'both-proxied'])
expected_args = Namespace(
agent_stream=None, agent_url=None, bootstrap_host=None,
client_interface='eth0', controller_interface='lxdbr0',
deadline=None, debug=False, env='an-env', juju_bin='/bin/juju',
keep_env=False, logs=log_dir, machine=[], region=None,
scenario='both-proxied', series=None, temp_env_name='an-env-mod',
upload_tools=False, verbose=20)
self.assertEqual(expected_args, args)
def test_help(self):
fake_stdout = StringIO.StringIO()
with parse_error(self) as fake_stderr:
with patch("sys.stdout", fake_stdout):
assess_proxy.parse_args(["--help"])
self.assertEqual("", fake_stderr.getvalue())
self.assertNotIn("TODO", fake_stdout.getvalue())
class TestMain(TestCase):
def test_main(self):
with temp_dir() as log_dir:
argv = ["an-env", "/bin/juju", log_dir, "an-env-mod",
"both-proxied", "--verbose"]
client = Mock(spec=["is_jes_enabled"])
with patch("assess_proxy.configure_logging",
autospec=True) as mock_cl:
with patch("assess_proxy.BootstrapManager.booted_context",
autospec=True) as mock_bc:
with patch('deploy_stack.client_from_config',
return_value=client) as mock_cfc:
with patch("assess_proxy.assess_proxy",
autospec=True) as mock_assess:
with patch("assess_proxy.check_network",
autospec=True,
return_value='FORWARD') as mock_check:
with patch("assess_proxy.set_firewall",
autospec=True) as mock_set:
with patch("assess_proxy.reset_firewall",
autospec=True) as mock_reset:
returecode = assess_proxy.main(argv)
self.assertEqual(0, returecode)
mock_cl.assert_called_once_with(logging.DEBUG)
mock_cfc.assert_called_once_with(
'an-env', "/bin/juju", debug=False, soft_deadline=None)
mock_check.assert_called_once_with('eth0', 'lxdbr0')
mock_set.assert_called_once_with(
'both-proxied', 'eth0', 'lxdbr0', 'FORWARD')
mock_reset.assert_called_once_with()
self.assertEqual(mock_bc.call_count, 1)
mock_assess.assert_called_once_with(client, 'both-proxied')
def test_main_error(self):
# When there is an error raised during setup or testing, the finally
# block with reset_firewall is always called.
with temp_dir() as log_dir:
argv = ["an-env", "/bin/juju", log_dir, "an-env-mod",
"both-proxied", "--verbose"]
with patch("assess_proxy.configure_logging", autospec=True):
with patch("assess_proxy.check_network",
autospec=True, return_value='FORWARD'):
with patch("assess_proxy.set_firewall",
autospec=True, side_effect=ValueError):
with patch("assess_proxy.reset_firewall",
autospec=True) as mock_reset:
with self.assertRaises(ValueError):
assess_proxy.main(argv)
mock_reset.assert_called_once_with()
class TestAssess(TestCase):
def test_proxy(self):
# Using fake_client means that deploy and get_status have plausible
# results. Wrapping it in a Mock causes every call to be recorded, and
# allows assertions to be made about calls. Mocks and the fake client
# can also be used separately.
fake_client = Mock(wraps=fake_juju_client())
fake_client.bootstrap()
assess_proxy.assess_proxy(fake_client, 'both-proxied')
fake_client.deploy.assert_called_once_with('cs:xenial/ubuntu')
fake_client.wait_for_started.assert_called_once_with()
fake_client.wait_for_workloads.assert_called_once_with()
self.assertEqual(
1, fake_client.get_status().get_service_unit_count('ubuntu'))
self.assertNotIn("TODO", self.log_stream.getvalue())
def test_check_environment(self):
proxy_data = "http_proxy=http\nhttps_proxy=https"
proxy_env = {
'http_proxy': 'http', 'https_proxy': 'https',
'ftp_proxy': 'ftp', 'no_proxy': '127.0.0.1'}
with temp_dir() as base:
env_file = os.path.join(base, 'environment')
with open(env_file, 'w') as _file:
_file.write(proxy_data)
with patch('assess_proxy.get_environment_file_path',
return_value=env_file):
with patch.dict(os.environ, proxy_env):
proxies = assess_proxy.check_environment()
http_proxy, https_proxy, ftp_proxy, no_proxy = proxies
self.assertEqual('http', http_proxy)
self.assertEqual('https', https_proxy)
self.assertEqual('ftp', ftp_proxy)
self.assertEqual('127.0.0.1', no_proxy)
def test_check_environment_missing_env(self):
proxy_env = {'http_proxy': 'http'}
with patch.dict(os.environ, proxy_env, clear=True):
with self.assertRaises(assess_proxy.UndefinedProxyError):
assess_proxy.check_environment()
def test_check_environment_mising_environment_file(self):
proxy_env = {'http_proxy': 'http', 'https_proxy': 'https'}
with patch.dict(os.environ, proxy_env):
with patch('assess_proxy.get_environment_file_path',
return_value='/tmp/etc/evironment.missing'):
with self.assertRaises(assess_proxy.UndefinedProxyError):
assess_proxy.check_environment()
def test_check_environment_environment_file_proxy_undefined(self):
proxy_data = "# no proxy info"
proxy_env = {'http_proxy': 'http', 'https_proxy': 'https'}
with temp_dir() as base:
env_file = os.path.join(base, 'environment')
with open(env_file, 'w') as _file:
_file.write(proxy_data)
with patch('assess_proxy.get_environment_file_path',
return_value=env_file):
with patch.dict(os.environ, proxy_env):
with self.assertRaises(assess_proxy.UndefinedProxyError):
assess_proxy.check_environment()
def test_check_network(self):
iptables_rule = (
'-A INPUT -i lxdbr0 -p tcp -m tcp --dport 53 -j ACCEPT\n'
'-A FORWARD -i lxdbr0 -m comment --comment "by lxd" -j ACCEPT\n'
'-A FORWARD -0 lxdbr0 -m comment --comment "by lxd" -j ACCEPT')
with patch('subprocess.check_output', autospec=True,
return_value=iptables_rule) as mock_scc:
with patch('subprocess.call', autospec=True,
side_effect=[0, 0]) as mock_sc:
with patch('assess_proxy.check_environment',
autospec=True) as mock_ce:
forward_rule = assess_proxy.check_network('eth0', 'lxdbr0')
self.assertEqual(
'-A FORWARD -i lxdbr0 -m comment --comment "by lxd" -j ACCEPT',
forward_rule)
mock_scc.assert_called_once_with(
['sudo', 'iptables', '-S', 'FORWARD'])
self.assertEqual(
[call(['ifconfig', 'eth0']), call(['ifconfig', 'lxdbr0'])],
mock_sc.mock_calls)
mock_ce.assert_called_once_with()
def test_check_network_forward_rule_no_match_error(self):
iptables_rule = '-A FORWARD -i lxdbr1 -j ACCEPT'
with patch('subprocess.check_output', autospec=True,
return_value=iptables_rule):
with patch('subprocess.call', autospec=True,
side_effect=[0, 0]):
with patch('assess_proxy.check_environment', autospec=True):
with self.assertRaises(ValueError):
assess_proxy.check_network('eth0', 'lxdbr0')
def test_check_network_forward_rule_many_match_error(self):
iptables_rule = (
'-A FORWARD -i lxdbr0 -m comment --comment "by lxd" -j ACCEPT\n'
'-A FORWARD -i lxdbr0 -m comment --comment "by other" -j ACCEPT'
)
with patch('subprocess.check_output', autospec=True,
return_value=iptables_rule):
with patch('subprocess.call', autospec=True,
side_effect=[0, 0]):
with patch('assess_proxy.check_environment', autospec=True):
with self.assertRaises(ValueError):
assess_proxy.check_network('eth0', 'lxdbr0')
def test_check_network_client_interface_error(self):
with patch('subprocess.call', autospec=True,
side_effect=[0, 1]):
with self.assertRaises(ValueError):
assess_proxy.check_network('eth0', 'lxdbr0')
def test_check_network_controller_interface_error(self):
with patch('subprocess.call', autospec=True,
side_effect=[1, 0]):
with self.assertRaises(ValueError):
assess_proxy.check_network('eth0', 'lxdbr0')
def test_backup_iptables(self):
with patch('subprocess.check_call', autospec=True,
return_value=0) as mock_cc:
assess_proxy.backup_iptables()
mock_cc.assert_called_once_with(
[assess_proxy.IPTABLES_BACKUP_BASH], shell=True)
expected_log = (
"INFO Backing up iptables to /etc/iptables.before-assess-proxy\n")
self.assertEqual(expected_log, self.log_stream.getvalue())
def test_setup_common_firewall(self):
with patch('subprocess.check_call', autospec=True,
return_value=0) as mock_cc:
assess_proxy.setup_common_firewall()
mock_cc.assert_called_once_with(
[assess_proxy.UFW_PROXY_COMMON_BASH], shell=True)
expected_log = (
"INFO Setting common firewall rules.\n"
"INFO These are safe permissive rules.\n")
self.assertEqual(expected_log, self.log_stream.getvalue())
def test_setup_client_firewall(self):
with patch('subprocess.check_call', autospec=True,
return_value=0) as mock_cc:
assess_proxy.setup_client_firewall('eth0')
script = assess_proxy.UFW_PROXY_CLIENT_BASH.format(
interface='eth0')
mock_cc.assert_called_once_with([script], shell=True)
expected_log = (
"INFO Setting client firewall rules.\n"
"INFO These rules restrict the localhost on eth0.\n")
self.assertEqual(expected_log, self.log_stream.getvalue())
def test_setup_controller_firewall(self):
original_forward_rule = '-A FORWARD -i lxdbr0 -j ACCEPT'
with patch('subprocess.check_call', autospec=True,
return_value=0) as mock_cc:
assess_proxy.setup_controller_firewall(
'lxdbr0', original_forward_rule)
script = assess_proxy.UFW_PROXY_CONTROLLER_BASH.format(
interface='lxdbr0',
original_forward_rule='FORWARD -i lxdbr0 -j ACCEPT')
mock_cc.assert_called_once_with([script], shell=True)
expected_log = (
"INFO Setting controller firewall rules.\n"
"INFO These rules restrict the controller on lxdbr0.\n")
self.assertEqual(expected_log, self.log_stream.getvalue())
def test_set_firewall_both(self):
forward_rule = '-A FORWARD -i lxdbr0 -j ACCEPT'
with patch('assess_proxy.backup_iptables', autospec=True) as mock_bi:
with patch('assess_proxy.setup_common_firewall',
autospec=True) as mock_common:
with patch('assess_proxy.setup_client_firewall',
autospec=True) as mock_client:
with patch('assess_proxy.setup_controller_firewall',
autospec=True) as mock_controller:
assess_proxy.set_firewall(
'both-proxied', 'eth0', 'lxdbr0', forward_rule)
mock_bi.assert_called_once_with()
mock_common.assert_called_once_with()
mock_client.assert_called_once_with('eth0')
mock_controller.assert_called_once_with('lxdbr0', forward_rule)
expected_log = (
"INFO \nIn case of disaster, the firewall can be restored"
" by running:\n"
"INFO sudo iptables-restore /etc/iptables.before-assess-proxy\n"
"INFO sudo ufw reset\n\n")
logged = self.log_stream.getvalue()
self.assertIsTrue(logged.startswith(expected_log), logged)
def test_set_firewall_client(self):
forward_rule = '-A FORWARD -i lxdbr0 -j ACCEPT'
with patch('assess_proxy.backup_iptables', autospec=True) as mock_bi:
with patch('assess_proxy.setup_common_firewall',
autospec=True) as mock_common:
with patch('assess_proxy.setup_client_firewall',
autospec=True) as mock_client:
with patch('assess_proxy.setup_controller_firewall',
autospec=True) as mock_controller:
assess_proxy.set_firewall(
'client-proxied', 'eth0', 'lxdbr0', forward_rule)
mock_bi.assert_called_once_with()
mock_common.assert_called_once_with()
mock_client.assert_called_once_with('eth0')
self.assertEqual(0, mock_controller.call_count)
def test_set_firewall_controller(self):
forward_rule = '-A FORWARD -i lxdbr0 -j ACCEPT'
with patch('assess_proxy.backup_iptables', autospec=True) as mock_bi:
with patch('assess_proxy.setup_common_firewall',
autospec=True) as mock_common:
with patch('assess_proxy.setup_client_firewall',
autospec=True) as mock_client:
with patch('assess_proxy.setup_controller_firewall',
autospec=True) as mock_controller:
assess_proxy.set_firewall(
'controller-proxied', 'eth0', 'lxdbr0',
forward_rule)
mock_bi.assert_called_once_with()
mock_common.assert_called_once_with()
mock_controller.assert_called_once_with('lxdbr0', forward_rule)
self.assertEqual(0, mock_client.call_count)
def test_reset_firewall(self):
# Verify the ufw was called to reset and disable even if one of the
# commands exited with an error.
error = subprocess.CalledProcessError(
1, ('sudo', 'ufw', '--force', 'reset'))
with patch('subprocess.call', autospec=True,
side_effect=[0, error, 0]) as mock_sc:
errors = assess_proxy.reset_firewall()
self.assertEqual([error], errors)
self.assertEqual([
call(('sudo', 'iptables-restore',
'/etc/iptables.before-assess-proxy')),
call(('sudo', 'ufw', '--force', 'reset')),
call(('sudo', 'ufw', '--force', 'disable'))],
mock_sc.mock_calls)
expected_log = (
"INFO ('sudo', 'iptables-restore',"
" '/etc/iptables.before-assess-proxy') exited successfully\n"
"ERROR ('sudo', 'ufw', '--force', 'reset') exited with 1\n"
"ERROR This host may be in a dirty state.\n"
"INFO ('sudo', 'ufw', '--force', 'disable') exited successfully\n")
self.assertEqual(expected_log, self.log_stream.getvalue())
|