#14 fixture operational saas database

doc/changes/changes_0.3.0.md

@@ -8,4 +8,8 @@ This release adds integration tests for the most important calls to SaaS API.
 
 * #21: Added integration test for operation "create database"
 * #23: Added integration test for operation "add IP to whitelist"
+
+## Feature
+
+* #14: Added fixture waiting until SaaS database is running
 * #25: Fixed transitive dependencies required by generated API client

doc/developer_guide/developer_guide.md

@@ -43,8 +43,8 @@ openapi-python-client reads the JSON specification of the SaaS API and generates
 The easiest way is to make openapi-python-client create a dedicated file `pyproject.toml` and copy the transitive dependencies from there to SAPIPY's file `pyproject.toml`.
 
 In order to create file `pyproject.toml`
-* In file `noxfile.py` you need to replace mode `update` by `generate`
-* Additionally in file `openapi_config.yml` you need to specify a non-existing top-level directory as `name` and a package that does not contain slashes, e.g.
+* In file `noxfile.py`, function `generate_api` you need to replace mode `update` by `generate`.
+* Additionally, in file `openapi_config.yml` you need to specify a non-existing top-level directory as `project_name_override` and a package that does not contain slashes, e.g.
 
 ```yaml
 project_name_override: "generate"

pyproject.toml

@@ -25,6 +25,7 @@ python = ">=3.8.0,<4.0"
 requests = "^2.31.0"
 types-requests = "^2.31.0.6"
 ifaddr = "^0.2.0"
+tenacity = "^8.2.3"
 # generated by openapi-python-client
 httpx = ">=0.20.0,<0.28.0"
 attrs = ">=21.3.0"

test/integration/api_access.py

@@ -1,24 +1,36 @@
 from typing import Iterable
 from contextlib import contextmanager
-from datetime import datetime
+from datetime import datetime, timedelta
+from tenacity.wait import wait_fixed
+from tenacity.stop import stop_after_delay
 
 from exasol.saas.client import openapi
+from exasol.saas.client.openapi.models.status import Status
 from exasol.saas.client.openapi.api.databases import (
     create_database,
     delete_database,
     list_databases,
+    get_database,
 )
 from exasol.saas.client.openapi.api.security import (
     list_allowed_i_ps,
     add_allowed_ip,
     delete_allowed_ip,
 )
+from tenacity import retry, TryAgain
 
 
 def timestamp() -> str:
     return f'{datetime.now().timestamp():.0f}'
 
 
+class DatabaseStartupFailure(Exception):
+    """
+    If a SaaS database instance during startup reports a status other than
+    transitional or successful.
+    """
+
+
 def create_saas_client(
         host: str,
         pat: str,
@@ -88,6 +100,40 @@ def database(
             if not keep and db:
                 self.delete_database(db.id, ignore_delete_failure)
 
+    def get_database(self, database_id: str):
+        return get_database.sync(
+            self._account_id,
+            database_id,
+            client=self._client,
+        )
+
+    def wait_until_running(
+            self,
+            database_id: str,
+            timeout: timedelta = timedelta(minutes=30),
+            interval: timedelta = timedelta(minutes=2),
+    ) -> str:
+        transitional = [
+            Status.TOCREATE,
+            Status.CREATING,
+            Status.SCALING,
+        ]
+        success = [
+            Status.RUNNING,
+        ]
+
+        @retry(wait=wait_fixed(interval), stop=stop_after_delay(timeout))
+        def poll_status():
+            db = self.get_database(database_id)
+            if db.status in transitional:
+                print(f'status = {db.status}')
+                raise TryAgain
+            return db.status
+
+        if poll_status() not in success:
+            raise DatabaseStartupFailure()
+
+
     def list_allowed_ip_ids(self) -> Iterable[openapi.models.allowed_ip.AllowedIP]:
         ips = list_allowed_i_ps.sync(
             self._account_id,

test/integration/conftest.py

@@ -33,3 +33,10 @@ def saas_database(api_access) -> openapi.models.database.Database:
     """
     with api_access.database() as db:
         yield db
+
+
+@pytest.fixture(scope="session")
+def operational_saas_database_id(api_access) -> str:
+    with api_access.database() as db:
+        api_access.wait_until_running(db.id)
+        yield db

test/integration/databases_test.py

@@ -1,4 +1,7 @@
+import pytest
 from exasol.saas.client import openapi
+from tenacity import RetryError
+from datetime import timedelta
 
 
 def test_lifecycle(api_access):
@@ -24,3 +27,14 @@ def test_lifecycle(api_access):
         # delete database and verify database is not listed anymore
         testee.delete_database(db.id)
         assert db.id not in testee.list_database_ids()
+
+
+def test_poll(api_access):
+    with api_access.database() as db:
+        print(f'{db.status}')
+        with pytest.raises(RetryError):
+            api_access.wait_until_running(
+                db.id,
+                timeout=timedelta(seconds=3),
+                interval=timedelta(seconds=1),
+            )