mirror of
				https://github.com/apache/cloudstack.git
				synced 2025-10-26 08:42:29 +01:00 
			
		
		
		
	* Don't allow inadvertent deletion of hidden details via API * Update VM details unit test ensuring system/hidden details not removed * Update test/integration/component/test_update_vm.py --------- Co-authored-by: Marcus Sorensen <mls@apple.com> Co-authored-by: dahn <daan.hoogland@gmail.com>
		
			
				
	
	
		
			256 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			256 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			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.cloudstackTestCase import cloudstackTestCase
 | |
| from marvin.lib.base import Account, VirtualMachine, ServiceOffering
 | |
| from marvin.lib.utils import (validateList, cleanup_resources)
 | |
| from marvin.lib.common import get_zone, get_domain, get_template
 | |
| from marvin.codes import PASS
 | |
| from nose.plugins.attrib import attr
 | |
| 
 | |
| class TestData(object):
 | |
|     """Test data object that is required to create resources
 | |
|     """
 | |
|     def __init__(self):
 | |
|         self.testdata = {
 | |
|             #data to create an account
 | |
|             "account": {
 | |
|                 "email": "test@test.com",
 | |
|                 "firstname": "Test",
 | |
|                 "lastname": "User",
 | |
|                 "username": "test",
 | |
|                 "password": "password",
 | |
|             },
 | |
|             #data reqd for virtual machine creation
 | |
|             "virtual_machine" : {
 | |
|             },
 | |
|             #small service offering
 | |
|             "service_offering": {
 | |
|                 "small": {
 | |
|                     "name": "Small Instance",
 | |
|                     "displaytext": "Small Instance",
 | |
|                     "cpunumber": 1,
 | |
|                     "cpuspeed": 100,
 | |
|                     "memory": 256,
 | |
|                 },
 | |
|             },
 | |
|             "ostype": 'CentOS 5.3 (64-bit)',
 | |
|         }
 | |
| 
 | |
| 
 | |
| class TestUpdateVirtualMachine(cloudstackTestCase):
 | |
|     """Test deploy a VM into a user account
 | |
|     """
 | |
| 
 | |
|     def setUp(self):
 | |
|         self.testdata = TestData().testdata
 | |
|         self.apiclient = self.testClient.getApiClient()
 | |
|         self.dbclient = self.testClient.getDbConnection()
 | |
| 
 | |
|         # Get Zone, Domain and Default Built-in template
 | |
|         self.domain = get_domain(self.apiclient)
 | |
|         self.zone = get_zone(self.apiclient, self.testClient.getZoneForTests())
 | |
|         self.testdata["mode"] = self.zone.networktype
 | |
|         self.template = get_template(self.apiclient, self.zone.id, self.testdata["ostype"])
 | |
| 
 | |
|         #create a user account
 | |
|         self.account = Account.create(
 | |
|             self.apiclient,
 | |
|             self.testdata["account"],
 | |
|             domainid=self.domain.id
 | |
|         )
 | |
|         #create a service offering
 | |
|         self.service_offering = ServiceOffering.create(
 | |
|             self.apiclient,
 | |
|             self.testdata["service_offering"]["small"]
 | |
|         )
 | |
|         #build cleanup list
 | |
|         self.cleanup = [
 | |
|             self.service_offering,
 | |
|             self.account
 | |
|         ]
 | |
| 
 | |
|     @attr(tags=['advanced', 'simulator', 'basic', 'sg'], required_hardware="false")
 | |
|     def test_update_vm_name(self):
 | |
|         """Test Update VirtualMachine Name
 | |
| 
 | |
|         # Validate the following:
 | |
|         # 1. VirtualMachine has uuid name, displayname
 | |
|         # 2. listVirtualMachines returns accurate information
 | |
|         # 3. Stop the VM
 | |
|         # 4. updateVirtualmachine no args and then new displayname
 | |
|         # 5. listVirtualMachines nad check the displayName set
 | |
|         # 6. start the VM
 | |
|         # 7. Verify displayName is still set
 | |
|         """
 | |
