when destroy the vms, delete the tags from virtual router

Author: matheusdaluz

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java

@@ -39,6 +39,8 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
+import com.cloud.server.ResourceTag;
+import com.cloud.server.TaggedResourceService;
 import org.apache.cloudstack.acl.ControlledEntity.ACLType;
 import org.apache.cloudstack.acl.SecurityChecker.AccessType;
 import org.apache.cloudstack.affinity.AffinityGroupService;
@@ -472,6 +474,8 @@ public class UserVmManagerImpl extends ManagerBase implements UserVmManager, Vir
     private TemplateApiService _tmplService;
     @Inject
     private ConfigurationDao _configDao;
+    @Inject
+    private TaggedResourceService _taggedResourceService;
 
     private ScheduledExecutorService _executor = null;
     private ScheduledExecutorService _vmIpFetchExecutor = null;
@@ -2818,6 +2822,28 @@ public UserVm destroyVm(DestroyVMCmd cmd) throws ResourceUnavailableException, C
         return destroyedVm;
     }
 
+    protected Boolean removeTagsFromVm(long vmId) {
+        UserVmVO vm = _vmDao.findById(vmId);
+        Long resourceId = _taggedResourceService.getResourceId(vm.getUuid(), ResourceTag.ResourceObjectType.UserVm);
+        List<? extends ResourceTag> resourceTags = _taggedResourceService.listByResourceTypeAndId(ResourceTag.ResourceObjectType.UserVm, resourceId);
+        if (resourceTags.size() > 0) {
+            List<String> resourceIds = Arrays.asList(vm.getUuid());
+            Map<String, String> tags = new HashMap<>();
+            return _taggedResourceService.deleteTags(resourceIds, ResourceTag.ResourceObjectType.UserVm, tags);
+        } else {
+            return false;
+        }
+
+    }
+
+    public void setTaggedResourceService(TaggedResourceService taggedResourceServiceMock) {
+        _taggedResourceService = taggedResourceServiceMock;
+    }
+
+    public void setVmDao(UserVmDao userVmMock) {
+        _vmDao = userVmMock;
+    }
+
     private List<VolumeVO> getVolumesFromIds(DestroyVMCmd cmd) {
         List<VolumeVO> volumes = new ArrayList<>();
         if (cmd.getVolumeIds() != null) {
@@ -4601,17 +4627,23 @@ public UserVm destroyVm(long vmId, boolean expunge) throws ResourceUnavailableEx
         }
 
         boolean status;
+        boolean resultRemovedTags;
         State vmState = vm.getState();
 
         try {
             VirtualMachineEntity vmEntity = _orchSrvc.getVirtualMachine(vm.getUuid());
             status = vmEntity.destroy(Long.toString(userId), expunge);
+            resultRemovedTags = removeTagsFromVm(vmId);
         } catch (CloudException e) {
             CloudRuntimeException ex = new CloudRuntimeException("Unable to destroy with specified vmId", e);
             ex.addProxyObject(vm.getUuid(), "vmId");
             throw ex;
         }
 
+        if (!resultRemovedTags) {
+            s_logger.error("Error to delete tags or tags not exists, for the vm with id " + vmId);
+        }
+
         if (status) {
             // Mark the account's volumes as destroyed
             List<VolumeVO> volumes = _volsDao.findByInstance(vmId);

server/src/test/java/com/cloud/user/AccountManagerImplVolumeDeleteEventTest.java

@@ -33,6 +33,8 @@
 import java.util.List;
 import java.util.Map;
 
+import com.cloud.tags.TaggedResourceManagerImpl;
+import com.cloud.vm.dao.UserVmDao;
 import org.apache.cloudstack.acl.ControlledEntity;
 import org.apache.cloudstack.acl.SecurityChecker.AccessType;
 import org.apache.cloudstack.engine.cloud.entity.api.VirtualMachineEntity;
@@ -68,6 +70,9 @@ public class AccountManagerImplVolumeDeleteEventTest extends AccountManagetImplT
     UserVmManagerImpl _vmMgr;
     Map<String, Object> oldFields = new HashMap<>();
     UserVmVO vm = mock(UserVmVO.class);
+    TaggedResourceManagerImpl taggedResourceManagerMock = mock(TaggedResourceManagerImpl.class);
+
+
 
     // Configures the static fields of the UsageEventUtils class, Storing the
     // previous values to be restored during the cleanup phase, to avoid
@@ -138,6 +143,9 @@ protected void defineMocksBehavior() throws AgentUnavailableException, Concurren
         when(_serviceOfferingDao.findByIdIncludingRemoved(anyLong(), anyLong())).thenReturn(offering);
 
         when(_domainMgr.getDomain(anyLong())).thenReturn(domain);
+        Mockito.when(vm.getUuid()).thenReturn("1l");
+        _vmMgr.setTaggedResourceService(taggedResourceManagerMock);
+
 
         Mockito.doReturn(true).when(_vmMgr).expunge(any(UserVmVO.class), anyLong(), any(Account.class));
 

server/src/test/java/com/cloud/vm/UserVmManagerImplTest.java

@@ -17,8 +17,14 @@
 package com.cloud.vm;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
+import com.cloud.server.ResourceTag;
+import com.cloud.tags.ResourceTagVO;
+import com.cloud.tags.TaggedResourceManagerImpl;
 import org.apache.cloudstack.api.BaseCmd.HTTPMethod;
 import org.apache.cloudstack.api.command.user.vm.UpdateVMCmd;
 import org.apache.cloudstack.context.CallContext;
@@ -76,6 +82,9 @@ public class UserVmManagerImplTest {
     @Mock
     private NetworkModel networkModel;
 
+    @Mock
+    private TaggedResourceManagerImpl taggedResourceManagerMock;
+
     private long vmId = 1l;
 
     @Before
@@ -276,4 +285,45 @@ private void configureValidateOrReplaceMacAddressTest(int times, String macAddre
         Mockito.verify(networkModel, Mockito.times(times)).getNextAvailableMacAddressInNetwork(Mockito.anyLong());
         Assert.assertEquals(expectedMacAddress, returnedMacAddress);
     }
+
+    @Test
+    public void validateRemoveTagsWhenExists() {
+
+        List<ResourceTag> resourceTags = Arrays.asList(new ResourceTagVO("test", "test", 1l, 2l,
+                2l, ResourceTag.ResourceObjectType.UserVm, "", "test"));
+
+        Map<String, String> tags = new HashMap<>();
+        List<String> resourceIds = Arrays.asList("123");
+
+        userVmManagerImpl.setVmDao(userVmDao);
+        userVmManagerImpl.setTaggedResourceService(taggedResourceManagerMock);
+
+        Mockito.when(taggedResourceManagerMock.getUuid("123", ResourceTag.ResourceObjectType.UserVm)).thenReturn("123");
+        Mockito.when(taggedResourceManagerMock.deleteTags(resourceIds, ResourceTag.ResourceObjectType.UserVm, tags)).thenReturn(true);
+        Mockito.<List<? extends ResourceTag>>when(taggedResourceManagerMock.listByResourceTypeAndId(ResourceTag.ResourceObjectType.UserVm, 0)).thenReturn(resourceTags);
+
+
+        Mockito.when(userVmVoMock.getUuid()).thenReturn("123");
+        Mockito.when(userVmDao.findById(Mockito.eq(vmId))).thenReturn(userVmVoMock);
+
+        Boolean result = userVmManagerImpl.removeTagsFromVm(1l);
+        Assert.assertTrue(result);
+    }
+
+
+    @Test
+    public void validateWhenRemoveTagsNoExists() {
+
+        List<ResourceTag> resourceTags = Arrays.asList();
+
+        userVmManagerImpl.setVmDao(userVmDao);
+        userVmManagerImpl.setTaggedResourceService(taggedResourceManagerMock);
+
+        Mockito.<List<? extends ResourceTag>>when(taggedResourceManagerMock.listByResourceTypeAndId(ResourceTag.ResourceObjectType.UserVm, 123)).thenReturn(resourceTags);
+        Mockito.when(userVmVoMock.getUuid()).thenReturn("123");
+        Mockito.when(userVmDao.findById(Mockito.eq(vmId))).thenReturn(userVmVoMock);
+
+        Boolean result = userVmManagerImpl.removeTagsFromVm(1l);
+        Assert.assertFalse(result);
+    }
 }