Merge "Moved hypervisor to the SDK"

Author: Zuul

openstackclient/compute/v2/hypervisor.py

@@ -18,8 +18,8 @@
 import json
 import re
 
-from novaclient import api_versions
 from novaclient import exceptions as nova_exceptions
+from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -28,11 +28,44 @@
 from openstackclient.i18n import _
 
 
+def _get_hypervisor_columns(item, client):
+    column_map = {'name': 'hypervisor_hostname'}
+    hidden_columns = ['location', 'servers']
+
+    if sdk_utils.supports_microversion(client, '2.88'):
+        hidden_columns.extend([
+            'current_workload',
+            'disk_available',
+            'local_disk_free',
+            'local_disk_size',
+            'local_disk_used',
+            'memory_free',
+            'memory_size',
+            'memory_used',
+            'running_vms',
+            'vcpus_used',
+            'vcpus',
+        ])
+    else:
+        column_map.update({
+            'disk_available': 'disk_available_least',
+            'local_disk_free': 'free_disk_gb',
+            'local_disk_size': 'local_gb',
+            'local_disk_used': 'local_gb_used',
+            'memory_free': 'free_ram_mb',
+            'memory_used': 'memory_mb_used',
+            'memory_size': 'memory_mb',
+        })
+
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item, column_map, hidden_columns)
+
+
 class ListHypervisor(command.Lister):
     _description = _("List hypervisors")
 
     def get_parser(self, prog_name):
