Minor adjustments pre-v2.3 (#431)

* pcu descriptor classes get as many optional fields
as makes sense; changed the exception raised for
non-existing pcu group id in create_database.

* adjust tests to changed exception in create_db

* create_database: different error for nonexistent pcu group vs. in another region

* Address review comments; BUMP TO 2.3.0

Author: sl-at-ibm

CHANGES

@@ -1,5 +1,5 @@
-main
-====
+v 2.3.0
+=======
 Supported Python versions are now 3.10 to 3.14:
     - removal of Python 3.9 [Breaking change w.r.t. 2.2]
 `AstraDatabaseAdmin`: support for listing PCU Groups.
@@ -29,13 +29,11 @@ maintenance: base and vectorize integration tests fail fast unless all non-syste
 
 v 2.2.1
 =======
-
 Suppress warning about unexpected 'pcu_types' field in `[async_]find_available_regions`.
 Maintenance:
     - Minor edits to `release.yaml` workflow (secrets; task names/comments).
 
 
-
 v 2.2.0
 =======
 Supported Python versions are now 3.9 to 3.14:

astrapy/admin/admin.py

@@ -1236,30 +1236,53 @@ def create_database(
         # If a PCU group ID is provided, try to validate it
         if _definition.pcu_group_id is not None:
             logger.info("PCU Group ID pre-check: starting existence check.")
-            pcu_groups: list[PCUGroupDescriptor] | None
+            pcu_groups_overall: list[PCUGroupDescriptor] | None
             try:
-                pcu_groups = self.list_pcu_groups(
-                    cloud_provider=_definition.cloud_provider,
-                    region=_definition.region,
+                pcu_groups_overall = self.list_pcu_groups(
                     database_admin_timeout_ms=database_admin_timeout_ms,
                     request_timeout_ms=request_timeout_ms,
                     timeout_ms=timeout_ms,
                 )
             except Exception as e:
-                pcu_groups = None
+                pcu_groups_overall = None
                 logger.info(f"PCU Group ID pre-check threw an exception: {str(e)}")
-            if pcu_groups is not None:
-                matching_pcu_groups = [
-                    pg for pg in pcu_groups if pg.id == _definition.pcu_group_id
+            if pcu_groups_overall is not None:
+                matching_pcu_groups_overall = [
+                    pg for pg in pcu_groups_overall if pg.id == _definition.pcu_group_id
                 ]
-                logger.info(
-                    "PCU Group ID pre-check failed. Aborting database creation."
-                )
-                if matching_pcu_groups == []:
-                    raise ValueError(
-                        f"Requested PCU Group ID '{_definition.pcu_group_id}' not found for cloud provider "
-                        f"('{_definition.cloud_provider}') and region ('{_definition.region}')."
+                if matching_pcu_groups_overall == []:
+                    # no such pcu group id at all: abort 1
+                    logger.info(
+                        "PCU Group ID pre-check did not pass (id not found). "
+                        "Aborting database creation."
+                    )
+                    raise DevOpsAPIException(
+                        f"Requested PCU Group ID '{_definition.pcu_group_id}' not "
+                        "found for cloud provider provider/region "
+                        f"('{_definition.cloud_provider}' / '{_definition.region}'). "
+                        "Aborting database creation."
+                    )
+                else:
+                    # is the matching group in the right cloud provider / region?
+                    expected_cpr = (
+                        _definition.cloud_provider.lower(),
+                        _definition.region.lower(),
+                    )
+                    found_cpr = (
+                        matching_pcu_groups_overall[0].cloud_provider.lower(),
+                        matching_pcu_groups_overall[0].region.lower(),
                     )
+                    if expected_cpr != found_cpr:
+                        # wrong region: abort 2
+                        logger.info(
+                            "PCU Group ID pre-check did not pass (wrong "
+                            "provider/region). Aborting database creation."
+                        )
+                        raise DevOpsAPIException(
+                            f"Requested PCU Group ID '{_definition.pcu_group_id}' "
+                            f"is in another cloud provider and region ('{found_cpr[0]}' "
+                            f"/ '{found_cpr[1]}'). Aborting database creation."
+                        )
                 logger.info("PCU Group ID pre-check succeeded.")
             else:
                 logger.info("PCU Group ID pre-check aborted.")
@@ -1513,32 +1536,55 @@ async def async_create_database(
         # If a PCU group ID is provided, try to validate it
         if _definition.pcu_group_id is not None:
             logger.info("PCU Group ID pre-check: starting existence check, async.")
-            pcu_groups: list[PCUGroupDescriptor] | None
+            pcu_groups_overall: list[PCUGroupDescriptor] | None
             try:
-                pcu_groups = await self.async_list_pcu_groups(
-                    cloud_provider=_definition.cloud_provider,
-                    region=_definition.region,
+                pcu_groups_overall = await self.async_list_pcu_groups(
                     database_admin_timeout_ms=database_admin_timeout_ms,
                     request_timeout_ms=request_timeout_ms,
                     timeout_ms=timeout_ms,
                 )
             except Exception as e:
-                pcu_groups = None
+                pcu_groups_overall = None
                 logger.info(
-                    f"PCU Group ID pre-check threw an exception, async: {str(e)}"
+                    f"PCU Group ID pre-check threw an exception: {str(e)}, async"
                 )
-            if pcu_groups is not None:
-                matching_pcu_groups = [
-                    pg for pg in pcu_groups if pg.id == _definition.pcu_group_id
+            if pcu_groups_overall is not None:
+                matching_pcu_groups_overall = [
+                    pg for pg in pcu_groups_overall if pg.id == _definition.pcu_group_id
                 ]
-                logger.info(
-                    "PCU Group ID pre-check failed. Aborting database creation, async."
-                )
-                if matching_pcu_groups == []:
-                    raise ValueError(
-                        f"Requested PCU Group ID '{_definition.pcu_group_id}' not found for cloud provider "
-                        f"('{_definition.cloud_provider}') and region ('{_definition.region}')."
+                if matching_pcu_groups_overall == []:
+                    # no such pcu group id at all: abort 1
+                    logger.info(
+                        "PCU Group ID pre-check did not pass (id not found). "
+                        "Aborting database creation, async."
+                    )
+                    raise DevOpsAPIException(
+                        f"Requested PCU Group ID '{_definition.pcu_group_id}' "
+                        "not found for cloud provider provider/region "
+                        f"('{_definition.cloud_provider}' / '{_definition.region}'). "
+                        "Aborting database creation."
+                    )
+                else:
+                    # is the matching group in the right cloud provider / region?
+                    expected_cpr = (
+                        _definition.cloud_provider.lower(),
+                        _definition.region.lower(),
+                    )
+                    found_cpr = (
+                        matching_pcu_groups_overall[0].cloud_provider.lower(),
+                        matching_pcu_groups_overall[0].region.lower(),
                     )
+                    if expected_cpr != found_cpr:
+                        # wrong region: abort 2
+                        logger.info(
+                            "PCU Group ID pre-check did not pass (wrong "
+                            "provider/region). Aborting database creation, async."
+                        )
+                        raise DevOpsAPIException(
+                            f"Requested PCU Group ID '{_definition.pcu_group_id}' "
+                            f"is in another cloud provider and region ('{found_cpr[0]}' "
+                            f"/ '{found_cpr[1]}'). Aborting database creation."
+                        )
                 logger.info("PCU Group ID pre-check succeeded, async.")
             else:
                 logger.info("PCU Group ID pre-check aborted, async.")
@@ -1563,7 +1609,8 @@ async def async_create_database(
                 )
                 raise PermissionError(CANNOT_POLL_ERROR_MESSAGE)
         logger.info(
-            f"creating database {name}/({_definition.cloud_provider}, {_definition.region}) (DevOps API), async"
+            f"creating database {name}/({_definition.cloud_provider}, "
+            f"{_definition.region}) (DevOps API), async"
         )
         cd_raw_response = await self._dev_ops_api_commander.async_raw_request(
             caller_function_name="async_create_database",

astrapy/data/info/database_info.py

@@ -545,12 +545,23 @@ class PCUGroupTypeDetailsDescriptor:
         disk_cache: the amount of disk cache for this PCU type.
     """
 
-    v_cpu: int
-    memory: str
-    disk_cache: str
+    v_cpu: int | None = None
+    memory: str | None = None
+    disk_cache: str | None = None
 
     def __repr__(self) -> str:
-        body = f"v_cpu={self.v_cpu}, memory={self.memory}, disk_cache={self.disk_cache}"
+        pieces = [
+            pc
+            for pc in (
+                f"v_cpu={self.v_cpu}" if self.v_cpu is not None else None,
+                f"memory={self.memory}" if self.memory is not None else None,
+                f"disk_cache={self.disk_cache}"
+                if self.disk_cache is not None
+                else None,
+            )
+            if pc is not None
+        ]
+        body = ", ".join(pieces)
         return f"{self.__class__.__name__}({body})"
 
     def as_dict(self) -> dict[str, Any]:
@@ -559,9 +570,13 @@ def as_dict(self) -> dict[str, Any]:
         """
 
         return {
-            "vCPU": self.v_cpu,
-            "memory": self.memory,
-            "disk_cache": self.disk_cache,
+            k: v
+            for k, v in {
+                "vCPU": self.v_cpu,
+                "memory": self.memory,
+                "disk_cache": self.disk_cache,
+            }.items()
+            if v is not None
         }
 
     @classmethod
@@ -581,9 +596,9 @@ def _from_dict(cls, raw_dict: dict[str, Any]) -> PCUGroupTypeDetailsDescriptor:
             },
         )
         return PCUGroupTypeDetailsDescriptor(
-            v_cpu=raw_dict["vCPU"],
-            memory=raw_dict["memory"],
-            disk_cache=raw_dict["disk_cache"],
+            v_cpu=raw_dict.get("vCPU"),
+            memory=raw_dict.get("memory"),
+            disk_cache=raw_dict.get("disk_cache"),
         )
 
 
@@ -603,7 +618,7 @@ class PCUGroupTypeDescriptor:
     type: str
     region: str | None
     cloud_provider: str | None
-    details: PCUGroupTypeDetailsDescriptor
+    details: PCUGroupTypeDetailsDescriptor | None
 
     def __repr__(self) -> str:
         pieces = [
@@ -614,7 +629,7 @@ def __repr__(self) -> str:
                 f"cloud_provider={self.cloud_provider}"
                 if self.cloud_provider is not None
                 else None,
-                "details=...",
+                "details=..." if self.details is not None else None,
             )
             if pc is not None
         ]
@@ -632,7 +647,7 @@ def as_dict(self) -> dict[str, Any]:
                 "type": self.type,
                 "region": self.region,
                 "provider": self.cloud_provider,
-                "details": self.details.as_dict(),
+                "details": self.details.as_dict() if self.details is not None else None,
             }.items()
             if v is not None
         }
@@ -658,7 +673,9 @@ def _from_dict(cls, raw_dict: dict[str, Any]) -> PCUGroupTypeDescriptor:
             type=raw_dict["type"],
             region=raw_dict.get("region"),
             cloud_provider=raw_dict["provider"] if "provider" in raw_dict else None,
-            details=PCUGroupTypeDetailsDescriptor._from_dict(raw_dict["details"]),
+            details=PCUGroupTypeDetailsDescriptor._from_dict(raw_dict["details"])
+            if "details" in raw_dict
+            else None,
         )
 
 
@@ -689,26 +706,36 @@ class PCUGroupDescriptor:
     """
 
     id: str
-    org_id: str
-    title: str
+    org_id: str | None
+    title: str | None
     cloud_provider: str
     region: str
-    instance_type: str
-    pcu_type: PCUGroupTypeDescriptor
-    provision_type: str
-    min: int
-    max: int
-    description: str
+    instance_type: str | None
+    pcu_type: PCUGroupTypeDescriptor | None
+    provision_type: str | None
+    min: int | None
+    max: int | None
+    description: str | None
     created_at: datetime.datetime | None
     updated_at: datetime.datetime | None
-    created_by: str
-    updated_by: str
-    status: str
+    created_by: str | None
+    updated_by: str | None
+    status: str | None
     reserved: int | None = None
 
     def __repr__(self) -> str:
-        body = f"id={self.id}, org_id={self.org_id}, title={self.title}, status={self.status}, ..."
-        return f"{self.__class__.__name__}({body})"
+        pieces = [
+            pc
+            for pc in (
+                f"id={self.id}" if self.id is not None else None,
+                f"org_id={self.org_id}" if self.org_id is not None else None,
+                f"title={self.title}" if self.title is not None else None,
+                f"status={self.status}" if self.status is not None else None,
+            )
+            if pc is not None
+        ]
+        body = ", ".join(pieces)
+        return f"{self.__class__.__name__}({body}, ...)"
 
     def as_dict(self) -> dict[str, Any]:
         """
@@ -724,7 +751,9 @@ def as_dict(self) -> dict[str, Any]:
                 "cloudProvider": self.cloud_provider,
                 "region": self.region,
                 "instanceType": self.instance_type,
-                "pcuType": self.pcu_type.as_dict(),
+                "pcuType": self.pcu_type.as_dict()
+                if self.pcu_type is not None
+                else None,
                 "provisionType": self.provision_type,
                 "min": self.min,
                 "max": self.max,
@@ -775,20 +804,22 @@ def _from_dict(cls, raw_dict: dict[str, Any]) -> PCUGroupDescriptor:
         )
         return PCUGroupDescriptor(
             id=raw_dict["uuid"],
-            org_id=raw_dict["orgId"],
-            title=raw_dict["title"],
+            org_id=raw_dict.get("orgId"),
+            title=raw_dict.get("title"),
             cloud_provider=raw_dict["cloudProvider"],
             region=raw_dict["region"],
-            instance_type=raw_dict["instanceType"],
-            pcu_type=PCUGroupTypeDescriptor._from_dict(raw_dict["pcuType"]),
-            provision_type=raw_dict["provisionType"],
-            min=raw_dict["min"],
-            max=raw_dict["max"],
+            instance_type=raw_dict.get("instanceType"),
+            pcu_type=PCUGroupTypeDescriptor._from_dict(raw_dict["pcuType"])
+            if "pcuType" in raw_dict
+            else None,
+            provision_type=raw_dict.get("provisionType"),
+            min=raw_dict.get("min"),
+            max=raw_dict.get("max"),
             reserved=raw_dict.get("reserved"),
-            description=raw_dict["description"],
+            description=raw_dict.get("description"),
             created_at=_failsafe_parse_date(raw_dict.get("createdAt")),
             updated_at=_failsafe_parse_date(raw_dict.get("updatedAt")),
-            created_by=raw_dict["createdBy"],
-            updated_by=raw_dict["updatedBy"],
-            status=raw_dict["status"],
+            created_by=raw_dict.get("createdBy"),
+            updated_by=raw_dict.get("updatedBy"),
+            status=raw_dict.get("status"),
         )

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 requires-python = ">=3.10,<4.0"
 name = "astrapy"
-version = "2.2.1"
+version = "2.3.0"
 description = "A Python client for the Data API on DataStax Astra DB"
 authors = [
     {"name" = "Stefano Lottini", "email" = "stefano.lottini@ibm.com"},

tests/base/admin_assets.py

@@ -15,6 +15,7 @@
 from __future__ import annotations
 
 import datetime
+from typing import Any
 
 from astrapy.info import (
     PCUGroupTypeDescriptor,
@@ -130,3 +131,15 @@
     "updated_by": "umWGYUwuxFvQKBKPAHwHjKef",
     "status": "CREATED",
 }
+
+MINIMAL_PCU_GROUP_DESCRIPTOR = {
+    "uuid": "minimal_pgd_id",
+    "cloudProvider": "AWS",
+    "region": "us-west-2",
+}
+
+MINIMAL_PCU_GROUP_TYPE_DESCRIPTOR = {
+    "type": "small",
+}
+
+MINIMAL_PCU_GROUP_TYPE_DETAILS_DESCRIPTOR: dict[str, Any] = {}