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

Author: Batalex

charmcraft.yaml

@@ -4,15 +4,20 @@
 type: charm
 parts:
   charm:
+    build-snaps:
+      - rustup
     charm-binary-python-packages:
       - setuptools
       - pydantic
     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"

config.yaml

@@ -108,7 +108,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', 'false'"
     type: string
     default: "false"

poetry.lock

@@ -41,9 +41,6 @@ pydantic = "^1.10.7"
 pyyaml = "^6.0.1"
 requests = ">2.25"
 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
@@ -74,8 +71,6 @@ ruff = ">=0.1.0"
 codespell = ">=2.2.2"
 pyright = "^1.1.301"
 lightkube = "0.15.0"
-# FIXME: Unpin once rustc 1.76 is available at build time
-rpds-py = "<0.19"
 
 [tool.poetry.group.unit]
 optional = true

pyproject.toml

@@ -234,7 +234,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
 

src/core/structured_config.py

@@ -85,7 +85,7 @@ async def test_build_and_deploy(ops_test: OpsTest, kafka_charm, app_charm):
             num_units=1,
             resources={"kafka-image": KAFKA_CONTAINER},
             trust=True,
-            config={"expose-external": "nodeport"},
+            config={"expose_external": "nodeport"},
         ),
         ops_test.model.deploy(ZK_NAME, channel="3/edge", num_units=1, trust=True),
         ops_test.model.deploy(app_charm, application_name=DUMMY_NAME, trust=True),
@@ -124,7 +124,7 @@ async def test_multi_cluster_isolation(ops_test: OpsTest, kafka_charm):
             num_units=1,
             resources={"kafka-image": KAFKA_CONTAINER},
             trust=True,
-            config={"expose-external": "nodeport"},
+            config={"expose_external": "nodeport"},
         ),
         ops_test.model.deploy(
             ZK_NAME, application_name=second_zk_name, channel="3/edge", trust=True

tests/integration/ha/test_ha.py

@@ -55,7 +55,7 @@ async def test_build_and_deploy(self, ops_test: OpsTest, kafka_charm):
                 config={
                     "roles": "broker,balancer" if self.balancer_app == APP_NAME else "broker",
                     "profile": "testing",
-                    "expose-external": "nodeport",
+                    "expose_external": "nodeport",
                 },
                 resources={"kafka-image": KAFKA_CONTAINER},
                 trust=True,
@@ -92,7 +92,7 @@ async def test_build_and_deploy(self, ops_test: OpsTest, kafka_charm):
                 config={
                     "roles": self.balancer_app,
                     "profile": "testing",
-                    "expose-external": "nodeport",
+                    "expose_external": "nodeport",
                 },
                 resources={"kafka-image": KAFKA_CONTAINER},
                 trust=True,

tests/integration/test_balancer.py

@@ -45,7 +45,7 @@ async def test_build_and_deploy(ops_test: OpsTest, kafka_charm):
             num_units=1,
             resources={"kafka-image": KAFKA_CONTAINER},
             trust=True,
-            config={"expose-external": "nodeport"},
+            config={"expose_external": "nodeport"},
         ),
     )
     await ops_test.model.block_until(lambda: len(ops_test.model.applications[ZK_NAME].units) == 3)

tests/integration/test_charm.py

@@ -36,7 +36,7 @@ async def test_build_and_deploy(ops_test: OpsTest, kafka_charm):
             resources={"kafka-image": KAFKA_CONTAINER},
             num_units=1,
             trust=True,
-            config={"expose-external": "nodeport"},
+            config={"expose_external": "nodeport"},
         ),
     )
     await ops_test.model.block_until(lambda: len(ops_test.model.applications[ZK_NAME].units) == 3)

tests/integration/test_password_rotation.py

@@ -51,7 +51,7 @@ async def test_deploy_charms_relate_active(
             num_units=1,
             resources={"kafka-image": KAFKA_CONTAINER},
             trust=True,
-            config={"expose-external": "nodeport"},
+            config={"expose_external": "nodeport"},
         ),
         ops_test.model.deploy(app_charm, application_name=DUMMY_NAME_1, num_units=1, trust=True),
     )

tests/integration/test_provider.py

@@ -32,7 +32,7 @@ async def test_kafka_simple_scale_up(ops_test: OpsTest, kafka_charm):
             num_units=1,
             resources={"kafka-image": KAFKA_CONTAINER},
             trust=True,
-            config={"expose-external": "nodeport"},
+            config={"expose_external": "nodeport"},
         ),
     )
     await ops_test.model.wait_for_idle(apps=[APP_NAME, ZK_NAME])

tests/integration/test_scaling.py

@@ -55,7 +55,7 @@ async def test_deploy_tls(ops_test: OpsTest, kafka_charm, app_charm):
             resources={"kafka-image": KAFKA_CONTAINER},
             config={
                 "ssl_principal_mapping_rules": "RULE:^.*[Cc][Nn]=([a-zA-Z0-9.]*).*$/$1/L,DEFAULT",
-                "expose-external": "nodeport",
+                "expose_external": "nodeport",
             },
             trust=True,
         ),

tests/integration/test_tls.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")