python-openstackclient/openstackclient/tests/unit/volume/v3/fakes.py

# 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 random
from unittest import mock
import uuid

from cinderclient import api_versions

from openstackclient.tests.unit.compute.v2 import fakes as compute_fakes
from openstackclient.tests.unit import fakes
from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
from openstackclient.tests.unit import utils
from openstackclient.tests.unit.volume.v2 import fakes as volume_v2_fakes


class FakeVolumeClient(object):

    def __init__(self, **kwargs):
        self.auth_token = kwargs['token']
        self.management_url = kwargs['endpoint']
        self.api_version = api_versions.APIVersion('3.0')

        self.attachments = mock.Mock()
        self.attachments.resource_class = fakes.FakeResource(None, {})
        self.groups = mock.Mock()
        self.groups.resource_class = fakes.FakeResource(None, {})
        self.group_snapshots = mock.Mock()
        self.group_snapshots.resource_class = fakes.FakeResource(None, {})
        self.group_types = mock.Mock()
        self.group_types.resource_class = fakes.FakeResource(None, {})
        self.messages = mock.Mock()
        self.messages.resource_class = fakes.FakeResource(None, {})
        self.volumes = mock.Mock()
        self.volumes.resource_class = fakes.FakeResource(None, {})
        self.volume_types = mock.Mock()
        self.volume_types.resource_class = fakes.FakeResource(None, {})


class TestVolume(utils.TestCommand):

    def setUp(self):
        super().setUp()

        self.app.client_manager.volume = FakeVolumeClient(
            endpoint=fakes.AUTH_URL,
            token=fakes.AUTH_TOKEN
        )
        self.app.client_manager.identity = identity_fakes.FakeIdentityv3Client(
            endpoint=fakes.AUTH_URL,
            token=fakes.AUTH_TOKEN
        )
        self.app.client_manager.compute = compute_fakes.FakeComputev2Client(
            endpoint=fakes.AUTH_URL,
            token=fakes.AUTH_TOKEN,
        )


# TODO(stephenfin): Check if the responses are actually the same
FakeVolume = volume_v2_fakes.FakeVolume
FakeVolumeType = volume_v2_fakes.FakeVolumeType


class FakeVolumeGroup:
    """Fake one or more volume groups."""

    @staticmethod
    def create_one_volume_group(attrs=None):
        """Create a fake group.

        :param attrs: A dictionary with all attributes of group
        :return: A FakeResource object with id, name, status, etc.
        """
        attrs = attrs or {}

        group_type = attrs.pop('group_type', None) or uuid.uuid4().hex
        volume_types = attrs.pop('volume_types', None) or [uuid.uuid4().hex]

        # Set default attribute
        group_info = {
            'id': uuid.uuid4().hex,
            'status': random.choice([
                'available',
            ]),
            'availability_zone': f'az-{uuid.uuid4().hex}',
            'created_at': '2015-09-16T09:28:52.000000',
            'name': 'first_group',
            'description': f'description-{uuid.uuid4().hex}',
            'group_type': group_type,
            'volume_types': volume_types,
            'volumes': [f'volume-{uuid.uuid4().hex}'],
            'group_snapshot_id': None,
            'source_group_id': None,
            'project_id': f'project-{uuid.uuid4().hex}',
        }

        # Overwrite default attributes if there are some attributes set
        group_info.update(attrs)

        group = fakes.FakeResource(
            None,
            group_info,
            loaded=True)
        return group

    @staticmethod
    def create_volume_groups(attrs=None, count=2):
        """Create multiple fake groups.

        :param attrs: A dictionary with all attributes of group
        :param count: The number of groups to be faked
        :return: A list of FakeResource objects
        """
        groups = []
        for n in range(0, count):
            groups.append(FakeVolumeGroup.create_one_volume_group(attrs))

        return groups


class FakeVolumeGroupSnapshot:
    """Fake one or more volume group snapshots."""

    @staticmethod
    def create_one_volume_group_snapshot(attrs=None, methods=None):
        """Create a fake group snapshot.

        :param attrs: A dictionary with all attributes
        :param methods: A dictionary with all methods
        :return: A FakeResource object with id, name, description, etc.
        """
        attrs = attrs or {}

        # Set default attribute
        group_snapshot_info = {
            'id': uuid.uuid4().hex,
            'name': f'group-snapshot-{uuid.uuid4().hex}',
            'description': f'description-{uuid.uuid4().hex}',
            'status': random.choice(['available']),
            'group_id': uuid.uuid4().hex,
            'group_type_id': uuid.uuid4().hex,
            'project_id': uuid.uuid4().hex,
        }

        # Overwrite default attributes if there are some attributes set
        group_snapshot_info.update(attrs)

        group_snapshot = fakes.FakeResource(
            None,
            group_snapshot_info,
            methods=methods,
            loaded=True)
        return group_snapshot

    @staticmethod
    def create_volume_group_snapshots(attrs=None, count=2):
        """Create multiple fake group snapshots.

        :param attrs: A dictionary with all attributes of group snapshot
        :param count: The number of group snapshots to be faked
        :return: A list of FakeResource objects
        """
        group_snapshots = []
        for n in range(0, count):
            group_snapshots.append(
                FakeVolumeGroupSnapshot.create_one_volume_group_snapshot(attrs)
            )

        return group_snapshots


