Source code for cfme.test_framework.appliance

import attr
import pytest
import six.moves.urllib.parse
import warnings

from cfme.fixtures import terminalreporter
from cfme.utils import conf
from cfme.utils.appliance import (
    load_appliances_from_config, stack,
    DummyAppliance,
    ApplianceSummoningWarning)
from cfme.utils.path import log_path

PLUGIN_KEY = "appliance-holder"
warnings.simplefilter('error', ApplianceSummoningWarning)


def pytest_addoption(parser):
    parser.addoption('--dummy-appliance', action='store_true')
    parser.addoption('--dummy-appliance-version', default=None)


def appliances_from_cli(cli_appliances):
    appliance_config = dict(appliances=[])
    for appliance_data in cli_appliances:
        parsed_url = six.moves.urllib.parse.urlparse(appliance_data['hostname'])
        if not parsed_url.hostname:
            raise ValueError(
                "Invalid appliance url: {}".format(appliance_data)
            )

        appliance = appliance_data.copy()
        appliance.update(dict(
            hostname=parsed_url.hostname,
            ui_protocol=parsed_url.scheme if parsed_url.scheme else "https",
            ui_port=parsed_url.port if parsed_url.port else 443,
        ))

        appliance_config['appliances'].append(appliance)

    return load_appliances_from_config(appliance_config)


@pytest.hookimpl(tryfirst=True)
def pytest_configure(config):

    reporter = terminalreporter.reporter()
    if config.getoption('--dummy-appliance'):
        appliances = [DummyAppliance.from_config(config)]
        reporter.write_line('Retrieved Dummy Appliance', red=True)
    elif stack.top:
        appliances = [stack.top]
    elif config.option.appliances:
        appliances = appliances_from_cli(config.option.appliances)
        reporter.write_line('Retrieved these appliances from the --appliance parameters', red=True)
    elif config.getoption('--use-sprout'):
        from .sprout.plugin import mangle_in_sprout_appliances

        mangle_in_sprout_appliances(config)
        appliances = appliances_from_cli(config.option.appliances)
        reporter.write_line('Retrieved these appliances from the --sprout-* parameters', red=True)
    else:
        appliances = load_appliances_from_config(conf.env)
        reporter.write_line('Retrieved these appliances from the conf.env', red=True)

    if not stack.top:
        for appliance in appliances:
            reporter.write_line('* {!r}'.format(appliance), cyan=True)
    appliance = appliances[0]
    if not appliance.is_dev:
        appliance.set_session_timeout(86400)
    stack.push(appliance)
    plugin = ApplianceHolderPlugin(appliance, appliances)
    config.pluginmanager.register(plugin, PLUGIN_KEY)


@pytest.hookimpl(trylast=True)
def pytest_unconfigure():
    stack.pop()


@attr.s(cmp=False)
class ApplianceHolderPlugin(object):
    held_appliance = attr.ib()
    appliances = attr.ib(default=attr.Factory(list))

    @pytest.fixture(scope="session")
    def appliance(self):
        return self.held_appliance

    def pytest_sessionstart(self):
        if isinstance(self.held_appliance, DummyAppliance) or self.held_appliance.is_dev:
            return
        if pytest.store.parallelizer_role != 'slave':
            with log_path.join('appliance_version').open('w') as appliance_version:
                appliance_version.write(self.held_appliance.version.vstring)