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
|
__author__ = "John Hollowell"
__copyright__ = "(c) John Hollowell 2022"
__license__ = "MIT"
import logging
from unittest import mock
import pytest
from proxmoxer import core
from proxmoxer.backends import https
from proxmoxer.backends.command_base import JsonSimpleSerializer, Response
from .api_mock import ( # pylint: disable=unused-import # noqa: F401
PVERegistry,
mock_pve,
)
from .test_paramiko import mock_ssh_client # pylint: disable=unused-import # noqa: F401
# pylint: disable=no-self-use,protected-access
MODULE_LOGGER_NAME = "proxmoxer.core"
class TestResourceException:
def test_init_none(self):
e = core.ResourceException(None, None, None)
assert e.status_code is None
assert e.status_message is None
assert e.content is None
assert e.errors is None
assert str(e) == "None None: None"
assert repr(e) == "ResourceException('None None: None')"
def test_init_basic(self):
e = core.ResourceException(500, "Internal Error", "Unable to do the thing")
assert e.status_code == 500
assert e.status_message == "Internal Error"
assert e.content == "Unable to do the thing"
assert e.errors is None
assert str(e) == "500 Internal Error: Unable to do the thing"
assert repr(e) == "ResourceException('500 Internal Error: Unable to do the thing')"
def test_init_error(self):
e = core.ResourceException(
500, "Internal Error", "Unable to do the thing", "functionality not found"
)
assert e.status_code == 500
assert e.status_message == "Internal Error"
assert e.content == "Unable to do the thing"
assert e.errors == "functionality not found"
assert str(e) == "500 Internal Error: Unable to do the thing - functionality not found"
assert (
repr(e)
== "ResourceException('500 Internal Error: Unable to do the thing - functionality not found')"
)
class TestProxmoxResource:
obj = core.ProxmoxResource()
base_url = "http://example.com/"
def test_url_join_empty_base(self):
assert "/" == self.obj.url_join("", "")
def test_url_join_empty(self):
assert "https://www.example.com:80/" == self.obj.url_join("https://www.example.com:80", "")
def test_url_join_basic(self):
assert "https://www.example.com/nodes/node1" == self.obj.url_join(
"https://www.example.com", "nodes", "node1"
)
def test_url_join_all_segments(self):
assert "https://www.example.com/base/path#div1?search=query" == self.obj.url_join(
"https://www.example.com/base#div1?search=query", "path"
)
def test_repr(self):
obj = core.ProxmoxResource(base_url="root")
assert repr(obj.first.second("third")) == "ProxmoxResource (root/first/second/third)"
def test_getattr_private(self):
with pytest.raises(AttributeError) as exc_info:
self.obj._thing
assert str(exc_info.value) == "_thing"
def test_getattr_single(self):
test_obj = core.ProxmoxResource(base_url=self.base_url)
ret = test_obj.nodes
assert isinstance(ret, core.ProxmoxResource)
assert ret._store["base_url"] == self.base_url + "nodes"
def test_call_basic(self):
test_obj = core.ProxmoxResource(base_url=self.base_url)
ret = test_obj("nodes")
assert isinstance(ret, core.ProxmoxResource)
assert ret._store["base_url"] == self.base_url + "nodes"
def test_call_emptystr(self):
test_obj = core.ProxmoxResource(base_url=self.base_url)
ret = test_obj("")
assert isinstance(ret, core.ProxmoxResource)
assert ret._store["base_url"] == self.base_url
def test_call_list(self):
test_obj = core.ProxmoxResource(base_url=self.base_url)
ret = test_obj(["nodes", "node1"])
assert isinstance(ret, core.ProxmoxResource)
assert ret._store["base_url"] == self.base_url + "nodes/node1"
def test_call_stringable(self):
test_obj = core.ProxmoxResource(base_url=self.base_url)
class Thing:
def __str__(self):
return "string"
ret = test_obj(Thing())
assert isinstance(ret, core.ProxmoxResource)
assert ret._store["base_url"] == self.base_url + "string"
def test_request_basic_get(self, mock_resource, caplog):
caplog.set_level(logging.DEBUG, logger=MODULE_LOGGER_NAME)
ret = mock_resource._request("GET", params={"key": "value"})
assert caplog.record_tuples == [
(MODULE_LOGGER_NAME, logging.INFO, "GET " + self.base_url),
(
MODULE_LOGGER_NAME,
logging.DEBUG,
'Status code: 200, output: b\'{"data": {"key": "value"}}\'',
),
]
assert ret == {"data": {"key": "value"}}
def test_request_basic_post(self, mock_resource, caplog):
caplog.set_level(logging.DEBUG, logger=MODULE_LOGGER_NAME)
ret = mock_resource._request("POST", data={"key": "value"})
assert caplog.record_tuples == [
(
MODULE_LOGGER_NAME,
logging.INFO,
"POST " + self.base_url + " " + str({"key": "value"}),
),
(
MODULE_LOGGER_NAME,
logging.DEBUG,
'Status code: 200, output: b\'{"data": {"key": "value"}}\'',
),
]
assert ret == {"data": {"key": "value"}}
def test_request_fail(self, mock_resource, caplog):
caplog.set_level(logging.DEBUG, logger=MODULE_LOGGER_NAME)
with pytest.raises(core.ResourceException) as exc_info:
mock_resource("fail")._request("GET")
assert caplog.record_tuples == [
(
MODULE_LOGGER_NAME,
logging.INFO,
"GET " + self.base_url + "fail",
),
(
MODULE_LOGGER_NAME,
logging.DEBUG,
"Status code: 500, output: b'this is the error'",
),
]
assert exc_info.value.status_code == 500
assert exc_info.value.status_message == "Internal Server Error"
assert exc_info.value.content == str(b"this is the error")
assert exc_info.value.errors is None
def test_request_fail_with_reason(self, mock_resource, caplog):
caplog.set_level(logging.DEBUG, logger=MODULE_LOGGER_NAME)
with pytest.raises(core.ResourceException) as exc_info:
mock_resource(["fail", "reason"])._request("GET")
assert caplog.record_tuples == [
(
MODULE_LOGGER_NAME,
logging.INFO,
"GET " + self.base_url + "fail/reason",
),
(
MODULE_LOGGER_NAME,
logging.DEBUG,
"Status code: 500, output: b'this is the error'",
),
]
assert exc_info.value.status_code == 500
assert exc_info.value.status_message == "Internal Server Error"
assert exc_info.value.content == "this is the reason"
assert exc_info.value.errors == {"errors": b"this is the error"}
def test_request_params_cleanup(self, mock_resource):
mock_resource._request("GET", params={"key": "value", "remove_me": None})
assert mock_resource._store["session"].params == {"key": "value"}
def test_request_data_cleanup(self, mock_resource):
mock_resource._request("POST", data={"key": "value", "remove_me": None})
assert mock_resource._store["session"].data == {"key": "value"}
class TestProxmoxResourceMethods:
_resource = core.ProxmoxResource(base_url="https://example.com")
def test_get(self, mock_private_request):
ret = self._resource.get("nodes", key="value")
ret_self = ret["self"]
assert ret["method"] == "GET"
assert ret["params"] == {"key": "value"}
assert ret_self._store["base_url"] == "https://example.com/nodes"
def test_post(self, mock_private_request):
ret = self._resource.post("nodes", key="value")
ret_self = ret["self"]
assert ret["method"] == "POST"
assert ret["data"] == {"key": "value"}
assert ret_self._store["base_url"] == "https://example.com/nodes"
def test_put(self, mock_private_request):
ret = self._resource.put("nodes", key="value")
ret_self = ret["self"]
assert ret["method"] == "PUT"
assert ret["data"] == {"key": "value"}
assert ret_self._store["base_url"] == "https://example.com/nodes"
def test_delete(self, mock_private_request):
ret = self._resource.delete("nodes", key="value")
ret_self = ret["self"]
assert ret["method"] == "DELETE"
assert ret["params"] == {"key": "value"}
assert ret_self._store["base_url"] == "https://example.com/nodes"
def test_create(self, mock_private_request):
ret = self._resource.create("nodes", key="value")
ret_self = ret["self"]
assert ret["method"] == "POST"
assert ret["data"] == {"key": "value"}
assert ret_self._store["base_url"] == "https://example.com/nodes"
def test_set(self, mock_private_request):
ret = self._resource.set("nodes", key="value")
ret_self = ret["self"]
assert ret["method"] == "PUT"
assert ret["data"] == {"key": "value"}
assert ret_self._store["base_url"] == "https://example.com/nodes"
class TestProxmoxAPI:
def test_init_basic(self):
prox = core.ProxmoxAPI(
"host", token_name="name", token_value="value", service="pVe", backend="hTtPs"
)
assert isinstance(prox, core.ProxmoxAPI)
assert isinstance(prox, core.ProxmoxResource)
assert isinstance(prox._backend, https.Backend)
assert prox._backend.auth.service == "PVE"
def test_init_invalid_service(self):
with pytest.raises(NotImplementedError) as exc_info:
core.ProxmoxAPI("host", service="NA")
assert str(exc_info.value) == "NA service is not supported"
def test_init_invalid_backend(self):
with pytest.raises(NotImplementedError) as exc_info:
core.ProxmoxAPI("host", service="pbs", backend="LocaL")
assert str(exc_info.value) == "PBS service does not support local backend"
def test_init_local_with_host(self):
with pytest.raises(NotImplementedError) as exc_info:
core.ProxmoxAPI("host", service="pve", backend="LocaL")
assert str(exc_info.value) == "local backend does not support host keyword"
def test_repr_https(self):
prox = core.ProxmoxAPI("host", token_name="name", token_value="value", backend="hTtPs")
assert repr(prox) == "ProxmoxAPI (https backend for https://host:8006/api2/json)"
def test_repr_local(self):
prox = core.ProxmoxAPI(backend="local")
assert repr(prox) == "ProxmoxAPI (local backend for localhost)"
@pytest.mark.skip("openssh_wrapper is not available")
def test_repr_openssh(self):
prox = core.ProxmoxAPI("host", user="user", backend="openssh")
assert repr(prox) == "ProxmoxAPI (openssh backend for host)"
def test_repr_paramiko(self, mock_ssh_client):
prox = core.ProxmoxAPI("host", user="user", backend="ssh_paramiko")
assert repr(prox) == "ProxmoxAPI (ssh_paramiko backend for host)"
def test_get_tokens_https(self, mock_pve):
prox = core.ProxmoxAPI("1.2.3.4:1234", user="user", password="password", backend="https")
ticket, csrf = prox.get_tokens()
assert ticket == "ticket"
assert csrf == "CSRFPreventionToken"
def test_get_tokens_local(self):
prox = core.ProxmoxAPI(service="pve", backend="local")
ticket, csrf = prox.get_tokens()
assert ticket is None
assert csrf is None
def test_init_with_cert(self):
prox = core.ProxmoxAPI(
"host",
token_name="name",
token_value="value",
service="pVe",
backend="hTtPs",
cert="somepem",
)
assert isinstance(prox, core.ProxmoxAPI)
assert isinstance(prox, core.ProxmoxResource)
assert isinstance(prox._backend, https.Backend)
assert prox._backend.auth.service == "PVE"
assert prox._backend.cert == "somepem"
assert prox._store["session"].cert == "somepem"
def test_init_with_cert_key(self):
prox = core.ProxmoxAPI(
"host",
token_name="name",
token_value="value",
service="pVe",
backend="hTtPs",
cert=("somepem", "somekey"),
)
assert isinstance(prox, core.ProxmoxAPI)
assert isinstance(prox, core.ProxmoxResource)
assert isinstance(prox._backend, https.Backend)
assert prox._backend.auth.service == "PVE"
assert prox._backend.cert == ("somepem", "somekey")
assert prox._store["session"].cert == ("somepem", "somekey")
class MockSession:
def request(self, method, url, data=None, params=None):
# store the arguments in the session so they can be tested after the call
self.data = data
self.params = params
self.method = method
self.url = url
if "fail" in url:
r = Response(b"this is the error", 500)
if "reason" in url:
r.reason = "this is the reason"
return r
else:
return Response(b'{"data": {"key": "value"}}', 200)
@pytest.fixture
def mock_private_request():
def mock_request(self, method, data=None, params=None):
return {"self": self, "method": method, "data": data, "params": params}
with mock.patch("proxmoxer.core.ProxmoxResource._request", mock_request):
yield
@pytest.fixture
def mock_resource():
return core.ProxmoxResource(
session=MockSession(), base_url="http://example.com/", serializer=JsonSimpleSerializer()
)
|