feat: DPV1

Author: Gu1nness

.github/workflows/ci.yaml

@@ -167,8 +167,6 @@ jobs:
           # Update whenever charmcraft.yaml is changed
           - series: jammy 
             bases-index: 0
-          - series: noble
-            bases-index: 1
         tox-environments:
           - integration-db-v1
           - integration-opensearch-v1

.gitignore

@@ -5,12 +5,24 @@ build/
 .coverage
 __pycache__/
 *.py[cod]
-tests/integration/application-charm/lib/charms/data_platform_libs/v0/database_requires.py
-tests/integration/database-charm/lib/charms/data_platform_libs/v0/database_provides.py
-tests/integration/application-charm/lib/charms/data_platform_libs/v0/data_interfaces.py
-tests/integration/application-s3-charm/lib/charms/data_platform_libs/v0/s3.py
-tests/integration/database-charm/lib/charms/data_platform_libs/v0/data_interfaces.py
-tests/integration/kafka-charm/lib/charms/data_platform_libs/v0/data_interfaces.py
-tests/integration/s3-charm/lib/charms/data_platform_libs/v0/s3.py'
+tests/v0/integration/application-charm/lib/charms/data_platform_libs/v0/database_requires.py
+tests/v0/integration/database-charm/lib/charms/data_platform_libs/v0/database_provides.py
+tests/v0/integration/application-charm/lib/charms/data_platform_libs/v0/data_interfaces.py
+tests/v0/integration/application-s3-charm/lib/charms/data_platform_libs/v0/s3.py
+tests/v0/integration/database-charm/lib/charms/data_platform_libs/v0/data_interfaces.py
+tests/v0/integration/kafka-charm/lib/charms/data_platform_libs/v0/data_interfaces.py
+tests/v0/integration/s3-charm/lib/charms/data_platform_libs/v0/s3.py
+tests/v1/integration/application-charm/lib/charms/data_platform_libs/v1/database_requires.py
+tests/v1/integration/database-charm/lib/charms/data_platform_libs/v1/database_provides.py
+tests/v1/integration/application-charm/lib/charms/data_platform_libs/v1/data_interfaces.py
+tests/v1/integration/application-s3-charm/lib/charms/data_platform_libs/v1/s3.py
+tests/v1/integration/database-charm/lib/charms/data_platform_libs/v1/data_interfaces.py
+tests/v1/integration/kafka-charm/lib/charms/data_platform_libs/v1/data_interfaces.py
+tests/v1/integration/s3-charm/lib/charms/data_platform_libs/v1/s3.py'
+tests/v1/integration/backward-compatibility-charm/lib/charms/data_platform_libs/v0/data_interfaces.py
+tests/v1/integration/backward-compatibility-charm/lib/charms/data_platform_libs/v1/data_interfaces.py
+tests/v1/integration/opensearch-charm/lib/charms/data_platform_libs/v1/data_interfaces.py
+tests/v1/integration/kafka-connect-charm/lib/charms/data_platform_libs/v1/data_interfaces.py
+tests/v1/integration/dummy-database-charm/lib/charms/data_platform_libs/v1/data_interfaces.py
 .vscode/
 .idea/

lib/charms/data_platform_libs/v1/data_interfaces.py

@@ -287,9 +287,9 @@ def _on_database_requested(self, event: DatabaseRequestedEvent) -> None:
 from typing_extensions import TypeAliasType, override
 
 try:
-    import psycopg
+    import psycopg2
 except ImportError:
-    psycopg = None
+    psycopg2 = None
 
 # The unique Charmhub library identifier, never change it
 LIBID = "6c3e6b6680d64e9c89e611d1a15f65be"
@@ -654,6 +654,7 @@ class PeerModel(BaseModel):
         populate_by_name=True,
         serialize_by_alias=True,
         alias_generator=lambda x: x.replace("_", "-"),
+        extra="allow",
     )
 
     @model_validator(mode="after")
@@ -680,6 +681,8 @@ def extract_secrets(self, info: ValidationInfo):
 
                 if value and field_info.annotation == OptionalSecretBool:
                     value = SecretBool(json.loads(value))
+                elif value:
+                    value = SecretStr(value)
                 setattr(self, field, value)
 
         return self
