Introduce Neutron DHCP agent commands to OSC

This patch introduces neutron dhcp-agent related commands to OpenStack
client.

The equivalent neutron commands implemented in OSC:

neutron: dhcp-agent-list-hosting-net
OSC: network agent list --network

neutron: dhcp-agent-network-add
OSC: network agent add network

neutron: dhcp-agent-network-remove
OSC: network agent remove network

neutron: net-list-on-dhcp-agent
OSC: network list --agent

Change-Id: I77a933f4b3ce875c63cef5b6a32aee78fd844b03

Author: shank7485

doc/source/command-objects/network-agent.rst

@@ -10,6 +10,31 @@ agent is "True".
 
 Network v2
 
+network agent add network
+-------------------------
+
+Add network to an agent
+
+.. program:: network agent add network
+.. code:: bash
+
+    openstack network agent add network
+        [--dhcp]
+        <agent-id>
+        <network>
+
+.. describe:: --dhcp
+
+    Add a network to DHCP agent.
+
+.. describe:: <agent-id>
+
+    Agent to which a network is added. (ID only)
+
+.. describe:: <network>
+
+    Network to be added to an agent. (ID or name)
+
 network agent delete
 --------------------
 
@@ -37,6 +62,7 @@ List network agents
     openstack network agent list
         [--agent-type <agent-type>]
         [--host <host>]
+        [--network <network>]
 
 .. option:: --agent-type <agent-type>
 
@@ -49,6 +75,10 @@ List network agents
 
     List only agents running on the specified host
 
+.. option:: --network <network>
+
+    List agents hosting a network. (ID or name)
+
 network agent set
 -----------------
 
@@ -94,3 +124,28 @@ Display network agent details
 .. describe:: <network-agent>
 
     Network agent to display (ID only)
+
+network agent remove network
+----------------------------
+
+Remove network from an agent
+
+.. program:: network agent remove network
+.. code:: bash
+
+    openstack network agent remove network
+        [--dhcp]
+        <agent-id>
+        <network>
+
+.. describe:: --dhcp
+
+    Remove network from DHCP agent.
+
+.. describe:: <agent-id>
+
+    Agent to which a network is removed. (ID only)
+
+.. describe:: <network>
+
+    Network to be removed from an agent. (ID or name)

doc/source/command-objects/network.rst

@@ -203,6 +203,7 @@ List networks
         [--provider-network-type <provider-network-type>]
         [--provider-physical-network <provider-physical-network>]
         [--provider-segment <provider-segment>]
+        [--agent <agent-id>]
 
 .. option:: --external
 
@@ -290,6 +291,10 @@ List networks
 
     *Network version 2 only*
 
+.. option:: --agent <agent-id>
+
+    List networks hosted by agent (ID only)
+
 network set
 -----------
 

openstackclient/network/v2/network.py

@@ -60,12 +60,10 @@ def _get_network_columns(item):
 
 
 def _get_columns(item):
-    columns = list(item.keys())
-    if 'tenant_id' in columns:
-        columns.remove('tenant_id')
-    if 'project_id' not in columns:
-        columns.append('project_id')
-    return tuple(sorted(columns))
+    column_map = {
+        'tenant_id': 'project_id',
+    }
+    return sdk_utils.get_osc_show_columns_for_sdk_resource(item, column_map)
 
 
 def _get_attrs(client_manager, parsed_args):
@@ -305,9 +303,9 @@ def take_action_network(self, client, parsed_args):
     def take_action_compute(self, client, parsed_args):
         attrs = _get_attrs_compute(self.app.client_manager, parsed_args)
         obj = client.networks.create(**attrs)
-        columns = _get_columns(obj._info)
+        display_columns, columns = _get_columns(obj._info)
         data = utils.get_dict_properties(obj._info, columns)
-        return (columns, data)
+        return (display_columns, data)
 
 
 class DeleteNetwork(common.NetworkAndComputeDelete):
@@ -420,7 +418,11 @@ def update_parser_network(self, parser):
             help=_("List networks according to VLAN ID for VLAN networks "
                    "or Tunnel ID for GENEVE/GRE/VXLAN networks")
         )
-
+        parser.add_argument(
+            '--agent',
+            metavar='<agent-id>',
+            dest='agent_id',
+            help=_('List networks hosted by agent (ID only)'))
         return parser
 
     def take_action_network(self, client, parsed_args):
@@ -450,6 +452,26 @@ def take_action_network(self, client, parsed_args):
                 'Router Type',
                 'Availability Zones',
             )
+        elif parsed_args.agent_id:
+            columns = (
+                'id',
+                'name',
+                'subnet_ids'
+            )
+            column_headers = (
+                'ID',
+                'Name',
+                'Subnets',
+            )
+            client = self.app.client_manager.network
+            dhcp_agent = client.get_agent(parsed_args.agent_id)
+            data = client.dhcp_agent_hosting_networks(dhcp_agent)
+
+            return (column_headers,
+                    (utils.get_item_properties(
+                        s, columns,
+                        formatters=_formatters,
+                    ) for s in data))
         else:
             columns = (
                 'id',
@@ -665,6 +687,6 @@ def take_action_compute(self, client, parsed_args):
             client.networks,
             parsed_args.network,
         )
-        columns = _get_columns(obj._info)
+        display_columns, columns = _get_columns(obj._info)
         data = utils.get_dict_properties(obj._info, columns)
-        return (columns, data)
+        return (display_columns, data)

openstackclient/network/v2/network_agent.py

@@ -29,7 +29,6 @@
 def _format_admin_state(state):
     return 'UP' if state else 'DOWN'
 
