test: Add baseline tests for package.

Author: mitjohnson

tests/conftest.py

@@ -0,0 +1,19 @@
+import os
+import pytest
+
+
+@pytest.fixture(autouse=True)
+def setup_and_teardown_per_test():
+    """Setup and teardown logic for each test run."""
+    with open("py_ddns.ini", "w") as f:
+        f.write("""[Client_settings]\nlogging_level=info\n""")
+
+    yield  # This allows each test to run before cleanup
+
+    files = ["py_ddns.ini", "py_ddns.db", "py_ddns.log"]
+    for file in files:
+        try:
+            if os.path.exists(file):
+                os.remove(file)
+        except Exception as e:
+            print(f"Error occurred while trying to remove {file}: {e}")

tests/test_client.py

@@ -0,0 +1,29 @@
+import pytest
+from pyddns.client import DDNSClient
+
+
+class TestDDNSClient(DDNSClient):
+    def update_dns(self, ip_address: str, record_name: str) -> None:
+        pass  # Mock implementation for testing
+
+
+def test_ddns_client_ipv4():
+    client = TestDDNSClient()
+    ip = client.get_ipv4()
+    assert ip is not None, "Failed to retrieve IPv4 address!"
+    assert isinstance(ip, str), "Returned IP is not a string!"
+
+
+@pytest.mark.parametrize(
+    "ip_address, record_name",
+    [
+        ("127.0.0.1", "test.example.com"),
+        ("192.168.0.1", "local.example.com"),
+    ],
+)
+def test_ddns_client_update_dns(ip_address, record_name):
+    client = TestDDNSClient()
+    try:
+        client.update_dns(ip_address, record_name)
+    except Exception as e:
+        pytest.fail(f"update_dns raised an exception: {e}")

tests/test_cloudflare_service.py

@@ -0,0 +1,34 @@
+import pytest
+from unittest.mock import MagicMock
+from pyddns.services.cloudflare_service import CloudflareDNS
+
+
+def test_cloudflare_dns_initialization():
+    with pytest.raises(KeyError):
+        CloudflareDNS(api_token=None, zone_id=None)
+
+    client = CloudflareDNS(api_token="test_token", zone_id="test_zone")
+    assert client is not None, "Failed to initialize CloudflareDNS!"
+
+
+def test_cloudflare_dns_update():
+    client = CloudflareDNS(api_token="test_token", zone_id="test_zone")
+    client.cf_client = MagicMock()
+
+    try:
+        client.update_dns("127.0.0.1", "test.example.com")
+    except Exception as e:
+        pytest.fail(f"update_dns raised an exception: {e}")
+
+
+def test_cloudflare_dns_obtain_record():
+    client = CloudflareDNS(api_token="test_token", zone_id="test_zone")
+    client.cf_client = MagicMock()
+    client.cf_client.dns.records.list = MagicMock(
+        return_value=MagicMock(result=[])
+    )
+
+    record = client._obtain_record("test.example.com")
+    assert (
+        record is None
+    ), "_obtain_record should return None if no records are found!"

tests/test_config.py

@@ -0,0 +1,19 @@
+import pytest
+from pyddns.config import Config
+
+
+def test_config_singleton():
+    config1 = Config(config_file="py_ddns.ini")
+    config2 = Config(config_file="py_ddns.ini")
+    assert config1 is config2, "Config is not a singleton!"
+
+
+def test_config_get():
+    config = Config(config_file="py_ddns.ini")
+    value = config.get("Client_settings", "logging_level")
+    assert value == "info", "Config did not return the correct value!"
+
+
+def test_config_file_not_found():
+    with pytest.raises(FileNotFoundError):
+        Config(config_file="non_existent.ini")

tests/test_duckdns_service.py

@@ -0,0 +1,37 @@
+import pytest
+from unittest.mock import MagicMock
+from pyddns.services.duckdns_service import DuckDNS
+
+
+def test_duckdns_initialization():
+    with pytest.raises(KeyError):
+        DuckDNS(token=None)
+
+    client = DuckDNS(token="test_token")
+    assert client is not None, "Failed to initialize DuckDNS!"
+
+
+def test_duckdns_update():
+    client = DuckDNS(token="test_token")
+    client.storage = MagicMock()
+    client.storage.update_ip = MagicMock()
+
+    client._parse_api_response = MagicMock(
+        return_value=("OK", "127.0.0.1", None, "UPDATED")
+    )
+
+    try:
+        client.update_dns("127.0.0.1", "test.example.com")
+    except Exception as e:
+        pytest.fail(f"update_dns raised an exception: {e}")
+
+    client.storage.update_ip.assert_called_once()
+
+
+def test_duckdns_obtain_record():
+    client = DuckDNS(token="test_token")
+    client.storage = MagicMock()
+    client.storage.retrieve_record = MagicMock(return_value="test")
+
+    record = client._obtain_record("test.example.com")
+    assert record == "test", "_obtain_record should return the correct record!"

tests/test_storage.py

@@ -0,0 +1,28 @@
+from pyddns.storage import Storage
+
+
+def test_storage_singleton():
+    storage1 = Storage(filename="py_ddns.db")
+    storage2 = Storage(filename="py_ddns.db")
+    assert storage1 is storage2, "Storage is not a singleton!"
+
+
+def test_storage_create_tables():
+    storage = Storage(filename="py_ddns.db")
+    assert storage.cursor is not None, "Cursor is not initialized!"
+
+
+def test_storage_add_and_retrieve():
+    storage = Storage(filename="py_ddns.db")
+    storage.add_service("TestService", "test.example.com", "127.0.0.1")
+    record = storage.retrieve_record("test.example.com")
+    assert record is not None, "Failed to retrieve the record!"
+    assert record[0] == "127.0.0.1", "Retrieved IP does not match!"
+
+
+def test_storage_update_ip():
+    storage = Storage(filename="py_ddns.db")
+    storage.add_service("TestService2", "test2.example.com", "127.0.0.1")
+    storage.update_ip("TestService2", "test2.example.com", "127.0.0.2")
+    record = storage.retrieve_record("test2.example.com")
+    assert record[0] == "127.0.0.2", "IP address was not updated!"