feat: waiting functionality for DNS service

examples/wait/wait_example.py

@@ -0,0 +1,58 @@
+import os
+
+from stackit.core.configuration import Configuration
+from stackit.dns.api.default_api import DefaultApi
+from stackit.dns.models.create_record_set_payload import CreateRecordSetPayload
+from stackit.dns.models.create_zone_payload import CreateZonePayload
+from stackit.dns.models.record_payload import RecordPayload
+from stackit.dns.wait import (
+    wait_for_create_recordset,
+    wait_for_create_zone,
+    wait_for_delete_recordset,
+    wait_for_delete_zone,
+)
+
+project_id = os.getenv("PROJECT_ID")
+
+# Create a new API client, that uses default authentication and configuration
+config = Configuration()
+client = DefaultApi(config)
+
+
+# Create a new DNS zone
+create_zone_response = client.create_zone(
+    create_zone_payload=CreateZonePayload(name="myZone", dnsName="testZone.com"), project_id=project_id
+)
+zone_id = create_zone_response.zone.id
+
+# Wait for the zone to be fully created
+wait_for_zone_response = wait_for_create_zone(client, project_id, zone_id)
+
+# Create a DNS record in the newly created DNS zone
+create_record_response = client.create_record_set(
+    project_id,
+    zone_id,
+    CreateRecordSetPayload(
+        name="a",
+        records=[
+            RecordPayload(content="192.168.0.1"),  # Will go nowhere
+        ],
+        type="A",
+    ),
+)
+rr_set_id = create_record_response.rrset.id
+
+# Wait for the DNS record to be fully created
+wait_for_rr_set_record_response = wait_for_create_recordset(client, project_id, zone_id, rr_set_id)
+
+# delete newly created recordset
+delete_rr_set_message = client.delete_record_set(project_id, zone_id, rr_set_id)
+
+# Wait for rr_set deletion
+wait_for_rr_set_deletion_response = wait_for_delete_recordset(client, project_id, zone_id, rr_set_id)
+
+# Delete newly created DNS zone
+delete_zone_message = client.delete_zone(project_id, zone_id)
+
+# Wait for deletion of DNS zone
+wait_for_zone_deletion_response = wait_for_delete_zone(client, project_id, zone_id)

services/dns/pyproject.toml

