mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
Emit template UUID and class type over event bus when deleting templates.
The behavior is now consistent with template creation. This commit also adds a unit test for this functionality to make sure that it will always happen.
This commit is contained in:
jeff
parent
5ccebf0f2b
commit
7aec943ef8
@ -394,7 +394,7 @@ public class HypervisorTemplateAdapter extends TemplateAdapterBase {
|
||||
// publish zone-wide usage event
|
||||
Long sZoneId = ((ImageStoreEntity)imageStore).getDataCenterId();
|
||||
if (sZoneId != null) {
|
||||
UsageEventUtils.publishUsageEvent(eventType, template.getAccountId(), sZoneId, template.getId(), null, null, null);
|
||||
UsageEventUtils.publishUsageEvent(eventType, template.getAccountId(), sZoneId, template.getId(), null, VirtualMachineTemplate.class.getName(), template.getUuid());
|
||||
}
|
||||
|
||||
s_logger.info("Delete template from image store: " + imageStore.getName());
|
||||
|
||||
@ -0,0 +1,285 @@
|
||||
// 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.
|
||||
//
|
||||
|
||||
package com.cloud.template;
|
||||
|
||||
import java.lang.reflect.Field;
|
||||
import java.lang.reflect.InvocationTargetException;
|
||||
import java.lang.reflect.Method;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.concurrent.ExecutionException;
|
||||
|
||||
import org.apache.cloudstack.engine.subsystem.api.storage.DataStore;
|
||||
import org.apache.cloudstack.engine.subsystem.api.storage.TemplateDataFactory;
|
||||
import org.apache.cloudstack.engine.subsystem.api.storage.TemplateInfo;
|
||||
import org.apache.cloudstack.engine.subsystem.api.storage.TemplateService;
|
||||
import org.apache.cloudstack.engine.subsystem.api.storage.TemplateService.TemplateApiResult;
|
||||
import org.apache.cloudstack.framework.async.AsyncCallFuture;
|
||||
import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
|
||||
import org.apache.cloudstack.framework.events.Event;
|
||||
import org.apache.cloudstack.framework.events.EventBus;
|
||||
import org.apache.cloudstack.framework.events.EventBusException;
|
||||
import org.apache.cloudstack.framework.messagebus.MessageBus;
|
||||
import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreDao;
|
||||
import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreVO;
|
||||
import org.apache.cloudstack.storage.image.datastore.ImageStoreEntity;
|
||||
import org.junit.Assert;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.InjectMocks;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.Mockito;
|
||||
import org.mockito.MockitoAnnotations;
|
||||
import org.mockito.invocation.InvocationOnMock;
|
||||
import org.mockito.stubbing.Answer;
|
||||
import org.powermock.api.mockito.PowerMockito;
|
||||
import org.powermock.core.classloader.annotations.PrepareForTest;
|
||||
import org.powermock.modules.junit4.PowerMockRunner;
|
||||
|
||||
import com.cloud.dc.dao.DataCenterDao;
|
||||
import com.cloud.event.EventTypes;
|
||||
import com.cloud.event.UsageEventUtils;
|
||||
import com.cloud.event.UsageEventVO;
|
||||
import com.cloud.event.dao.UsageEventDao;
|
||||
import com.cloud.storage.Storage.ImageFormat;
|
||||
import com.cloud.storage.TemplateProfile;
|
||||
import com.cloud.storage.VMTemplateStorageResourceAssoc.Status;
|
||||
import com.cloud.storage.dao.VMTemplateZoneDao;
|
||||
import com.cloud.storage.VMTemplateVO;
|
||||
import com.cloud.user.AccountVO;
|
||||
import com.cloud.user.ResourceLimitService;
|
||||
import com.cloud.user.dao.AccountDao;
|
||||
import com.cloud.utils.component.ComponentContext;
|
||||
|
||||
import static org.mockito.Mockito.any;
|
||||
import static org.mockito.Mockito.anyLong;
|
||||
import static org.mockito.Mockito.when;
|
||||
import static org.mockito.Mockito.eq;
|
||||
import static org.mockito.Mockito.doAnswer;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
@RunWith(PowerMockRunner.class)
|
||||
@PrepareForTest(ComponentContext.class)
|
||||
public class HypervisorTemplateAdapterTest {
|
||||
@Mock
|
||||
EventBus _bus;
|
||||
List<Event> events = new ArrayList<>();
|
||||
|
||||
@Mock
|
||||
TemplateManager _templateMgr;
|
||||
|
||||
@Mock
|
||||
TemplateService _templateService;
|
||||
|
||||
@Mock
|
||||
TemplateDataFactory _dataFactory;
|
||||
|
||||
@Mock
|
||||
VMTemplateZoneDao _templateZoneDao;
|
||||
|
||||
@Mock
|
||||
TemplateDataStoreDao _templateStoreDao;
|
||||
|
||||
@Mock
|
||||
UsageEventDao _usageEventDao;
|
||||
|
||||
@Mock
|
||||
ResourceLimitService _resourceManager;
|
||||
|
||||
@Mock
|
||||
MessageBus _messageBus;
|
||||
|
||||
@Mock
|
||||
AccountDao _accountDao;
|
||||
|
||||
@Mock
|
||||
DataCenterDao _dcDao;
|
||||
|
||||
@Mock
|
||||
ConfigurationDao _configDao;
|
||||
|
||||
@InjectMocks
|
||||
HypervisorTemplateAdapter _adapter;
|
||||
|
||||
//UsageEventUtils reflection abuse helpers
|
||||
private Map<String, Object> oldFields = new HashMap<>();
|
||||
private List<UsageEventVO> usageEvents = new ArrayList<>();
|
||||
|
||||
@Before
|
||||
public void before() {
|
||||
MockitoAnnotations.initMocks(this);
|
||||
}
|
||||
|
||||
public UsageEventUtils setupUsageUtils() throws EventBusException {
|
||||
Mockito.when(_configDao.getValue(eq("publish.usage.events"))).thenReturn("true");
|
||||
Mockito.when(_usageEventDao.persist(Mockito.any(UsageEventVO.class))).then(new Answer<Void>() {
|
||||
@Override public Void answer(InvocationOnMock invocation) throws Throwable {
|
||||
UsageEventVO vo = (UsageEventVO)invocation.getArguments()[0];
|
||||
usageEvents.add(vo);
|
||||
return null;
|
||||
}
|
||||
});
|
||||
|
||||
Mockito.when(_usageEventDao.listAll()).thenReturn(usageEvents);
|
||||
|
||||
doAnswer(new Answer<Void>() {
|
||||
@Override public Void answer(InvocationOnMock invocation) throws Throwable {
|
||||
Event event = (Event)invocation.getArguments()[0];
|
||||
events.add(event);
|
||||
return null;
|
||||
}
|
||||
}).when(_bus).publish(any(Event.class));
|
||||
|
||||
PowerMockito.mockStatic(ComponentContext.class);
|
||||
when(ComponentContext.getComponent(eq(EventBus.class))).thenReturn(_bus);
|
||||
|
||||
UsageEventUtils utils = new UsageEventUtils();
|
||||
|
||||
Map<String, String> usageUtilsFields = new HashMap<String, String>();
|
||||
usageUtilsFields.put("usageEventDao", "_usageEventDao");
|
||||
usageUtilsFields.put("accountDao", "_accountDao");
|
||||
usageUtilsFields.put("dcDao", "_dcDao");
|
||||
usageUtilsFields.put("configDao", "_configDao");
|
||||
|
||||
for (String fieldName : usageUtilsFields.keySet()) {
|
||||
try {
|
||||
Field f = UsageEventUtils.class.getDeclaredField(fieldName);
|
||||
f.setAccessible(true);
|
||||
//Remember the old fields for cleanup later (see cleanupUsageUtils)
|
||||
Field staticField = UsageEventUtils.class.getDeclaredField("s_" + fieldName);
|
||||
staticField.setAccessible(true);
|
||||
oldFields.put(f.getName(), staticField.get(null));
|
||||
f.set(utils,
|
||||
this.getClass()
|
||||
.getDeclaredField(
|
||||
usageUtilsFields.get(fieldName))
|
||||
.get(this));
|
||||
} catch (IllegalArgumentException | IllegalAccessException
|
||||
| NoSuchFieldException | SecurityException e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
|
||||
}
|
||||
try {
|
||||
Method method = UsageEventUtils.class.getDeclaredMethod("init");
|
||||
method.setAccessible(true);
|
||||
method.invoke(utils);
|
||||
} catch (SecurityException | IllegalAccessException
|
||||
| IllegalArgumentException | InvocationTargetException
|
||||
| NoSuchMethodException e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
|
||||
return utils;
|
||||
}
|
||||
|
||||
public void cleanupUsageUtils() {
|
||||
UsageEventUtils utils = new UsageEventUtils();
|
||||
|
||||
for (String fieldName : oldFields.keySet()) {
|
||||
try {
|
||||
Field f = UsageEventUtils.class.getDeclaredField(fieldName);
|
||||
f.setAccessible(true);
|
||||
f.set(utils, oldFields.get(fieldName));
|
||||
} catch (IllegalArgumentException | IllegalAccessException
|
||||
| NoSuchFieldException | SecurityException e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
|
||||
}
|
||||
try {
|
||||
Method method = UsageEventUtils.class.getDeclaredMethod("init");
|
||||
method.setAccessible(true);
|
||||
method.invoke(utils);
|
||||
} catch (SecurityException | NoSuchMethodException
|
||||
| IllegalAccessException | IllegalArgumentException
|
||||
| InvocationTargetException e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testEmitDeleteEventUuid() throws InterruptedException, ExecutionException, EventBusException {
|
||||
//All the mocks required for this test to work.
|
||||
ImageStoreEntity store = mock(ImageStoreEntity.class);
|
||||
when(store.getId()).thenReturn(1l);
|
||||
when(store.getDataCenterId()).thenReturn(1l);
|
||||
when(store.getName()).thenReturn("Test Store");
|
||||
|
||||
TemplateDataStoreVO dataStoreVO = mock(TemplateDataStoreVO.class);
|
||||
when(dataStoreVO.getDownloadState()).thenReturn(Status.DOWNLOADED);
|
||||
|
||||
TemplateInfo info = mock(TemplateInfo.class);
|
||||
when(info.getDataStore()).thenReturn(store);
|
||||
|
||||
VMTemplateVO template = mock(VMTemplateVO.class);
|
||||
when(template.getId()).thenReturn(1l);
|
||||
when(template.getName()).thenReturn("Test Template");
|
||||
when(template.getFormat()).thenReturn(ImageFormat.QCOW2);
|
||||
when(template.getAccountId()).thenReturn(1l);
|
||||
when(template.getUuid()).thenReturn("Test UUID"); //TODO possibly return this from method for comparison, if things work how i want
|
||||
|
||||
TemplateProfile profile = mock(TemplateProfile.class);
|
||||
when(profile.getTemplate()).thenReturn(template);
|
||||
when(profile.getZoneId()).thenReturn(1l);
|
||||
|
||||
TemplateApiResult result = mock(TemplateApiResult.class);
|
||||
when(result.isSuccess()).thenReturn(true);
|
||||
when(result.isFailed()).thenReturn(false);
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
AsyncCallFuture<TemplateApiResult> future = mock(AsyncCallFuture.class);
|
||||
when(future.get()).thenReturn(result);
|
||||
|
||||
AccountVO acct = mock(AccountVO.class);
|
||||
when(acct.getId()).thenReturn(1l);
|
||||
when(acct.getDomainId()).thenReturn(1l);
|
||||
|
||||
when(_templateMgr.getImageStoreByTemplate(anyLong(), anyLong())).thenReturn(Collections.singletonList((DataStore)store));
|
||||
when(_templateStoreDao.listByTemplateStore(anyLong(), anyLong())).thenReturn(Collections.singletonList(dataStoreVO));
|
||||
when(_dataFactory.getTemplate(anyLong(), any(DataStore.class))).thenReturn(info);
|
||||
when(_dataFactory.listTemplateOnCache(anyLong())).thenReturn(Collections.singletonList(info));
|
||||
when(_templateService.deleteTemplateAsync(any(TemplateInfo.class))).thenReturn(future);
|
||||
when(_accountDao.findById(anyLong())).thenReturn(acct);
|
||||
when(_accountDao.findByIdIncludingRemoved(anyLong())).thenReturn(acct);
|
||||
|
||||
//Test actually begins here.
|
||||
setupUsageUtils();
|
||||
|
||||
_adapter.delete(profile);
|
||||
Assert.assertNotNull(usageEvents);
|
||||
Assert.assertNotNull(events);
|
||||
Assert.assertEquals(1, events.size());
|
||||
|
||||
Event event = events.get(0);
|
||||
Assert.assertNotNull(event);
|
||||
Assert.assertNotNull(event.getResourceType());
|
||||
Assert.assertEquals(VirtualMachineTemplate.class.getName(), event.getResourceType());
|
||||
Assert.assertNotNull(event.getResourceUUID());
|
||||
Assert.assertEquals("Test UUID", event.getResourceUUID());
|
||||
Assert.assertEquals(EventTypes.EVENT_TEMPLATE_DELETE, event.getEventType());
|
||||
|
||||
|
||||
cleanupUsageUtils();
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user