cloudstack/test/integration/smoke/test_backup_recovery_nas.py
Abhisar Sinha 23c9e83047
Create Instance from backup on another Zone (DRaaS use case) (#11560)
* draas initial changes

* Added option to enable disaster recovery on a backup respository. Added UpdateBackupRepositoryCmd api.

* Added timeout for mount operation in backup restore configurable via global setting

* Addressed review comments

* fix for simulator test failures

* Added UT for coverage

* Fix create instance from backup ui for other providers

* Added events to add/update backup repository

* Fix race in fetchZones

* One more fix in fetchZones in DeployVMFromBackup.vue

* Fix zone selection in createNetwork via Create Instance from backup form.

* Allow template/iso selection in create instance from backup ui

* rename draasenabled to crosszoneinstancecreation

* Added Cross-zone instance creation in test_backup_recovery_nas.py

* Added UT in BackupManagerTest and UserVmManagerImplTest

* Integration test added for Cross-zone instance creation in test_backup_recovery_nas.py
2025-09-25 13:28:29 +05:30

268 lines
12 KiB
Python

#!/usr/bin/env python
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
from marvin.cloudstackAPI import listZones
from marvin.cloudstackTestCase import cloudstackTestCase
from marvin.lib.utils import (cleanup_resources)
from marvin.lib.base import (Account, Network, ServiceOffering, DiskOffering, VirtualMachine, BackupOffering,
NetworkOffering, BackupRepository, Backup, Configurations, Volume, StoragePool)
from marvin.lib.common import (get_domain, get_zone, get_template)
from nose.plugins.attrib import attr
from marvin.codes import FAILED
import time
class TestNASBackupAndRecovery(cloudstackTestCase):
@classmethod
def setUpClass(cls):
# Setup
cls.testClient = super(TestNASBackupAndRecovery, cls).getClsTestClient()
cls.api_client = cls.testClient.getApiClient()
cls.services = cls.testClient.getParsedTestDataConfig()
cls.zone = get_zone(cls.api_client, cls.testClient.getZoneForTests())
cls.services["mode"] = cls.zone.networktype
cls.hypervisor = cls.testClient.getHypervisorInfo()
cls.domain = get_domain(cls.api_client)
cls.template = get_template(cls.api_client, cls.zone.id, cls.services["ostype"])
if cls.template == FAILED:
assert False, "get_template() failed to return template with description %s" % cls.services["ostype"]
cls.services["small"]["zoneid"] = cls.zone.id
cls.services["small"]["template"] = cls.template.id
cls._cleanup = []
if cls.hypervisor.lower() != 'kvm':
cls.skipTest(cls, reason="Test can be run only on KVM hypervisor")
cls.storage_pool = StoragePool.list(cls.api_client)[0]
if cls.storage_pool.type.lower() != 'networkfilesystem':
cls.skipTest(cls, reason="Test can be run only if the primary storage is of type NFS")
# Check backup configuration values, set them to enable the nas provider
backup_enabled_cfg = Configurations.list(cls.api_client, name='backup.framework.enabled')
backup_provider_cfg = Configurations.list(cls.api_client, name='backup.framework.provider.plugin')
cls.backup_enabled = backup_enabled_cfg[0].value
cls.backup_provider = backup_provider_cfg[0].value
if cls.backup_enabled == "false":
cls.skipTest(cls, reason="Test can be run only if the config backup.framework.enabled is true")
if cls.backup_provider != "nas":
Configurations.update(cls.api_client, 'backup.framework.provider.plugin', value='nas')
cls.account = Account.create(cls.api_client, cls.services["account"], domainid=cls.domain.id)
cls._cleanup = [cls.account]
# Create NAS backup repository and offering. Use the same directory as the storage pool
cls.backup_repository = BackupRepository.add(cls.api_client, zoneid=cls.zone.id, name="Nas",
address=cls.storage_pool.ipaddress + ":" + cls.storage_pool.path,
provider="nas", type="nfs",)
cls._cleanup.append(cls.backup_repository)
cls.provider_offerings = BackupOffering.listExternal(cls.api_client, cls.zone.id)
cls.backup_offering = BackupOffering.importExisting(cls.api_client, cls.zone.id, cls.provider_offerings[0].externalid,
cls.provider_offerings[0].name, cls.provider_offerings[0].description)
cls._cleanup.append(cls.backup_offering)
cls.offering = ServiceOffering.create(cls.api_client,cls.services["service_offerings"]["small"])
cls.diskoffering = DiskOffering.create(cls.api_client, cls.services["disk_offering"])
cls._cleanup.extend([cls.offering, cls.diskoffering, cls.account])
cls.vm = VirtualMachine.create(cls.api_client, cls.services["small"], accountid=cls.account.name,
domainid=cls.account.domainid, serviceofferingid=cls.offering.id,
diskofferingid=cls.diskoffering.id, mode=cls.services["mode"])
@classmethod
def tearDownClass(cls):
try:
# Cleanup resources used
cleanup_resources(cls.api_client, cls._cleanup)
if cls.backup_provider != "nas":
Configurations.update(cls.api_client, 'backup.framework.provider.plugin', value=cls.backup_provider)
except Exception as e:
raise Exception("Warning: Exception during cleanup : %s" % e)
def setUp(self):
self.apiclient = self.testClient.getApiClient()
self.dbclient = self.testClient.getDbConnection()
if self.hypervisor.lower() != 'kvm':
raise self.skipTest("Skipping test cases which must only run for Simulator")
self.cleanup = []
def tearDown(self):
try:
cleanup_resources(self.apiclient, self.cleanup)
except Exception as e:
raise Exception("Warning: Exception during cleanup : %s" % e)
def vm_backup_create_vm_from_backup_int(self, templateid=None, networkids=None):
self.backup_offering.assignOffering(self.apiclient, self.vm.id)
# Create a file and take backup
try:
ssh_client_vm = self.vm.get_ssh_client(reconnect=True)
ssh_client_vm.execute("touch test_backup_and_recovery.txt")
except Exception as err:
self.fail("SSH failed for Virtual machine: %s due to %s" % (self.vm.ipaddress, err))
time.sleep(5)
Backup.create(self.apiclient, self.vm.id, "backup1")
Backup.create(self.apiclient, self.vm.id, "backup2")
# Verify backup is created for the VM
backups = Backup.list(self.apiclient, self.vm.id)
self.assertEqual(len(backups), 2, "There should exist two backups for the VM")
# Remove VM from offering
self.backup_offering.removeOffering(self.apiclient, self.vm.id)
# Verify no. of backups after removing the backup offering
backups = Backup.list(self.apiclient, self.vm.id)
self.assertEqual(len(backups), 2, "There should exist two backups for the VM")
# Create a new VM from first backup
new_vm_name = "vm-from-backup1-" + str(int(time.time()))
new_vm = Backup.createVMFromBackup(
self.apiclient,
self.services["small"],
mode=self.services["mode"],
backupid=backups[0].id,
vmname=new_vm_name,
accountname=self.account.name,
domainid=self.account.domainid,
zoneid=self.destZone.id,
networkids=networkids,
templateid=templateid
)
self.cleanup.append(new_vm)
# Verify the new VM was created successfully
self.assertIsNotNone(new_vm, "Failed to create VM from backup")
self.assertEqual(new_vm.name, new_vm_name, "VM name does not match the requested name")
# Verify the new VM is running
self.assertEqual(new_vm.state, "Running", "New VM should be in Running state")
# Verify the new VM has the correct service offering
self.assertEqual(new_vm.serviceofferingid, self.offering.id,
"New VM should have the correct service offering")
# Verify the new VM has the correct zone
self.assertEqual(new_vm.zoneid, self.destZone.id, "New VM should be in the correct zone")
# Verify the new VM has the correct number of volumes (ROOT + DATADISK)
volumes = Volume.list(
self.apiclient,
virtualmachineid=new_vm.id,
listall=True
)
self.assertTrue(isinstance(volumes, list), "List volumes should return a valid list")
self.assertEqual(2, len(volumes), "The new VM should have 2 volumes (ROOT + DATADISK)")
# Verify that the file is present in the Instance created from backup
try:
ssh_client_new_vm = new_vm.get_ssh_client(reconnect=True)
result = ssh_client_new_vm.execute("ls test_backup_and_recovery.txt")
self.assertEqual(result[0], "test_backup_and_recovery.txt",
"Instance created from Backup should have the same file as the backup.")
except Exception as err:
self.fail("SSH failed for Virtual machine: %s due to %s" % (self.vm.ipaddress, err))
# Delete backups
Backup.delete(self.apiclient, backups[0].id)
Backup.delete(self.apiclient, backups[1].id)
@attr(tags=["advanced", "backup"], required_hardware="true")
def test_vm_backup_lifecycle(self):
"""
Test VM backup lifecycle
"""
# Verify there are no backups for the VM
backups = Backup.list(self.apiclient, self.vm.id)
self.assertEqual(backups, None, "There should not exist any backup for the VM")
# Assign VM to offering and create ad-hoc backup
self.backup_offering.assignOffering(self.apiclient, self.vm.id)
Backup.create(self.apiclient, self.vm.id)
# Verify backup is created for the VM
backups = Backup.list(self.apiclient, self.vm.id)
self.assertEqual(len(backups), 1, "There should exist only one backup for the VM")
backup = backups[0]
# Delete backup
Backup.delete(self.apiclient, backup.id)
# Verify backup is deleted
backups = Backup.list(self.apiclient, self.vm.id)
self.assertEqual(backups, None, "There should not exist any backup for the VM")
# Remove VM from offering
self.backup_offering.removeOffering(self.apiclient, self.vm.id)
@attr(tags=["advanced", "backup"], required_hardware="true")
def test_vm_backup_create_vm_from_backup(self):
"""
Test creating a new VM from a backup
"""
self.destZone = self.zone
self.vm_backup_create_vm_from_backup_int()
@attr(tags=["advanced", "backup"], required_hardware="true")
def test_vm_backup_create_vm_from_backup_in_another_zone(self):
"""
Test creating a new VM from a backup in another zone
"""
cmd = listZones.listZonesCmd()
zones = self.apiclient.listZones(cmd)
if not isinstance(zones, list):
raise Exception("Failed to find zones.")
if len(zones) < 2:
self.skipTest("Skipping test due to there are less than two zones.")
return
self.destZone = zones[1]
template = get_template(self.api_client, self.destZone.id, self.services["ostype"])
list_isolated_network_offerings_response = NetworkOffering.list(
self.apiclient,
name="DefaultIsolatedNetworkOfferingWithSourceNatService"
)
isolated_network_offering_id = list_isolated_network_offerings_response[0].id
network = {
"name": "Network-",
"displaytext": "Network-"
}
network["name"] = self.account.name + " -destZone"
network["displaytext"] = self.account.name + " -destZone"
network = Network.create(
self.apiclient,
network,
accountid=self.account.name,
domainid=self.domain.id,
networkofferingid=isolated_network_offering_id,
zoneid=self.destZone.id
)
backup_repository = self.backup_repository.update(self.api_client, crosszoneinstancecreation=True)
self.assertEqual(backup_repository.crosszoneinstancecreation, True, "Cross-Zone Instance Creation could not be enabled on the backup repository")
self.vm_backup_create_vm_from_backup_int(template.id, [network.id])