Ensure availability_zone set globally for agents

Inline with the neutron-gateway charm, move availability_zone
configuration to the neutron.conf configuration file to ensure
that its set consistently for all neutron agents that may be
running on the unit.

Change-Id: If9438302f8f889a1cbaf93f8a460e190e551241b
Closes-Bug: 1829537

hooks/neutron_ovs_context.py

@@ -258,12 +258,11 @@ class OVSPluginContext(context.NeutronContext):
         return ovs_ctxt
 
 
-class DHCPAgentContext(OSContextGenerator):
+class ZoneContext(OSContextGenerator):
 
     def __call__(self):
         """Return the 'default_availability_zone' from the principal that this
-        ovs unit is attached to (as a subordinate) and the 'dns_domain' from
+        ovs unit is attached to (as a subordinate)
-        the neutron-plugin-api relations (if one is set).
 
         :returns: {} if no relation set, or
             {'availability_zone': availability_zone from principal relation}
@@ -283,6 +282,20 @@ class DHCPAgentContext(OSContextGenerator):
                     unit=units[0])
                 if availability_zone:
                     ctxt['availability_zone'] = availability_zone
+        return ctxt
+
+
+class DHCPAgentContext(ZoneContext):
+
+    def __call__(self):
+        """Return the 'default_availability_zone' from the principal that this
+        ovs unit is attached to (as a subordinate) and the 'dns_domain' from
+        the neutron-plugin-api relations (if one is set).
+
+        :returns: {} if no relation set, or
+            {'availability_zone': availability_zone from principal relation}
+        """
+        ctxt = super(DHCPAgentContext, self).__call__()
 
         dnsmasq_flags = config('dnsmasq-flags')
         if dnsmasq_flags:

hooks/neutron_ovs_utils.py

@@ -164,6 +164,7 @@ BASE_RESOURCE_MAP = OrderedDict([
                      context.ZeroMQContext(),
                      context.NotificationDriverContext(),
                      neutron_ovs_context.HostIPContext(),
+                     neutron_ovs_context.ZoneContext(),
                      ],
     }),
     (ML2_CONF, {

templates/mitaka/dhcp_agent.ini

@@ -31,8 +31,3 @@ enable_metadata_network = True
 enable_isolated_metadata = True
 
 ovs_use_veth = True
-
-[AGENT]
-{% if availability_zone -%}
-availability_zone = {{ availability_zone }}
-{% endif -%}

templates/mitaka/neutron.conf

@@ -38,6 +38,8 @@ rpc_response_timeout = {{ rpc_response_timeout }}
 root_helper = sudo neutron-rootwrap /etc/neutron/rootwrap.conf
 report_interval = {{ report_interval }}
 
+{% include "parts/agent" %}
+
 [keystone_authtoken]
 signing_dir = /var/lib/neutron/keystone-signing
 

templates/ocata/dhcp_agent.ini

@@ -32,8 +32,3 @@ force_metadata = True
 enable_isolated_metadata = True
 
 ovs_use_veth = True
-
-[AGENT]
-{% if availability_zone -%}
-availability_zone = {{ availability_zone }}
-{% endif -%}

templates/ocata/neutron.conf

@@ -41,6 +41,8 @@ rpc_response_timeout = {{ rpc_response_timeout }}
 root_helper = sudo neutron-rootwrap /etc/neutron/rootwrap.conf
 report_interval = {{ report_interval }}
 
+{% include "parts/agent" %}
+
 [keystone_authtoken]
 signing_dir = /var/lib/neutron/keystone-signing
 

templates/parts/agent

@@ -0,0 +1,3 @@
+{% if availability_zone -%}
+availability_zone = {{ availability_zone }}
+{% endif -%}

templates/stein/neutron.conf

@@ -45,6 +45,8 @@ rpc_response_timeout = {{ rpc_response_timeout }}
 root_helper = sudo neutron-rootwrap /etc/neutron/rootwrap.conf
 report_interval = {{ report_interval }}
 
+{% include "parts/agent" %}
+
 [keystone_authtoken]
 signing_dir = /var/lib/neutron/keystone-signing
 

unit_tests/test_neutron_ovs_context.py

@@ -275,6 +275,44 @@ class OVSPluginContextTest(CharmTestCase):
         self.assertEqual(expect, napi_ctxt())
 
 
+class ZoneContextTest(CharmTestCase):
+
+    def setUp(self):
+        super(ZoneContextTest, self).setUp(context, TO_PATCH)
+        self.config.side_effect = self.test_config.get
+
+    def tearDown(self):
+        super(ZoneContextTest, self).tearDown()
+
+    def test_default_availability_zone_not_provided(self):
+        self.relation_ids.return_value = ['rid1']
+        self.related_units.return_value = ['nova-compute/0']
+        self.relation_get.return_value = None
+        self.assertEqual(
+            context.ZoneContext()(),
+            {}
+        )
+        self.relation_ids.assert_called_with('neutron-plugin')
+        self.relation_get.assert_called_once_with(
+            'default_availability_zone',
+            rid='rid1',
+            unit='nova-compute/0')
+
+    def test_default_availability_zone_provided(self):
+        self.relation_ids.return_value = ['rid1']
+        self.related_units.return_value = ['nova-compute/0']
+        self.relation_get.return_value = 'nova'
+        self.assertEqual(
+            context.ZoneContext()(),
+            {'availability_zone': 'nova'}
+        )
+        self.relation_ids.assert_called_with('neutron-plugin')
+        self.relation_get.assert_called_once_with(
+            'default_availability_zone',
+            rid='rid1',
+            unit='nova-compute/0')
+
+
 class DHCPAgentContextTest(CharmTestCase):
 
     def setUp(self):