Skip to content

chore: add tests for object contexts samples #3347

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

chore: add tests for object contexts samples #3347

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cceee4e
chore: add tests for object contexts samples
nidhiii-27 Oct 13, 2025
fd03bf2
chore: correct lint errors
nidhiii-27 Oct 13, 2025
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
76 changes: 76 additions & 0 deletions samples/snippets/src/test/java/com/example/storage/ITObjectSnippets.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@
import com.example.storage.object.GenerateEncryptionKey;
import com.example.storage.object.GenerateV4GetObjectSignedUrl;
import com.example.storage.object.GenerateV4PutObjectSignedUrl;
import com.example.storage.object.GetObjectContexts;
import com.example.storage.object.GetObjectMetadata;
import com.example.storage.object.ListObjectContexts;
import com.example.storage.object.ListObjects;
import com.example.storage.object.ListObjectsWithOldVersions;
import com.example.storage.object.ListObjectsWithPrefix;
Expand All @@ -52,6 +54,7 @@
import com.example.storage.object.MakeObjectPublic;
import com.example.storage.object.RestoreSoftDeletedObject;
import com.example.storage.object.RotateObjectEncryptionKey;
import com.example.storage.object.SetObjectContexts;
import com.example.storage.object.SetObjectMetadata;
import com.example.storage.object.SetObjectRetentionPolicy;
import com.example.storage.object.StreamObjectDownload;
Expand All @@ -65,6 +68,8 @@
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.BlobInfo;
import com.google.cloud.storage.BlobInfo.ObjectContexts;
import com.google.cloud.storage.BlobInfo.ObjectCustomContextPayload;
import com.google.cloud.storage.Bucket;
import com.google.cloud.storage.BucketInfo;
import com.google.cloud.storage.BucketInfo.IamConfiguration;
Expand All @@ -79,6 +84,7 @@
import com.google.cloud.storage.it.runner.annotations.Inject;
import com.google.cloud.storage.it.runner.registry.KmsFixture;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import com.google.common.io.BaseEncoding;
import java.io.File;
import java.io.IOException;
Expand All @@ -89,6 +95,7 @@
import java.nio.file.Path;
import java.time.Duration;
import java.util.Date;
import java.util.Map;
import java.util.Random;
import javax.net.ssl.HttpsURLConnection;
import org.junit.Assert;
Expand Down Expand Up @@ -630,4 +637,73 @@ public void testRestoreSoftDeletedObject() throws Exception {
assertNotNull(storage.get(BlobId.of(bucketName, blob)));
}
}

@Test
public void testSetObjectContexts() throws Exception {
String blobName = generator.randomObjectName();
String key = "test-key-get";
String value = "test-value-get";

Blob initialBlob = storage.create(info(blobName), CONTENT, BlobTargetOption.doesNotExist());

SetObjectContexts.setObjectContexts(
GOOGLE_CLOUD_PROJECT, bucket.getName(), blobName, key, value);
String setOutput = stdOut.getCapturedOutputAsUtf8String();
assertThat(setOutput).contains("Updated custom contexts for object " + blobName);

Blob updatedBlob = storage.get(bucket.getName(), blobName);
assertThat(updatedBlob.getContexts().getCustom().get(key).getValue()).isEqualTo(value);
}

@Test
public void testGetObjectContexts() throws Exception {
String blobName = generator.randomObjectName();
String key = "test-key-get";
String value = "test-value-get";

storage.create(info(blobName), CONTENT, BlobTargetOption.doesNotExist());

ObjectCustomContextPayload payload =
ObjectCustomContextPayload.newBuilder().setValue(value).build();
Map<String, ObjectCustomContextPayload> custom = Maps.newHashMap();
custom.put(key, payload);
ObjectContexts contexts = ObjectContexts.newBuilder().setCustom(custom).build();
BlobInfo pendingUpdate =
storage.get(bucket.getName(), blobName).toBuilder().setContexts(contexts).build();
storage.update(pendingUpdate);

GetObjectContexts.getObjectContexts(GOOGLE_CLOUD_PROJECT, bucket.getName(), blobName);

String getOutput = stdOut.getCapturedOutputAsUtf8String();

assertThat(getOutput).contains("Custom Contexts:");
assertThat(getOutput).contains(key + "=ObjectCustomContextPayload{");
assertThat(getOutput).contains("value=" + value);
}

@Test
public void testListObjectContexts() throws Exception {
String blobName = generator.randomObjectName();
String key = "test-key-list";
String value = "test-value-list";

storage.create(info(blobName), CONTENT, BlobTargetOption.doesNotExist());

ObjectCustomContextPayload payload =
ObjectCustomContextPayload.newBuilder().setValue(value).build();
Map<String, ObjectCustomContextPayload> custom = Maps.newHashMap();
custom.put(key, payload);
ObjectContexts contexts = ObjectContexts.newBuilder().setCustom(custom).build();
BlobInfo pendingUpdate =
storage.get(bucket.getName(), blobName).toBuilder().setContexts(contexts).build();
storage.update(pendingUpdate);

ListObjectContexts.listObjectContexts(GOOGLE_CLOUD_PROJECT, bucket.getName(), key);
String listOutput = stdOut.getCapturedOutputAsUtf8String();

assertThat(listOutput).contains("gs://" + bucket.getName() + "/" + blobName);

assertThat(listOutput)
.contains("Listing objects for bucket: " + bucket.getName() + "with context key: " + key);
}
}