[DPE-5945] Rename expose_external configuration option (#274)

canonical · Nov 20, 2024 · a7a775a · a7a775a
1 parent fe4b61c
commit a7a775a
Show file tree

Hide file tree

Showing 7 changed files with 202 additions and 197 deletions.
diff --git a/charmcraft.yaml b/charmcraft.yaml
@@ -4,14 +4,19 @@
 type: charm
 parts:
   charm:
+    build-snaps:
+      - rustup
     charm-binary-python-packages:
       - setuptools
     build-packages:
       - libffi-dev
       - libssl-dev
-      - rustc
-      - cargo
       - pkg-config
+    override-build:
+      # get latest rust stable toolchain
+      rustup default stable
+
+      craftctl default
 bases:
   - build-on:
       - name: "ubuntu"

diff --git a/config.yaml b/config.yaml
@@ -112,7 +112,7 @@ options:
     description: The maximum percentage of the total cpu, disk and network capacity that is allowed to be used on a broker. For example, a value of `0.8` ensures that no broker should have >80% utilization
     type: float
     default: 0.8
-  expose-external:
+  expose_external:
     description: "String to determine how to expose the Kafka cluster externally from the Kubernetes cluster. Possible values: 'nodeport', 'none'"
     type: string
     default: "nodeport"
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -46,8 +46,6 @@ pydantic = "<2"
 pyyaml = "^6.0.1"
 requests = "^2.32.3"
 lightkube = "0.15.0"
-# FIXME: Unpin once rustc 1.76 is available at build time
-rpds-py = "<0.19"
 
 [tool.poetry.group.charm-libs.dependencies]
 # data_platform_libs/v0/data_interfaces.py
@@ -78,8 +76,6 @@ black = "^22.3.0"
 ruff = ">=0.1.0"
 codespell = ">=2.2.2"
 pyright = "^1.1.301"
-# FIXME: Unpin once rustc 1.76 is available at build time
-rpds-py = "<0.19"
 
 [tool.poetry.group.unit]
 optional = true
@@ -104,7 +100,7 @@ pure-sasl = ">=0.5"
 kafka-python = ">=2.0"
 requests = ">2.25"
 
-pytest-operator-cache = {git = "https://github.com/canonical/data-platform-workflows", tag = "v22.0.0", subdirectory = "python/pytest_plugins/pytest_operator_cache"}
+pytest-operator-cache = { git = "https://github.com/canonical/data-platform-workflows", tag = "v22.0.0", subdirectory = "python/pytest_plugins/pytest_operator_cache" }
 # To be enabled if we are using groups on integration tests
 
 [tool.poetry.group.format.dependencies]

diff --git a/src/core/structured_config.py b/src/core/structured_config.py
@@ -235,7 +235,7 @@ def profile_values(cls, value: str) -> str | None:
     @validator("expose_external")
     @classmethod
     def expose_external_validator(cls, value: str) -> str | None:
-        """Check expose-external config option is only used on Kubernetes charm."""
+        """Check expose_external config option is only used on Kubernetes charm."""
         if SUBSTRATE == "vm":
             return
 

diff --git a/tests/unit/test_config.py b/tests/unit/test_config.py
@@ -132,7 +132,7 @@ def test_listeners_in_server_properties(
 ) -> None:
     """Checks that listeners are split into INTERNAL, CLIENT and EXTERNAL."""
     # Given
-    charm_configuration["options"]["expose-external"]["default"] = "nodeport"
+    charm_configuration["options"]["expose_external"]["default"] = "nodeport"
     cluster_peer = PeerRelation(PEER, PEER, local_unit_data={"private-address": "treebeard"})
     zk_relation = Relation(ZK, ZK, remote_app_data=zk_data)
     client_relation = Relation(REL_NAME, "app")

diff --git a/tests/unit/test_kraft.py b/tests/unit/test_kraft.py
@@ -91,7 +91,7 @@ def test_ready_to_start_no_peer_cluster(charm_configuration, base_state: State):
 def test_ready_to_start_missing_data_as_controller(charm_configuration, base_state: State):
     # Given
     charm_configuration["options"]["roles"]["default"] = "controller"
-    charm_configuration["options"]["expose-external"]["default"] = "none"
+    charm_configuration["options"]["expose_external"]["default"] = "none"
     ctx = Context(
         KafkaCharm,
         meta=METADATA,
@@ -112,7 +112,7 @@ def test_ready_to_start_missing_data_as_controller(charm_configuration, base_sta
 def test_ready_to_start_missing_data_as_broker(charm_configuration, base_state: State):
     # Given
     charm_configuration["options"]["roles"]["default"] = "broker"
-    charm_configuration["options"]["expose-external"]["default"] = "none"
+    charm_configuration["options"]["expose_external"]["default"] = "none"
     ctx = Context(
         KafkaCharm,
         meta=METADATA,
@@ -136,7 +136,7 @@ def test_ready_to_start_missing_data_as_broker(charm_configuration, base_state:
 def test_ready_to_start(charm_configuration, base_state: State):
     # Given
     charm_configuration["options"]["roles"]["default"] = "broker,controller"
-    charm_configuration["options"]["expose-external"]["default"] = "none"
+    charm_configuration["options"]["expose_external"]["default"] = "none"
     ctx = Context(
         KafkaCharm,
         meta=METADATA,