[JUJU-5140] Write controller configuration file

.github/workflows/ci.yml

@@ -143,7 +143,7 @@ jobs:
 
     - name: Install Juju
       run: |
-        sudo snap install juju --channel 4.0/edge
+        sudo snap install juju --channel 4.0/beta
 
     - name: Bootstrap on LXD
       if: matrix.cloud == 'lxd'

metadata.yaml

@@ -2,7 +2,7 @@
 # Licensed under the GPLv3, see LICENSE file for details.
 name: juju-controller
 assumes:
-- juju >= 3.3
+- juju >= 4.0
 description: |
   The Juju controller charm is used to expose various pieces
   of functionality of a Juju controller.

src/charm.py

@@ -12,29 +12,34 @@
 from charms.prometheus_k8s.v0.prometheus_scrape import MetricsEndpointProvider
 from ops.charm import CharmBase, CollectStatusEvent
 from ops.framework import StoredState
-from ops.charm import RelationJoinedEvent, RelationDepartedEvent
+from ops.charm import InstallEvent, RelationJoinedEvent, RelationDepartedEvent
 from ops.main import main
 from ops.model import ActiveStatus, BlockedStatus, ErrorStatus, Relation
+from pathlib import Path
 from typing import List
 
 logger = logging.getLogger(__name__)
 
 
 class JujuControllerCharm(CharmBase):
     DB_BIND_ADDR_KEY = 'db-bind-address'
+    ALL_BIND_ADDRS_KEY = 'db-bind-addresses'
+
     _stored = StoredState()
 
     def __init__(self, *args):
         super().__init__(*args)
 
+        self.framework.observe(self.on.install, self._on_install)
         self.framework.observe(self.on.collect_unit_status, self._on_collect_status)
         self.framework.observe(self.on.config_changed, self._on_config_changed)
         self.framework.observe(
             self.on.dashboard_relation_joined, self._on_dashboard_relation_joined)
         self.framework.observe(
             self.on.website_relation_joined, self._on_website_relation_joined)
 
-        self._stored.set_default(db_bind_address='', last_bind_addresses=[], all_bind_addresses=dict())
+        self._stored.set_default(
+            db_bind_address='', last_bind_addresses=[], all_bind_addresses=dict())
         self.framework.observe(
             self.on.dbcluster_relation_changed, self._on_dbcluster_relation_changed)
 
@@ -45,6 +50,12 @@ def __init__(self, *args):
         self.framework.observe(
             self.on.metrics_endpoint_relation_broken, self._on_metrics_endpoint_relation_broken)
 
