From f13575930847e86c9a9bb3cd39eaa7c84c945e8e Mon Sep 17 00:00:00 2001 From: Lucas Gameiro Date: Thu, 13 Jun 2024 10:00:51 -0300 Subject: [PATCH] [DPE-4416] Update rolling-ops lib to version 0.7 (#478) * update rolling ops lib and unit test setup * async_replication integration fixes * fix relation_departed condition * revert sync standby assertion removal * Handle upgrade of top of the stack Juju leader Signed-off-by: Marcelo Henrique Neppel --------- Signed-off-by: Marcelo Henrique Neppel Co-authored-by: Marcelo Henrique Neppel --- lib/charms/rolling_ops/v0/rollingops.py | 18 ++++++++++++++---- src/relations/async_replication.py | 2 +- tests/unit/test_charm.py | 1 + 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/lib/charms/rolling_ops/v0/rollingops.py b/lib/charms/rolling_ops/v0/rollingops.py index 5a7d4ce306..57aa9bf352 100644 --- a/lib/charms/rolling_ops/v0/rollingops.py +++ b/lib/charms/rolling_ops/v0/rollingops.py @@ -49,7 +49,7 @@ def _restart(self, event): To kick off the rolling restart, emit this library's AcquireLock event. The simplest way to do so would be with an action, though it might make sense to acquire the lock in -response to another event. +response to another event. ```python def _on_trigger_restart(self, event): @@ -88,7 +88,7 @@ def _on_trigger_restart(self, event): # Increment this PATCH version before using `charmcraft publish-lib` or reset # to 0 if you are raising the major API version -LIBPATCH = 5 +LIBPATCH = 7 class LockNoRelationError(Exception): @@ -182,6 +182,7 @@ def _state(self) -> LockState: # Active acquire request. return LockState.ACQUIRE + logger.debug("Lock state: %s %s", unit_state, app_state) return app_state # Granted or unset/released @_state.setter @@ -202,21 +203,27 @@ def _state(self, state: LockState): if state is LockState.IDLE: self.relation.data[self.app].update({str(self.unit): state.value}) + logger.debug("state: %s", state.value) + def acquire(self): """Request that a lock be acquired.""" self._state = LockState.ACQUIRE + logger.debug("Lock acquired.") def release(self): """Request that a lock be released.""" self._state = LockState.RELEASE + logger.debug("Lock released.") def clear(self): """Unset a lock.""" self._state = LockState.IDLE + logger.debug("Lock cleared.") def grant(self): """Grant a lock to a unit.""" self._state = LockState.GRANTED + logger.debug("Lock granted.") def is_held(self): """This unit holds the lock.""" @@ -266,9 +273,11 @@ def __init__(self, handle, callback_override: Optional[str] = None): self.callback_override = callback_override or "" def snapshot(self): + """Snapshot of lock event.""" return {"callback_override": self.callback_override} def restore(self, snapshot): + """Restores lock event.""" self.callback_override = snapshot["callback_override"] @@ -288,7 +297,7 @@ def __init__(self, charm: CharmBase, relation: AnyStr, callback: Callable): charm: the charm we are attaching this to. relation: an identifier, by convention based on the name of the relation in the metadata.yaml, which identifies this instance of RollingOperatorsFactory, - distinct from other instances that may be hanlding other events. + distinct from other instances that may be handling other events. callback: a closure to run when we have a lock. (It must take a CharmBase object and EventBase object as args.) """ @@ -309,6 +318,7 @@ def __init__(self, charm: CharmBase, relation: AnyStr, callback: Callable): self.framework.observe(charm.on[self.name].acquire_lock, self._on_acquire_lock) self.framework.observe(charm.on[self.name].run_with_lock, self._on_run_with_lock) self.framework.observe(charm.on[self.name].process_locks, self._on_process_locks) + self.framework.observe(charm.on.leader_elected, self._on_process_locks) def _callback(self: CharmBase, event: EventBase) -> None: """Placeholder for the function that actually runs our event. @@ -381,7 +391,7 @@ def _on_acquire_lock(self: CharmBase, event: ActionEvent): """Request a lock.""" try: Lock(self).acquire() # Updates relation data - # emit relation changed event in the edge case where aquire does not + # emit relation changed event in the edge case where acquire does not relation = self.model.get_relation(self.name) # persist callback override for eventual run diff --git a/src/relations/async_replication.py b/src/relations/async_replication.py index 1e4df96c88..320beeb487 100644 --- a/src/relations/async_replication.py +++ b/src/relations/async_replication.py @@ -487,7 +487,7 @@ def _on_async_relation_changed(self, event: RelationChangedEvent) -> None: def _on_async_relation_departed(self, event: RelationDepartedEvent) -> None: """Set a flag to avoid setting a wrong status message on relation broken event handler.""" # This is needed because of https://bugs.launchpad.net/juju/+bug/1979811. - if event.departing_unit == self.charm.unit: + if event.departing_unit == self.charm.unit and self.charm._peers is not None: self.charm._peers.data[self.charm.unit].update({"departing": "True"}) def _on_async_relation_joined(self, _) -> None: diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py index 7370788179..7ab182447f 100644 --- a/tests/unit/test_charm.py +++ b/tests/unit/test_charm.py @@ -44,6 +44,7 @@ def harness(): harness.begin() harness.add_relation("upgrade", harness.charm.app.name) harness.add_relation(PEER, harness.charm.app.name) + harness.add_relation("restart", harness.charm.app.name) yield harness harness.cleanup()