Source code for stepler.keystone.fixtures.groups

"""
--------------
Group fixtures
--------------
"""

# 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.keystone import steps
from stepler.third_party import utils

__all__ = [
    'group_steps',
    'create_group',
    'group',
]


@pytest.fixture
def group_steps(keystone_client):
    """Function fixture to get group steps.

    Args:
        keystone_client (object): instantiated keystone client

    Returns:
        stepler.keystone.steps.GroupSteps: instantiated group steps
    """
    return steps.GroupSteps(keystone_client.groups)


@pytest.yield_fixture
def create_group(group_steps):
    """Callable function fixture to create single keystone group with options.

    Can be called several times during a test.
    After the test it destroys all created groups.

    Args:
        group_steps (object): instantiated keystone steps

    Returns:
        function: function to create single keystone group with options
    """
    groups = []

    def _create_group(*args, **kwargs):
        group = group_steps.create_group(*args, **kwargs)
        groups.append(group)
        return group

    yield _create_group

    for group in groups:
        group_steps.delete_group(group)


@pytest.fixture
def group(create_group):
    """Function fixture to create single keystone group.

    Args:
        create_group (function): function to create group with options

    Returns:
        object: keystone group
    """
    group_name = next(utils.generate_ids('group'))
    return create_group(group_name)