@@ -18,7 +18,7 @@ packages = [
 
 [tool.poetry.dependencies]
 python = ">=3.8,<4.0"
-stackit-core = "^0.0.1a"
+stackit-core = "0.0.1a1"
 requests = "^2.32.3"
 pydantic = "^2.9.2"
 python-dateutil = "^2.9.0.post0"

services/dns/src/stackit/dns/wait.py

@@ -0,0 +1,255 @@
+from enum import Enum
+from typing import Any, Tuple, Union
+
+from stackit.core.wait import Wait
+
+from stackit.dns.api.default_api import DefaultApi
+from stackit.dns.exceptions import ApiException
+from stackit.dns.models.record_set_response import RecordSetResponse
+from stackit.dns.models.zone_response import ZoneResponse
+
+
+class _States(str, Enum):
+    CreateSuccess = "CREATE_SUCCEEDED"
+    CreateFail = "CREATE_FAILED"
+    UpdateSuccess = "UPDATE_SUCCEEDED"
+    UpdateFail = "UPDATE_FAILED"
+    DeleteSuccess = "DELETE_SUCCEEDED"
+    DeleteFail = "DELETE_FAILED"
+
+
+def wait_for_create_zone(
+    api_client: DefaultApi,
+    project_id: str,
+    zone_id: str,
+    sleep_before_wait: int = 0,
+    throttle: int = 5,
+    timeout: int = 30,
+    temp_error_retry_limit: int = 5,
+) -> ZoneResponse:
+
+    def get_zone_execute_state() -> Tuple[bool, Union[Exception, None], Union[int, None], Any]:
+
+        nonlocal api_client, project_id, zone_id
+
+        try:
+            response = api_client.get_zone(project_id, zone_id)
+            if response.zone.id != zone_id:
+                return False, ValueError("ID of zone in return not equal to ID of requested zone."), None, None
+            elif response.zone.state == _States.CreateSuccess:
+                return True, None, None, response
+            elif response.zone.state == _States.CreateFail:
+                return True, Exception("Create failed for zone with ID %s" % zone_id), None, response
+            else:
+                return False, None, None, None
+        except ApiException as e:
+            return False, e, e.status, None
+        except Exception as e:
+            return False, e, None, None
+
+    wait = Wait(
+        get_zone_execute_state,
+        sleep_before_wait=sleep_before_wait,
+        throttle=throttle,
+        timeout=timeout,
+        temp_error_retry_limit=temp_error_retry_limit,
+    )
+    return wait.wait()
+
+
+def wait_for_partial_update_zone(
+    api_client: DefaultApi,
+    project_id: str,
+    zone_id: str,
+    sleep_before_wait: int = 0,
+    throttle: int = 5,
+    timeout: int = 30,
+    temp_error_retry_limit: int = 5,
+) -> ZoneResponse:
+
+    def get_zone_execute_state() -> Tuple[bool, Union[Exception, None], Union[int, None], Any]:
+
+        nonlocal api_client, project_id, zone_id
+
+        try:
+            response = api_client.get_zone(project_id, zone_id)
+            if response.zone.id != zone_id:
+                return False, ValueError("ID of zone in return not equal to ID of requested zone."), None, None
+            elif response.zone.state == _States.UpdateSuccess:
+                return True, None, None, response
+            elif response.zone.state == _States.UpdateFail:
+                return True, Exception("Update failed for zone with ID %s" % zone_id), None, response
+            else:
+                return False, None, None, None
+        except ApiException as e:
+            return False, e, e.status, None
+        except Exception as e:
+            return False, e, None, None
+
+    wait = Wait(
+        get_zone_execute_state,
+        sleep_before_wait=sleep_before_wait,
+        throttle=throttle,
+        timeout=timeout,
+        temp_error_retry_limit=temp_error_retry_limit,
+    )
+    return wait.wait()
+
+
+def wait_for_delete_zone(
+    api_client: DefaultApi,
+    project_id: str,
+    zone_id: str,
+    sleep_before_wait: int = 0,
+    throttle: int = 5,
+    timeout: int = 30,
+    temp_error_retry_limit: int = 5,
+) -> ZoneResponse:
+
+    def get_zone_execute_state() -> Tuple[bool, Union[Exception, None], Union[int, None], Any]:
+
+        nonlocal api_client, project_id, zone_id
+
+        try:
+            response = api_client.get_zone(project_id, zone_id)
+            if response.zone.id != zone_id:
+                return False, ValueError("ID of zone in return not equal to ID of requested zone."), None, None
+            elif response.zone.state == _States.DeleteSuccess:
+                return True, None, None, response
+            elif response.zone.state == _States.DeleteFail:
+                return True, Exception("Delete failed for zone with ID %s" % zone_id), None, response
+            else:
+                return False, None, None, None
+        except ApiException as e:
+            return False, e, e.status, None
+        except Exception as e:
+            return False, e, None, None
+
+    wait = Wait(
+        get_zone_execute_state,
+        sleep_before_wait=sleep_before_wait,
+        throttle=throttle,
+        timeout=timeout,
+        temp_error_retry_limit=temp_error_retry_limit,
+    )
+    return wait.wait()
+
+
+def wait_for_create_recordset(
+    api_client: DefaultApi,
+    project_id: str,
+    zone_id: str,
+    rr_set_id: str,
+    sleep_before_wait: int = 0,
+    throttle: int = 5,
+    timeout: int = 30,
+    temp_error_retry_limit: int = 5,
+) -> RecordSetResponse:
+
+    def get_rr_set_execute_state() -> Tuple[bool, Union[Exception, None], Union[int, None], Any]:
+
+        nonlocal api_client, project_id, zone_id, rr_set_id
+
+        try:
+            response = api_client.get_record_set(project_id, zone_id, rr_set_id)
+            if response.rrset.id != rr_set_id:
+                return False, ValueError("ID of rrset in return not equal to ID of requested rrset."), None, None
+            elif response.rrset.state == _States.CreateSuccess:
+                return True, None, None, response
+            elif response.rrset.state == _States.CreateFail:
+                return True, Exception("Create failed for rrset with ID %s" % rr_set_id), None, response
+            else:
+                return False, None, None, None
+        except ApiException as e:
+            return False, e, e.status, None
+        except Exception as e:
+            return False, e, None, None
+
+    wait = Wait(
+        get_rr_set_execute_state,
+        sleep_before_wait=sleep_before_wait,
+        throttle=throttle,
+        timeout=timeout,
+        temp_error_retry_limit=temp_error_retry_limit,
+    )
+    return wait.wait()
+
+
+def wait_for_partial_update_recordset(
+    api_client: DefaultApi,
+    project_id: str,
+    zone_id: str,
+    rr_set_id: str,
+    sleep_before_wait: int = 0,
+    throttle: int = 5,
+    timeout: int = 30,
+    temp_error_retry_limit: int = 5,
+) -> RecordSetResponse:
+
+    def get_rr_set_execute_state() -> Tuple[bool, Union[Exception, None], Union[int, None], Any]:
+
+        nonlocal api_client, project_id, zone_id, rr_set_id
+
+        try:
+            response = api_client.get_record_set(project_id, zone_id, rr_set_id)
+            if response.rrset.id != rr_set_id:
+                return False, ValueError("ID of rrset in return not equal to ID of requested rrset."), None, None
+            elif response.rrset.state == _States.UpdateSuccess:
+                return True, None, None, response
+            elif response.rrset.state == _States.UpdateFail:
+                return True, Exception("Update failed for rrset with ID %s" % rr_set_id), None, response
+            else:
+                return False, None, None, None
+        except ApiException as e:
+            return False, e, e.status, None
+        except Exception as e:
+            return False, e, None, None
+
+    wait = Wait(
+        get_rr_set_execute_state,
+        sleep_before_wait=sleep_before_wait,
+        throttle=throttle,
+        timeout=timeout,
+        temp_error_retry_limit=temp_error_retry_limit,
+    )
+    return wait.wait()
+
+
+def wait_for_delete_recordset(
+    api_client: DefaultApi,
+    project_id: str,
+    zone_id: str,
+    rr_set_id: str,
+    sleep_before_wait: int = 0,
+    throttle: int = 5,
+    timeout: int = 30,
+    temp_error_retry_limit: int = 5,
+) -> RecordSetResponse:
+
+    def get_rr_set_execute_state() -> Tuple[bool, Union[Exception, None], Union[int, None], Any]:
+
+        nonlocal api_client, project_id, zone_id, rr_set_id
+
+        try:
+            response = api_client.get_record_set(project_id, zone_id, rr_set_id)
+            if response.rrset.id != rr_set_id:
+                return False, ValueError("ID of rrset in return not equal to ID of requested rrset."), None, None
+            elif response.rrset.state == _States.DeleteSuccess:
+                return True, None, None, response
+            elif response.rrset.state == _States.DeleteFail:
+                return True, Exception("Delete failed for rrset with ID %s" % rr_set_id), None, response
+            else:
+                return False, None, None, None
+        except ApiException as e:
+            return False, e, e.status, None
+        except Exception as e:
+            return False, e, None, None
+
+    wait = Wait(
+        get_rr_set_execute_state,
+        sleep_before_wait=sleep_before_wait,
+        throttle=throttle,
+        timeout=timeout,
+        temp_error_retry_limit=temp_error_retry_limit,
+    )
+    return wait.wait()