1
0
mirror of https://github.com/dkmstr/openuds.git synced 2025-01-07 17:17:55 +03:00
openuds/server/tests/services/xen/test_service_fixed.py
2024-10-09 17:06:13 +02:00

182 lines
8.2 KiB
Python

# -*- 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 random
import typing
from unittest import mock
from uds.core import ui
from . import fixtures
from ...utils.test import UDSTransactionTestCase
from uds.services.Xen.xen import types as xen_types
class TestXenFixedService(UDSTransactionTestCase):
def setUp(self) -> None:
super().setUp()
fixtures.clean()
def test_service_is_available(self) -> None:
"""
Test the provider
"""
with fixtures.patched_provider() as provider:
api = typing.cast(mock.MagicMock, provider.api)
service = fixtures.create_service_fixed(provider=provider)
self.assertTrue(service.is_avaliable())
api.test.assert_called_with()
# With data cached, even if test fails, it will return True
api.test.side_effect = Exception('Testing exception')
self.assertTrue(service.is_avaliable())
# Data is cached, so we need to reset it
api.test.reset_mock()
service.provider().is_available.cache_clear() # type: ignore
# Now should return False as we have reset the cache
self.assertFalse(service.is_avaliable())
api.test.assert_called_with()
def test_service_vm_methods(self) -> None:
with fixtures.patched_provider() as provider:
service = fixtures.create_service_fixed(provider=provider)
VM = random.choice(fixtures.VMS_INFO)
VM.power_state = xen_types.PowerState.HALTED
service.start_vm(VM.opaque_ref)
self.assertEqual(VM.power_state, xen_types.PowerState.RUNNING)
service.stop_vm(VM.opaque_ref)
self.assertEqual(VM.power_state, xen_types.PowerState.HALTED)
VM.power_state = xen_types.PowerState.RUNNING
service.shutdown_vm(VM.opaque_ref)
self.assertEqual(VM.power_state, xen_types.PowerState.HALTED)
VM.power_state = xen_types.PowerState.RUNNING
service.reset_vm(VM.opaque_ref)
self.assertEqual(VM.power_state, xen_types.PowerState.RUNNING)
def test_enumerate_assignables(self) -> None:
with fixtures.patched_provider() as provider:
service = fixtures.create_service_fixed(provider=provider)
# Ensure machines are on same folder, so enumerate_assignables will return same machines
# (it will filter by folder also...)
service.machines.value = [
x.opaque_ref for x in fixtures.VMS_INFO if x.folder == service.folder.value
]
locate_vm: typing.Callable[[str], typing.Any] = lambda vmid: next(
(x for x in fixtures.VMS_INFO if x.opaque_ref == vmid), fixtures.VMS_INFO[0]
)
self.assertEqual(
list(service.enumerate_assignables()),
[
ui.gui.choice_item(locate_vm(x).opaque_ref, locate_vm(x).name or '')
for x in service.machines.value
],
)
def test_assign_from_assignables(self) -> None:
with fixtures.patched_provider() as provider:
service = fixtures.create_service_fixed(provider=provider)
vmid: str = typing.cast(list[str], fixtures.SERVICE_FIXED_VALUES_DICT['machines'])[0]
# Assign from assignables
with mock.patch('uds.services.Xen.deployment_fixed.XenFixedUserService') as userservice:
userservice_instance = userservice.return_value
userservice_instance.assign.return_value = 'OK'
self.assertEqual(
service.assign_from_assignables(vmid, mock.MagicMock(), userservice_instance), 'OK'
)
userservice_instance.assign.assert_called_with(vmid)
# vmid should be already assigned, so it will return an error (call error of userservice_instance)
self.assertEqual(
service.assign_from_assignables(vmid, mock.MagicMock(), userservice_instance),
userservice_instance.error.return_value,
)
def test_remove_and_free(self) -> None:
with fixtures.patched_provider() as provider:
service = fixtures.create_service_fixed(provider=provider)
with mock.patch.object(service, '_assigned_access') as assigned_access:
assigned_mock = mock.MagicMock()
assigned_access.return_value.__enter__.return_value = assigned_mock
service.remove_and_free('123')
assigned_mock.__contains__.assert_called_with('123')
assigned_mock.reset_mock()
assigned_mock.__contains__.return_value = True
service.remove_and_free('123')
assigned_mock.remove.assert_called_with('123')
assigned_mock.remove.assert_called_with('123')
def test_process_snapshot(self) -> None:
with fixtures.patched_provider() as provider:
api = typing.cast(mock.MagicMock, provider.api)
service = fixtures.create_service_fixed(provider=provider)
vmid = typing.cast(list[str], fixtures.SERVICE_FIXED_VALUES_DICT['machines'])[0]
userservice_instance = mock.MagicMock()
userservice_instance._vmid = vmid
# Create snapshot
api.list_snapshots.return_value = []
service.snapshot_creation(userservice_instance)
api.list_snapshots.assert_called_with(vmid, full_info=False)
api.create_snapshot.assert_called_with(vmid, 'UDS Snapshot')
# Skip snapshot creation
api.reset_mock()
api.list_snapshots.return_value = fixtures.VMS_INFO
service.snapshot_recovery(userservice_instance)
api.list_snapshots.assert_called_with(vmid, full_info=True)
api.create_snapshot.assert_not_called()
# Restore snapshot on exit
# First, no snapshots, so no restore
api.reset_mock()
api.list_snapshots.return_value = []
service.snapshot_creation(userservice_instance)
api.list_snapshots.assert_called_with(vmid, False)
# no snapshots, so no restore
api.restore_snapshot.assert_not_called()
# Reset and add snapshot
api.reset_mock()
api.list_snapshots.return_value = fixtures.VMS_INFO
service.snapshot_recovery(userservice_instance)
api.list_snapshots.assert_called_with(vmid, full_info=True)
# restore snapshot, as this is a test, in fact the SNAPSHOTS are the same as the VMS
api.restore_snapshot.assert_called_with(fixtures.VMS_INFO[0].opaque_ref)