Skip to content

Storage - Fix ImmutableStorageWithVersioningTests Container Cleanup to Handle Soft-Deleted Blobs and Versions #48716

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
ibrandes wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Storage - Fix ImmutableStorageWithVersioningTests Container Cleanup to Handle Soft-Deleted Blobs and Versions #48716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6119975
disabling test files
ibrandes Apr 7, 2026
889ea51
working cleanup fix
ibrandes Apr 7, 2026
a3cff84
fixing cleanup in sync and async tests
ibrandes Apr 7, 2026
6f89cc9
fixing copy and paste issue
ibrandes Apr 7, 2026
e7e9b14
removing unused import
ibrandes Apr 7, 2026
66419eb
removing unused imports
ibrandes Apr 8, 2026
40a14b2
Merge branch 'main' into storage/fixImmutableStorageWVersioningTests
ibrandes Apr 8, 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
63 changes: 48 additions & 15 deletions ...e-blob/src/test/java/com/azure/storage/blob/ImmutableStorageWithVersioningAsyncTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,15 @@
import com.azure.core.http.HttpResponse;
import com.azure.core.http.policy.BearerTokenAuthenticationPolicy;
import com.azure.core.test.TestMode;
import com.azure.core.util.CoreUtils;
import com.azure.core.util.polling.PollerFlux;
import com.azure.json.JsonProviders;
import com.azure.json.JsonWriter;
import com.azure.storage.blob.models.BlobContainerProperties;
import com.azure.storage.blob.models.BlobCopyInfo;
import com.azure.storage.blob.models.BlobErrorCode;
import com.azure.storage.blob.models.BlobImmutabilityPolicy;
import com.azure.storage.blob.models.BlobImmutabilityPolicyMode;
import com.azure.storage.blob.models.BlobItem;
import com.azure.storage.blob.models.BlobItemProperties;
import com.azure.storage.blob.models.BlobListDetails;
import com.azure.storage.blob.models.BlobProperties;
import com.azure.storage.blob.models.BlobRequestConditions;
Expand Down Expand Up @@ -74,7 +73,6 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.UUID;
import java.util.stream.Stream;

