Add Subnet service-types to subnets

Add '--service-type' to subnet arguments to support
Subnet service-types.

Change-Id: I215d83e4d4cf53e03fa35041c5e41a328641b3a9
Partially-implements: blueprint service-subnets

Author: Brian Haley

doc/source/command-objects/subnet.rst

@@ -29,6 +29,7 @@ Create new subnet
         [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
         [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
         [--network-segment <network-segment>]
+        [--service-type <service-type>]
         --network <network>
         <name>
 
@@ -116,6 +117,13 @@ Create new subnet
                   to change. Use global option ``--os-beta-command``
                   to enable this command option.
 
+.. option:: --service-type <service-type>
+
+     Service type for this subnet e.g.:
+     ``network:floatingip_agent_gateway``.
+     Must be a valid device owner value for a network port
+     (repeat option to set multiple service types)
+
 .. option:: --network <network>
 
      Network this subnet belongs to (name or ID)
@@ -171,6 +179,13 @@ List subnets
 
     List subnets which have DHCP disabled
 
+.. option:: --service-type <service-type>
+
+    List only subnets of a given service type in output
+    e.g.: ``network:floatingip_agent_gateway``.
+    Must be a valid device owner value for a network port
+    (repeat option to list multiple service types)
+
 subnet set
 ----------
 
@@ -185,6 +200,7 @@ Set subnet properties
         [--dns-nameserver <dns-nameserver>]
         [--gateway <gateway-ip>]
         [--host-route destination=<subnet>,gateway=<ip-address>]
+        [--service-type <service-type>]
         [--name <new-name>]
         <subnet>
 
@@ -221,6 +237,13 @@ Set subnet properties
      gateway: nexthop IP address
      (repeat option to add multiple routes)
 
+.. option:: --service-type <service-type>
+
+     Service type for this subnet e.g.:
+     ``network:floatingip_agent_gateway``.
+     Must be a valid device owner value for a network port
+     (repeat option to set multiple service types)
+
 .. option:: --name
 
      Updated name of the subnet
@@ -259,6 +282,7 @@ Unset subnet properties
         [--allocation-pool start=<ip-address>,end=<ip-address> [...]]
         [--dns-nameserver <dns-nameserver> [...]]
         [--host-route destination=<subnet>,gateway=<ip-address> [...]]
+        [--service-type <service-type>]
         <subnet>
 
 .. option:: --dns-nameserver <dns-nameserver>
@@ -280,6 +304,13 @@ Unset subnet properties
      gateway: nexthop IP address
      (repeat option to unset multiple host routes)
 
+.. option:: --service-type <service-type>
+
+     Service type to be removed from this subnet e.g.:
+     ``network:floatingip_agent_gateway``.
+     Must be a valid device owner value for a network port
+     (repeat option to unset multiple service types)
+
 .. _subnet_unset-subnet:
 .. describe:: <subnet>
 

functional/tests/network/v2/test_subnet.py

@@ -53,6 +53,13 @@ def test_subnet_set(self):
         raw_output = self.openstack('subnet show ' + self.NAME + opts)
         self.assertEqual("False\n" + self.NAME + "\n", raw_output)
 
+    def test_subnet_set_service_type(self):
+        TYPE = 'network:floatingip_agent_gateway'
+        self.openstack('subnet set --service-type ' + TYPE + ' ' + self.NAME)
+        opts = self.get_opts(['name', 'service_types'])
+        raw_output = self.openstack('subnet show ' + self.NAME + opts)
+        self.assertEqual(self.NAME + "\n" + TYPE + "\n", raw_output)
+
     def test_subnet_show(self):
         opts = self.get_opts(self.FIELDS)
         raw_output = self.openstack('subnet show ' + self.NAME + opts)

openstackclient/network/v2/subnet.py

@@ -48,6 +48,7 @@ def _format_host_routes(data):
     'allocation_pools': _format_allocation_pools,
     'dns_nameservers': utils.format_list,
     'host_routes': _format_host_routes,
+    'service_types': utils.format_list,
 }
 
 
@@ -82,6 +83,16 @@ def _get_common_parse_arguments(parser):
                "gateway: nexthop IP address "
                "(repeat option to add multiple routes)")
     )
