#14 fixture operational saas database

.github/workflows/checks.yml

@@ -109,6 +109,7 @@ jobs:
           SAAS_HOST: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_HOST }}
           SAAS_ACCOUNT_ID: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_ACCOUNT_ID }}
           SAAS_PAT: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_PAT }}
+          PYTEST_ADDOPTS: -o log_cli=true -o log_cli_level=INFO
         run: poetry run nox -s coverage -- --
 
       - name: Upload Artifacts

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"
@@ -56,6 +57,10 @@ source = [
     "exasol",
 ]
 
+omit = [
+    '*/exasol/saas/client/openapi/*',
+]
+
 [tool.coverage.report]
 fail_under = 15
 

test/integration/api_access.py

@@ -1,22 +1,52 @@
+import getpass
+import logging
+import time
+
 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
+
+
+LOG = logging.getLogger(__name__)
+LOG.setLevel(logging.INFO)
+
+
+# For auto-stopping idle database clusters
+MINIMUM_IDLE_TIME = timedelta(minutes=15)
+
+
+# If deleting a database too early, then logging and accounting could be invalid.
+MINIMUM_LIFETIME = timedelta(seconds=30)
+
+
+def _timestamp_name() -> str:
+    username = getpass.getuser()
+    timestamp = f'{datetime.now().timestamp():.0f}'
+    return f"{username}-{timestamp}"
 
 
-def timestamp() -> str:
-    return f'{datetime.now().timestamp():.0f}'
+class DatabaseStartupFailure(Exception):
+    """
+    If a SaaS database instance during startup reports a status other than
+    successful.
+    """
 
 
 def create_saas_client(
@@ -46,12 +76,18 @@ def create_database(self, cluster_size: str = "XS") -> openapi.models.database.D
         cluster_spec = openapi.models.CreateCluster(
             name="my-cluster",
             size=cluster_size,
+            auto_stop=openapi.models.AutoStop(
+                enabled=True,
+                idle_time=int(MINIMUM_IDLE_TIME.seconds / 60),
+            ),
         )
+        db_name = _timestamp_name()
+        LOG.info(f"Creating database {db_name}")
         return create_database.sync(
             self._account_id,
             client=self._client,
             body=openapi.models.CreateDatabase(
-                name=f"pytest-{timestamp()}",
+                name=db_name,
                 initial_cluster=cluster_spec,
                 provider="aws",
                 region='us-east-1',
@@ -81,12 +117,52 @@ def database(
             ignore_delete_failure: bool = False,
     ):
         db = None
+        start = datetime.now()
         try:
             db = self.create_database()
             yield db
+            self.wait_for_delete_clearance(start)
         finally:
-            if not keep and db:
-                self.delete_database(db.id, ignore_delete_failure)
+            if db and not keep:
+                LOG.info(f"Deleting database {db.name}")
+                response = self.delete_database(db.id, ignore_delete_failure)
+                if response.status_code == 200:
+                    LOG.info(f"Successfully deleted database {db.name}.")
+                else:
+                    LOG.info(f"Ignoring status code {response.status_code}.")
+            elif not db:
+                LOG.warning("Cannot delete db None")
+            else:
+                LOG.info(f"Keeping database {db.name} as keep = {keep}")
+
+    def get_database(self, database_id: str) -> openapi.models.database.Database:
+        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:
+        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 not in success:
+                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(
@@ -95,6 +171,14 @@ def list_allowed_ip_ids(self) -> Iterable[openapi.models.allowed_ip.AllowedIP]:
         )
         return (x.id for x in ips)
 
+    def wait_for_delete_clearance(self, start: datetime.time):
+        lifetime = datetime.now() - start
+        if lifetime < MINIMUM_LIFETIME:
+            wait = MINIMUM_LIFETIME - lifetime
+            LOG.info(f"Waiting {int(wait.seconds)} seconds"
+                     " before deleting the database.")
+            time.sleep(wait.seconds)
+
     def add_allowed_ip(self, cidr_ip: str = "0.0.0.0/0") -> openapi.models.allowed_ip.AllowedIP:
         """
         Suggested values for cidr_ip:
@@ -103,7 +187,7 @@ def add_allowed_ip(self, cidr_ip: str = "0.0.0.0/0") -> openapi.models.allowed_i
         * ::/0 = all ipv6
         """
         rule = openapi.models.create_allowed_ip.CreateAllowedIP(
-            name=f"pytest-{timestamp()}",
+            name=_timestamp_name(),
             cidr_ip=cidr_ip,
         )
         return add_allowed_ip.sync(
@@ -129,5 +213,5 @@ def allowed_ip(
             ip = self.add_allowed_ip(cidr_ip)
             yield ip
         finally:
-            if not keep and ip:
+            if ip and not keep:
                 self.delete_allowed_ip(ip.id, ignore_delete_failure)

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,8 @@
+import pytest
+
 from exasol.saas.client import openapi
+from tenacity import RetryError
+from datetime import datetime, timedelta
 
 
 def test_lifecycle(api_access):
@@ -14,6 +18,7 @@ def test_lifecycle(api_access):
 
     testee = api_access
     with testee.database(ignore_delete_failure=True) as db:
+        start = datetime.now()
         # verify state and clusters of created database
         assert db.status == openapi.models.Status.TOCREATE and \
             db.clusters.total == 1
@@ -22,5 +27,17 @@ def test_lifecycle(api_access):
         assert db.id in testee.list_database_ids()
 
         # delete database and verify database is not listed anymore
+        testee.wait_for_delete_clearance(start)
         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),
+            )