|         self.virtual_machine = VirtualMachine.create(
 | |
|             self.apiclient,
 | |
|             self.testdata["virtual_machine"],
 | |
|             accountid=self.account.name,
 | |
|             zoneid=self.zone.id,
 | |
|             domainid=self.account.domainid,
 | |
|             serviceofferingid=self.service_offering.id,
 | |
|             templateid=self.template.id
 | |
|         )
 | |
| 
 | |
|         vm = self.listVmById(self.virtual_machine.id)
 | |
| 
 | |
|         self.debug(
 | |
|             "VirtualMachine launched with id, name, displayname: %s %s %s"\
 | |
|             % (self.virtual_machine.id, vm.name, vm.displayname)
 | |
|         )
 | |
| 
 | |
|         self.assertEqual(
 | |
|             vm.state,
 | |
|             "Running",
 | |
|             msg="VM is not in Running state"
 | |
|         )
 | |
|         self.debug("Stopping VirtualMachine to update displayname")
 | |
| 
 | |
|         self.virtual_machine.stop(self.apiclient)
 | |
|         #CLOUDSTACK-3184: update without args as this results in an NPE
 | |
|         self.virtual_machine.update(self.apiclient)
 | |
| 
 | |
|         self.virtual_machine.update(self.apiclient, displayname='newdisplayname')
 | |
|         list_vms = VirtualMachine.list(self.apiclient, id=vm.id)
 | |
|         vmnew = list_vms[0]
 | |
| 
 | |
|         self.assertNotEqual(vmnew.displayname, vm.displayname,
 | |
|             msg="displayname remained the same after updateVirtualMachine")
 | |
|         self.assertEqual(vmnew.displayname, 'newdisplayname',
 | |
|             msg="display name not updated successfully, displayname is %s" % vmnew.displayname)
 | |
| 
 | |
|         self.debug("Starting VirtualMachine after updated displayname")
 | |
|         self.virtual_machine.start(self.apiclient)
 | |
|         list_vms = VirtualMachine.list(self.apiclient, id=vm.id)
 | |
|         vmnewstarted = list_vms[0]
 | |
| 
 | |
|         self.assertEqual(vmnew.displayname, vmnewstarted.displayname,
 | |
|             msg="display name changed on start, displayname is %s" % vmnewstarted.displayname)
 | |
| 
 | |
|     @attr(tags=['advanced', 'simulator', 'basic', 'sg', 'details'], required_hardware="false")
 | |
|     def test_update_vm_details_admin(self):
 | |
|         """Test Update VirtualMachine Details
 | |
| 
 | |
|         # Set up a VM
 | |
|         # Set up hidden detail in DB for VM
 | |
| 
 | |
|         # Validate the following:
 | |
|         # 1. Can add two details (detail1, detail2)
 | |
|         # 2. Can fetch new details on VM
 | |
|         # 3. Can delete detail1
 | |
|         # 4. Hidden detail not removed
 | |
|         # 6. The detail2 remains
 | |
|         # 7. Ensure cleanup parameter doesn't remove hidden details
 | |
|         """
 | |
|         hidden_detail_name = "configDriveLocation"
 | |
|         detail1 = "detail1"
 | |
|         detail2 = "detail2"
 | |
| 
 | |
|         # set up a VM
 | |
|         self.virtual_machine = VirtualMachine.create(
 | |
|             self.apiclient,
 | |
|             self.testdata["virtual_machine"],
 | |
|             accountid=self.account.name,
 | |
|             zoneid=self.zone.id,
 | |
|             domainid=self.account.domainid,
 | |
|             serviceofferingid=self.service_offering.id,
 | |
|             templateid=self.template.id
 | |
|         )
 | |
|         self.cleanup.append(self.virtual_machine)
 | |
| 
 | |
|         vm = self.listVmById(self.virtual_machine.id)
 | |
| 
 | |
|         self.debug(
 | |
|             "VirtualMachine launched with id, name, displayname: %s %s %s" \
 | |
|             % (self.virtual_machine.id, vm.name, vm.displayname)
 | |
|         )
 | |
| 
 | |
|         # set up a hidden detail
 | |
|         dbresult = self.dbclient.execute("select id from vm_instance where uuid='%s'" % vm.id)
 | |
|         self.assertEqual(validateList(dbresult)[0], PASS, "sql query returned invalid response")
 | |
|         vm_db_id = dbresult[0][0]
 | |
