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 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
|
from __future__ import annotations
from unittest import mock
import pytest
from hcloud.actions import BoundAction
from hcloud.firewalls import (
BoundFirewall,
Firewall,
FirewallResource,
FirewallResourceLabelSelector,
FirewallRule,
FirewallsClient,
)
from hcloud.servers import Server
class TestBoundFirewall:
@pytest.fixture()
def bound_firewall(self, hetzner_client):
return BoundFirewall(client=hetzner_client.firewalls, data=dict(id=1))
def test_bound_firewall_init(self, firewall_response):
bound_firewall = BoundFirewall(
client=mock.MagicMock(), data=firewall_response["firewall"]
)
assert bound_firewall.id == 38
assert bound_firewall.name == "Corporate Intranet Protection"
assert bound_firewall.labels == {}
assert isinstance(bound_firewall.rules, list)
assert len(bound_firewall.rules) == 2
assert isinstance(bound_firewall.applied_to, list)
assert len(bound_firewall.applied_to) == 2
assert bound_firewall.applied_to[0].server.id == 42
assert bound_firewall.applied_to[0].type == "server"
assert bound_firewall.applied_to[1].label_selector.selector == "key==value"
assert bound_firewall.applied_to[1].type == "label_selector"
firewall_in_rule = bound_firewall.rules[0]
assert isinstance(firewall_in_rule, FirewallRule)
assert firewall_in_rule.direction == FirewallRule.DIRECTION_IN
assert firewall_in_rule.protocol == FirewallRule.PROTOCOL_TCP
assert firewall_in_rule.port == "80"
assert isinstance(firewall_in_rule.source_ips, list)
assert len(firewall_in_rule.source_ips) == 3
assert firewall_in_rule.source_ips == [
"28.239.13.1/32",
"28.239.14.0/24",
"ff21:1eac:9a3b:ee58:5ca:990c:8bc9:c03b/128",
]
assert isinstance(firewall_in_rule.destination_ips, list)
assert len(firewall_in_rule.destination_ips) == 0
assert firewall_in_rule.description == "allow http in"
firewall_out_rule = bound_firewall.rules[1]
assert isinstance(firewall_out_rule, FirewallRule)
assert firewall_out_rule.direction == FirewallRule.DIRECTION_OUT
assert firewall_out_rule.protocol == FirewallRule.PROTOCOL_TCP
assert firewall_out_rule.port == "80"
assert isinstance(firewall_out_rule.source_ips, list)
assert len(firewall_out_rule.source_ips) == 0
assert isinstance(firewall_out_rule.destination_ips, list)
assert len(firewall_out_rule.destination_ips) == 3
assert firewall_out_rule.destination_ips == [
"28.239.13.1/32",
"28.239.14.0/24",
"ff21:1eac:9a3b:ee58:5ca:990c:8bc9:c03b/128",
]
assert firewall_out_rule.description == "allow http out"
@pytest.mark.parametrize(
"params", [{}, {"sort": ["created"], "page": 1, "per_page": 2}]
)
def test_get_actions_list(
self, hetzner_client, bound_firewall, response_get_actions, params
):
hetzner_client.request.return_value = response_get_actions
result = bound_firewall.get_actions_list(**params)
hetzner_client.request.assert_called_with(
url="/firewalls/1/actions", method="GET", params=params
)
actions = result.actions
assert result.meta is None
assert len(actions) == 1
assert isinstance(actions[0], BoundAction)
assert actions[0]._client == hetzner_client.actions
assert actions[0].id == 13
assert actions[0].command == "set_firewall_rules"
@pytest.mark.parametrize("params", [{}, {"sort": ["created"]}])
def test_get_actions(
self, hetzner_client, bound_firewall, response_get_actions, params
):
hetzner_client.request.return_value = response_get_actions
actions = bound_firewall.get_actions(**params)
params.update({"page": 1, "per_page": 50})
hetzner_client.request.assert_called_with(
url="/firewalls/1/actions", method="GET", params=params
)
assert len(actions) == 1
assert isinstance(actions[0], BoundAction)
assert actions[0]._client == hetzner_client.actions
assert actions[0].id == 13
assert actions[0].command == "set_firewall_rules"
def test_update(self, hetzner_client, bound_firewall, response_update_firewall):
hetzner_client.request.return_value = response_update_firewall
firewall = bound_firewall.update(
name="New Corporate Intranet Protection", labels={}
)
hetzner_client.request.assert_called_with(
url="/firewalls/1",
method="PUT",
json={"name": "New Corporate Intranet Protection", "labels": {}},
)
assert firewall.id == 38
assert firewall.name == "New Corporate Intranet Protection"
def test_delete(self, hetzner_client, bound_firewall):
delete_success = bound_firewall.delete()
hetzner_client.request.assert_called_with(url="/firewalls/1", method="DELETE")
assert delete_success is True
def test_set_rules(self, hetzner_client, bound_firewall, response_set_rules):
hetzner_client.request.return_value = response_set_rules
actions = bound_firewall.set_rules(
[
FirewallRule(
direction=FirewallRule.DIRECTION_IN,
protocol=FirewallRule.PROTOCOL_ICMP,
source_ips=["0.0.0.0/0", "::/0"],
description="New firewall description",
)
]
)
hetzner_client.request.assert_called_with(
url="/firewalls/1/actions/set_rules",
method="POST",
json={
"rules": [
{
"direction": "in",
"protocol": "icmp",
"source_ips": ["0.0.0.0/0", "::/0"],
"description": "New firewall description",
}
]
},
)
assert actions[0].id == 13
assert actions[0].progress == 100
def test_apply_to_resources(
self, hetzner_client, bound_firewall, response_set_rules
):
hetzner_client.request.return_value = response_set_rules
actions = bound_firewall.apply_to_resources(
[FirewallResource(type=FirewallResource.TYPE_SERVER, server=Server(id=5))]
)
hetzner_client.request.assert_called_with(
url="/firewalls/1/actions/apply_to_resources",
method="POST",
json={"apply_to": [{"type": "server", "server": {"id": 5}}]},
)
assert actions[0].id == 13
assert actions[0].progress == 100
def test_remove_from_resources(
self, hetzner_client, bound_firewall, response_set_rules
):
hetzner_client.request.return_value = response_set_rules
actions = bound_firewall.remove_from_resources(
[FirewallResource(type=FirewallResource.TYPE_SERVER, server=Server(id=5))]
)
hetzner_client.request.assert_called_with(
url="/firewalls/1/actions/remove_from_resources",
method="POST",
json={"remove_from": [{"type": "server", "server": {"id": 5}}]},
)
assert actions[0].id == 13
assert actions[0].progress == 100
class TestFirewallsClient:
@pytest.fixture()
def firewalls_client(self):
return FirewallsClient(client=mock.MagicMock())
def test_get_by_id(self, firewalls_client, firewall_response):
firewalls_client._client.request.return_value = firewall_response
firewall = firewalls_client.get_by_id(1)
firewalls_client._client.request.assert_called_with(
url="/firewalls/1", method="GET"
)
assert firewall._client is firewalls_client
assert firewall.id == 38
assert firewall.name == "Corporate Intranet Protection"
@pytest.mark.parametrize(
"params",
[
{
"name": "Corporate Intranet Protection",
"sort": "id",
"label_selector": "k==v",
"page": 1,
"per_page": 10,
},
{"name": ""},
{},
],
)
def test_get_list(self, firewalls_client, two_firewalls_response, params):
firewalls_client._client.request.return_value = two_firewalls_response
result = firewalls_client.get_list(**params)
firewalls_client._client.request.assert_called_with(
url="/firewalls", method="GET", params=params
)
firewalls = result.firewalls
assert result.meta is None
assert len(firewalls) == 2
firewalls1 = firewalls[0]
firewalls2 = firewalls[1]
assert firewalls1._client is firewalls_client
assert firewalls1.id == 38
assert firewalls1.name == "Corporate Intranet Protection"
assert firewalls2._client is firewalls_client
assert firewalls2.id == 39
assert firewalls2.name == "Corporate Extranet Protection"
@pytest.mark.parametrize(
"params",
[
{
"name": "Corporate Intranet Protection",
"sort": "id",
"label_selector": "k==v",
},
{},
],
)
def test_get_all(self, firewalls_client, two_firewalls_response, params):
firewalls_client._client.request.return_value = two_firewalls_response
firewalls = firewalls_client.get_all(**params)
params.update({"page": 1, "per_page": 50})
firewalls_client._client.request.assert_called_with(
url="/firewalls", method="GET", params=params
)
assert len(firewalls) == 2
firewalls1 = firewalls[0]
firewalls2 = firewalls[1]
assert firewalls1._client is firewalls_client
assert firewalls1.id == 38
assert firewalls1.name == "Corporate Intranet Protection"
assert firewalls2._client is firewalls_client
assert firewalls2.id == 39
assert firewalls2.name == "Corporate Extranet Protection"
def test_get_by_name(self, firewalls_client, one_firewalls_response):
firewalls_client._client.request.return_value = one_firewalls_response
firewall = firewalls_client.get_by_name("Corporate Intranet Protection")
params = {"name": "Corporate Intranet Protection"}
firewalls_client._client.request.assert_called_with(
url="/firewalls", method="GET", params=params
)
assert firewall._client is firewalls_client
assert firewall.id == 38
assert firewall.name == "Corporate Intranet Protection"
@pytest.mark.parametrize(
"firewall", [Firewall(id=1), BoundFirewall(mock.MagicMock(), dict(id=1))]
)
def test_get_actions_list(self, firewalls_client, firewall, response_get_actions):
firewalls_client._client.request.return_value = response_get_actions
result = firewalls_client.get_actions_list(firewall)
firewalls_client._client.request.assert_called_with(
url="/firewalls/1/actions", method="GET", params={}
)
actions = result.actions
assert result.meta is None
assert len(actions) == 1
assert isinstance(actions[0], BoundAction)
assert actions[0]._client == firewalls_client._client.actions
assert actions[0].id == 13
assert actions[0].command == "set_firewall_rules"
def test_create(self, firewalls_client, response_create_firewall):
firewalls_client._client.request.return_value = response_create_firewall
response = firewalls_client.create(
"Corporate Intranet Protection",
rules=[
FirewallRule(
direction=FirewallRule.DIRECTION_IN,
protocol=FirewallRule.PROTOCOL_ICMP,
source_ips=["0.0.0.0/0"],
)
],
resources=[
FirewallResource(
type=FirewallResource.TYPE_SERVER, server=Server(id=4711)
),
FirewallResource(
type=FirewallResource.TYPE_LABEL_SELECTOR,
label_selector=FirewallResourceLabelSelector(selector="key==value"),
),
],
)
firewalls_client._client.request.assert_called_with(
url="/firewalls",
method="POST",
json={
"name": "Corporate Intranet Protection",
"rules": [
{"direction": "in", "protocol": "icmp", "source_ips": ["0.0.0.0/0"]}
],
"apply_to": [
{"type": "server", "server": {"id": 4711}},
{
"type": "label_selector",
"label_selector": {"selector": "key==value"},
},
],
},
)
bound_firewall = response.firewall
actions = response.actions
assert bound_firewall._client is firewalls_client
assert bound_firewall.id == 38
assert bound_firewall.name == "Corporate Intranet Protection"
assert len(bound_firewall.applied_to) == 2
assert len(actions) == 2
@pytest.mark.parametrize(
"firewall", [Firewall(id=38), BoundFirewall(mock.MagicMock(), dict(id=38))]
)
def test_update(self, firewalls_client, firewall, response_update_firewall):
firewalls_client._client.request.return_value = response_update_firewall
firewall = firewalls_client.update(
firewall, name="New Corporate Intranet Protection", labels={}
)
firewalls_client._client.request.assert_called_with(
url="/firewalls/38",
method="PUT",
json={"name": "New Corporate Intranet Protection", "labels": {}},
)
assert firewall.id == 38
assert firewall.name == "New Corporate Intranet Protection"
@pytest.mark.parametrize(
"firewall", [Firewall(id=1), BoundFirewall(mock.MagicMock(), dict(id=1))]
)
def test_set_rules(self, firewalls_client, firewall, response_set_rules):
firewalls_client._client.request.return_value = response_set_rules
actions = firewalls_client.set_rules(
firewall,
[
FirewallRule(
direction=FirewallRule.DIRECTION_IN,
protocol=FirewallRule.PROTOCOL_ICMP,
source_ips=["0.0.0.0/0", "::/0"],
)
],
)
firewalls_client._client.request.assert_called_with(
url="/firewalls/1/actions/set_rules",
method="POST",
json={
"rules": [
{
"direction": "in",
"protocol": "icmp",
"source_ips": ["0.0.0.0/0", "::/0"],
}
]
},
)
assert actions[0].id == 13
assert actions[0].progress == 100
@pytest.mark.parametrize(
"firewall", [Firewall(id=1), BoundFirewall(mock.MagicMock(), dict(id=1))]
)
def test_delete(self, firewalls_client, firewall):
delete_success = firewalls_client.delete(firewall)
firewalls_client._client.request.assert_called_with(
url="/firewalls/1", method="DELETE"
)
assert delete_success is True
@pytest.mark.parametrize(
"firewall", [Firewall(id=1), BoundFirewall(mock.MagicMock(), dict(id=1))]
)
def test_apply_to_resources(self, firewalls_client, firewall, response_set_rules):
firewalls_client._client.request.return_value = response_set_rules
actions = firewalls_client.apply_to_resources(
firewall,
[FirewallResource(type=FirewallResource.TYPE_SERVER, server=Server(id=5))],
)
firewalls_client._client.request.assert_called_with(
url="/firewalls/1/actions/apply_to_resources",
method="POST",
json={"apply_to": [{"type": "server", "server": {"id": 5}}]},
)
assert actions[0].id == 13
assert actions[0].progress == 100
@pytest.mark.parametrize(
"firewall", [Firewall(id=1), BoundFirewall(mock.MagicMock(), dict(id=1))]
)
def test_remove_from_resources(
self, firewalls_client, firewall, response_set_rules
):
firewalls_client._client.request.return_value = response_set_rules
actions = firewalls_client.remove_from_resources(
firewall,
[FirewallResource(type=FirewallResource.TYPE_SERVER, server=Server(id=5))],
)
firewalls_client._client.request.assert_called_with(
url="/firewalls/1/actions/remove_from_resources",
method="POST",
json={"remove_from": [{"type": "server", "server": {"id": 5}}]},
)
assert actions[0].id == 13
assert actions[0].progress == 100
def test_actions_get_by_id(self, firewalls_client, response_get_actions):
firewalls_client._client.request.return_value = {
"action": response_get_actions["actions"][0]
}
action = firewalls_client.actions.get_by_id(13)
firewalls_client._client.request.assert_called_with(
url="/firewalls/actions/13", method="GET"
)
assert isinstance(action, BoundAction)
assert action._client == firewalls_client._client.actions
assert action.id == 13
assert action.command == "set_firewall_rules"
def test_actions_get_list(self, firewalls_client, response_get_actions):
firewalls_client._client.request.return_value = response_get_actions
result = firewalls_client.actions.get_list()
firewalls_client._client.request.assert_called_with(
url="/firewalls/actions",
method="GET",
params={},
)
actions = result.actions
assert result.meta is None
assert len(actions) == 1
assert isinstance(actions[0], BoundAction)
assert actions[0]._client == firewalls_client._client.actions
assert actions[0].id == 13
assert actions[0].command == "set_firewall_rules"
def test_actions_get_all(self, firewalls_client, response_get_actions):
firewalls_client._client.request.return_value = response_get_actions
actions = firewalls_client.actions.get_all()
firewalls_client._client.request.assert_called_with(
url="/firewalls/actions",
method="GET",
params={"page": 1, "per_page": 50},
)
assert len(actions) == 1
assert isinstance(actions[0], BoundAction)
assert actions[0]._client == firewalls_client._client.actions
assert actions[0].id == 13
assert actions[0].command == "set_firewall_rules"
|