Expand Down Expand Up @@ -155,25 +153,60 @@ public static void cleanupSpec() throws MalformedURLException {
.buildClient();

BlobContainerClient containerClient = cleanupClient.getBlobContainerClient(vlwContainerName);
BlobContainerProperties containerProperties = containerClient.getProperties();

if (containerProperties.getLeaseState() == LeaseStateType.LEASED) {
if (containerClient.getProperties().getLeaseState() == LeaseStateType.LEASED) {
createLeaseClient(containerClient).breakLeaseWithResponse(
new BlobBreakLeaseOptions().setBreakPeriod(Duration.ofSeconds(0)), null, null);
}
if (containerProperties.isImmutableStorageWithVersioningEnabled()) {
ListBlobsOptions options = new ListBlobsOptions()
.setDetails(new BlobListDetails().setRetrieveImmutabilityPolicy(true).setRetrieveLegalHold(true));

// With soft-delete enabled, deleting a blob in a VLW container creates a non-current
// version rather than truly removing it. A basic listBlobs() can't see these leftovers,
// but they still block container deletion (409 Conflict). Listing with versions, deleted
// blobs, and snapshots makes them visible so we can clear policies and delete each one.
// Multiple passes handle new non-current versions surfaced by prior deletions.
ListBlobsOptions options = new ListBlobsOptions().setDetails(new BlobListDetails().setRetrieveVersions(true)
.setRetrieveDeletedBlobs(true)
.setRetrieveDeletedBlobsWithVersions(true)
.setRetrieveSnapshots(true));

for (int round = 0; round < 5; round++) {
boolean found = false;
for (BlobItem blob : containerClient.listBlobs(options, null)) {
BlobClient blobClient = containerClient.getBlobClient(blob.getName());
BlobItemProperties blobProperties = blob.getProperties();
if (Objects.equals(true, blobProperties.hasLegalHold())) {
blobClient.setLegalHold(false);
found = true;
BlobClient baseClient = containerClient.getBlobClient(blob.getName());
BlobClient targetClient;

if (blob.getSnapshot() != null) {
targetClient = baseClient.getSnapshotClient(blob.getSnapshot());
} else if (!CoreUtils.isNullOrEmpty(blob.getVersionId())
&& !Boolean.TRUE.equals(blob.isCurrentVersion())) {
targetClient = baseClient.getVersionClient(blob.getVersionId());
} else {
targetClient = baseClient;
}

// Unconditionally clear legal holds and immutability policies. Errors are
// expected for soft-deleted blobs or blobs that don't have these set.
try {
targetClient.setLegalHold(false);
} catch (BlobStorageException ignored) {
}
if (blobProperties.getImmutabilityPolicy().getPolicyMode() != null) {
blobClient.deleteImmutabilityPolicy();
try {
targetClient.deleteImmutabilityPolicy();
} catch (BlobStorageException ignored) {
}
blobClient.delete();
// Deleting the current version by version ID returns 403
// (OperationNotAllowedOnRootBlob); fall back to base blob URL.
try {
targetClient.deleteIfExists();
} catch (BlobStorageException e) {
if (e.getStatusCode() == 403) {
baseClient.deleteIfExists();
}
}
Comment thread
ibrandes marked this conversation as resolved.
}
if (!found) {
break;
}
}

Expand Down
61 changes: 47 additions & 14 deletions ...torage-blob/src/test/java/com/azure/storage/blob/ImmutableStorageWithVersioningTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
import com.azure.storage.blob.models.BlobImmutabilityPolicy;
import com.azure.storage.blob.models.BlobImmutabilityPolicyMode;
import com.azure.storage.blob.models.BlobItem;
import com.azure.storage.blob.models.BlobItemProperties;
import com.azure.storage.blob.models.BlobLegalHoldResult;
import com.azure.storage.blob.models.BlobListDetails;
import com.azure.storage.blob.models.BlobProperties;
Expand Down Expand Up @@ -80,7 +79,6 @@
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import java.util.stream.Stream;

import static org.junit.jupiter.api.Assertions.assertEquals;
Expand Down Expand Up @@ -158,25 +156,60 @@ public static void cleanupSpec() throws MalformedURLException {
.buildClient();

BlobContainerClient containerClient = cleanupClient.getBlobContainerClient(vlwContainerName);
BlobContainerProperties containerProperties = containerClient.getProperties();

if (containerProperties.getLeaseState() == LeaseStateType.LEASED) {
if (containerClient.getProperties().getLeaseState() == LeaseStateType.LEASED) {
createLeaseClient(containerClient).breakLeaseWithResponse(
new BlobBreakLeaseOptions().setBreakPeriod(Duration.ofSeconds(0)), null, null);
}
if (containerProperties.isImmutableStorageWithVersioningEnabled()) {
ListBlobsOptions options = new ListBlobsOptions()
.setDetails(new BlobListDetails().setRetrieveImmutabilityPolicy(true).setRetrieveLegalHold(true));

// With soft-delete enabled, deleting a blob in a VLW container creates a non-current
// version rather than truly removing it. A basic listBlobs() can't see these leftovers,
// but they still block container deletion (409 Conflict). Listing with versions, deleted
// blobs, and snapshots makes them visible so we can clear policies and delete each one.
// Multiple passes handle new non-current versions surfaced by prior deletions.
ListBlobsOptions options = new ListBlobsOptions().setDetails(new BlobListDetails().setRetrieveVersions(true)
.setRetrieveDeletedBlobs(true)
.setRetrieveDeletedBlobsWithVersions(true)
.setRetrieveSnapshots(true));

for (int round = 0; round < 5; round++) {
boolean found = false;
for (BlobItem blob : containerClient.listBlobs(options, null)) {
BlobClient blobClient = containerClient.getBlobClient(blob.getName());
BlobItemProperties blobProperties = blob.getProperties();
if (Objects.equals(true, blobProperties.hasLegalHold())) {
blobClient.setLegalHold(false);
found = true;
BlobClient baseClient = containerClient.getBlobClient(blob.getName());
BlobClient targetClient;

if (blob.getSnapshot() != null) {
targetClient = baseClient.getSnapshotClient(blob.getSnapshot());
} else if (!CoreUtils.isNullOrEmpty(blob.getVersionId())
&& !Boolean.TRUE.equals(blob.isCurrentVersion())) {
Comment thread
ibrandes marked this conversation as resolved.
targetClient = baseClient.getVersionClient(blob.getVersionId());
} else {
targetClient = baseClient;
}

// Unconditionally clear legal holds and immutability policies. Errors are
// expected for soft-deleted blobs or blobs that don't have these set.
try {
targetClient.setLegalHold(false);
} catch (BlobStorageException ignored) {
}
if (blobProperties.getImmutabilityPolicy().getPolicyMode() != null) {
blobClient.deleteImmutabilityPolicy();
try {
targetClient.deleteImmutabilityPolicy();
} catch (BlobStorageException ignored) {
}
blobClient.delete();
// Deleting the current version by version ID returns 403
// (OperationNotAllowedOnRootBlob); fall back to base blob URL.
try {
targetClient.deleteIfExists();
} catch (BlobStorageException e) {
if (e.getStatusCode() == 403) {
baseClient.deleteIfExists();
Comment thread
ibrandes marked this conversation as resolved.
}
}
}
if (!found) {
break;
}
}

Expand Down