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
|
__author__ = "John Hollowell"
__copyright__ = "(c) John Hollowell 2022"
__license__ = "MIT"
import tempfile
from unittest import mock
import pytest
from proxmoxer.backends import command_base
from .api_mock import PVERegistry
# pylint: disable=no-self-use
class TestResponse:
def test_init_all_args(self):
resp = command_base.Response(b"content", 200)
assert resp.content == b"content"
assert resp.text == "b'content'"
assert resp.status_code == 200
assert resp.headers == {"content-type": "application/json"}
assert str(resp) == "Response (200) b'content'"
class TestCommandBaseSession:
base_url = PVERegistry.base_url
_session = command_base.CommandBaseSession()
def test_init_all_args(self):
sess = command_base.CommandBaseSession(service="SERVICE", timeout=10, sudo=True)
assert sess.service == "service"
assert sess.timeout == 10
assert sess.sudo is True
def test_exec(self):
with pytest.raises(NotImplementedError):
self._session._exec("command")
def test_upload_file_obj(self):
with pytest.raises(NotImplementedError), tempfile.TemporaryFile("w+b") as f_obj:
self._session.upload_file_obj(f_obj, "/tmp/file.iso")
def test_request_basic(self, mock_exec):
resp = self._session.request("GET", self.base_url + "/fake/echo")
assert resp.status_code == 200
assert resp.content == [
"pvesh",
"get",
self.base_url + "/fake/echo",
"--output-format",
"json",
]
def test_request_task(self, mock_exec_task):
resp = self._session.request("GET", self.base_url + "/stdout")
assert resp.status_code == 200
assert (
resp.content == "UPID:node:003094EA:095F1EFE:63E88772:download:file.iso:root@pam:done"
)
resp_stderr = self._session.request("GET", self.base_url + "/stderr")
assert resp_stderr.status_code == 200
assert (
resp_stderr.content
== "UPID:node:003094EA:095F1EFE:63E88772:download:file.iso:root@pam:done"
)
# assert False # DEBUG
def test_request_error(self, mock_exec_err):
resp = self._session.request(
"GET", self.base_url + "/fake/echo", data={"thing": "403 Unauthorized"}
)
assert resp.status_code == 403
assert (
resp.content
== "pvesh\nget\nhttps://1.2.3.4:1234/api2/json/fake/echo\n-thing\n403 Unauthorized\n--output-format\njson"
)
def test_request_error_generic(self, mock_exec_err):
resp = self._session.request("GET", self.base_url + "/fake/echo", data={"thing": "failure"})
assert resp.status_code == 500
assert (
resp.content
== "pvesh\nget\nhttps://1.2.3.4:1234/api2/json/fake/echo\n-thing\nfailure\n--output-format\njson"
)
def test_request_sudo(self, mock_exec):
resp = command_base.CommandBaseSession(sudo=True).request(
"GET", self.base_url + "/fake/echo"
)
assert resp.status_code == 200
assert resp.content == [
"sudo",
"pvesh",
"get",
self.base_url + "/fake/echo",
"--output-format",
"json",
]
def test_request_data(self, mock_exec):
resp = self._session.request("GET", self.base_url + "/fake/echo", data={"key": "value"})
assert resp.status_code == 200
assert resp.content == [
"pvesh",
"get",
self.base_url + "/fake/echo",
"-key",
"value",
"--output-format",
"json",
]
def test_request_bytes_data(self, mock_exec):
resp = self._session.request(
"GET", self.base_url + "/fake/echo", data={"key": b"bytes-value"}
)
assert resp.status_code == 200
assert resp.content == [
"pvesh",
"get",
self.base_url + "/fake/echo",
"-key",
"bytes-value",
"--output-format",
"json",
]
def test_request_qemu_exec(self, mock_exec):
resp = self._session.request(
"POST",
self.base_url + "/node/node1/qemu/100/agent/exec",
data={"command": "echo 'hello world'"},
)
assert resp.status_code == 200
assert resp.content == [
"pvesh",
"create",
self.base_url + "/node/node1/qemu/100/agent/exec",
"-command",
"echo",
"-command",
"hello world",
"--output-format",
"json",
]
def test_request_qemu_exec_list(self, mock_exec):
resp = self._session.request(
"POST",
self.base_url + "/node/node1/qemu/100/agent/exec",
data={"command": ["echo", "hello world"]},
)
assert resp.status_code == 200
assert resp.content == [
"pvesh",
"create",
self.base_url + "/node/node1/qemu/100/agent/exec",
"-command",
"echo",
"-command",
"hello world",
"--output-format",
"json",
]
def test_request_upload(self, mock_exec, mock_upload_file_obj):
with tempfile.NamedTemporaryFile("w+b") as f_obj:
resp = self._session.request(
"POST",
self.base_url + "/node/node1/storage/local/upload",
data={"content": "iso", "filename": f_obj},
)
assert resp.status_code == 200
assert resp.content == [
"pvesh",
"create",
self.base_url + "/node/node1/storage/local/upload",
"-content",
"iso",
"-filename",
str(f_obj.name),
"-tmpfilename",
"/tmp/tmpasdfasdf",
"--output-format",
"json",
]
class TestJsonSimpleSerializer:
_serializer = command_base.JsonSimpleSerializer()
def test_loads_pass(self):
input_str = '{"key1": "value1", "key2": "value2"}'
exp_output = {"key1": "value1", "key2": "value2"}
response = command_base.Response(input_str.encode("utf-8"), 200)
act_output = self._serializer.loads(response)
assert act_output == exp_output
def test_loads_not_json(self):
input_str = "There was an error with the request"
exp_output = {"errors": b"There was an error with the request"}
response = command_base.Response(input_str.encode("utf-8"), 200)
act_output = self._serializer.loads(response)
assert act_output == exp_output
def test_loads_not_unicode(self):
input_str = '{"data": {"key1": "value1", "key2": "value2"}, "errors": {}}\x80'
exp_output = {"errors": input_str.encode("utf-8")}
response = command_base.Response(input_str.encode("utf-8"), 200)
act_output = self._serializer.loads(response)
assert act_output == exp_output
class TestCommandBaseBackend:
backend = command_base.CommandBaseBackend()
sess = command_base.CommandBaseSession()
backend.session = sess
def test_init(self):
b = command_base.CommandBaseBackend()
assert b.session is None
assert b.target is None
def test_get_session(self):
assert self.backend.get_session() == self.sess
def test_get_base_url(self):
assert self.backend.get_base_url() == ""
def test_get_serializer(self):
assert isinstance(self.backend.get_serializer(), command_base.JsonSimpleSerializer)
@classmethod
def _exec_echo(_, cmd):
# if getting a tmpfile on the remote, return fake tmpfile
if cmd == [
"python3",
"-c",
"import tempfile; import sys; tf = tempfile.NamedTemporaryFile(); sys.stdout.write(tf.name)",
]:
return b"/tmp/tmpasdfasdf", None
return cmd, None
@classmethod
def _exec_err(_, cmd):
return None, "\n".join(cmd)
@classmethod
def _exec_task(_, cmd):
upid = "UPID:node:003094EA:095F1EFE:63E88772:download:file.iso:root@pam:done"
if "stderr" in cmd[2]:
return None, upid
else:
return upid, None
@classmethod
def upload_file_obj_echo(_, file_obj, remote_path):
return file_obj, remote_path
@pytest.fixture
def mock_upload_file_obj():
with mock.patch.object(
command_base.CommandBaseSession, "upload_file_obj", upload_file_obj_echo
):
yield
@pytest.fixture
def mock_exec():
with mock.patch.object(command_base.CommandBaseSession, "_exec", _exec_echo):
yield
@pytest.fixture
def mock_exec_task():
with mock.patch.object(command_base.CommandBaseSession, "_exec", _exec_task):
yield
@pytest.fixture
def mock_exec_err():
with mock.patch.object(command_base.CommandBaseSession, "_exec", _exec_err):
yield
|
