Add network availability for osc

This patch implements openstack client for network ip availability.

Implements: blueprint neutron-ip-capacity

Depends-On: I3b40d8edea87c068c4e8133e436511765064d5f8
Change-Id: Iffaa2e20ff495fbd205d3397e027e8141d04385e

1 files changed, 109 insertions, 0 deletions

diff --git a/openstackclient/network/v2/ip_availability.py b/openstackclient/network/v2/ip_availability.py
new file mode 100644
index 00000000..cc240338
--- /dev/null
+++ b/openstackclient/network/v2/ip_availability.py
@@ -0,0 +1,109 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+#
+
+"""IP Availability Info implementations"""
+
+from openstackclient.common import command
+from openstackclient.common import utils
+from openstackclient.i18n import _
+from openstackclient.identity import common as identity_common
+
+
+_formatters = {
+    'subnet_ip_availability': utils.format_list_of_dicts,
+}
+
+
+def _get_columns(item):
+    columns = list(item.keys())
+    if 'tenant_id' in columns:
+        columns.remove('tenant_id')
+        columns.append('project_id')
+    return tuple(sorted(columns))
+
+
+class ListIPAvailability(command.Lister):
+    """List IP availability for network"""
+
+    def get_parser(self, prog_name):
+        parser = super(ListIPAvailability, self).get_parser(prog_name)
+        parser.add_argument(
+            '--ip-version',
+            type=int,
+            choices=[4, 6],
+            metavar='<ip-version>',
+            dest='ip_version',
+            help=_("List IP availability of given IP version networks"),
+        )
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=_("List IP availability of given project"),
+        )
+        identity_common.add_project_domain_option_to_parser(parser)
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+
+        columns = (
+            'network_id',
+            'network_name',
+            'total_ips',
+            'used_ips',
+        )
+        column_headers = (
+            'Network ID',
+            'Network Name',
+            'Total IPs',
+            'Used IPs',
+        )
+
+        filters = {}
+        if parsed_args.ip_version:
+            filters['ip_version'] = parsed_args.ip_version
+
+        if parsed_args.project:
+            identity_client = self.app.client_manager.identity
+            project_id = identity_common.find_project(
+                identity_client,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+            filters['tenant_id'] = project_id
+        data = client.network_ip_availabilities(**filters)
+        return (column_headers,
+                (utils.get_item_properties(
+                    s, columns,
+                ) for s in data))
+
+
+class ShowIPAvailability(command.ShowOne):
+    """Show network IP availability details"""
+
+    def get_parser(self, prog_name):
+        parser = super(ShowIPAvailability, self).get_parser(prog_name)
+        parser.add_argument(
+            'network',
+            metavar="<network>",
+            help=_("Show IP availability for a specific network (name or ID)"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        obj = client.find_network_ip_availability(parsed_args.network,
+                                                  ignore_missing=False)
+        columns = _get_columns(obj)
+        data = utils.get_item_properties(obj, columns, formatters=_formatters)
+        return columns, data