Adapter refactor
Some checks failed
ci/woodpecker/push/tests Pipeline failed

Allows using different ways to retrieve hosts IP address
This commit is contained in:
Sonny Bakker 2025-05-03 13:12:13 +02:00
parent 97cf1a8f5c
commit e93d864ae1
15 changed files with 861 additions and 710 deletions

View file

@ -0,0 +1,129 @@
from subprocess import CalledProcessError
from unittest import TestCase, skip
from unittest.mock import MagicMock, patch
from requests.exceptions import Timeout
from requests.models import HTTPError
from transip_client.adapters import IpifyAdapter, OpenDNSAdapter
class IpifyAdapterTestCase(TestCase):
adapter_class = IpifyAdapter
def setUp(self) -> None:
patcher = patch("transip_client.adapters.requests.get")
self.mocked_requests_get = patcher.start()
self.addCleanup(patcher.stop)
def test_simple(self):
self.mocked_requests_get.return_value = MagicMock(text="8.8.8.8")
adapter = self.adapter_class()
self.assertEqual(adapter.get_ip(), "8.8.8.8")
def test_service_unavailable(self):
self.mocked_requests_get.side_effect = Timeout
adapter = self.adapter_class()
with self.assertRaises(OSError) as exception_manager:
adapter.get_ip()
exception = exception_manager.exception
self.assertEqual(
str(exception), f"Unable to retrieve current IP from {adapter.service}"
)
def test_error_response(self):
request_mock = MagicMock()
request_mock.raise_for_status.side_effect = HTTPError
self.mocked_requests_get.return_value = request_mock
adapter = self.adapter_class()
with self.assertRaises(OSError) as exception_manager:
adapter.get_ip()
exception = exception_manager.exception
self.assertEqual(
str(exception), f"Unable to retrieve current IP from {adapter.service}"
)
def test_no_text_content(self):
self.mocked_requests_get.return_value = MagicMock(text="")
adapter = self.adapter_class()
with self.assertRaises(OSError) as exception_manager:
adapter.get_ip()
exception = exception_manager.exception
self.assertEqual(
str(exception),
f"Unable to determine IP from response from {adapter.service}",
)
class OpenDNSAdapterTestCase(TestCase):
def setUp(self) -> None:
patcher = patch("transip_client.adapters.subprocess.check_output")
self.mocked_check_output = patcher.start()
self.addCleanup(patcher.stop)
def test_simple(self):
self.mocked_check_output.return_value = "8.8.8.8\n"
adapter = OpenDNSAdapter()
self.assertEqual(adapter.get_ip(), "8.8.8.8")
def test_retry_next_resolvers(self):
self.mocked_check_output.side_effect = (
CalledProcessError(9, "dig +short myip.opendns.com @resolver1.opendns.com"),
CalledProcessError(9, "dig +short myip.opendns.com @resolver2.opendns.com"),
CalledProcessError(9, "dig +short myip.opendns.com @resolver3.opendns.com"),
"9.9.9.9\n",
)
adapter = OpenDNSAdapter()
self.assertEqual(adapter.get_ip(), "9.9.9.9")
def test_resolvers_exhausted(self):
self.mocked_check_output.side_effect = (
CalledProcessError(9, "dig +short myip.opendns.com @resolver1.opendns.com"),
CalledProcessError(9, "dig +short myip.opendns.com @resolver2.opendns.com"),
CalledProcessError(9, "dig +short myip.opendns.com @resolver3.opendns.com"),
CalledProcessError(9, "dig +short myip.opendns.com @resolver4.opendns.com"),
)
adapter = OpenDNSAdapter()
with self.assertRaises(OSError) as exception_manager:
adapter.get_ip()
self.assertEqual(
str(exception_manager.exception),
"Exhausted all known IP resolvers, unable to retrieve IP",
)
def test_command_error(self):
self.mocked_check_output.side_effect = (
CalledProcessError(1, "dig +short myip.opendns.com @resolver1.opendns.com"),
)
adapter = OpenDNSAdapter()
with self.assertRaises(OSError) as exception_manager:
adapter.get_ip()
self.assertEqual(
str(exception_manager.exception), "Unable to retrieve current IP"
)

