Source code for stepler.horizon.fixtures.routers

"""
-----------------------------------
Fixtures to manipulate with routers
-----------------------------------
"""

# 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.horizon import steps

__all__ = [
    'routers_steps_ui'
]


@pytest.fixture
def routers_steps_ui(network_setup, router_steps, login, horizon):
    """Function fixture to get routers steps.

    router_steps instance is used for routers cleanup.

    Args:
        network_setup (None): should set up network before steps using
        router_steps (RouterSteps): instantiated router steps
        login (None): should log in horizon before steps using
        horizon (Horizon): instantiated horizon web application

    Returns:
        RoutersSteps: instantiated routers steps
    """
    return steps.RoutersSteps(horizon)