Merge branch '6/edge' into no-private-ops

Author: tonyandrewmeyer

.gitignore

@@ -17,3 +17,4 @@ share/
 
 /requirements.txt
 /requirements-last-build.txt
+/charm_internal_version

charmcraft.yaml

@@ -20,6 +20,11 @@ parts:
     override-build: |
       rustup default stable
       craftctl default
+  files:
+    plugin: dump
+    source: .
+    prime:
+      - charm_internal_version
 bases:
   - build-on:
       - name: "ubuntu"

lib/charms/mongodb/v0/set_status.py

@@ -7,6 +7,7 @@
 from typing import Optional, Tuple
 
 from charms.mongodb.v1.mongodb import MongoConfiguration, MongoDBConnection
+from data_platform_helpers.version_check import NoVersionError, get_charm_revision
 from ops.charm import CharmBase
 from ops.framework import Object
 from ops.model import ActiveStatus, BlockedStatus, StatusBase, WaitingStatus
@@ -22,7 +23,7 @@
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 3
+LIBPATCH = 4
 
 AUTH_FAILED_CODE = 18
 UNAUTHORISED_CODE = 13
@@ -88,7 +89,7 @@ def is_status_related_to_mismatched_revision(self, status_type: str) -> bool:
         "goal state" which processes data differently and the other via the ".status" property.
         Hence we have to be flexible to handle each.
         """
-        if not self.charm.get_cluster_mismatched_revision_status():
+        if not self.get_cluster_mismatched_revision_status():
             return False
 
         if "waiting" in status_type and self.charm.is_role(Config.Role.CONFIG_SERVER):
@@ -153,7 +154,7 @@ def is_unit_status_ready_for_upgrade(self) -> bool:
         if isinstance(current_status, ActiveStatus):
             return True
 
-        if not isinstance(current_status, WaitingStatus):
+        if not isinstance(current_status, BlockedStatus):
             return False
 
         if status_message and "is not up-to date with config-server" in status_message:
@@ -235,7 +236,49 @@ def get_invalid_integration_status(self) -> Optional[StatusBase]:
                 "Relation to s3-integrator is not supported, config role must be config-server"
             )
 
-        return self.charm.get_cluster_mismatched_revision_status()
+        return self.get_cluster_mismatched_revision_status()
+
+    def get_cluster_mismatched_revision_status(self) -> Optional[StatusBase]:
+        """Returns a Status if the cluster has mismatched revisions."""
+        # check for invalid versions in sharding integrations, i.e. a shard running on
+        # revision  88 and a config-server running on revision 110
+        current_charms_version = get_charm_revision(
+            self.charm.unit, local_version=self.charm.get_charm_internal_revision
+        )
+        local_identifier = (
+            "-locally built"
+            if self.charm.version_checker.is_local_charm(self.charm.app.name)
+            else ""
+        )
+        try:
+            if self.charm.version_checker.are_related_apps_valid():
+                return
+        except NoVersionError as e:
+            # relations to shards/config-server are expected to provide a version number. If they
+            # do not, it is because they are from an earlier charm revision, i.e. pre-revison X.
+            logger.debug(e)
+            if self.charm.is_role(Config.Role.SHARD):
+                return BlockedStatus(
+                    f"Charm revision ({current_charms_version}{local_identifier}) is not up-to date with config-server."
+                )
+
+        if self.charm.is_role(Config.Role.SHARD):
+            config_server_revision = self.charm.version_checker.get_version_of_related_app(
+                self.get_config_server_name()
+            )
+            remote_local_identifier = (
+                "-locally built"
+                if self.charm.version_checker.is_local_charm(self.get_config_server_name())
+                else ""
+            )
+            return BlockedStatus(
+                f"Charm revision ({current_charms_version}{local_identifier}) is not up-to date with config-server ({config_server_revision}{remote_local_identifier})."
+            )
+
+        if self.charm.is_role(Config.Role.CONFIG_SERVER):
+            return WaitingStatus(
+                f"Waiting for shards to upgrade/downgrade to revision {current_charms_version}{local_identifier}."
+            )
 
 
 def build_unit_status(mongodb_config: MongoConfiguration, unit_host: str) -> StatusBase:

poetry.lock

@@ -21,7 +21,7 @@ tenacity = "^8.2.3"
 pyyaml = "^6.0.1"
 jinja2 = "^3.1.3"
 poetry-core = "^1.9.0"
-data-platform-helpers = "^0.1.2"
+data-platform-helpers = "^0.1.3"
 pyOpenSSL = "^24.2.1"
 setuptools = "^72.0.0"
 
@@ -72,7 +72,7 @@ juju = "^3.5.0"
 pytest = "^8.1.1"
 pytest-asyncio = "^0.21.1"
 pytest-mock = "^3.14.0"
-pytest-operator = "^0.34.0"
+pytest-operator = "^0.36.0"
 pytest-operator-cache = {git = "https://github.com/canonical/data-platform-workflows", tag = "v21.0.0", subdirectory = "python/pytest_plugins/pytest_operator_cache"}
 pytest-operator-groups = {git = "https://github.com/canonical/data-platform-workflows", tag = "v21.0.0", subdirectory = "python/pytest_plugins/pytest_operator_groups"}
 pytest-github-secrets = {git = "https://github.com/canonical/data-platform-workflows", tag = "v21.0.0", subdirectory = "python/pytest_plugins/github_secrets"}

pyproject.toml

@@ -38,11 +38,16 @@
     OperatorUser,
 )
 from charms.prometheus_k8s.v0.prometheus_scrape import MetricsEndpointProvider
+from data_platform_helpers.version_check import (
+    CrossAppVersionChecker,
+    get_charm_revision,
+)
 from ops.charm import (
     ActionEvent,
     CharmBase,
     ConfigChangedEvent,
     RelationDepartedEvent,
+    RelationEvent,
     StartEvent,
     UpdateStatusEvent,
 )
@@ -55,7 +60,6 @@
     ModelError,
     Relation,
     RelationDataContent,
-    StatusBase,
     Unit,
     WaitingStatus,
 )
@@ -93,6 +97,7 @@ def __init__(self, *args):
         super().__init__(*args)
 
         self.framework.observe(self.on.mongod_pebble_ready, self._on_mongod_pebble_ready)
+        self.framework.observe(self.on.config_changed, self._on_config_changed)
         self.framework.observe(self.on.start, self._on_start)
         self.framework.observe(self.on.update_status, self._on_update_status)
         self.framework.observe(
@@ -138,6 +143,15 @@ def __init__(self, *args):
         self.config_server = ShardingProvider(self)
         self.cluster = ClusterProvider(self)
 
+        self.version_checker = CrossAppVersionChecker(
+            self,
+            version=get_charm_revision(self.unit, local_version=self.get_charm_internal_revision),
+            relations_to_check=[
+                Config.Relations.SHARDING_RELATIONS_NAME,
+                Config.Relations.CONFIG_SERVER_RELATIONS_NAME,
+            ],
+        )
+
     # BEGIN: properties
 
     @property
@@ -468,16 +482,15 @@ def primary(self) -> str | None:
 
         return None
 
+    @property
+    def get_charm_internal_revision(self) -> str:
+        """Returns the contents of the get_charm_internal_revision file."""
+        with open(Config.CHARM_INTERNAL_VERSION_FILE, "r") as f:
+            return f.read().strip()
+
     # END: properties
 
     # BEGIN: generic helper methods
-    def get_cluster_mismatched_revision_status(self) -> Optional[StatusBase]:
-        """Returns a Status if the cluster has mismatched revisions.
-
-        TODO implement this method as a part of sharding upgrades.
-        """
-        return None
-
     def remote_mongos_config(self, hosts) -> MongoConfiguration:
         """Generates a MongoConfiguration object for mongos in the deployment of MongoDB."""
         # mongos that are part of the cluster have the same username and password, but different
@@ -659,25 +672,40 @@ def _on_start(self, event) -> None:
             event.defer()
             return
 
-    def _relation_changes_handler(self, event) -> None:
+    def _relation_changes_handler(self, event: RelationEvent) -> None:
         """Handles different relation events and updates MongoDB replica set."""
         self._connect_mongodb_exporter()
         self._connect_pbm_agent()
 
-        if type(event) is RelationDepartedEvent:
+        if isinstance(event, RelationDepartedEvent):
             if event.departing_unit.name == self.unit.name:
                 self.unit_peer_data.setdefault("unit_departed", "True")
 
         if not self.unit.is_leader():
             return
 
+        if self.upgrade_in_progress:
+            logger.warning(
+                "Adding replicas during an upgrade is not supported. The charm may be in a broken, unrecoverable state"
+            )
+            event.defer()
+            return
+
         # Admin password and keyFile should be created before running MongoDB.
         # This code runs on leader_elected event before mongod_pebble_ready
         self._generate_secrets()
 
         if not self.db_initialised:
             return
 
+        self._reconcile_mongo_hosts_and_users(event)
+
+    def _reconcile_mongo_hosts_and_users(self, event: RelationEvent) -> None:
+        """Auxiliary function to reconcile mongo data for relation events.
+
+        Args:
+            event: The relation event
+        """
         with MongoDBConnection(self.mongodb_config) as mongo:
             try:
                 replset_members = mongo.get_replset_members()
@@ -1551,7 +1579,7 @@ def is_relation_feasible(self, rel_interface: str) -> bool:
             )
             return False
 
-        if revision_mismatch_status := self.get_cluster_mismatched_revision_status():
+        if revision_mismatch_status := self.status.get_cluster_mismatched_revision_status():
             self.status.set_and_share_status(revision_mismatch_status)
             return False
 

src/charm.py

@@ -22,6 +22,7 @@ class Config:
     MONGOD_CONF_DIR = "/etc/mongod"
     MONGODB_LOG_FILENAME = "mongodb.log"
 
+    CHARM_INTERNAL_VERSION_FILE = "charm_internal_version"
     LICENSE_PATH = "/licenses/LICENSE"
     CONTAINER_NAME = "mongod"
     SERVICE_NAME = "mongod"

src/config.py

@@ -7,40 +7,26 @@
 class MongoError(Exception):
     """Common parent for Mongo errors, allowing to catch them all at once."""
 
-    pass
-
 
 class AdminUserCreationError(MongoError):
     """Raised when a commands to create an admin user on MongoDB fail."""
 
-    pass
-
 
 class ApplicationHostNotFoundError(MongoError):
     """Raised when a queried host is not in the application peers or the current host."""
 
-    pass
-
 
 class MongoSecretError(MongoError):
     """Common parent for all Mongo Secret Exceptions."""
 
-    pass
-
 
 class SecretNotAddedError(MongoSecretError):
     """Raised when a Juju 3 secret couldn't be set or re-set."""
 
-    pass
-
 
 class MissingSecretError(MongoSecretError):
     """Could be raised when a Juju 3 mandatory secret couldn't be found."""
 
-    pass
-
 
 class SecretAlreadyExistsError(MongoSecretError):
     """A secret that we want to create already exists."""
-
-    pass

src/exceptions.py

@@ -0,0 +1,2 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.