locp/testinfra-bdd

"""
Then address fixtures for testinfra-bdd.

Please avoid already-imported warning: PYTEST_DONT_REWRITE.
"""
from pytest_bdd import parsers, then, when

from testinfra_bdd.parsers import parse_addr_and_port


@when(parsers.parse('the TestInfra address is {address}'))
def when_the_address_is(address: str, testinfra_bdd_host):
    """
    Check the status of a user.

    Parameters
    ----------
    username : str
        The address (e.g. "www.ggoogle.com").
    testinfra_bdd_host : testinfra_bdd.fixture.TestinfraBDD
        The test fixture.
    """
    testinfra_bdd_host.address = testinfra_bdd_host.host.addr(address.strip('"'))


@when(parsers.parse('the TestInfra address and port is {url}'))
def when_the_address_and_port_is(url, testinfra_bdd_host):
    """
    Check the status of an address and port.

    Parameters
    ----------
    url: str
        The hostname and port (e.g. "www.google.com:443").
    testinfra_bdd_host : testinfra_bdd.fixture.TestinfraBDD
        The test fixture
    """
    (
        testinfra_bdd_host.address,
        testinfra_bdd_host.port,
        testinfra_bdd_host.port_number
    ) = parse_addr_and_port(url.strip('"'), testinfra_bdd_host.host)


@then(parsers.parse('the TestInfra address is {expected_state}'))
def the_address_is(expected_state, testinfra_bdd_host):
    """
    Check the actual state of an address against an expected state.

    Parameters
    ----------
    expected_state : str
        The expected state of the address.

    testinfra_bdd_host : testinfra_bdd.fixture.TestinfraBDD
        The test fixture.

    Raises
    ------
    AssertError
        If the actual state does not match the state.
    """
    address = testinfra_bdd_host.address
    assert address, 'Address is not set.  Did you miss a "When address is" step?'
    properties = {
        'resolvable': address.is_resolvable,
        'reachable': address.is_reachable
    }
    expected_state = expected_state.strip('"')
    assert expected_state in properties, f'Invalid state for {address.name} ("{expected_state}").'
    message = f'Expected the address {address.name} to be {expected_state} but it is not.'
    assert properties[expected_state], message


@then(parsers.parse('the TestInfra port is {expected_state}'))
def the_port_is(expected_state, testinfra_bdd_host):
    """
    Check the actual state of an address port against an expected state.

    Parameters
    ----------
    expected_state : str
        The expected state of the port.

    testinfra_bdd_host : testinfra_bdd.fixture.TestinfraBDD
        The test fixture.

    Raises
    ------
    AssertError
        If the actual state does not match the state.
    """
    port = testinfra_bdd_host.port
    expected_state = expected_state.strip('"')
    assert port, 'Port is not set.  Did you miss a "When the address and port" step?'
    properties = {
        'reachable': port.is_reachable
    }
    assert expected_state in properties, f'Unknown Port property ("{expected_state}").'
    message = f'{testinfra_bdd_host.address.name}:{testinfra_bdd_host.port_number} is unreachable.'
    assert properties['reachable'], message