Merge "Support neutron subnets without gateway IPs"

shade/openstackcloud.py

@@ -3748,7 +3748,8 @@ class OpenStackCloud(object):
 
     def create_subnet(self, network_name_or_id, cidr, ip_version=4,
                       enable_dhcp=False, subnet_name=None, tenant_id=None,
-                      allocation_pools=None, gateway_ip=None,
+                      allocation_pools=None,
+                      gateway_ip=None, disable_gateway_ip=False,
                       dns_nameservers=None, host_routes=None,
                       ipv6_ra_mode=None, ipv6_address_mode=None):
         """Create a subnet on a specified network.
@@ -3783,6 +3784,10 @@ class OpenStackCloud(object):
            The gateway IP address. When you specify both allocation_pools and
            gateway_ip, you must ensure that the gateway IP does not overlap
            with the specified allocation pools.
+        :param bool disable_gateway_ip:
+           Set to ``True`` if gateway IP address is disabled and ``False`` if
+           enabled. It is not allowed with gateway_ip.
+           Default is ``False``.
         :param list dns_nameservers:
            A list of DNS name servers for the subnet. For example::
 
@@ -3818,6 +3823,10 @@ class OpenStackCloud(object):
             raise OpenStackCloudException(
                 "Network %s not found." % network_name_or_id)
 
+        if disable_gateway_ip and gateway_ip:
+            raise OpenStackCloudException(
+                'arg:disable_gateway_ip is not allowed with arg:gateway_ip')
+
         # The body of the neutron message for the subnet we wish to create.
         # This includes attributes that are required or have defaults.
         subnet = {
@@ -3836,6 +3845,8 @@ class OpenStackCloud(object):
             subnet['allocation_pools'] = allocation_pools
         if gateway_ip:
             subnet['gateway_ip'] = gateway_ip
+        if disable_gateway_ip:
+            subnet['gateway_ip'] = None
         if dns_nameservers:
             subnet['dns_nameservers'] = dns_nameservers
         if host_routes:
@@ -3878,8 +3889,9 @@ class OpenStackCloud(object):
         return True
 
     def update_subnet(self, name_or_id, subnet_name=None, enable_dhcp=None,
-                      gateway_ip=None, allocation_pools=None,
+                      gateway_ip=None, disable_gateway_ip=None,
-                      dns_nameservers=None, host_routes=None):
+                      allocation_pools=None, dns_nameservers=None,
+                      host_routes=None):
         """Update an existing subnet.
 
         :param string name_or_id:
@@ -3892,6 +3904,10 @@ class OpenStackCloud(object):
            The gateway IP address. When you specify both allocation_pools and
            gateway_ip, you must ensure that the gateway IP does not overlap
            with the specified allocation pools.
+        :param bool disable_gateway_ip:
+           Set to ``True`` if gateway IP address is disabled and ``False`` if
+           enabled. It is not allowed with gateway_ip.
+           Default is ``False``.
         :param list allocation_pools:
            A list of dictionaries of the start and end addresses for the
            allocation pools. For example::
@@ -3932,6 +3948,8 @@ class OpenStackCloud(object):
             subnet['enable_dhcp'] = enable_dhcp
         if gateway_ip:
             subnet['gateway_ip'] = gateway_ip
+        if disable_gateway_ip:
+            subnet['gateway_ip'] = None
         if allocation_pools:
             subnet['allocation_pools'] = allocation_pools
         if dns_nameservers:
@@ -3943,6 +3961,10 @@ class OpenStackCloud(object):
             self.log.debug("No subnet data to update")
             return
 
+        if disable_gateway_ip and gateway_ip:
+            raise OpenStackCloudException(
+                'arg:disable_gateway_ip is not allowed with arg:gateway_ip')
+
         curr_subnet = self.get_subnet(name_or_id)
         if not curr_subnet:
             raise OpenStackCloudException(

shade/tests/unit/test_shade.py

@@ -341,6 +341,44 @@ class TestShade(base.TestCase):
                                  host_routes=routes)
         self.assertTrue(mock_client.create_subnet.called)
 