@@ -706,9 +709,11 @@ def serialize_model(self, handler: SerializerFunctionWrapHandler, info: Serializ
                 actual_value = (
                     value.get_secret_value() if issubclass(value.__class__, _SecretBase) else value
                 )
+                if not isinstance(actual_value, str):
+                    actual_value = json.dumps(actual_value)
 
                 if secret is None:
-                    if actual_value:
+                    if value:
                         secret = repository.add_secret(
                             aliased_field,
                             actual_value,
@@ -721,11 +726,9 @@ def serialize_model(self, handler: SerializerFunctionWrapHandler, info: Serializ
                 content = secret.get_content()
                 full_content = copy.deepcopy(content)
 
-                if actual_value is None:
-                    full_content.pop(field, None)
+                if value is None:
+                    full_content.pop(aliased_field, None)
                 else:
-                    if not isinstance(actual_value, str):
-                        actual_value = json.dumps(actual_value)
                     full_content.update({aliased_field: actual_value})
                 secret.set_content(full_content)
         return handler(self)
@@ -744,6 +747,7 @@ class CommonModel(BaseModel):
         populate_by_name=True,
         serialize_by_alias=True,
         alias_generator=lambda x: x.replace("_", "-"),
+        extra="allow",
     )
 
     resource: str = Field(validation_alias=AliasChoices(*RESOURCE_ALIASES), default="")
@@ -787,6 +791,9 @@ def extract_secrets(self, info: ValidationInfo):
                 value = secret.get_content().get(aliased_field)
                 if value and field_info.annotation == OptionalSecretBool:
                     value = SecretBool(json.loads(value))
+                elif value:
+                    value = SecretStr(value)
+
                 setattr(self, field, value)
         return self
 
@@ -822,9 +829,11 @@ def serialize_model(self, handler: SerializerFunctionWrapHandler, info: Serializ
                 actual_value = (
                     value.get_secret_value() if issubclass(value.__class__, _SecretBase) else value
                 )
+                if not isinstance(actual_value, str):
+                    actual_value = json.dumps(actual_value)
 
                 if secret is None:
-                    if actual_value:
+                    if value:
                         secret = repository.add_secret(
                             aliased_field, actual_value, secret_group, short_uuid
                         )
@@ -836,12 +845,10 @@ def serialize_model(self, handler: SerializerFunctionWrapHandler, info: Serializ
                 content = secret.get_content()
                 full_content = copy.deepcopy(content)
 
-                if actual_value is None:
-                    full_content.pop(field, None)
+                if value is None:
+                    full_content.pop(aliased_field, None)
                     _encountered_secrets.add((secret, secret_field))
                 else:
-                    if not isinstance(actual_value, str):
-                        actual_value = json.dumps(actual_value)
                     full_content.update({aliased_field: actual_value})
                 secret.set_content(full_content)
 
@@ -1003,10 +1010,11 @@ class DataContractV1(BaseModel, Generic[TResourceProviderModel]):
 TCommonModel = TypeVar("TCommonModel", bound=CommonModel)
 
 
-def is_topic_value_acceptable(value: str | None):
+def is_topic_value_acceptable(value: str | None) -> str | None:
     """Check whether the given Kafka topic value is acceptable."""
     if value and "*" in value[:3]:
         raise ValueError(f"Error on topic '{value}',, unacceptable value.")
+    return value
 
 
 class KafkaRequestModel(RequirerCommonModel):
@@ -1709,9 +1717,12 @@ def write_model(
     """Writes the data stored in the model using the repository object."""
     context = context or {}
     dumped = model.model_dump(
-        mode="json", context={"repository": repository} | context, exclude_none=True
+        mode="json", context={"repository": repository} | context, exclude_none=False
     )
     for field, value in dumped.items():
+        if value is None:
+            repository.delete_field(field)
+            continue
         dumped_value = value if isinstance(value, str) else json.dumps(value)
         repository.write_field(field, dumped_value)
 
@@ -1951,13 +1962,19 @@ class ResourceEntityCreatedEvent(ResourceRequirerEvent[TResourceProviderModel]):
 
 
 class ResourceEndpointsChangedEvent(ResourceRequirerEvent[TResourceProviderModel]):
-    """Read/Write enpoinds are changed."""
+    """Read/Write enpoints are changed."""
 
     pass
 
 
 class ResourceReadOnlyEndpointsChangedEvent(ResourceRequirerEvent[TResourceProviderModel]):
-    """Read-only enpoinds are changed."""
+    """Read-only enpoints are changed."""
+
+    pass
+
+
+class AuthenticationUpdatedEvent(ResourceRequirerEvent[TResourceProviderModel]):
+    """Authentication was updated for a user."""
 
     pass
 
@@ -1972,6 +1989,7 @@ class ResourceRequiresEvents(CharmEvents, Generic[TResourceProviderModel]):
     resource_entity_created = EventSource(ResourceEntityCreatedEvent)
     endpoints_changed = EventSource(ResourceEndpointsChangedEvent)
     read_only_endpoints_changed = EventSource(ResourceReadOnlyEndpointsChangedEvent)
+    authentication_updated = EventSource(AuthenticationUpdatedEvent)
 
 
 ##############################################################################
@@ -2072,6 +2090,34 @@ def compute_diff(
 
         return _diff
 
+    def _relation_from_secret_label(self, secret_label: str) -> Relation | None:
+        """Retrieve the relation that belongs to a secret label."""
+        contents = secret_label.split(".")
+
+        if not (contents and len(contents) >= 3):
+            return
+
+        try:
+            relation_id = int(contents[1])
+        except ValueError:
+            return
+
+        relation_name = contents[0]
+
+        try:
+            return self.model.get_relation(relation_name, relation_id)
+        except ModelError:
+            return
+
+    def _short_uuid_from_secret_label(self, secret_label: str) -> str | None:
+        """Retrieve the relation that belongs to a secret label."""
+        contents = secret_label.split(".")
+
+        if not (contents and len(contents) >= 5):
+            return
+
+        return contents[2]
+
 
 class ResourceProviderEventHandler(EventHandlers, Generic[TRequirerCommonModel]):
     """Event Handler for resource provider."""
@@ -2204,34 +2250,6 @@ def _handle_bulk_event(
             )
             store_new_data(event.relation, self.component, new_data, request.request_id)
 
-    def _relation_from_secret_label(self, secret_label: str) -> Relation | None:
-        """Retrieve the relation that belongs to a secret label."""
-        contents = secret_label.split(".")
-
-        if not (contents and len(contents) >= 3):
-            return
-
-        try:
-            relation_id = int(contents[1])
-        except ValueError:
-            return
-
-        relation_name = contents[0]
-
-        try:
-            return self.model.get_relation(relation_name, relation_id)
-        except ModelError:
-            return
-
-    def _short_uuid_from_secret_label(self, secret_label: str) -> str | None:
-        """Retrieve the relation that belongs to a secret label."""
-        contents = secret_label.split(".")
-
-        if not (contents and len(contents) >= 5):
-            return
-
-        return contents[2]
-
     @override
     def _on_secret_changed_event(self, event: SecretChangedEvent) -> None:
         if not self.mtls_enabled:
@@ -2251,6 +2269,11 @@ def _on_secret_changed_event(self, event: SecretChangedEvent) -> None:
 
         if relation.app == self.charm.app:
             logging.info("Secret changed event ignored for Secret Owner")
+            return
+
+        if relation.name != self.relation_name:
+            logging.info("Secret changed on wrong relation.")
+            return
 
         remote_unit = None
         for unit in relation.units:
@@ -2470,39 +2493,39 @@ def are_all_resources_created(self, rel_id: int) -> bool:
     def _is_pg_plugin_enabled(plugin: str, connection_string: str) -> bool:
         # Actual checking method.
         # No need to check for psycopg here, it's been checked before.
-        if not psycopg:
+        if not psycopg2:
             return False
 
         try:
-            with psycopg.connect(connection_string) as connection:
+            with psycopg2.connect(connection_string) as connection:
                 with connection.cursor() as cursor:
                     cursor.execute(
                         "SELECT TRUE FROM pg_extension WHERE extname=%s::text;", (plugin,)
                     )
                     return cursor.fetchone() is not None
-        except psycopg.Error as e:
+        except psycopg2.Error as e:
             logger.exception(
                 f"failed to check whether {plugin} plugin is enabled in the database: %s",
                 str(e),
             )
             return False
 
-    def is_postgresql_plugin_enabled(self, plugin: str, relation_id: int = 0) -> bool:
+    def is_postgresql_plugin_enabled(self, plugin: str, relation_index: int = 0) -> bool:
         """Returns whether a plugin is enabled in the database.
 
         Args:
             plugin: name of the plugin to check.
-            relation_id: Optional index to check the database (default: 0 - first relation).
+            relation_index: Optional index to check the database (default: 0 - first relation).
         """
-        if not psycopg:
+        if not psycopg2:
             return False
 
         # Can't check a non existing relation.
-        if len(self.relations) <= relation_id:
+        if len(self.relations) <= relation_index:
             return False
 
-        relation_id = self.relations[relation_id].id
-        model = self.interface.build_model(relation_id=relation_id)
+        relation = self.relations[relation_index]
+        model = self.interface.build_model(relation_id=relation.id, component=relation.app)
         for request in model.requests:
             if request.endpoints and request.username and request.password:
                 host = request.endpoints.split(":")[0]
@@ -2577,7 +2600,48 @@ def _get_relation_alias(self, relation_id: int) -> str | None:
 
     def _on_secret_changed_event(self, event: SecretChangedEvent):
         """Event notifying about a new value of a secret."""
-        pass
+        if not event.secret.label:
+            return
+        relation = self._relation_from_secret_label(event.secret.label)
+        short_uuid = self._short_uuid_from_secret_label(event.secret.label)
+
+        if not relation:
+            logging.info(
+                f"Received secret {event.secret.label} but couldn't parse, seems irrelevant"
+            )
+            return
+
+        if relation.app == self.charm.app:
+            logging.info("Secret changed event ignored for Secret Owner")
+            return
+
+        if relation.name != self.relation_name:
+            logging.info("Secret changed on wrong relation.")
+            return
+
+        remote_unit = None
+        for unit in relation.units:
+            if unit.app != self.charm.app:
+                remote_unit = unit
+                break
+
+        response_model = self.interface.build_model(relation.id)
+        if not short_uuid:
+            return
+        for _response in response_model.requests:
+            if _response.request_id == short_uuid:
+                response = _response
+                break
+        else:
+            logger.info(f"Unknown request id {short_uuid}")
+            return
+
+        getattr(self.on, "authentication_updated").emit(
+            relation,
+            app=relation.app,
+            unit=remote_unit,
+            response=response,
+        )
 
     def _on_relation_created_event(self, event: RelationCreatedEvent) -> None:
         """Event emitted when the database relation is created."""