openuds/server/tests/services/openstack/fixtures.py

# -*- coding: utf-8 -*-

#
# Copyright (c) 2024 Virtual Cable S.L.U.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
#    * Redistributions of source code must retain the above copyright notice,
#      this list of conditions and the following disclaimer.
#    * Redistributions in binary form must reproduce the above copyright notice,
#      this list of conditions and the following disclaimer in the documentation
#      and/or other materials provided with the distribution.
#    * Neither the name of Virtual Cable S.L.U. nor the names of its contributors
#      may be used to endorse or promote products derived from this software
#      without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""
Author: Adolfo Gómez, dkmaster at dkmon dot com
"""
import contextlib
import datetime
import typing
import uuid
import random

from unittest import mock

from uds.core import environment, types
from uds.core.ui.user_interface import gui

from ...utils.autospec import autospec, AutoSpecMethodInfo

from uds.services.OpenStack import provider, provider_legacy, service
from uds.services.OpenStack.openstack import openstack_client, types as openstack_types

AnyOpenStackProvider: typing.TypeAlias = typing.Union[provider.OpenStackProvider, provider_legacy.OpenStackProviderLegacy]


GUEST_IP_ADDRESS: str = '1.0.0.1'

FLAVORS_LIST: list[openstack_types.FlavorInfo] = [
    openstack_types.FlavorInfo(
        id='ai2.xlarge.4',
        name='ai2.xlarge.4',
        vcpus=4,
        ram=1024 * n,  # MiB
        disk=1024 * 1024 * n,  # GiB
        swap=0,
        is_public=n % 2 == 0,
        disabled=n % 4 == 0,  # Disabled every 4 flavors
    )
    for n in range(1, 16)
]

AVAILABILITY_ZONES_LIST: list[openstack_types.AvailabilityZoneInfo] = [
    openstack_types.AvailabilityZoneInfo(
        id=f'az{n}',
        name=f'az name{n}',
        available=n % 2 == 0,
    )
    for n in range(1, 16)
]


PROJECTS_LIST: list[openstack_types.ProjectInfo] = [
    openstack_types.ProjectInfo(id=f'pid{n}', name=f'project name{n}') for n in range(1, 16)
]

REGIONS_LIST: list[openstack_types.RegionInfo] = [
    openstack_types.RegionInfo(id=f'rid{n}', name=f'region name{n}') for n in range(1, 16)
]

SERVERS_LIST: list[openstack_types.ServerInfo] = [
    openstack_types.ServerInfo(
        id=f'sid{n}',
        name=f'server name{n}',
        href=f'https://xxxx/v2/yyyy/servers/zzzzz{n}',
        flavor=FLAVORS_LIST[(n - 1) % len(FLAVORS_LIST)].id,
        status=openstack_types.ServerStatus.ACTIVE,
        power_state=openstack_types.PowerState.SHUTDOWN,
        addresses=[
            openstack_types.ServerInfo.AddresInfo(
                version=4,
                ip='172.16.0.148',
                mac='fa:16:3e:0d:fd:91',
                type='fixed',
                network_name='724cc8a5-0ce2-4224-ab1a-f2b84501dcfd',
            )
        ],
        access_addr_ipv4='',
        access_addr_ipv6='',
        fault=None,
        admin_pass='',
    )
    for n in range(1, 16)
]

IMAGES_LIST: list[openstack_types.ImageInfo] = [
    openstack_types.ImageInfo(
        id=f'iid{n}',
        name=f'image name{n}',
    )
    for n in range(1, 16)
]

VOLUMES_TYPE_LIST: list[openstack_types.VolumeTypeInfo] = [
    openstack_types.VolumeTypeInfo(
        id=f'vid{n}',
        name=f'volume type name{n}',
    )
    for n in range(1, 16)
]

VOLUMES_LIST: list[openstack_types.VolumeInfo] = [
    openstack_types.VolumeInfo(
        id=f'vid{n}',
        name=f'volume name{n}',
        description=f'volume description{n}',
        size=1024 * n,  # GiB
        availability_zone=f'zone{n}',
        bootable=n % 2 == 0,
        encrypted=n % 3 == 0,
    )
    for n in range(1, 16)
]

VOLUME_SNAPSHOTS_LIST: list[openstack_types.VolumeSnapshotInfo] = [
    openstack_types.VolumeSnapshotInfo(
        id=f'vsid{n}',
        volume_id=VOLUMES_LIST[(n - 1) % len(VOLUMES_LIST)].id,
        name=f'volume snapshot name{n}',
        description=f'volume snapshot description{n}',
        status=openstack_types.SnapshotStatus.AVAILABLE,
        size=128 * n,
        created_at=datetime.datetime(2009, 12, 9, 0, 0, 0),
        updated_at=datetime.datetime(2024, 1, 1, 0, 0, 0),
    )
    for n in range(1, 16)
]

SUBNETS_LIST: list[openstack_types.SubnetInfo] = [
    openstack_types.SubnetInfo(
        id=f'subnetid{n}',
        name=f'subnet name{n}',
        cidr=f'192.168.{n}.0/24',
        enable_dhcp=n % 2 == 0,
        gateway_ip=f'192.168.{n}.1',
        ip_version=[4, 6][n % 2],
        network_id=f'netid{n}',
    )
    for n in range(1, 16)
]

NETWORKS_LIST: list[openstack_types.NetworkInfo] = [
    openstack_types.NetworkInfo(
        id=f'netid{n}',
        name=f'network name{n}',
        status=openstack_types.NetworkStatus.ACTIVE,
        shared=n % 2 == 0,
        subnets=random.sample([s.id for s in SUBNETS_LIST], 2),
        availability_zones=[
            AVAILABILITY_ZONES_LIST[(j - 1) % len(AVAILABILITY_ZONES_LIST)].id for j in range(1, 4)
        ],
    )
    for n in range(1, 16)
]

PORTS_LIST: list[openstack_types.PortInfo] = [
    openstack_types.PortInfo(
        id=f'portid{n}',
        name=f'port name{n}',
        status=openstack_types.PortStatus.ACTIVE,
        device_id=f'devid{n}',
        device_owner=f'devowner{n}',
        mac_address=f'fa:{n:02x}:3e:0d:{n+1:02x}:91',
        fixed_ips=[
            openstack_types.PortInfo.FixedIpInfo(
                ip_address=f'192.168.{j}.1',
                subnet_id=random.choice([s.id for s in SUBNETS_LIST]),
            )
            for j in range(1, 4)
        ],
    )
    for n in range(1, 16)
]

SECURITY_GROUPS_LIST: list[openstack_types.SecurityGroupInfo] = [
    openstack_types.SecurityGroupInfo(
        id=f'sgid{n}',
        name=f'security group name{n}',
        description=f'security group description{n}',
    )
    for n in range(1, 16)
]

CONSOLE_CONNECTION_INFO: types.services.ConsoleConnectionInfo = types.services.ConsoleConnectionInfo(
    type='spice',
    address=GUEST_IP_ADDRESS,
    port=5900,
    secure_port=5901,
    cert_subject='',
    ticket=types.services.ConsoleConnectionTicket(value='ticket'),
    ca='',
    proxy='',
    monitors=1,
)

T = typing.TypeVar('T')


def get_id(iterable: typing.Iterable[T], id: str) -> T:
    try:
        return next(filter(lambda x: x.id == id, iterable))  # type: ignore
    except StopIteration:
        raise ValueError(f'Id {id} not found in iterable') from None


# Methods that returns None or "internal" methods are not tested
# The idea behind this is to allow testing the provider, service and deployment classes
# without the need of a real OpenStack environment
CLIENT_METHODS_INFO: typing.Final[list[AutoSpecMethodInfo]] = [
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_flavors, return_value=FLAVORS_LIST),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.list_availability_zones, return_value=AVAILABILITY_ZONES_LIST
    ),
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_projects, return_value=PROJECTS_LIST),
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_regions, return_value=REGIONS_LIST),
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_servers, return_value=SERVERS_LIST),
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_images, return_value=IMAGES_LIST),
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_volume_types, return_value=VOLUMES_TYPE_LIST),
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_volumes, return_value=VOLUMES_LIST),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.list_volume_snapshots, return_value=VOLUME_SNAPSHOTS_LIST
    ),
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_networks, return_value=NETWORKS_LIST),
    AutoSpecMethodInfo(openstack_client.OpenstackClient.list_ports, return_value=PORTS_LIST),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.list_security_groups, return_value=SECURITY_GROUPS_LIST
    ),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.get_server,
        method=lambda server_id: get_id(SERVERS_LIST, server_id),  # pyright: ignore
    ),  # pyright: ignore
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.get_volume,
        method=lambda volume_id: get_id(VOLUMES_LIST, volume_id),  # pyright: ignore
    ),  # pyright: ignore
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.get_volume_snapshot,
        method=lambda snapshot_id: get_id(VOLUME_SNAPSHOTS_LIST, snapshot_id),  # pyright: ignore
    ),  # pyright: ignore
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.update_snapshot,
        method=lambda snapshot_id, name, description: get_id(  # pyright: ignore
            VOLUME_SNAPSHOTS_LIST, snapshot_id  # pyright: ignore
        ),
    ),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.create_volume_snapshot,
        method=lambda volume_id, name, description: random.choice(VOLUME_SNAPSHOTS_LIST),  # pyright: ignore
    ),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.create_volume_from_snapshot,
        method=lambda snapshot_id, name, description: get_id(  # pyright: ignore
            VOLUMES_LIST, f'vid{len(VOLUMES_LIST) + 1}'
        ),
    ),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.create_server_from_snapshot,
        method=lambda *args, **kwargs: random.choice(SERVERS_LIST),  # pyright: ignore
    ),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.test_connection,
        return_value=True,
    ),
    AutoSpecMethodInfo(
        openstack_client.OpenstackClient.is_available,
        return_value=True,
    ),
    # connect returns None
    # Test method
    # AutoSpecMethodInfo(client.Client.list_projects, return_value=True),
    # AutoSpecMethodInfo(
    #    client.ProxmoxClient.get_node_stats,
    #    method=lambda node, **kwargs: next(filter(lambda n: n.name == node, NODE_STATS)),  # pyright: ignore
    # ),
]

PROVIDER_VALUES_DICT: typing.Final[gui.ValuesDictType] = {
    'endpoint': 'host',
    'access': 'public',
    'domain': 'domain',
    'username': 'username',
    'password': 'password',
    'concurrent_creation_limit': 1,
    'concurrent_removal_limit': 1,
    'timeout': 10,
    'tenant': 'tenant',
    'region': 'region',
    'use_subnets_name': False,
    'https_proxy': 'https_proxy',
}

PROVIDER_LEGACY_VALUES_DICT: typing.Final[gui.ValuesDictType] = {
    'host': 'host',
    'port': 5000,
    'ssl': False,
    'access': 'public',
    'domain': 'domain',
    'username': 'username',
    'password': 'password',
    'concurrent_creation_limit': 1,
    'concurrent_removal_limit': 1,
    'timeout': 10,
    'https_proxy': 'https_proxy',
}


SERVICE_VALUES_DICT: typing.Final[gui.ValuesDictType] = {
    'region': random.choice(REGIONS_LIST).id,
    'project': random.choice(PROJECTS_LIST).id,
    'availability_zone': random.choice(AVAILABILITY_ZONES_LIST).id,
    'volume': random.choice(VOLUMES_LIST).id,
    'network': random.choice(NETWORKS_LIST).id,
    'flavor': random.choice(FLAVORS_LIST).id,
    'security_groups': [random.choice(SECURITY_GROUPS_LIST).id],
    'basename': 'bname',
    'lenname': 5,
    'maintain_on_error': False,
    # 'prov_uuid': str(uuid.uuid4()),  # Not stored on db, so not needed
}


def create_client_mock() -> mock.Mock:
    """
    Create a mock of ProxmoxClient
    """
    return autospec(openstack_client.OpenstackClient, CLIENT_METHODS_INFO)


@contextlib.contextmanager
def patch_provider_api(
    legacy: bool = False,
    **kwargs: typing.Any,
) -> typing.Generator[mock.Mock, None, None]:
    client = create_client_mock()
    path = (
        'uds.services.OpenStack.provider_legacy.OpenStackProviderLegacy'
        if legacy
        else 'uds.services.OpenStack.provider.OpenStackProvider'
    )
    try:
        mock.patch(path + '.api', return_value=client).start()
        yield client
    finally:
        mock.patch.stopall()


def create_provider(**kwargs: typing.Any) -> provider.OpenStackProvider:
    """
    Create a provider
    """
    values = PROVIDER_VALUES_DICT.copy()
    values.update(kwargs)

    uuid_ = str(uuid.uuid4())
    return provider.OpenStackProvider(
        environment=environment.Environment.private_environment(uuid), values=values, uuid=uuid_
    )


def create_provider_legacy(**kwargs: typing.Any) -> provider_legacy.OpenStackProviderLegacy:
    """
    Create a provider legacy
    """
    values = PROVIDER_LEGACY_VALUES_DICT.copy()
    values.update(kwargs)

    uuid_ = str(uuid.uuid4())
    return provider_legacy.OpenStackProviderLegacy(
        environment=environment.Environment.private_environment(uuid), values=values, uuid=uuid_
    )


def create_service(
    provider: AnyOpenStackProvider, **kwargs: typing.Any
) -> service.OpenStackLiveService:
    """
    Create a service
    """
    values = SERVICE_VALUES_DICT.copy()
    values.update(kwargs)

    uuid_ = str(uuid.uuid4())
    return service.OpenStackLiveService(
        provider=provider,
        environment=environment.Environment.private_environment(uuid),
        values=values,
        uuid=uuid_,
    )