tempest/tempest/lib/api_schema/response/compute/v2_1/hypervisors.py

# Copyright 2014 NEC Corporation.  All rights reserved.
#
#    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.

import copy

from tempest.lib.api_schema.response.compute.v2_1 import parameter_types

get_hypervisor_statistics = {
    'status_code': [200],
    'response_body': {
        'type': 'object',
        'properties': {
            'hypervisor_statistics': {
                'type': 'object',
                'properties': {
                    'count': {'type': 'integer'},
                    'current_workload': {'type': 'integer'},
                    'disk_available_least': {'type': ['integer', 'null']},
                    'free_disk_gb': {'type': 'integer'},
                    'free_ram_mb': {'type': 'integer'},
                    'local_gb': {'type': 'integer'},
                    'local_gb_used': {'type': 'integer'},
                    'memory_mb': {'type': 'integer'},
                    'memory_mb_used': {'type': 'integer'},
                    'running_vms': {'type': 'integer'},
                    'vcpus': {'type': 'integer'},
                    'vcpus_used': {'type': 'integer'}
                },
                'additionalProperties': False,
                'required': ['count', 'current_workload',
                             'disk_available_least', 'free_disk_gb',
                             'free_ram_mb', 'local_gb', 'local_gb_used',
                             'memory_mb', 'memory_mb_used', 'running_vms',
                             'vcpus', 'vcpus_used']
            }
        },
        'additionalProperties': False,
        'required': ['hypervisor_statistics']
    }
}


hypervisor_detail = {
    'type': 'object',
    'properties': {
        'status': {'type': 'string'},
        'state': {'type': 'string'},
        'cpu_info': {'type': 'string'},
        'current_workload': {'type': 'integer'},
        'disk_available_least': {'type': ['integer', 'null']},
        'host_ip': parameter_types.ip_address,
        'free_disk_gb': {'type': 'integer'},
        'free_ram_mb': {'type': 'integer'},
        'hypervisor_hostname': {'type': 'string'},
        'hypervisor_type': {'type': 'string'},
        'hypervisor_version': {'type': 'integer'},
        'id': {'type': ['integer', 'string']},
        'local_gb': {'type': 'integer'},
        'local_gb_used': {'type': 'integer'},
        'memory_mb': {'type': 'integer'},
        'memory_mb_used': {'type': 'integer'},
        'running_vms': {'type': 'integer'},
        'service': {
            'type': 'object',
            'properties': {
                'host': {'type': 'string'},
                'id': {'type': ['integer', 'string']},
                'disabled_reason': {'type': ['string', 'null']}
            },
            'additionalProperties': False,
            'required': ['host', 'id']
        },
        'vcpus': {'type': 'integer'},
        'vcpus_used': {'type': 'integer'}
    },
    'additionalProperties': False,
    # NOTE: When loading os-hypervisor-status extension,
    # a response contains status and state. So these params
    # should not be required.
    'required': ['cpu_info', 'current_workload',
                 'disk_available_least', 'host_ip',
                 'free_disk_gb', 'free_ram_mb',
                 'hypervisor_hostname', 'hypervisor_type',
                 'hypervisor_version', 'id', 'local_gb',
                 'local_gb_used', 'memory_mb', 'memory_mb_used',
                 'running_vms', 'service', 'vcpus', 'vcpus_used']
}

list_hypervisors_detail = {
    'status_code': [200],
    'response_body': {
        'type': 'object',
        'properties': {
            'hypervisors': {
                'type': 'array',
                'items': hypervisor_detail
            }
        },
        'additionalProperties': False,
        'required': ['hypervisors']
    }
}

get_hypervisor = {
    'status_code': [200],
    'response_body': {
        'type': 'object',
        'properties': {
            'hypervisor': hypervisor_detail
        },
        'additionalProperties': False,
        'required': ['hypervisor']
    }
}

list_search_hypervisors = {
    'status_code': [200],
    'response_body': {
        'type': 'object',
        'properties': {
            'hypervisors': {
                'type': 'array',
                'items': {
                    'type': 'object',
                    'properties': {
                        'status': {'type': 'string'},
                        'state': {'type': 'string'},
                        'id': {'type': ['integer', 'string']},
                        'hypervisor_hostname': {'type': 'string'}
                    },
                    'additionalProperties': False,
                    # NOTE: When loading os-hypervisor-status extension,
                    # a response contains status and state. So these params
                    # should not be required.
                    'required': ['id', 'hypervisor_hostname']
                }
            }
        },
        'additionalProperties': False,
        'required': ['hypervisors']
    }
}

get_hypervisor_uptime = {
    'status_code': [200],
    'response_body': {
        'type': 'object',
        'properties': {
            'hypervisor': {
                'type': 'object',
                'properties': {
                    'status': {'type': 'string'},
                    'state': {'type': 'string'},
                    'id': {'type': ['integer', 'string']},
                    'hypervisor_hostname': {'type': 'string'},
                    'uptime': {'type': 'string'}
                },
                'additionalProperties': False,
                # NOTE: When loading os-hypervisor-status extension,
                # a response contains status and state. So these params
                # should not be required.
                'required': ['id', 'hypervisor_hostname', 'uptime']
            }
        },
        'additionalProperties': False,
        'required': ['hypervisor']
    }
}

get_hypervisors_servers = copy.deepcopy(list_search_hypervisors)
get_hypervisors_servers['response_body']['properties']['hypervisors']['items'][
    'properties']['servers'] = {
        'type': 'array',
        'items': {
            'type': 'object',
            'properties': {
                'uuid': {'type': 'string'},
                'name': {'type': 'string'}
            },
            'additionalProperties': False,
        }
    }
# In V2 API, if there is no servers (VM) on the Hypervisor host then 'servers'
# attribute will not be present in response body So it is not 'required'.