Source code for stepler.nova.tests.test_metadata

"""
---------------------
Server metadata tests
---------------------
"""

# 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 pytest

from stepler import config
from stepler.third_party import utils

METADATA_KEY = 'key'
METADATA_VALUE = next(utils.generate_ids('test_meta'))
TEST_METADATA_INFO = {METADATA_KEY: METADATA_VALUE}

SET_META_CMD_TEMPLATE = (
    '/bin/bash -c '
    '"{openrc_cmd}; nova host-meta {host} set {key}={value}"'.format(
        openrc_cmd=config.OPENRC_ACTIVATE_CMD,
        host='{host}',
        key=METADATA_KEY,
        value=METADATA_VALUE))
DEL_META_CMD_TEMPLATE = (
    '/bin/bash -c '
    '"{openrc_cmd}; nova host-meta {host} delete {key}"'.format(
        openrc_cmd=config.OPENRC_ACTIVATE_CMD,
        host='{host}',
        key=METADATA_KEY))


@pytest.mark.idempotent_id('fb831027-2663-4b76-b81f-868a85ca08fe')
def test_metadata_reach_all_booted_vm(
        security_group,
        floating_ip,
        ubuntu_image,
        keypair,
        flavor,
        net_subnet_router,
        create_server_context,
        server_steps):
    """**Scenario:** Verify that image can be connected with SSH.

    **Setup:**

    #. Create security group
    #. Create floating IP
    #. Get Glance ubuntu image OR download and create it if ubuntu image is
        not present.
    #. Create keypair
    #. Create flavor

    **Steps:**

    #. Get flavor ``m1.small``
    #. Get admin internal network
    #. Create nova server
    #. Attach floating IP to nova server
    #. Check that server is available via SSH
    #. Detach floating IP
    #. Delete nova server

    **Teardown:**

    #. Delete flavor
    #. Delete keypair
    #. Release floating IP
    #. Delete security group
    """
    network, _, _ = net_subnet_router

    with create_server_context(next(utils.generate_ids('server')),
                               image=ubuntu_image,
                               flavor=flavor,
                               networks=[network],
                               keypair=keypair,
                               security_groups=[security_group],
                               username='ubuntu') as server:

        server_steps.attach_floating_ip(server, floating_ip)
        server_steps.get_server_ssh(server)
        server_steps.detach_floating_ip(server, floating_ip)


@pytest.mark.requires("computes_count >= 2")
@pytest.mark.idempotent_id('2af40022-a2ca-4615-aff3-2c07354ce983')
def test_put_metadata_on_instances_on_single_compute(
        security_group,
        flavor,
        cirros_image,
        network,
        subnet,
        nova_availability_zone_hosts,
        flavor_steps,
        server_steps,
        os_faults_steps,
        execute_command_with_rollback):
    """**Scenario:** Put metadata on all instances scheduled on a single
    compute node.

    **Setup:**

    #. Create security group
    #. Create flavor
    #. Upload cirros image
    #. Create network and subnetwork

    **Steps:**

    #. Get FQDNs of nova hosts
    #. Create 2 nova servers on host 1
    #. Create 2 nova servers on host 2
    #. From controller node add new 'key=value' to metadata of servers,
        located on host 1.
    #. Check that servers from host 1 have 'key=value' in their metadata
    #. Check that servers from host 2 do NOT have 'key=value' in their metadata
    #. From controller node delete 'key=value' from metadata of servers,
        located on host 1.
    #. Check that servers from host 1 and host 2 do NOT have 'key=value' in
        their metadata

    **Teardown:**

    #. Delete servers
    #. Delete security group
    #. Delete network and subnetwork
    """
    host_1 = nova_availability_zone_hosts[0]
    host_2 = nova_availability_zone_hosts[1]

    controller_node = os_faults_steps.get_node(service_names=[config.NOVA_API])

    cmd_set_meta = SET_META_CMD_TEMPLATE.format(host=host_1)
    cmd_del_meta = DEL_META_CMD_TEMPLATE.format(host=host_1)

    host1_servers = server_steps.create_servers(
        count=2,
        image=cirros_image,
        flavor=flavor,
        networks=[network],
        security_groups=[security_group],
        availability_zone='nova:{}'.format(host_1))

    host2_servers = server_steps.create_servers(
        count=2,
        image=cirros_image,
        flavor=flavor,
        networks=[network],
        security_groups=[security_group],
        availability_zone='nova:{}'.format(host_2))

    with execute_command_with_rollback(
            nodes=controller_node,
            cmd=cmd_set_meta,
            rollback_cmd=cmd_del_meta):

        for server in host1_servers:
            server_steps.check_metadata_presence(
                server, TEST_METADATA_INFO,
                timeout=config.SERVER_UPDATE_TIMEOUT)

        for server in host2_servers:
            server_steps.check_metadata_presence(
                server, TEST_METADATA_INFO, present=False,
                timeout=config.SERVER_UPDATE_TIMEOUT)

    for server in host1_servers + host2_servers:
        server_steps.check_metadata_presence(
            server, TEST_METADATA_INFO, present=False,
            timeout=config.SERVER_UPDATE_TIMEOUT)