+    def _on_install(self, event: InstallEvent):
+        """Ensure that the controller configuration file exists."""
+        file_path = self._controller_config_path()
+        Path(file_path).parent.mkdir(parents=True, exist_ok=True)
+        open(file_path, 'w+').close()
+
     def _on_collect_status(self, event: CollectStatusEvent):
         if len(self._stored.last_bind_addresses) > 1:
             event.add_status(BlockedStatus(
@@ -133,32 +144,47 @@ def _on_metrics_endpoint_relation_broken(self, event: RelationDepartedEvent):
         self.control_socket.remove_metrics_user(username)
 
     def _on_dbcluster_relation_changed(self, event):
-        """Ensure that a bind address for Dqlite is set in relation data,
-        if we can determine a unique one from the relation's bound space.
+        """Maintain our own bind address in relation data.
         If we are the leader, aggregate the bind addresses for all the peers,
         and ensure the result is set in the application data bag.
+        If the aggregate addresses have changed, rewrite the config file.
         """
-        self._ensure_db_bind_address(event)
+        relation = event.relation
+        self._ensure_db_bind_address(relation)
 
         if self.unit.is_leader():
             # The event only has *other* units so include this
             # unit's bind address if we have managed to set it.
             ip = self._stored.db_bind_address
             all_bind_addresses = {self.unit.name: ip} if ip else dict()
 
-            for unit in event.relation.units:
-                unit_data = event.relation.data[unit]
+            for unit in relation.units:
+                unit_data = relation.data[unit]
                 if self.DB_BIND_ADDR_KEY in unit_data:
                     all_bind_addresses[unit.name] = unit_data[self.DB_BIND_ADDR_KEY]
 
             if self._stored.all_bind_addresses == all_bind_addresses:
                 return
 
-            event.relation.data[self.app]['db-bind-addresses'] = json.dumps(all_bind_addresses)
-            self._stored.all_bind_addresses = all_bind_addresses
+            relation.data[self.app][self.ALL_BIND_ADDRS_KEY] = json.dumps(all_bind_addresses)
+            self._update_config_file(all_bind_addresses)
+        else:
+            app_data = relation.data[self.app]
+            if self.ALL_BIND_ADDRS_KEY in app_data:
+                all_bind_addresses = json.loads(app_data[self.ALL_BIND_ADDRS_KEY])
+            else:
+                all_bind_addresses = dict()
+
+            if self._stored.all_bind_addresses == all_bind_addresses:
+                return
+
+            self._update_config_file(all_bind_addresses)
 
-    def _ensure_db_bind_address(self, event):
-        ips = [str(ip) for ip in self.model.get_binding(event.relation).network.ingress_addresses]
+    def _ensure_db_bind_address(self, relation):
+        """Ensure that a bind address for Dqlite is set in relation data,
+        if we can determine a unique one from the relation's bound space.
+        """
+        ips = [str(ip) for ip in self.model.get_binding(relation).network.ingress_addresses]
         self._stored.last_bind_addresses = ips
 
         if len(ips) > 1:
@@ -170,9 +196,24 @@ def _ensure_db_bind_address(self, event):
         if self._stored.db_bind_address == ip:
             return
 
-        event.relation.data[self.unit].update({self.DB_BIND_ADDR_KEY: ip})
+        logger.info('setting new DB bind address: %s', ip)
+        relation.data[self.unit].update({self.DB_BIND_ADDR_KEY: ip})
         self._stored.db_bind_address = ip
 
+    def _update_config_file(self, bind_addresses):
+        file_path = self._controller_config_path()
+        with open(file_path) as conf_file:
+            conf = yaml.safe_load(conf_file)
+
+        if not conf:
+            conf = dict()
+        conf[self.ALL_BIND_ADDRS_KEY] = bind_addresses
+
+        with open(file_path, 'w') as conf_file:
+            yaml.dump(conf, conf_file)
+
+        self._stored.all_bind_addresses = bind_addresses
+
     def api_port(self) -> str:
         """Return the port on which the controller API server is listening."""
         api_addresses = self._agent_conf('apiaddresses')
@@ -199,6 +240,10 @@ def _agent_conf(self, key: str):
             agent_conf = yaml.safe_load(agent_conf_file)
             return agent_conf.get(key)
 
+    def _controller_config_path(self) -> str:
+        unit_num = self.unit.name.split('/')[1]
+        return f'/var/lib/juju/agents/controller-{unit_num}/agent.conf'
+
 
 def metrics_username(relation: Relation) -> str:
     """

tests/test_charm.py

@@ -5,6 +5,8 @@
 import json
 import os
 import unittest
+import yaml
+
 from charm import JujuControllerCharm, AgentConfException
 from ops.model import BlockedStatus, ActiveStatus, ErrorStatus
 from ops.testing import Harness
@@ -156,17 +158,15 @@ def test_dbcluster_relation_changed_single_addr(self, binding, _):
         harness = self.harness
         binding.return_value = mockBinding(['192.168.1.17'])
 
+        harness.set_leader()
+
         # Have another unit enter the relation.
         # Its bind address should end up in the application data bindings list.
-        relation_id = harness.add_relation('dbcluster', 'controller')
+        relation_id = harness.add_relation('dbcluster', harness.charm.app.name)
         harness.add_relation_unit(relation_id, 'juju-controller/1')
         self.harness.update_relation_data(
             relation_id, 'juju-controller/1', {'db-bind-address': '192.168.1.100'})
 
-        harness.set_leader()
-        harness.charm._on_dbcluster_relation_changed(
-            harness.charm.model.get_relation('dbcluster').data[harness.charm.unit])
-
         unit_data = harness.get_relation_data(relation_id, 'juju-controller/0')
         self.assertEqual(unit_data['db-bind-address'], '192.168.1.17')
 
@@ -183,15 +183,46 @@ def test_dbcluster_relation_changed_multi_addr_error(self, binding, _):
         harness = self.harness
         binding.return_value = mockBinding(["192.168.1.17", "192.168.1.18"])
 
-        relation_id = harness.add_relation('dbcluster', 'controller')
+        relation_id = harness.add_relation('dbcluster', harness.charm.app.name)
         harness.add_relation_unit(relation_id, 'juju-controller/1')
 
-        harness.charm._on_dbcluster_relation_changed(
-            harness.charm.model.get_relation('dbcluster').data[harness.charm.unit])
+        self.harness.update_relation_data(
+            relation_id, 'juju-controller/1', {'db-bind-address': '192.168.1.100'})
 
         harness.evaluate_status()
         self.assertIsInstance(harness.charm.unit.status, BlockedStatus)
 
+    @patch("builtins.open", new_callable=mock_open)
+    @patch("ops.model.Model.get_binding")
+    def test_dbcluster_relation_changed_write_file(self, binding, mock_open):
+        harness = self.harness
+        binding.return_value = mockBinding(['192.168.1.17'])
+
+        relation_id = harness.add_relation('dbcluster', harness.charm.app)
+        harness.add_relation_unit(relation_id, 'juju-controller/1')
+        bound = {'juju-controller/0': '192.168.1.17', 'juju-controller/1': '192.168.1.100'}
+        self.harness.update_relation_data(
+            relation_id, harness.charm.app.name, {'db-bind-addresses': json.dumps(bound)})
+
+        file_path = '/var/lib/juju/agents/controller-0/agent.conf'
+        self.assertEqual(mock_open.call_count, 2)
+
+        # First call to read out the YAML
+        first_call_args, _ = mock_open.call_args_list[0]
+        self.assertEqual(first_call_args, (file_path,))
+
+        # Second call to write the updated YAML.
+        second_call_args, _ = mock_open.call_args_list[1]
+        self.assertEqual(second_call_args, (file_path, 'w'))
+
+        # yaml.dump appears to write the the file incrementally,
+        # so we need to hoover up the call args to reconstruct.
+        written = ''
+        for args in mock_open().write.call_args_list:
+            written += args[0][0]
+
+        self.assertEqual(yaml.safe_load(written), {'db-bind-addresses': bound})
+
 
 class mockNetwork:
     def __init__(self, addresses):