+    parser.add_argument(
+        '--service-type',
+        metavar='<service-type>',
+        action='append',
+        dest='service_types',
+        help=_("Service type for this subnet "
+               "e.g.: network:floatingip_agent_gateway. "
+               "Must be a valid device owner value for a network port "
+               "(repeat option to set multiple service types)")
+    )
 
 
 def _get_columns(item):
@@ -177,6 +188,9 @@ def _get_attrs(client_manager, parsed_args, is_create=True):
         # Change 'gateway' entry to 'nexthop' to match the API
         attrs['host_routes'] = convert_entries_to_nexthop(
             parsed_args.host_routes)
+    if ('service_types' in parsed_args and
+       parsed_args.service_types is not None):
+        attrs['service_types'] = parsed_args.service_types
     return attrs
 
 
@@ -352,6 +366,16 @@ def get_parser(self, prog_name):
             action='store_true',
             help=_("List subnets which have DHCP disabled")
         )
+        parser.add_argument(
+            '--service-type',
+            metavar='<service-type>',
+            action='append',
+            dest='service_types',
+            help=_("List only subnets of a given service type in output "
+                   "e.g.: network:floatingip_agent_gateway. "
+                   "Must be a valid device owner value for a network port "
+                   "(repeat option to list multiple service types)")
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -362,17 +386,19 @@ def take_action(self, parsed_args):
             filters['enable_dhcp'] = True
         elif parsed_args.no_dhcp:
             filters['enable_dhcp'] = False
+        if parsed_args.service_types:
+            filters['service_types'] = parsed_args.service_types
         data = self.app.client_manager.network.subnets(**filters)
 
         headers = ('ID', 'Name', 'Network', 'Subnet')
         columns = ('id', 'name', 'network_id', 'cidr')
         if parsed_args.long:
             headers += ('Project', 'DHCP', 'Name Servers',
                         'Allocation Pools', 'Host Routes', 'IP Version',
-                        'Gateway')
+                        'Gateway', 'Service Types')
             columns += ('tenant_id', 'enable_dhcp', 'dns_nameservers',
                         'allocation_pools', 'host_routes', 'ip_version',
-                        'gateway_ip')
+                        'gateway_ip', 'service_types')
 
         return (headers,
                 (utils.get_item_properties(
@@ -430,6 +456,8 @@ def take_action(self, parsed_args):
             attrs['host_routes'] += obj.host_routes
         if 'allocation_pools' in attrs:
             attrs['allocation_pools'] += obj.allocation_pools
+        if 'service_types' in attrs:
+            attrs['service_types'] += obj.service_types
         client.update_subnet(obj, **attrs)
         return
 
@@ -489,6 +517,16 @@ def get_parser(self, prog_name):
                    'gateway: nexthop IP address '
                    '(repeat option to unset multiple host routes)')
         )
+        parser.add_argument(
+            '--service-type',
+            metavar='<service-type>',
+            action='append',
+            dest='service_types',
+            help=_('Service type to be removed from this subnet '
+                   'e.g.: network:floatingip_agent_gateway. '
+                   'Must be a valid device owner value for a network port '
+                   '(repeat option to unset multiple service types)')
+        )
         parser.add_argument(
             'subnet',
             metavar="<subnet>",
@@ -528,5 +566,13 @@ def take_action(self, parsed_args):
                        str(error))
                 raise exceptions.CommandError(msg)
             attrs['allocation_pools'] = tmp_obj.allocation_pools
+        if parsed_args.service_types:
+            try:
+                _update_arguments(tmp_obj.service_types,
+                                  parsed_args.service_types)
+            except ValueError as error:
+                msg = (_("%s not in service-types") % str(error))
+                raise exceptions.CommandError(msg)
+            attrs['service_types'] = tmp_obj.service_types
         if attrs:
             client.update_subnet(obj, **attrs)

openstackclient/tests/network/v2/fakes.py

@@ -889,6 +889,7 @@ def create_one_subnet(attrs=None):
             'ipv6_address_mode': None,
             'ipv6_ra_mode': None,
             'segment_id': None,
+            'service_types': [],
             'subnetpool_id': None,
         }