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
|
"""Tests for remote access to juju machines."""
import logging
from mock import patch
import os
from StringIO import StringIO
import subprocess
import unittest
import winrm
from jujupy import (
EnvJujuClient,
SimpleEnvironment,
Status,
)
from remote import (
remote_from_address,
remote_from_unit,
WinRmRemote,
)
from utility import (
temp_dir,
)
class TestRemote(unittest.TestCase):
precise_status_output = """\
machines:
"1":
series: precise
services:
a-service:
units:
a-service/0:
machine: "1"
public-address: 10.55.60.1
"""
win2012hvr2_status_output = """\
machines:
"2":
series: win2012hvr2
services:
a-service:
units:
a-service/0:
machine: "2"
public-address: 10.55.60.2
"""
def setUp(self):
log = logging.getLogger()
self.addCleanup(setattr, log, "handlers", log.handlers)
log.handlers = []
self.log_stream = StringIO()
handler = logging.StreamHandler(self.log_stream)
handler.setFormatter(logging.Formatter("%(levelname)s %(message)s"))
log.addHandler(handler)
def test_remote_from_unit(self):
env = SimpleEnvironment("an-env", {"type": "nonlocal"})
client = EnvJujuClient(env, None, None)
unit = "a-service/0"
with patch.object(client, "get_status", autospec=True) as st:
st.return_value = Status.from_text(self.precise_status_output)
remote = remote_from_unit(client, unit)
self.assertEqual(
repr(remote),
"<SSHRemote env='an-env' unit='a-service/0'>")
self.assertIs(False, remote.is_windows())
def test_remote_from_unit_with_series(self):
env = SimpleEnvironment("an-env", {"type": "nonlocal"})
client = EnvJujuClient(env, None, None)
unit = "a-service/0"
remote = remote_from_unit(client, unit, series="trusty")
self.assertEqual(
repr(remote),
"<SSHRemote env='an-env' unit='a-service/0'>")
self.assertIs(False, remote.is_windows())
def test_remote_from_unit_with_status(self):
env = SimpleEnvironment("an-env", {"type": "nonlocal"})
client = EnvJujuClient(env, None, None)
unit = "a-service/0"
status = Status.from_text(self.win2012hvr2_status_output)
remote = remote_from_unit(client, unit, status=status)
self.assertEqual(
repr(remote),
"<WinRmRemote env='an-env' unit='a-service/0' addr='10.55.60.2'>")
self.assertIs(True, remote.is_windows())
def test_remote_from_address(self):
remote = remote_from_address("10.55.60.1")
self.assertEqual(repr(remote), "<SSHRemote addr='10.55.60.1'>")
self.assertIs(None, remote.is_windows())
def test_remote_from_address_and_series(self):
remote = remote_from_address("10.55.60.2", series="trusty")
self.assertEqual(repr(remote), "<SSHRemote addr='10.55.60.2'>")
self.assertIs(False, remote.is_windows())
def test_remote_from_address_and_win_series(self):
remote = remote_from_address("10.55.60.3", series="win2012hvr2")
self.assertEqual(repr(remote), "<WinRmRemote addr='10.55.60.3'>")
self.assertIs(True, remote.is_windows())
def test_run_with_unit(self):
env = SimpleEnvironment("an-env", {"type": "nonlocal"})
client = EnvJujuClient(env, None, None)
unit = "a-service/0"
remote = remote_from_unit(client, unit, series="trusty")
with patch.object(client, "get_juju_output") as mock_cmd:
mock_cmd.return_value = "contents of /a/file"
output = remote.run("cat /a/file")
self.assertEqual(output, "contents of /a/file")
mock_cmd.assert_called_once_with("ssh", unit, "cat /a/file")
def test_run_with_unit_fallback(self):
env = SimpleEnvironment("an-env", {"type": "nonlocal"})
client = EnvJujuClient(env, None, None)
unit = "a-service/0"
with patch.object(client, "get_status") as st:
st.return_value = Status.from_text(self.precise_status_output)
remote = remote_from_unit(client, unit)
with patch.object(client, "get_juju_output") as mock_cmd:
mock_cmd.side_effect = subprocess.CalledProcessError(1, "ssh")
with patch.object(remote, "_run_subprocess") as mock_run:
mock_run.return_value = "contents of /a/file"
output = remote.run("cat /a/file")
self.assertEqual(output, "contents of /a/file")
mock_cmd.assert_called_once_with("ssh", unit, "cat /a/file")
mock_run.assert_called_once_with([
"ssh",
"-o", "User ubuntu",
"-o", "UserKnownHostsFile /dev/null",
"-o", "StrictHostKeyChecking no",
"10.55.60.1",
"cat /a/file",
])
self.assertRegexpMatches(
self.log_stream.getvalue(),
"(?m)^WARNING juju ssh to 'a-service/0' failed: .*")
def test_run_with_address(self):
remote = remote_from_address("10.55.60.1")
with patch.object(remote, "_run_subprocess") as mock_run:
mock_run.return_value = "contents of /a/file"
output = remote.run("cat /a/file")
self.assertEqual(output, "contents of /a/file")
mock_run.assert_called_once_with([
"ssh",
"-o", "User ubuntu",
"-o", "UserKnownHostsFile /dev/null",
"-o", "StrictHostKeyChecking no",
"10.55.60.1",
"cat /a/file",
])
def test_cat(self):
remote = remote_from_address("10.55.60.1")
with patch.object(remote, "_run_subprocess") as mock_run:
remote.cat("/a/file")
mock_run.assert_called_once_with([
"ssh",
"-o", "User ubuntu",
"-o", "UserKnownHostsFile /dev/null",
"-o", "StrictHostKeyChecking no",
"10.55.60.1",
"cat /a/file",
])
def test_cat_on_windows(self):
env = SimpleEnvironment("an-env", {"type": "nonlocal"})
client = EnvJujuClient(env, None, None)
unit = "a-service/0"
with patch.object(client, "get_status", autospec=True) as st:
st.return_value = Status.from_text(self.win2012hvr2_status_output)
response = winrm.Response(("contents of /a/file", "", 0))
remote = remote_from_unit(client, unit)
with patch.object(remote.session, "run_cmd", autospec=True,
return_value=response) as mock_run:
output = remote.cat("/a/file")
self.assertEqual(output, "contents of /a/file")
st.assert_called_once_with()
mock_run.assert_called_once_with("type", ["/a/file"])
def test_copy(self):
remote = remote_from_address("10.55.60.1")
dest = "/local/path"
with patch.object(remote, "_run_subprocess") as mock_run:
remote.copy(dest, ["/var/log/*", "~/.config"])
mock_run.assert_called_once_with([
"scp",
"-C",
"-o", "User ubuntu",
"-o", "UserKnownHostsFile /dev/null",
"-o", "StrictHostKeyChecking no",
"10.55.60.1:/var/log/*",
"10.55.60.1:~/.config",
"/local/path",
])
def test_copy_on_windows(self):
env = SimpleEnvironment("an-env", {"type": "nonlocal"})
client = EnvJujuClient(env, None, None)
unit = "a-service/0"
dest = "/local/path"
with patch.object(client, "get_status", autospec=True) as st:
st.return_value = Status.from_text(self.win2012hvr2_status_output)
response = winrm.Response(("fake output", "", 0))
remote = remote_from_unit(client, unit)
with patch.object(remote.session, "run_ps", autospec=True,
return_value=response) as mock_run:
with patch.object(remote, "_encoded_copy_to_dir",
autospec=True) as mock_cpdir:
remote.copy(dest, ["C:\\logs\\*", "%APPDATA%\\*.log"])
mock_cpdir.assert_called_once_with(dest, "fake output")
st.assert_called_once_with()
self.assertEquals(mock_run.call_count, 1)
self.assertRegexpMatches(
mock_run.call_args[0][0],
r'.*"C:\\logs\\[*]","%APPDATA%\\[*].log".*')
def test_run_cmd(self):
env = SimpleEnvironment("an-env", {"type": "nonlocal"})
client = EnvJujuClient(env, None, None)
unit = "a-service/0"
with patch.object(client, "get_status", autospec=True) as st:
st.return_value = Status.from_text(self.win2012hvr2_status_output)
response = winrm.Response(("some out", "some err", 0))
remote = remote_from_unit(client, unit)
with patch.object(remote.session, "run_cmd", autospec=True,
return_value=response) as mock_run:
output = remote.run_cmd(
["C:\\Program Files\\bin.exe", "/IN", "Bob's Stuff"])
self.assertEqual(output, response)
st.assert_called_once_with()
mock_run.assert_called_once_with(
'"C:\\Program Files\\bin.exe"', ['/IN "Bob\'s Stuff"'])
def test_encoded_copy_to_dir_one(self):
output = "testfile|K0ktLuECAA==\r\n"
with temp_dir() as dest:
WinRmRemote._encoded_copy_to_dir(dest, output)
with open(os.path.join(dest, "testfile")) as f:
self.assertEqual(f.read(), "test\n")
def test_encoded_copy_to_dir_many(self):
output = "test one|K0ktLuECAA==\r\ntest two|K0ktLuECAA==\r\n\r\n"
with temp_dir() as dest:
WinRmRemote._encoded_copy_to_dir(dest, output)
for name in ("test one", "test two"):
with open(os.path.join(dest, name)) as f:
self.assertEqual(f.read(), "test\n")
def test_encoded_copy_traversal_guard(self):
output = "../../../etc/passwd|K0ktLuECAA==\r\n"
with temp_dir() as dest:
with self.assertRaises(ValueError):
WinRmRemote._encoded_copy_to_dir(dest, output)
|