Skip to content

Reject creating a snapshot with a duplicate name for the same volume #14089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nagaboinaramgopal wants to merge 2 commits into
base: 4.20
Choose a base branch
from
+64 −0
Open

Reject creating a snapshot with a duplicate name for the same volume #14089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b229715
snapshot: reject a duplicate snapshot name for a volume
nagaboinaramgopal Sep 9, 2026
ca6075e
snapshot: look up a duplicate snapshot name by volume and name
nagaboinaramgopal Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions engine/schema/src/main/java/com/cloud/storage/dao/SnapshotDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ public interface SnapshotDao extends GenericDao<SnapshotVO, Long>, StateDao<Snap

List<SnapshotVO> listByStatusNotIn(long volumeId, Snapshot.State... status);

SnapshotVO findByVolumeIdAndNameNotInStatus(long volumeId, String name, Snapshot.State... status);

/**
* Retrieves a list of snapshots filtered by ids.
* @param ids Snapshot ids.
Expand Down
16 changes: 16 additions & 0 deletions engine/schema/src/main/java/com/cloud/storage/dao/SnapshotDaoImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ public class SnapshotDaoImpl extends GenericDaoBase<SnapshotVO, Long> implements
private SearchBuilder<SnapshotVO> InstanceIdSearch;
private SearchBuilder<SnapshotVO> StatusSearch;
private SearchBuilder<SnapshotVO> notInStatusSearch;
private SearchBuilder<SnapshotVO> volumeIdNameNotInStatusSearch;
private GenericSearchBuilder<SnapshotVO, Long> CountSnapshotsByAccount;
@Inject
ResourceTagDao _tagsDao;
Expand Down Expand Up @@ -159,6 +160,12 @@ protected void init() {
notInStatusSearch.and("status", notInStatusSearch.entity().getState(), SearchCriteria.Op.NOTIN);
notInStatusSearch.done();

volumeIdNameNotInStatusSearch = createSearchBuilder();
volumeIdNameNotInStatusSearch.and("volumeId", volumeIdNameNotInStatusSearch.entity().getVolumeId(), SearchCriteria.Op.EQ);
volumeIdNameNotInStatusSearch.and("name", volumeIdNameNotInStatusSearch.entity().getName(), SearchCriteria.Op.EQ);
volumeIdNameNotInStatusSearch.and("status", volumeIdNameNotInStatusSearch.entity().getState(), SearchCriteria.Op.NOTIN);
volumeIdNameNotInStatusSearch.done();

CountSnapshotsByAccount = createSearchBuilder(Long.class);
CountSnapshotsByAccount.select(null, Func.COUNT, null);
CountSnapshotsByAccount.and("account", CountSnapshotsByAccount.entity().getAccountId(), SearchCriteria.Op.EQ);
Expand Down Expand Up @@ -295,6 +302,15 @@ public List<SnapshotVO> listByStatusNotIn(long volumeId, Snapshot.State... statu
return listBy(sc, null);
}

@Override
public SnapshotVO findByVolumeIdAndNameNotInStatus(long volumeId, String name, Snapshot.State... status) {
SearchCriteria<SnapshotVO> sc = volumeIdNameNotInStatusSearch.create();
sc.setParameters("volumeId", volumeId);
sc.setParameters("name", name);
sc.setParameters("status", (Object[]) status);
return findOneBy(sc);
}

@Override
public List<SnapshotVO> searchByVolumes(List<Long> volumeIds) {
if (CollectionUtils.isEmpty(volumeIds)) {
Expand Down
4 changes: 4 additions & 0 deletions server/src/main/java/com/cloud/storage/snapshot/SnapshotManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1721,6 +1721,10 @@ public Snapshot allocSnapshot(Long volumeId, Long policyId, String snapshotName,
if (snapshotName == null)
snapshotName = vmDisplayName + "_" + volume.getName() + "_" + timeString;

if (_snapshotDao.findByVolumeIdAndNameNotInStatus(volumeId, snapshotName, Snapshot.State.Destroyed, Snapshot.State.Error) != null) {
throw new InvalidParameterValueException(String.format("A snapshot with name [%s] already exists for volume %s.", snapshotName, volume));
}

HypervisorType hypervisorType = HypervisorType.None;
StoragePoolVO storagePool = _storagePoolDao.findById(volume.getDataStore().getId());
if (storagePool.getScope() == ScopeType.ZONE) {
Expand Down
42 changes: 42 additions & 0 deletions server/src/test/java/com/cloud/storage/snapshot/SnapshotManagerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,13 @@
import org.apache.cloudstack.engine.subsystem.api.storage.SnapshotResult;
import org.apache.cloudstack.engine.subsystem.api.storage.SnapshotService;
import org.apache.cloudstack.framework.async.AsyncCallFuture;
import org.apache.cloudstack.context.CallContext;
import org.apache.cloudstack.engine.subsystem.api.storage.VolumeDataFactory;
import org.apache.cloudstack.engine.subsystem.api.storage.VolumeInfo;
import org.apache.cloudstack.storage.datastore.db.PrimaryDataStoreDao;
import org.apache.cloudstack.storage.datastore.db.SnapshotDataStoreDao;
import org.apache.cloudstack.storage.datastore.db.SnapshotDataStoreVO;
import org.apache.cloudstack.storage.datastore.db.StoragePoolVO;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
Expand All @@ -45,10 +50,12 @@
import com.cloud.dc.dao.DataCenterDao;
import com.cloud.event.ActionEventUtils;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.hypervisor.Hypervisor.HypervisorType;
import com.cloud.exception.PermissionDeniedException;
import com.cloud.exception.ResourceUnavailableException;
import com.cloud.org.Grouping;
import com.cloud.storage.DataStoreRole;
import com.cloud.storage.ScopeType;
import com.cloud.storage.Snapshot;
import com.cloud.storage.SnapshotVO;
import com.cloud.storage.VolumeVO;
Expand All @@ -59,8 +66,10 @@
import com.cloud.user.AccountManager;
import com.cloud.user.AccountVO;
import com.cloud.user.ResourceLimitService;
import com.cloud.user.User;
import com.cloud.user.dao.AccountDao;
import com.cloud.utils.Pair;
import com.cloud.vm.dao.UserVmDao;

@RunWith(MockitoJUnitRunner.class)
public class SnapshotManagerImplTest {
Expand All @@ -86,9 +95,42 @@ public class SnapshotManagerImplTest {
SnapshotZoneDao snapshotZoneDao;
@Mock
VolumeDao volumeDao;
@Mock
PrimaryDataStoreDao primaryDataStoreDao;
@Mock
VolumeDataFactory volFactory;
@Mock
UserVmDao userVmDao;
@InjectMocks
SnapshotManagerImpl snapshotManager = new SnapshotManagerImpl();

@Test
public void testAllocSnapshotRejectsDuplicateNameForVolume() {
long volumeId = 1L;
CallContext.register(Mockito.mock(User.class), Mockito.mock(Account.class));
try {
VolumeInfo volume = Mockito.mock(VolumeInfo.class);
Mockito.when(volFactory.getVolume(volumeId)).thenReturn(volume);
DataStore dataStore = Mockito.mock(DataStore.class);
Mockito.when(volume.getDataStore()).thenReturn(dataStore);
Mockito.when(dataStore.getId()).thenReturn(10L);
StoragePoolVO pool = Mockito.mock(StoragePoolVO.class);
Mockito.when(primaryDataStoreDao.findById(10L)).thenReturn(pool);
Mockito.when(pool.getScope()).thenReturn(ScopeType.ZONE);
Mockito.when(pool.getHypervisor()).thenReturn(HypervisorType.None);
Mockito.when(volume.getInstanceId()).thenReturn(null);
Mockito.when(volume.getAccountId()).thenReturn(2L);

Mockito.when(snapshotDao.findByVolumeIdAndNameNotInStatus(volumeId, "dup", Snapshot.State.Destroyed, Snapshot.State.Error))
.thenReturn(Mockito.mock(SnapshotVO.class));

Assert.assertThrows(InvalidParameterValueException.class, () ->
snapshotManager.allocSnapshot(volumeId, Snapshot.MANUAL_POLICY_ID, "dup", null));
} finally {
CallContext.unregister();
}
}

@Test
public void testGetSnapshotZoneImageStoreValid() {
final long snapshotId = 1L;
Expand Down