+    @mock.patch.object(shade.OpenStackCloud, 'search_networks')
+    @mock.patch.object(shade.OpenStackCloud, 'neutron_client')
+    def test_create_subnet_without_gateway_ip(self, mock_client, mock_search):
+        net1 = dict(id='123', name='donald')
+        mock_search.return_value = [net1]
+        pool = [{'start': '192.168.200.2', 'end': '192.168.200.254'}]
+        dns = ['8.8.8.8']
+        self.cloud.create_subnet('kooky', '192.168.200.0/24',
+                                 allocation_pools=pool,
+                                 dns_nameservers=dns,
+                                 disable_gateway_ip=True)
+        self.assertTrue(mock_client.create_subnet.called)
+
+    @mock.patch.object(shade.OpenStackCloud, 'search_networks')
+    @mock.patch.object(shade.OpenStackCloud, 'neutron_client')
+    def test_create_subnet_with_gateway_ip(self, mock_client, mock_search):
+        net1 = dict(id='123', name='donald')
+        mock_search.return_value = [net1]
+        pool = [{'start': '192.168.200.8', 'end': '192.168.200.254'}]
+        dns = ['8.8.8.8']
+        gateway = '192.168.200.2'
+        self.cloud.create_subnet('kooky', '192.168.200.0/24',
+                                 allocation_pools=pool,
+                                 dns_nameservers=dns,
+                                 gateway_ip=gateway)
+        self.assertTrue(mock_client.create_subnet.called)
+
+    @mock.patch.object(shade.OpenStackCloud, 'search_networks')
+    @mock.patch.object(shade.OpenStackCloud, 'neutron_client')
+    def test_create_subnet_conflict_gw_ops(self, mock_client, mock_search):
+        net1 = dict(id='123', name='donald')
+        mock_search.return_value = [net1]
+        gateway = '192.168.200.3'
+        self.assertRaises(exc.OpenStackCloudException,
+                          self.cloud.create_subnet, 'kooky',
+                          '192.168.200.0/24', gateway_ip=gateway,
+                          disable_gateway_ip=True)
+
     @mock.patch.object(shade.OpenStackCloud, 'list_networks')
     @mock.patch.object(shade.OpenStackCloud, 'neutron_client')
     def test_create_subnet_bad_network(self, mock_client, mock_list):
@@ -406,6 +444,35 @@ class TestShade(base.TestCase):
         self.cloud.update_subnet('123', subnet_name='goofy')
         self.assertTrue(mock_client.update_subnet.called)
 
+    @mock.patch.object(shade.OpenStackCloud, 'get_subnet')
+    @mock.patch.object(shade.OpenStackCloud, 'neutron_client')
+    def test_update_subnet_gateway_ip(self, mock_client, mock_get):
+        subnet1 = dict(id='456', name='kooky')
+        mock_get.return_value = subnet1
+        gateway = '192.168.200.3'
+        self.cloud.update_subnet(
+            '456', gateway_ip=gateway)
+        self.assertTrue(mock_client.update_subnet.called)
+
+    @mock.patch.object(shade.OpenStackCloud, 'get_subnet')
+    @mock.patch.object(shade.OpenStackCloud, 'neutron_client')
+    def test_update_subnet_disable_gateway_ip(self, mock_client, mock_get):
+        subnet1 = dict(id='456', name='kooky')
+        mock_get.return_value = subnet1
+        self.cloud.update_subnet(
+            '456', disable_gateway_ip=True)
+        self.assertTrue(mock_client.update_subnet.called)
+
+    @mock.patch.object(shade.OpenStackCloud, 'get_subnet')
+    @mock.patch.object(shade.OpenStackCloud, 'neutron_client')
+    def test_update_subnet_conflict_gw_ops(self, mock_client, mock_get):
+        subnet1 = dict(id='456', name='kooky')
+        mock_get.return_value = subnet1
+        gateway = '192.168.200.3'
+        self.assertRaises(exc.OpenStackCloudException,
+                          self.cloud.update_subnet,
+                          '456', gateway_ip=gateway, disable_gateway_ip=True)
+
     @mock.patch.object(shade.OpenStackCloud, 'nova_client')
     def test_get_flavor_by_ram(self, mock_nova_client):