[DPE -3096] Fix profile limit memory config option (#306)

* Update data-platform-workflows to v7

* Fix profile limit memory config option

Signed-off-by: Marcelo Henrique Neppel <[email protected]>

* Update related unit test

Signed-off-by: Marcelo Henrique Neppel <[email protected]>

* Add CRAFT_SHARED_CACHE env variable to charmcraft pack wrapper

Signed-off-by: Marcelo Henrique Neppel <[email protected]>

---------

Signed-off-by: Marcelo Henrique Neppel <[email protected]>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Author: marceloneppel

.github/workflows/ci.yaml

@@ -22,7 +22,7 @@ on:
 jobs:
   lint:
     name: Lint
-    uses: canonical/data-platform-workflows/.github/workflows/lint.yaml@v6.3.2
+    uses: canonical/data-platform-workflows/.github/workflows/lint.yaml@v7.0.0
 
   unit-test:
     name: Unit test charm
@@ -42,7 +42,7 @@ jobs:
 
   build:
     name: Build charm
-    uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v6.3.2
+    uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v7.0.0
     permissions:
       actions: write  # Needed to manage GitHub Actions cache
 
@@ -60,7 +60,7 @@ jobs:
       - lint
       - unit-test
       - build
-    uses: canonical/data-platform-workflows/.github/workflows/integration_test_charm.yaml@v6.3.2
+    uses: canonical/data-platform-workflows/.github/workflows/integration_test_charm.yaml@v7.0.0
     with:
       artifact-name: ${{ needs.build.outputs.artifact-name }}
       cloud: lxd

.github/workflows/release.yaml

@@ -24,14 +24,14 @@ jobs:
 
   build:
     name: Build charm
-    uses: canonical/data-platform-workflows/.github/workflows/build_charm_without_cache.yaml@v6.3.2
+    uses: canonical/data-platform-workflows/.github/workflows/build_charm_without_cache.yaml@v7.0.0
 
   release:
     name: Release charm
     needs:
       - ci-tests
       - build
-    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v6.3.2
+    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v7.0.0
     with:
       channel: 14/edge
       artifact-name: ${{ needs.build.outputs.artifact-name }}

.github/workflows/sync_issue_to_jira.yaml

@@ -9,7 +9,7 @@ on:
 jobs:
   sync:
     name: Sync GitHub issue to Jira
-    uses: canonical/data-platform-workflows/.github/workflows/sync_issue_to_jira.yaml@v6.3.2
+    uses: canonical/data-platform-workflows/.github/workflows/sync_issue_to_jira.yaml@v7.0.0
     with:
       jira-base-url: https://warthogs.atlassian.net
       jira-project-key: DPE

config.yaml

@@ -228,11 +228,19 @@ options:
    type: string
    default: production
   profile-limit-memory:
+    type: int
+    description: |
+      [DEPRECTATED] Use profile_limit_memory instead. Amount of memory in Megabytes to limit PostgreSQL
+      and associated process to. If unset, this will be decided according to the default memory limit
+      in the selected profile. Only comes into effect when the `production` profile is selected. This
+      config option cannot be set at the same time as profile_limit_memory.
+  profile_limit_memory:
     type: int
     description: |
       Amount of memory in Megabytes to limit PostgreSQL and associated process to.
       If unset, this will be decided according to the default memory limit in the selected profile.
-      Only comes into effect when the `production` profile is selected.
+      Only comes into effect when the `production` profile is selected. This config option cannot be
+      set at the same time as profile-limit-memory.
   request_date_style:
     description: |
       Sets the display format for date and time values. Allowed formats are explained

poetry.lock

@@ -65,10 +65,10 @@ optional = true
 
 [tool.poetry.group.integration.dependencies]
 pytest = "^7.4.0"
-pytest-github-secrets = {git = "https://github.com/canonical/data-platform-workflows", tag = "v6.3.2", subdirectory = "python/pytest_plugins/github_secrets"}
+pytest-github-secrets = {git = "https://github.com/canonical/data-platform-workflows", tag = "v7.0.0", subdirectory = "python/pytest_plugins/github_secrets"}
 pytest-operator = "^0.29.0"
-pytest-operator-cache = {git = "https://github.com/canonical/data-platform-workflows", tag = "v6.3.2", subdirectory = "python/pytest_plugins/pytest_operator_cache"}
-pytest-operator-groups = {git = "https://github.com/canonical/data-platform-workflows", tag = "v6.3.2", subdirectory = "python/pytest_plugins/pytest_operator_groups"}
+pytest-operator-cache = {git = "https://github.com/canonical/data-platform-workflows", tag = "v7.0.0", subdirectory = "python/pytest_plugins/pytest_operator_cache"}
+pytest-operator-groups = {git = "https://github.com/canonical/data-platform-workflows", tag = "v7.0.0", subdirectory = "python/pytest_plugins/pytest_operator_groups"}
 juju = "^3.2.2"
 boto3 = "^1.28.70"
 tenacity = "^8.2.3"

pyproject.toml

@@ -1369,6 +1369,14 @@ def _is_workload_running(self) -> bool:
 
     def update_config(self, is_creating_backup: bool = False) -> bool:
         """Updates Patroni config file based on the existence of the TLS files."""
+        if (
+            self.model.config.get("profile-limit-memory") is not None
+            and self.model.config.get("profile_limit_memory") is not None
+        ):
+            raise ValueError(
+                "Both profile-limit-memory and profile_limit_memory are set. Please use only one of them."
+            )
+
         enable_tls = self.is_tls_enabled
         limit_memory = None
         if self.config.profile_limit_memory:

src/charm.py

@@ -204,7 +204,7 @@ def profile_limit_memory_validator(cls, value: int) -> Optional[int]:
         if value < 128:
             raise ValueError("PostgreSQL Charm requires at least 128MB")
         if value > 9999999:
-            raise ValueError("`profile-limit-memory` limited to 7 digits (9999999MB)")
+            raise ValueError("`profile_limit_memory` limited to 7 digits (9999999MB)")
 
         return value
 

src/config.py

@@ -1164,11 +1164,28 @@ def test_update_config(
         with patch.object(PostgresqlOperatorCharm, "postgresql", Mock()) as postgresql_mock:
             # Mock some properties.
             postgresql_mock.is_tls_enabled = PropertyMock(side_effect=[False, False, False, False])
-            _is_workload_running.side_effect = [True, True, False, True]
+            _is_workload_running.side_effect = [False, False, True, True, False, True]
             _member_started.side_effect = [True, True, False]
             postgresql_mock.build_postgresql_parameters.return_value = {"test": "test"}
 
+            # Test when only one of the two config options for profile limit memory is set.
+            self.harness.update_config({"profile-limit-memory": 1000})
+            self.charm.update_config()
+
+            # Test when only one of the two config options for profile limit memory is set.
+            self.harness.update_config(
+                {"profile_limit_memory": 1000}, unset={"profile-limit-memory"}
+            )
+            self.charm.update_config()
+
+            # Test when the two config options for profile limit memory are set at the same time.
+            _render_patroni_yml_file.reset_mock()
+            self.harness.update_config({"profile-limit-memory": 1000})
+            with self.assertRaises(ValueError):
+                self.charm.update_config()
+
             # Test without TLS files available.
+            self.harness.update_config(unset={"profile-limit-memory", "profile_limit_memory"})
             self.harness.update_relation_data(
                 self.rel_id, self.charm.unit.name, {"tls": "enabled"}
             )  # Mock some data in the relation to test that it change.

tests/unit/test_charm.py

@@ -19,6 +19,8 @@ allowlist_externals =
 
 [testenv:{build,pack-wrapper}]
 # Wrap `charmcraft pack`
+pass_env =
+    CRAFT_SHARED_CACHE
 allowlist_externals =
     {[testenv]allowlist_externals}
     charmcraft