-        parser = super(ListHypervisor, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--matching',
             metavar='<hostname>',
@@ -67,7 +100,7 @@ def get_parser(self, prog_name):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
 
         list_opts = {}
 
@@ -78,7 +111,7 @@ def take_action(self, parsed_args):
             raise exceptions.CommandError(msg)
 
         if parsed_args.marker:
-            if compute_client.api_version < api_versions.APIVersion('2.33'):
+            if not sdk_utils.supports_microversion(compute_client, '2.33'):
                 msg = _(
                     '--os-compute-api-version 2.33 or greater is required to '
                     'support the --marker option'
@@ -87,31 +120,51 @@ def take_action(self, parsed_args):
             list_opts['marker'] = parsed_args.marker
 
         if parsed_args.limit:
-            if compute_client.api_version < api_versions.APIVersion('2.33'):
+            if not sdk_utils.supports_microversion(compute_client, '2.33'):
                 msg = _(
                     '--os-compute-api-version 2.33 or greater is required to '
                     'support the --limit option'
                 )
                 raise exceptions.CommandError(msg)
             list_opts['limit'] = parsed_args.limit
 
-        columns = (
+        column_headers = (
             "ID",
             "Hypervisor Hostname",
             "Hypervisor Type",
             "Host IP",
             "State"
         )
+        columns = (
+            'id',
+            'name',
+            'hypervisor_type',
+            'host_ip',
+            'state'
+        )
         if parsed_args.long:
-            columns += ("vCPUs Used", "vCPUs", "Memory MB Used", "Memory MB")
+            if not sdk_utils.supports_microversion(compute_client, '2.88'):
+                column_headers += (
+                    'vCPUs Used',
+                    'vCPUs',
+                    'Memory MB Used',
+                    'Memory MB'
+                )
+                columns += (
+                    'vcpus_used',
+                    'vcpus',
+                    'memory_used',
+                    'memory_size'
+                )
 
         if parsed_args.matching:
-            data = compute_client.hypervisors.search(parsed_args.matching)
+            data = compute_client.find_hypervisor(
+                parsed_args.matching, ignore_missing=False)
         else:
-            data = compute_client.hypervisors.list(**list_opts)
+            data = compute_client.hypervisors(**list_opts, details=True)
 
         return (
-            columns,
+            column_headers,
             (utils.get_item_properties(s, columns) for s in data),
         )
 
@@ -120,7 +173,7 @@ class ShowHypervisor(command.ShowOne):
     _description = _("Display hypervisor details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowHypervisor, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "hypervisor",
             metavar="<hypervisor>",
@@ -129,20 +182,25 @@ def get_parser(self, prog_name):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
-        hypervisor = utils.find_resource(compute_client.hypervisors,
-                                         parsed_args.hypervisor)._info.copy()
+        compute_client = self.app.client_manager.sdk_connection.compute
+        hypervisor = compute_client.find_hypervisor(
+            parsed_args.hypervisor, ignore_missing=False).copy()
+
+        # Some of the properties in the hypervisor object need to be processed
+        # before they get reported to the user. We spend this section
+        # extracting the relevant details to be reported by modifying our
+        # copy of the hypervisor object.
+        aggregates = compute_client.aggregates()
+        hypervisor['aggregates'] = list()
+        service_details = hypervisor['service_details']
 
-        aggregates = compute_client.aggregates.list()
-        hypervisor["aggregates"] = list()
         if aggregates:
             # Hypervisors in nova cells are prefixed by "<cell>@"
-            if "@" in hypervisor['service']['host']:
-                cell, service_host = hypervisor['service']['host'].split(
-                    '@', 1)
+            if "@" in service_details['host']:
+                cell, service_host = service_details['host'].split('@', 1)
             else:
                 cell = None
-                service_host = hypervisor['service']['host']
+                service_host = service_details['host']
 
             if cell:
                 # The host aggregates are also prefixed by "<cell>@"
@@ -154,42 +212,45 @@ def take_action(self, parsed_args):
                 member_of = [aggregate.name
                              for aggregate in aggregates
                              if service_host in aggregate.hosts]
-            hypervisor["aggregates"] = member_of
+            hypervisor['aggregates'] = member_of
 
         try:
-            uptime = compute_client.hypervisors.uptime(hypervisor['id'])._info
+            if sdk_utils.supports_microversion(compute_client, '2.88'):
+                uptime = hypervisor['uptime'] or ''
+                del hypervisor['uptime']
+            else:
+                del hypervisor['uptime']
+                uptime = compute_client.get_hypervisor_uptime(
+                    hypervisor['id'])['uptime']
             # Extract data from uptime value
             # format: 0 up 0,  0 users,  load average: 0, 0, 0
             # example: 17:37:14 up  2:33,  3 users,
             #          load average: 0.33, 0.36, 0.34
             m = re.match(
                 r"\s*(.+)\sup\s+(.+),\s+(.+)\susers?,\s+load average:\s(.+)",
-                uptime['uptime'])
+                uptime)
             if m:
-                hypervisor["host_time"] = m.group(1)
-                hypervisor["uptime"] = m.group(2)
-                hypervisor["users"] = m.group(3)
-                hypervisor["load_average"] = m.group(4)
+                hypervisor['host_time'] = m.group(1)
+                hypervisor['uptime'] = m.group(2)
+                hypervisor['users'] = m.group(3)
+                hypervisor['load_average'] = m.group(4)
         except nova_exceptions.HTTPNotImplemented:
             pass
 
-        hypervisor["service_id"] = hypervisor["service"]["id"]
-        hypervisor["service_host"] = hypervisor["service"]["host"]
-        del hypervisor["service"]
+        hypervisor['service_id'] = service_details['id']
+        hypervisor['service_host'] = service_details['host']
+        del hypervisor['service_details']
 
-        if compute_client.api_version < api_versions.APIVersion('2.28'):
+        if not sdk_utils.supports_microversion(compute_client, '2.28'):
             # microversion 2.28 transformed this to a JSON blob rather than a
             # string; on earlier fields, do this manually
-            if hypervisor['cpu_info']:
-                hypervisor['cpu_info'] = json.loads(hypervisor['cpu_info'])
-            else:
-                hypervisor['cpu_info'] = {}
-
-        columns = tuple(sorted(hypervisor))
+            hypervisor['cpu_info'] = json.loads(hypervisor['cpu_info'] or '{}')
+        display_columns, columns = _get_hypervisor_columns(
+            hypervisor, compute_client)
         data = utils.get_dict_properties(
             hypervisor, columns,
             formatters={
                 'cpu_info': format_columns.DictColumn,
             })
 
-        return (columns, data)
+        return display_columns, data

openstackclient/tests/unit/compute/v2/fakes.py

@@ -20,6 +20,7 @@
 
 from novaclient import api_versions
 from openstack.compute.v2 import flavor as _flavor
+from openstack.compute.v2 import hypervisor as _hypervisor
 from openstack.compute.v2 import server
 from openstack.compute.v2 import server_group as _server_group
 from openstack.compute.v2 import server_interface as _server_interface
@@ -340,75 +341,6 @@ def create_one_extension(attrs=None):
         return extension
 
 
-class FakeHypervisor(object):
-    """Fake one or more hypervisor."""
-
-    @staticmethod
-    def create_one_hypervisor(attrs=None):
-        """Create a fake hypervisor.
-
-        :param dict attrs:
-            A dictionary with all attributes
-        :return:
-            A FakeResource object, with id, hypervisor_hostname, and so on
-        """
-        attrs = attrs or {}
-
-        # Set default attributes.
-        hypervisor_info = {
-            'id': 'hypervisor-id-' + uuid.uuid4().hex,
-            'hypervisor_hostname': 'hypervisor-hostname-' + uuid.uuid4().hex,
-            'status': 'enabled',
-            'host_ip': '192.168.0.10',
-            'cpu_info': {
-                'aaa': 'aaa',
-            },
-            'free_disk_gb': 50,
-            'hypervisor_version': 2004001,
-            'disk_available_least': 50,
-            'local_gb': 50,
-            'free_ram_mb': 1024,
-            'service': {
-                'host': 'aaa',
-                'disabled_reason': None,
-                'id': 1,
-            },
-            'vcpus_used': 0,
-            'hypervisor_type': 'QEMU',
-            'local_gb_used': 0,
-            'vcpus': 4,
-            'memory_mb_used': 512,
-            'memory_mb': 1024,
-            'current_workload': 0,
-            'state': 'up',
-            'running_vms': 0,
-        }
-
-        # Overwrite default attributes.
-        hypervisor_info.update(attrs)
-
-        hypervisor = fakes.FakeResource(info=copy.deepcopy(hypervisor_info),
-                                        loaded=True)
-        return hypervisor
-
-    @staticmethod
-    def create_hypervisors(attrs=None, count=2):
-        """Create multiple fake hypervisors.
-
-        :param dict attrs:
-            A dictionary with all attributes
-        :param int count:
-            The number of hypervisors to fake
-        :return:
-            A list of FakeResource objects faking the hypervisors
-        """
-        hypervisors = []
-        for i in range(0, count):
-            hypervisors.append(FakeHypervisor.create_one_hypervisor(attrs))
-
-        return hypervisors
-
-
 class FakeHypervisorStats(object):
     """Fake one or more hypervisor stats."""
 
@@ -1795,6 +1727,70 @@ def create_sdk_volume_attachments(attrs=None, methods=None, count=2):
         return volume_attachments
 
 
+def create_one_hypervisor(attrs=None):
+    """Create a fake hypervisor.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :return:
+        A FakeResource object, with id, hypervisor_hostname, and so on
+    """
+    attrs = attrs or {}
+
+    # Set default attributes.
+    hypervisor_info = {
+        'id': 'hypervisor-id-' + uuid.uuid4().hex,
+        'hypervisor_hostname': 'hypervisor-hostname-' + uuid.uuid4().hex,
+        'status': 'enabled',
+        'host_ip': '192.168.0.10',
+        'cpu_info': {
+            'aaa': 'aaa',
+        },
+        'free_disk_gb': 50,
+        'hypervisor_version': 2004001,
+        'disk_available_least': 50,
+        'local_gb': 50,
+        'free_ram_mb': 1024,
+        'service': {
+            'host': 'aaa',
+            'disabled_reason': None,
+            'id': 1,
+        },
+        'vcpus_used': 0,
+        'hypervisor_type': 'QEMU',
+        'local_gb_used': 0,
+        'vcpus': 4,
+        'memory_mb_used': 512,
+        'memory_mb': 1024,
+        'current_workload': 0,
+        'state': 'up',
+        'running_vms': 0,
+    }
+
+    # Overwrite default attributes.
+    hypervisor_info.update(attrs)
+
+    hypervisor = _hypervisor.Hypervisor(**hypervisor_info, loaded=True)
+    return hypervisor
+
+
+def create_hypervisors(attrs=None, count=2):
+    """Create multiple fake hypervisors.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :param int count:
+        The number of hypervisors to fake
+    :return:
+        A list of FakeResource objects faking the hypervisors
+    """
+    hypervisors = []
+    for i in range(0, count):
+        hypervisors.append(create_one_hypervisor(attrs))
+
+    return hypervisors
+
+
 def create_one_server_group(attrs=None):
     """Create a fake server group