[MISC] Define charm utility properties #842

sinclert-canonical · 2025-01-30T10:59:06Z

This PR defines a set of charm properties to reduce the chance of introducing typos when checking for specific keys in the app / unit data-bags, as well as reduce the cognitive load of logical statements.

The new properties are:

is_cluster_restoring_backup.
is_cluster_restoring_to_time.
is_unit_departing
is_unit_stopped.

The existing properties, now used throughout the codebase are:

is_cluster_initialised.

codecov · 2025-01-30T11:44:14Z

Codecov Report

Attention: Patch coverage is 82.75862% with 5 lines in your changes missing coverage. Please review.

Project coverage is 75.63%. Comparing base (02fc431) to head (b339193).
Report is 10 commits behind head on main.

Files with missing lines	Patch %	Lines
src/backups.py	33.33%	0 Missing and 2 partials ⚠️
src/charm.py	88.23%	0 Missing and 2 partials ⚠️
src/relations/async_replication.py	66.66%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #842      +/-   ##
==========================================
+ Coverage   75.53%   75.63%   +0.09%     
==========================================
  Files          12       12              
  Lines        3115     3127      +12     
  Branches      466      466              
==========================================
+ Hits         2353     2365      +12     
  Misses        621      621              
  Partials      141      141

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sinclert-canonical · 2025-01-30T11:44:44Z

src/relations/async_replication.py