-
 _formatters = {
     'admin_state_up': _format_admin_state,
     'is_admin_state_up': _format_admin_state,
@@ -45,6 +44,40 @@ def _get_network_columns(item):
     return sdk_utils.get_osc_show_columns_for_sdk_resource(item, column_map)
 
 
+class AddNetworkToAgent(command.Command):
+    _description = _("Add network to an agent")
+
+    def get_parser(self, prog_name):
+        parser = super(AddNetworkToAgent, self).get_parser(prog_name)
+        parser.add_argument(
+            '--dhcp',
+            action='store_true',
+            help=_('Add network to a DHCP agent'))
+        parser.add_argument(
+            'agent_id',
+            metavar='<agent-id>',
+            help=_('Agent to which a network is added. (ID only)'))
+        parser.add_argument(
+            'network',
+            metavar='<network>',
+            help=_('Network to be added to an agent.  (ID or name)'))
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        agent = client.get_agent(parsed_args.agent_id)
+        if parsed_args.dhcp:
+            network = client.find_network(
+                parsed_args.network, ignore_missing=False)
+            try:
+                client.add_dhcp_agent_to_network(agent, network)
+            except Exception:
+                msg = 'Failed to add {} to {}'.format(
+                    network.name, agent.agent_type)
+                exceptions.CommandError(msg)
+
+
 class DeleteNetworkAgent(command.Command):
     _description = _("Delete network agent(s)")
 
@@ -101,6 +134,11 @@ def get_parser(self, prog_name):
             metavar='<host>',
             help=_("List only agents running on the specified host")
         )
+        parser.add_argument(
+            '--network',
+            metavar='<network>',
+            help=_('List agents hosting a network (name or ID)')
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -138,16 +176,72 @@ def take_action(self, parsed_args):
         }
 
         filters = {}
-        if parsed_args.agent_type is not None:
-            filters['agent_type'] = key_value[parsed_args.agent_type]
-        if parsed_args.host is not None:
-            filters['host'] = parsed_args.host
-
-        data = client.agents(**filters)
-        return (column_headers,
-                (utils.get_item_properties(
-                    s, columns, formatters=_formatters,
-                ) for s in data))
+        if parsed_args.network is not None:
+            columns = (
+                'id',
+                'host',
+                'is_admin_state_up',
+                'is_alive',
+            )
+            column_headers = (
+                'ID',
+                'Host',
+                'Admin State Up',
+                'Alive',
+            )
+            network = client.find_network(
+                parsed_args.network, ignore_missing=False)
+            data = client.network_hosting_dhcp_agents(network)
+
+            return (column_headers,
+                    (utils.get_item_properties(
+                        s, columns,
+                        formatters=_formatters,
+                    ) for s in data))
+        else:
+            if parsed_args.agent_type is not None:
+                filters['agent_type'] = key_value[parsed_args.agent_type]
+            if parsed_args.host is not None:
+                filters['host'] = parsed_args.host
+
+            data = client.agents(**filters)
+            return (column_headers,
+                    (utils.get_item_properties(
+                        s, columns, formatters=_formatters,
+                    ) for s in data))
+
+
+class RemoveNetworkFromAgent(command.Command):
+    _description = _("Remove network from an agent.")
+
+    def get_parser(self, prog_name):
+        parser = super(RemoveNetworkFromAgent, self).get_parser(prog_name)
+        parser.add_argument(
+            '--dhcp',
+            action='store_true',
+            help=_('Remove network from DHCP agent'))
+        parser.add_argument(
+            'agent_id',
+            metavar='<agent-id>',
+            help=_('Agent to which a network is removed. (ID only)'))
+        parser.add_argument(
+            'network',
+            metavar='<network>',
+            help=_('Network to be removed from an agent. (ID or name)'))
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        agent = client.get_agent(parsed_args.agent_id)
+        if parsed_args.dhcp:
+            network = client.find_network(
+                parsed_args.network, ignore_missing=False)
+            try:
+                client.remove_dhcp_agent_from_network(agent, network)
+            except Exception:
+                msg = 'Failed to remove {} to {}'.format(
+                    network.name, agent.agent_type)
+                exceptions.CommandError(msg)
 
 
 # TODO(huanxuan): Use the SDK resource mapped attribute names once the

openstackclient/tests/functional/network/v2/test_network.py

@@ -238,6 +238,49 @@ def test_network_list(self):
         self.assertIn(name1, col_name)
         self.assertNotIn(name2, col_name)
 
+    def test_network_dhcp_agent(self):
+        name1 = uuid.uuid4().hex
+        cmd_output1 = json.loads(self.openstack(
+            'network create -f json ' +
+            '--description aaaa ' +
+            name1
+        ))
+
+        self.addCleanup(self.openstack, 'network delete ' + name1)
+
+        # Get network ID
+        network_id = cmd_output1['id']
+
+        # Get DHCP Agent ID
+        cmd_output2 = json.loads(self.openstack(
+            'network agent list -f json --agent-type dhcp'
+        ))
+        agent_id = cmd_output2[0]['ID']
+
+        # Add Agent to Network
+        self.openstack(
+            'network agent add network --dhcp '
+            + agent_id + ' ' + network_id
+        )
+
+        # Test network list --agent
+        cmd_output3 = json.loads(self.openstack(
+            'network list -f json --agent ' + agent_id
+        ))
+
+        # Cleanup
+        # Remove Agent from Network
+        self.openstack(
+            'network agent remove network --dhcp '
+            + agent_id + ' ' + network_id
+        )
+
+        # Assert
+        col_name = [x["ID"] for x in cmd_output3]
+        self.assertIn(
+            network_id, col_name
+        )
+
     def test_network_set(self):
         """Tests create options, set, show, delete"""
         name = uuid.uuid4().hex