|         self.debug("VM has database id %d" % vm_db_id)
 | |
| 
 | |
|         self.dbclient.execute("insert into user_vm_details (vm_id, name, value, display) values (%d,'%s','HOST', 0)" % (vm_db_id, hidden_detail_name))
 | |
| 
 | |
|         vm = self.listVmById(self.virtual_machine.id)
 | |
|         self.debug("VirtualMachine fetched with details: %s of type %s" % (vm.details, type(vm.details)))
 | |
| 
 | |
|         self.assertIsNone(vm.details[hidden_detail_name], "hidden detail should be hidden")
 | |
| 
 | |
|         # add two details by appending to what was returned via API
 | |
|         updating_vm_details = vm.details.__dict__
 | |
|         updating_vm_details[detail1] = "foo"
 | |
|         updating_vm_details[detail2] = "bar"
 | |
| 
 | |
|         self.debug("Updating VM to new details: %s" % updating_vm_details)
 | |
|         vm = self.virtual_machine.update(self.apiclient, details=[updating_vm_details])
 | |
| 
 | |
|         self.assertIsNotNone(vm.details[detail1], "Expect " + detail1)
 | |
|         self.assertIsNotNone(vm.details[detail2], "Expect " + detail2)
 | |
|         self.assertIsNone(vm.details[hidden_detail_name], "hidden detail should be hidden")
 | |
|         self.assertTrue(self.detailInDatabase(vm_db_id, hidden_detail_name), "hidden detail should still exist in db")
 | |
| 
 | |
|         # delete one detail
 | |
|         updating_vm_details = vm.details.__dict__
 | |
|         del updating_vm_details["detail1"]
 | |
| 
 | |
|         self.debug("Deleting one detail by updating details: %s" % updating_vm_details)
 | |
|         vm = self.virtual_machine.update(self.apiclient, details=[updating_vm_details])
 | |
| 
 | |
|         self.assertIsNone(vm.details[detail1], "Do not expect " + detail1)
 | |
|         self.assertIsNotNone(vm.details[detail2], "Expect " + detail2)
 | |
|         self.assertIsNone(vm.details[hidden_detail_name], "hidden detail should be hidden")
 | |
|         self.assertTrue(self.detailInDatabase(vm_db_id, hidden_detail_name), "hidden detail should still exist in db")
 | |
| 
 | |
|         # cleanup, ensure hidden detail is not deleted
 | |
|         vm = self.virtual_machine.update(self.apiclient, cleanupdetails="true")
 | |
|         self.assertIsNone(vm.details[detail1], "Do not expect " + detail1)
 | |
|         self.assertIsNone(vm.details[detail2], "Do not expect " + detail2)
 | |
|         self.assertIsNone(vm.details[hidden_detail_name], "hidden detail should be hidden")
 | |
|         self.assertTrue(self.detailInDatabase(vm_db_id, hidden_detail_name), "hidden detail should still exist in db")
 | |
| 
 | |
| 
 | |
|     def detailInDatabase(self, vm_id, detail_name):
 | |
|         dbresult = self.dbclient.execute("select id from user_vm_details where vm_id=%s and name='%s'" % (vm_id, detail_name))
 | |
|         self.debug("Detail %s for VM %s: %s" % (detail_name, vm_id, dbresult))
 | |
|         if validateList(dbresult)[0] == PASS:
 | |
|             return True
 | |
|         return False
 | |
| 
 | |
| 
 | |
|     def listVmById(self, id):
 | |
|         list_vms = VirtualMachine.list(self.apiclient, id=id)
 | |
|         self.assertEqual(
 | |
|             isinstance(list_vms, list),
 | |
|             True,
 | |
|             "List VM response was not a valid list"
 | |
|         )
 | |
|         self.assertNotEqual(
 | |
|             len(list_vms),
 | |
|             0,
 | |
|             "List VM response was empty"
 | |
|         )
 | |
|         return list_vms[0]
 | |
| 
 | |
|     def tearDown(self):
 | |
|         try:
 | |
|            cleanup_resources(self.apiclient, self.cleanup)
 | |
|         except Exception as e:
 | |
|             self.debug("Warning! Exception in tearDown: %s" % e)
 |