+        if not (self.charm.is_unit_stopped or self._is_following_promoted_cluster()) or not all(
            "stopped" in self.charm._peers.data[unit]
            or self.charm._peers.data[unit].get("unit-promoted-cluster-counter")
            == self._get_highest_promoted_cluster_counter_value()
-            for unit in {*self.charm._peers.units, self.charm.unit}
+            for unit in self.charm._peers.units


Review these lines carefully. I think I preserved the original logic

I think so too.

lucasgameiroborges

LGTM, thanks!

* try using pg 16 rock * try fix integration tests * remove argument on helper * more fixes * fix test issues * REVERT LATER: Adapt build_charm function * remove base=CHARM_BASE from deploy * remove juju 2.9 tests * grat permissions to public schema * fix linting and unit test * try refactor the permissions change * Update dependency uv to v0.5.27 (#847) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * grant public access to public schemas * [DPE-6053] Fix ports (#846) * Fix ports Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Remove unused import Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Remove unused charm library and fix unit tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix identation Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Bump libs * Conditional set_ports logic * Unit test * Don't expect juju managed resources --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * mark smoke test as unstable * test release charm to 16/edge * fix test release workflow * fix typo * Sync docs from Discourse (#801) Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> * Update dependency uv to v0.5.29 (#848) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Define charm utility properties (#842) * Update data-platform-workflows to v29.1.0 (#849) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * revert metadata.yaml * nits * Use `charmcraft test` & concierge (#852) * [MISC] Split topology script (#853) * Update charmcraft.yaml build tools (#851) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update dependency uv to v0.5.31 (#858) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update canonical/data-platform-workflows action to v30 (#859) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Use _promote_charm.yaml (#860) Use `charmcraft promote` and auto-generate release notes * Update dependency cryptography to v44.0.1 [SECURITY] (#855) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Sync docs from Discourse (#854) Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> * Update data-platform-workflows to v30.0.2 (#863) * Update canonical/has-signed-canonical-cla action to v2 (#865) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [DPE-5827] Set all nodes to synchronous replicas (#784) * Update patroni configuration * Update test assertion * Copy update_synchronous_node_count from VM * Add unit test * Set sync node count during upgrade * Fix tls test * Switchover primary * Add different helper to get leader * Add config boilerplate * Use config value when setting sync node count * Escape tuple * Add policy values * Add integration test * Fix casting * Fix test * Update to spec * Bump retry timout * Switch to planned units * Fix generator * Update conf description * Spread task * Pass the charm * [DPE-6484] Add scope to promote to primary (#850) * Promote unit action * Tweaks for failing REST calls * VM parity * [MISC] Enable RBAC in tests (#861) * Enable RBAC * Bump cosl * Add trust * Bump libs * [MISC] Define charm constants (#862) * Lock file maintenance Python dependencies (#835) * Lock file maintenance Python dependencies * Backoff boto3 1.36 --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Dragomir Penev <dragomir.penev@canonical.com> * Update canonical/data-platform-workflows action to v30.1.3 (#856) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update charmcraft.yaml build tools (#868) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Handle missing stanza output (#866) * Update ghcr.io/canonical/charmed-postgresql:14.15-22.04_edge Docker digest to 71d49b6 (#870) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Disable storage test on arm (#872) * Disable storage test on Arm * Bump libs * Correct import path * Update charmcraft.yaml build tools (#871) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Add degraded status to primary message (#874) * Add degraded status on to primary message * Use const running tests * [MISC] Sanitize PostgreSQL extra-user-roles arg (#876) * [MISC] Fix PostgreSQL lib function signature (#879) * [MISC] Skip backup tests without creds (#884) * Bump libs * Skip backups tests if no creds are set * Check that the cloud config is set to a value * Typo * Update tests/integration/conftest.py Co-authored-by: Carl Csaposs <carl.csaposs@canonical.com> * Switch all checks to gets * Typo --------- Co-authored-by: Carl Csaposs <carl.csaposs@canonical.com> * [DPE-6679] PostgreSQL Config Improvement (#867) * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * Update dependency jinja2 to v3.1.6 [SECURITY] (#882) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update canonical/data-platform-workflows action to v30.2.0 (#887) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Reduce required approvals on Renovate pull requests by 1 (#880) * Update dependency uv to v0.6.5 (#878) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Don't run juju2 and legacy tests * Use correct charm * Dual branch config * Remove 14 specific tests * Remove eer data secrets * Skip upgrade from stable * Upgrade on Noble * Build and deploy noble * Linting * Disable pgaudit during tests * Linting * Use common deploy for smoke test * Tweaks * Remove legacy rels * Tweak tests * Cleanup markers * Deploy without pgaudit in plugin tests * Update ghcr.io/canonical/charmed-postgresql Docker tag to v14.17 (#877) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Correct remove relation * Bump rock * Remove check for port forwarding --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: Lucas Gameiro Borges <lucas.borges@canonical.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Dragomir Penev <6687393+dragomirp@users.noreply.github.com> Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Sinclert Pérez <sinclert.perez@canonical.com> Co-authored-by: lucas.gameiro-borges <lucas.gameiro-borges@student-cs.fr> Co-authored-by: Carl Csaposs <carl.csaposs@canonical.com> Co-authored-by: Dragomir Penev <dragomir.penev@canonical.com> Co-authored-by: Danylo Bereznenko <pepsiqqfanta@gmail.com>

* Update dependency uv to v0.5.27 (#847) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [DPE-6053] Fix ports (#846) * Fix ports Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Remove unused import Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Remove unused charm library and fix unit tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix identation Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Bump libs * Conditional set_ports logic * Unit test * Don't expect juju managed resources --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Sync docs from Discourse (#801) Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> * Update dependency uv to v0.5.29 (#848) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Define charm utility properties (#842) * Update data-platform-workflows to v29.1.0 (#849) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Use `charmcraft test` & concierge (#852) * [MISC] Split topology script (#853) * Update charmcraft.yaml build tools (#851) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update dependency uv to v0.5.31 (#858) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update canonical/data-platform-workflows action to v30 (#859) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Use _promote_charm.yaml (#860) Use `charmcraft promote` and auto-generate release notes * Update dependency cryptography to v44.0.1 [SECURITY] (#855) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Sync docs from Discourse (#854) Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> * Update data-platform-workflows to v30.0.2 (#863) * Update canonical/has-signed-canonical-cla action to v2 (#865) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [DPE-5827] Set all nodes to synchronous replicas (#784) * Update patroni configuration * Update test assertion * Copy update_synchronous_node_count from VM * Add unit test * Set sync node count during upgrade * Fix tls test * Switchover primary * Add different helper to get leader * Add config boilerplate * Use config value when setting sync node count * Escape tuple * Add policy values * Add integration test * Fix casting * Fix test * Update to spec * Bump retry timout * Switch to planned units * Fix generator * Update conf description * Spread task * Pass the charm * [DPE-6484] Add scope to promote to primary (#850) * Promote unit action * Tweaks for failing REST calls * VM parity * [MISC] Enable RBAC in tests (#861) * Enable RBAC * Bump cosl * Add trust * Bump libs * [MISC] Define charm constants (#862) * Lock file maintenance Python dependencies (#835) * Lock file maintenance Python dependencies * Backoff boto3 1.36 --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Dragomir Penev <dragomir.penev@canonical.com> * Update canonical/data-platform-workflows action to v30.1.3 (#856) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update charmcraft.yaml build tools (#868) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Handle missing stanza output (#866) * Update ghcr.io/canonical/charmed-postgresql:14.15-22.04_edge Docker digest to 71d49b6 (#870) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Disable storage test on arm (#872) * Disable storage test on Arm * Bump libs * Correct import path * Update charmcraft.yaml build tools (#871) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Add degraded status to primary message (#874) * Add degraded status on to primary message * Use const running tests * [MISC] Sanitize PostgreSQL extra-user-roles arg (#876) * [MISC] Fix PostgreSQL lib function signature (#879) * [MISC] Skip backup tests without creds (#884) * Bump libs * Skip backups tests if no creds are set * Check that the cloud config is set to a value * Typo * Update tests/integration/conftest.py Co-authored-by: Carl Csaposs <carl.csaposs@canonical.com> * Switch all checks to gets * Typo --------- Co-authored-by: Carl Csaposs <carl.csaposs@canonical.com> * [DPE-6679] PostgreSQL Config Improvement (#867) * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * config improvement * Update dependency jinja2 to v3.1.6 [SECURITY] (#882) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update canonical/data-platform-workflows action to v30.2.0 (#887) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Reduce required approvals on Renovate pull requests by 1 (#880) * Update dependency uv to v0.6.5 (#878) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update ghcr.io/canonical/charmed-postgresql Docker tag to v14.17 (#877) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update dependency uv to v0.6.7 (#890) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update canonical/data-platform-workflows action to v31 (#891) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Try the new timescale * Check PR on */edge * Enable cache, disable pgaudit * Use the right base * Arm tests --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Sinclert Pérez <sinclert.perez@canonical.com> Co-authored-by: Carl Csaposs <carl.csaposs@canonical.com> Co-authored-by: Danylo Bereznenko <pepsiqqfanta@gmail.com>

github-actions bot added the Libraries: Out of sync label Jan 30, 2025

Use charm is_cluster_initialised property

9d910f2

sinclert-canonical force-pushed the sinclert/charm-data-properties branch from 09dc015 to 99586b8 Compare January 30, 2025 11:27

sinclert-canonical added 3 commits January 30, 2025 12:42

Define charm is_cluster_restoring properties

03052af

Define charm is_unit_departing property

cfce9de

Define charm is_unit_stopped property

b339193

sinclert-canonical force-pushed the sinclert/charm-data-properties branch from 99586b8 to b339193 Compare January 30, 2025 11:43

sinclert-canonical commented Jan 30, 2025

View reviewed changes

sinclert-canonical marked this pull request as ready for review January 30, 2025 11:44

sinclert-canonical requested review from dragomirp, lucasgameiroborges and marceloneppel January 30, 2025 11:45

lucasgameiroborges approved these changes Feb 6, 2025

View reviewed changes

dragomirp approved these changes Feb 7, 2025

View reviewed changes

sinclert-canonical merged commit b2b489f into main Feb 7, 2025
99 checks passed

sinclert-canonical deleted the sinclert/charm-data-properties branch February 7, 2025 12:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[MISC] Define charm utility properties #842

[MISC] Define charm utility properties #842

Uh oh!

sinclert-canonical commented Jan 30, 2025

Uh oh!

codecov bot commented Jan 30, 2025 •

edited

Loading

Uh oh!

sinclert-canonical Jan 30, 2025

Uh oh!

lucasgameiroborges Feb 6, 2025

Uh oh!

lucasgameiroborges left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[MISC] Define charm utility properties #842

[MISC] Define charm utility properties #842

Uh oh!

Conversation

sinclert-canonical commented Jan 30, 2025

Uh oh!

codecov bot commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sinclert-canonical Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

lucasgameiroborges Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

lucasgameiroborges left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jan 30, 2025 •

edited

Loading