zaza-openstack-tests/zaza/openstack/configure/guest.py

#!/usr/bin/env python3

# Copyright 2018 Canonical Ltd.
#
# 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.

"""Encapsulate nova testing."""

import subprocess
import logging
import time

import zaza.openstack.utilities.openstack as openstack_utils
import zaza.openstack.charm_tests.nova.utils as nova_utils
import zaza.openstack.utilities.exceptions as openstack_exceptions

from tenacity import (
    RetryError,
    Retrying,
    stop_after_attempt,
    wait_exponential,
)

boot_tests = {
    'cirros': {
        'image_name': 'cirros',
        'flavor_name': 'm1.tiny',
        'username': 'cirros',
        'bootstring': 'gocubsgo',
        'password': 'gocubsgo'},
    'bionic': {
        'image_name': 'bionic',
        'flavor_name': 'm1.small',
        'username': 'ubuntu',
        'bootstring': 'finished at'},
    'focal': {
        'image_name': 'focal',
        'flavor_name': 'm1.small',
        'username': 'ubuntu',
        'bootstring': 'finished at'},
    'jammy': {
        'image_name': 'jammy',
        'flavor_name': 'm1.small',
        'username': 'ubuntu',
        'bootstring': 'finished at'}
}


def launch_instance_retryer(instance_key, **kwargs):
    """Launch an instance and retry on failure.

    See launch_instance for kwargs

    :param instance_key: Key to collect associated config data with.
    :type instance_key: str
    """
    vm_name = kwargs.get('vm_name', time.strftime("%Y%m%d%H%M%S"))
    kwargs['vm_name'] = vm_name

    def remove_vm_on_failure(retry_state):
        logging.info(
            'Detected failure launching or connecting to VM {}'.format(
                vm_name))
        keystone_session = openstack_utils.get_overcloud_keystone_session()
        nova_client = openstack_utils.get_nova_session_client(keystone_session)
        vm = nova_client.servers.find(name=vm_name)
        openstack_utils.delete_resource(
            nova_client.servers,
            vm.id,
            msg="Waiting for the Nova VM {} to be deleted".format(vm.name))

    retryer = Retrying(
        stop=stop_after_attempt(3),
        after=remove_vm_on_failure,
    )
    instance = retryer(
        launch_instance,
        instance_key,
        **kwargs
    )
    return instance


def launch_instance(instance_key, use_boot_volume=False, vm_name=None,
                    private_network_name=None, image_name=None,
                    flavor_name=None, external_network_name=None, meta=None,
                    userdata=None, attach_to_external_network=False,
                    keystone_session=None):
    """Launch an instance.

    :param instance_key: Key to collect associated config data with.
    :type instance_key: str
    :param use_boot_volume: Whether to boot guest from a shared volume.
    :type use_boot_volume: boolean
    :param vm_name: Name to give guest.
    :type vm_name: str
    :param private_network_name: Name of private network to attach guest to.
    :type private_network_name: str
    :param image_name: Image name to use with guest.
    :type image_name: str
    :param flavor_name: Flavor name to use with guest.
    :type flavor_name: str
    :param external_network_name: External network to create floating ip from
                                  for guest.
    :type external_network_name: str
    :param meta: A dict of arbitrary key/value metadata to store for this
                 server. Both keys and values must be <=255 characters.
    :type meta: dict
    :param userdata: Configuration to use upon launch, used by cloud-init.
    :type userdata: str
    :param attach_to_external_network: Attach instance directly to external
                                       network.
    :type attach_to_external_network: bool
    :param keystone_session: Keystone session to use.
    :type keystone_session: Optional[keystoneauth1.session.Session]
    :returns: the created instance
    :rtype: novaclient.Server
    """
    if not keystone_session:
        keystone_session = openstack_utils.get_overcloud_keystone_session()

    nova_client = openstack_utils.get_nova_session_client(keystone_session)
    neutron_client = openstack_utils.get_neutron_session_client(
        keystone_session)

    # Collect resource information.
    vm_name = vm_name or time.strftime("%Y%m%d%H%M%S")

    image_name = image_name or boot_tests[instance_key]['image_name']
    image = nova_client.glance.find_image(image_name)

    flavor_name = flavor_name or boot_tests[instance_key]['flavor_name']
    flavor = nova_client.flavors.find(name=flavor_name)

    private_network_name = private_network_name or "private"

    meta = meta or {}
    external_network_name = external_network_name or "ext_net"

    if attach_to_external_network:
        instance_network_name = external_network_name
    else:
        instance_network_name = private_network_name

    net = neutron_client.find_resource("network", instance_network_name)
    nics = [{'net-id': net.get('id')}]

    if use_boot_volume:
        bdmv2 = [{
            'boot_index': '0',
            'uuid': image.id,
            'source_type': 'image',
            'volume_size': flavor.disk,
            'destination_type': 'volume',
            'delete_on_termination': True}]
        image = None
    else:
        bdmv2 = None

    # Launch instance.
    logging.info('Launching instance {}'.format(vm_name))
    instance = nova_client.servers.create(
        name=vm_name,
        image=image,
        block_device_mapping_v2=bdmv2,
        flavor=flavor,
        key_name=nova_utils.KEYPAIR_NAME,
        meta=meta,
        nics=nics,
        userdata=userdata)

    # Test Instance is ready.
    logging.info('Checking instance is active')
    openstack_utils.resource_reaches_status(
        nova_client.servers,
        instance.id,
        expected_status='ACTIVE',
        # NOTE(lourot): in some models this may sometimes take more than 15
        # minutes. See lp:1945991
        wait_iteration_max_time=120,
        stop_after_attempt=16)

    logging.info('Checking cloud init is complete')
    openstack_utils.cloud_init_complete(
        nova_client,
        instance.id,
        boot_tests[instance_key]['bootstring'])
    port = openstack_utils.get_ports_from_device_id(
        neutron_client,
        instance.id)[0]
    if attach_to_external_network:
        logging.info('attach_to_external_network={}, not assigning floating IP'
                     .format(attach_to_external_network))
        ip = port['fixed_ips'][0]['ip_address']
        logging.info('Using fixed IP {} on network {} for {}'
                     .format(ip, instance_network_name, vm_name))
    else:
        logging.info('Assigning floating ip.')
        ip = openstack_utils.create_floating_ip(
            neutron_client,
            external_network_name,
            port=port)['floating_ip_address']
        logging.info('Assigned floating IP {} to {}'.format(ip, vm_name))
    try:
        for attempt in Retrying(
                stop=stop_after_attempt(8),
                wait=wait_exponential(multiplier=1, min=2, max=60)):
            with attempt:
                try:
                    openstack_utils.ping_response(ip)
                except subprocess.CalledProcessError as e:
                    logging.error('Pinging {} failed with {}'
                                  .format(ip, e.returncode))
                    logging.error('stdout: {}'.format(e.stdout))
                    logging.error('stderr: {}'.format(e.stderr))
                    raise
    except RetryError:
        raise openstack_exceptions.NovaGuestNoPingResponse()

    # Check ssh'ing to instance.
    logging.info('Testing ssh access.')
    openstack_utils.ssh_test(
        username=boot_tests[instance_key]['username'],
        ip=ip,
        vm_name=vm_name,
        password=boot_tests[instance_key].get('password'),
        privkey=openstack_utils.get_private_key(nova_utils.KEYPAIR_NAME))
    return instance