class FakeVolumeGroupType:
    """Fake one or more volume group types."""

    @staticmethod
    def create_one_volume_group_type(attrs=None, methods=None):
        """Create a fake group type.

        :param attrs: A dictionary with all attributes of group type
        :param methods: A dictionary with all methods
        :return: A FakeResource object with id, name, description, etc.
        """
        attrs = attrs or {}

        # Set default attribute
        group_type_info = {
            'id': uuid.uuid4().hex,
            'name': f'group-type-{uuid.uuid4().hex}',
            'description': f'description-{uuid.uuid4().hex}',
            'is_public': random.choice([True, False]),
            'group_specs': {},
        }

        # Overwrite default attributes if there are some attributes set
        group_type_info.update(attrs)

        group_type = fakes.FakeResource(
            None,
            group_type_info,
            methods=methods,
            loaded=True)
        return group_type

    @staticmethod
    def create_volume_group_types(attrs=None, count=2):
        """Create multiple fake group types.

        :param attrs: A dictionary with all attributes of group type
        :param count: The number of group types to be faked
        :return: A list of FakeResource objects
        """
        group_types = []
        for n in range(0, count):
            group_types.append(
                FakeVolumeGroupType.create_one_volume_group_type(attrs)
            )

        return group_types


class FakeVolumeMessage:
    """Fake one or more volume messages."""

    @staticmethod
    def create_one_volume_message(attrs=None):
        """Create a fake message.

        :param attrs: A dictionary with all attributes of message
        :return: A FakeResource object with id, name, status, etc.
        """
        attrs = attrs or {}

        # Set default attribute
        message_info = {
            'created_at': '2016-02-11T11:17:37.000000',
            'event_id': f'VOLUME_{random.randint(1, 999999):06d}',
            'guaranteed_until': '2016-02-11T11:17:37.000000',
            'id': uuid.uuid4().hex,
            'message_level': 'ERROR',
            'request_id': f'req-{uuid.uuid4().hex}',
            'resource_type': 'VOLUME',
            'resource_uuid': uuid.uuid4().hex,
            'user_message': f'message-{uuid.uuid4().hex}',
        }

        # Overwrite default attributes if there are some attributes set
        message_info.update(attrs)

        message = fakes.FakeResource(
            None,
            message_info,
            loaded=True)
        return message

    @staticmethod
    def create_volume_messages(attrs=None, count=2):
        """Create multiple fake messages.

        :param attrs: A dictionary with all attributes of message
        :param count: The number of messages to be faked
        :return: A list of FakeResource objects
        """
        messages = []
        for n in range(0, count):
            messages.append(FakeVolumeMessage.create_one_volume_message(attrs))

        return messages

    @staticmethod
    def get_volume_messages(messages=None, count=2):
        """Get an iterable MagicMock object with a list of faked messages.

        If messages list is provided, then initialize the Mock object with the
        list. Otherwise create one.

        :param messages: A list of FakeResource objects faking messages
        :param count: The number of messages to be faked
        :return An iterable Mock object with side_effect set to a list of faked
            messages
        """
        if messages is None:
            messages = FakeVolumeMessage.create_messages(count)

        return mock.Mock(side_effect=messages)


class FakeVolumeAttachment:
    """Fake one or more volume attachments."""

    @staticmethod
    def create_one_volume_attachment(attrs=None):
        """Create a fake volume attachment.

        :param attrs: A dictionary with all attributes of volume attachment
        :return: A FakeResource object with id, status, etc.
        """
        attrs = attrs or {}

        attachment_id = uuid.uuid4().hex
        volume_id = attrs.pop('volume_id', None) or uuid.uuid4().hex
        server_id = attrs.pop('instance', None) or uuid.uuid4().hex

        # Set default attribute
        attachment_info = {
            'id': attachment_id,
            'volume_id': volume_id,
            'instance': server_id,
            'status': random.choice([
                'attached',
                'attaching',
                'detached',
                'reserved',
                'error_attaching',
                'error_detaching',
                'deleted',
            ]),
            'attach_mode': random.choice(['ro', 'rw']),
            'attached_at': '2015-09-16T09:28:52.000000',
            'detached_at': None,
            'connection_info': {
                'access_mode': 'rw',
                'attachment_id': attachment_id,
                'auth_method': 'CHAP',
                'auth_password': 'AcUZ8PpxLHwzypMC',
                'auth_username': '7j3EZQWT3rbE6pcSGKvK',
                'cacheable': False,
                'driver_volume_type': 'iscsi',
                'encrypted': False,
                'qos_specs': None,
                'target_discovered': False,
                'target_iqn':
                    f'iqn.2010-10.org.openstack:volume-{attachment_id}',
                'target_lun': '1',
                'target_portal': '192.168.122.170:3260',
                'volume_id': volume_id,
            },
        }

        # Overwrite default attributes if there are some attributes set
        attachment_info.update(attrs)

        attachment = fakes.FakeResource(
            None,
            attachment_info,
            loaded=True)
        return attachment

    @staticmethod
    def create_volume_attachments(attrs=None, count=2):
        """Create multiple fake volume attachments.

        :param attrs: A dictionary with all attributes of volume attachment
        :param count: The number of volume attachments to be faked
        :return: A list of FakeResource objects
        """
        attachments = []

        for n in range(0, count):
            attachments.append(
                FakeVolumeAttachment.create_one_volume_attachment(attrs))

        return attachments

    @staticmethod
    def get_volume_attachments(attachments=None, count=2):
        """Get an iterable MagicMock object with a list of faked volumes.

        If attachments list is provided, then initialize the Mock object with
        the list. Otherwise create one.

        :param attachments: A list of FakeResource objects faking volume
            attachments
        :param count: The number of volume attachments to be faked
        :return An iterable Mock object with side_effect set to a list of faked
            volume attachments
        """
        if attachments is None:
            attachments = FakeVolumeAttachment.create_volume_attachments(count)

        return mock.Mock(side_effect=attachments)