View file

@ -0,0 +1,359 @@
import json
from pathlib import Path
from unittest import TestCase
from unittest.mock import MagicMock, call, patch
from click.testing import CliRunner
from requests import HTTPError
from transip_client.cli import run
from transip_client.main import API_URL
class RunTestCase(TestCase):
def setUp(self):
patcher = patch("transip_client.main.requests.get")
self.mocked_get = patcher.start()
self.addCleanup(patcher.stop)
patcher = patch("transip_client.main.requests.put")
self.mocked_put = patcher.start()
self.addCleanup(patcher.stop)
patcher = patch("transip_client.main.requests.Session.send")
self.mocked_session = patcher.start()
self.addCleanup(patcher.stop)
patcher = patch("transip_client.main.import_string")
self.mocked_import_string = patcher.start()
self.addCleanup(patcher.stop)
self.runner = CliRunner()
self.private_key_path = (
Path(__file__).resolve().parent / "files" / "test-private-key.pem"
)
def test_simple(self):
mocked_adapter = MagicMock(get_ip=lambda: "111.420")
self.mocked_import_string.return_value = MagicMock(return_value=mocked_adapter)
self.mocked_get.side_effect = [
MagicMock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
self.mocked_session.return_value.json.return_value = {"token": "token"}
result = self.runner.invoke(
run,
["my-user", str(self.private_key_path), "foobar.com"],
catch_exceptions=False,
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
expected_json = json.dumps(
{
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
]
}
)
self.mocked_put.assert_called_with(
f"{API_URL}/domains/foobar.com/dns",
data=expected_json,
headers={"Authorization": "Bearer token"},
)
def test_error_response(self):
mocked_adapter = MagicMock(get_ip=lambda: "111.420")
self.mocked_import_string.return_value = MagicMock(return_value=mocked_adapter)
self.mocked_session.return_value.json.return_value = {"token": "token"}
self.mocked_get.side_effect = [HTTPError]
result = self.runner.invoke(
run,
["my-user", str(self.private_key_path), "foobar.com"],
catch_exceptions=False,
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
self.mocked_put.assert_not_called()
def test_update_error_response(self):
mocked_adapter = MagicMock(get_ip=lambda: "111.420")
self.mocked_import_string.return_value = MagicMock(return_value=mocked_adapter)
self.mocked_session.return_value.json.return_value = {"token": "token"}
self.mocked_get.side_effect = [
MagicMock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
MagicMock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/boofar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/boofar.com",
},
],
}
),
]
def raise_exception() -> None:
raise HTTPError
self.mocked_put.side_effect = (
MagicMock(raise_for_status=raise_exception),
MagicMock(status=200),
)
result = self.runner.invoke(
run,
["my-user", str(self.private_key_path), "foobar.com", "boofar.com"],
catch_exceptions=False,
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_has_calls(
(
call(
f"{API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
),
call(
f"{API_URL}/domains/boofar.com/dns",
headers={"Authorization": "Bearer token"},
),
)
)
self.assertCountEqual(
self.mocked_put.mock_calls,
(
call(
f"{API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
data=json.dumps(
{
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
]
}
),
),
call(
f"{API_URL}/domains/boofar.com/dns",
headers={"Authorization": "Bearer token"},
data=json.dumps(
{
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
]
}
),
),
),
)
def test_matching_ip(self):
mocked_adapter = MagicMock(get_ip=lambda: "111.420")
self.mocked_import_string.return_value = MagicMock(return_value=mocked_adapter)
self.mocked_get.side_effect = [
MagicMock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
self.mocked_session.return_value.json.return_value = {"token": "token"}
result = self.runner.invoke(
run,
["my-user", str(self.private_key_path), "foobar.com"],
catch_exceptions=False,
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
self.mocked_put.assert_not_called()
def test_readonly(self):
mocked_adapter = MagicMock(get_ip=lambda: "111.420")
self.mocked_import_string.return_value = MagicMock(return_value=mocked_adapter)
self.mocked_get.side_effect = [
MagicMock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
self.mocked_session.return_value.json.return_value = {"token": "token"}
result = self.runner.invoke(
run,
["my-user", str(self.private_key_path), "foobar.com", "--read-only"],
catch_exceptions=False,
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
self.mocked_put.assert_not_called()
def test_no_domains(self):
result = self.runner.invoke(
run,
["my-user", str(self.private_key_path)],
catch_exceptions=True,
)
self.assertEqual(result.exit_code, 1)
self.assertEqual(str(result.exception), "No domain(s) specified")
self.mocked_get.assert_not_called()
self.mocked_put.assert_not_called()
def test_unknown_private_key_path(self):
result = self.runner.invoke(
run,
["my-user", str("/tmp/foo"), "foobar.com"],
catch_exceptions=True,
)
self.assertEqual(result.exit_code, 1)
self.assertEqual(str(result.exception), "Unknown private key path: /tmp/foo")
self.mocked_get.assert_not_called()
self.mocked_put.assert_not_called()

View file

@ -1,528 +0,0 @@
import json
import os
from pathlib import Path
from unittest import TestCase
from unittest.mock import Mock, call, patch
from click.testing import CliRunner
from requests import HTTPError
from transip_client.cli import DEFAULT_API_URL, DEFAULT_SERVICE, run
class RunTestCase(TestCase):
def setUp(self):
patcher = patch("transip_client.main.requests.get")
self.mocked_get = patcher.start()
patcher = patch("transip_client.main.requests.put")
self.mocked_put = patcher.start()
patcher = patch("transip_client.main.requests.Session.send")
self.mocked_session = patcher.start()
self.runner = CliRunner()
def test_simple(self):
self.mocked_get.side_effect = [
Mock(text="111.420"),
Mock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
with self.assertLogs("transip_client.main", level="INFO") as logger:
result = self.runner.invoke(
run, "foobar.com", env={"TOKEN": "token"}, catch_exceptions=False
)
self.assertEqual(
logger.output, ["INFO:transip_client.main:Updated domain foobar.com"]
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
expected_json = json.dumps(
{
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
]
}
)
self.mocked_put.assert_called_with(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
data=expected_json,
headers={"Authorization": "Bearer token"},
)
def test_error_response(self):
self.mocked_get.side_effect = [Mock(text="111.420"), HTTPError]
with self.assertLogs("transip_client.main", level="INFO") as logger:
result = self.runner.invoke(
run, ["foobar.com"], env={"TOKEN": "token"}, catch_exceptions=False
)
error_log = logger.output[0]
self.assertIn("Failed retrieving information for foobar.com", error_log)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
self.mocked_put.assert_not_called()
def test_matching_ip(self):
self.mocked_get.side_effect = [
Mock(text="111.420"),
Mock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
result = self.runner.invoke(run, ["foobar.com"], env={"TOKEN": "token"})
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
self.mocked_put.assert_not_called()
def test_readonly(self):
self.mocked_get.side_effect = [
Mock(text="111.420"),
Mock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
result = self.runner.invoke(
run, ["foobar.com", "--read-only"], env={"TOKEN": "token"}
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
self.mocked_put.assert_not_called()
def test_different_api_url(self):
self.mocked_get.side_effect = [
Mock(text="111.420"),
Mock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
with self.assertLogs("transip_client.main", level="INFO") as logger:
result = self.runner.invoke(
run,
["foobar.com", "--api-url", "https://other-provider.com"],
env={"TOKEN": "token"},
)
self.assertEqual(
logger.output, ["INFO:transip_client.main:Updated domain foobar.com"]
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
"https://other-provider.com/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
expected_json = json.dumps(
{
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
]
}
)
self.mocked_put.assert_called_with(
"https://other-provider.com/domains/foobar.com/dns",
data=expected_json,
headers={"Authorization": "Bearer token"},
)
def test_env_var(self):
self.mocked_get.side_effect = [
Mock(text="111.420"),
Mock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
with self.assertLogs("transip_client.main", level="INFO") as logger:
result = self.runner.invoke(
run,
["foobar.com"],
env={
"TOKEN": "token",
"API_URL": "https://new-api.com",
},
)
self.assertEqual(
logger.output, ["INFO:transip_client.main:Updated domain foobar.com"]
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
"https://new-api.com/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
)
expected_json = json.dumps(
{
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
]
}
)
self.mocked_put.assert_called_with(
"https://new-api.com/domains/foobar.com/dns",
data=expected_json,
headers={"Authorization": "Bearer token"},
)
def test_multi_arg_env_var(self):
self.mocked_get.side_effect = [
Mock(text="111.420"),
Mock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
},
),
Mock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foofoo.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foofoo.com",
},
],
}
),
]
with self.assertLogs("transip_client.main", level="INFO") as logger:
result = self.runner.invoke(
run, [], env={"TOKEN": "token", "DOMAINS": "foobar.com foofoo.com"}
)
self.assertIsNone(result.exception)
self.assertEqual(
logger.output,
[
"INFO:transip_client.main:Updated domain foobar.com",
"INFO:transip_client.main:Updated domain foofoo.com",
],
)
self.assertEqual(result.exit_code, 0)
expected_calls = [
call(DEFAULT_SERVICE, timeout=10),
call(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer token"},
),
call(
f"{DEFAULT_API_URL}/domains/foofoo.com/dns",
headers={"Authorization": "Bearer token"},
),
]
# use any_order because of the asynchronous requests
self.mocked_get.assert_has_calls(expected_calls, any_order=True)
expected_json = json.dumps(
{
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
]
}
)
expected_calls = [
call(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
data=expected_json,
headers={"Authorization": "Bearer token"},
),
call(
f"{DEFAULT_API_URL}/domains/foofoo.com/dns",
data=expected_json,
headers={"Authorization": "Bearer token"},
),
]
self.mocked_put.assert_has_calls(expected_calls, any_order=True)
def test_no_domains(self):
result = self.runner.invoke(run, [], env={"TOKEN": "token"})
self.assertEqual(result.exit_code, 1)
self.assertEqual(str(result.exception), "No domain(s) specified")
self.mocked_get.assert_not_called()
self.mocked_put.assert_not_called()
def test_no_token_or_login_with_private_key_path(self):
result = self.runner.invoke(run, ["foobar.com"])
self.assertEqual(result.exit_code, 1)
self.assertEqual(
str(result.exception),
"Either a token or a login name with a path to a private key need"
" to be specified",
)
self.mocked_get.assert_not_called()
self.mocked_put.assert_not_called()
def test_login_without_private_key_path(self):
result = self.runner.invoke(run, ["foobar.com"], env={"LOGIN": "foo"})
self.assertEqual(result.exit_code, 1)
self.assertEqual(
str(result.exception),
"Both a login name and the path to a private key need to be specified",
)
self.mocked_get.assert_not_called()
self.mocked_put.assert_not_called()
def test_login_with_private_key_path(self):
self.mocked_get.side_effect = [
Mock(text="111.420"),
Mock(
json=lambda: {
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.421",
}
],
"_links": [
{
"rel": "self",
"link": "https://api.transip.nl/v6/domains/foobar.com/dns",
},
{
"rel": "domain",
"link": "https://api.transip.nl/v6/domains/foobar.com",
},
],
}
),
]
self.mocked_session.return_value.json.return_value = {"token": "FOOBAR"}
private_key_path = (
Path(os.path.dirname(__file__)) / "files" / "test-private-key.pem"
)
with self.assertLogs("transip_client.main", level="INFO") as logger:
result = self.runner.invoke(
run,
["foobar.com"],
env={"LOGIN": "foo", "PRIVATE_KEY_PATH": str(private_key_path)},
)
self.assertEqual(
logger.output, ["INFO:transip_client.main:Updated domain foobar.com"]
)
self.assertEqual(result.exit_code, 0)
self.mocked_get.assert_called_with(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
headers={"Authorization": "Bearer FOOBAR"},
)
expected_json = json.dumps(
{
"dnsEntries": [
{
"name": "@",
"expire": 60,
"type": "A",
"content": "111.420",
}
]
}
)
self.mocked_put.assert_called_with(
f"{DEFAULT_API_URL}/domains/foobar.com/dns",
data=expected_json,
headers={"Authorization": "Bearer FOOBAR"},
)