-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat(storage): add checksum validation in the json read channel #13270
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.
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
Draft
nidhiii-27
wants to merge
2
commits into
default-checksum-json-read
Choose a base branch
from
read-channel-checksumming
base: default-checksum-json-read
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+172
−4
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
136 changes: 136 additions & 0 deletions
136
...orage/src/test/java/com/google/cloud/storage/ApiaryUnbufferedReadableByteChannelTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Licensed 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.google.cloud.storage; | ||
|
|
||
| import static org.junit.Assert.assertArrayEquals; | ||
| import static org.junit.Assert.assertThrows; | ||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| import com.google.api.client.http.HttpTransport; | ||
| import com.google.api.client.json.gson.GsonFactory; | ||
| import com.google.api.client.testing.http.MockLowLevelHttpResponse; | ||
| import com.google.api.core.SettableApiFuture; | ||
| import com.google.api.services.storage.Storage; | ||
| import com.google.api.services.storage.model.StorageObject; | ||
| import com.google.cloud.storage.ApiaryUnbufferedReadableByteChannel.ApiaryReadRequest; | ||
| import com.google.cloud.storage.Retrying.RetrierWithAlg; | ||
| import com.google.common.collect.ImmutableMap; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.IOException; | ||
| import java.nio.ByteBuffer; | ||
| import java.nio.channels.Channels; | ||
| import java.nio.channels.WritableByteChannel; | ||
| import org.junit.Test; | ||
|
|
||
| public class ApiaryUnbufferedReadableByteChannelTest { | ||
|
|
||
| private static final byte[] CONTENT_BYTES = "Hello, World!".getBytes(); | ||
| private static final String CORRECT_CRC32C_BASE64 = "TVUQaA=="; | ||
| private static final String WRONG_CRC32C_BASE64 = "AAAAAA=="; | ||
|
|
||
| private Storage createMockStorageClient(String googHashHeader) { | ||
| HttpTransport transport = | ||
| new HttpTransport() { | ||
| @Override | ||
| protected com.google.api.client.http.LowLevelHttpRequest buildRequest( | ||
| String method, String url) throws IOException { | ||
| return new com.google.api.client.testing.http.MockLowLevelHttpRequest() { | ||
| @Override | ||
| public com.google.api.client.http.LowLevelHttpResponse execute() throws IOException { | ||
| MockLowLevelHttpResponse lowLevelResponse = | ||
| new MockLowLevelHttpResponse() | ||
| .setContent(CONTENT_BYTES) | ||
| .setContentLength(CONTENT_BYTES.length) | ||
| .addHeader("Content-Length", String.valueOf(CONTENT_BYTES.length)) | ||
| .addHeader("x-goog-generation", "12345"); | ||
| if (googHashHeader != null) { | ||
| lowLevelResponse.addHeader("x-goog-hash", googHashHeader); | ||
| } | ||
| return lowLevelResponse; | ||
| } | ||
| }; | ||
| } | ||
| }; | ||
| return new Storage.Builder(transport, GsonFactory.getDefaultInstance(), null) | ||
| .setApplicationName("test") | ||
| .build(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRead_successfulCrc32cValidation() throws IOException { | ||
| Storage storageClient = createMockStorageClient("crc32c=" + CORRECT_CRC32C_BASE64); | ||
|
|
||
| StorageObject from = new StorageObject().setBucket("bucket").setName("blob"); | ||
| ApiaryReadRequest apiaryReadRequest = | ||
| new ApiaryReadRequest(from, ImmutableMap.of(), ByteRangeSpec.nullRange()); | ||
|
|
||
| SettableApiFuture<StorageObject> resultFuture = SettableApiFuture.create(); | ||
| try (ApiaryUnbufferedReadableByteChannel channel = | ||
| new ApiaryUnbufferedReadableByteChannel( | ||
| apiaryReadRequest, | ||
| storageClient, | ||
| resultFuture, | ||
| RetrierWithAlg.attemptOnce(), | ||
| Retrying.neverRetry(), | ||
| Hasher.defaultHasher()); ) { | ||
|
|
||
| ByteArrayOutputStream out = new ByteArrayOutputStream(); | ||
| try (WritableByteChannel w = Channels.newChannel(out)) { | ||
| ByteBuffer buf = ByteBuffer.allocate(4096); | ||
| while (channel.read(new ByteBuffer[] {buf}, 0, 1) != -1) { | ||
| buf.flip(); | ||
| w.write(buf); | ||
| buf.clear(); | ||
| } | ||
| } | ||
|
|
||
| assertArrayEquals(CONTENT_BYTES, out.toByteArray()); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testRead_mismatchedCrc32cValidation_throwsChecksumMismatch() throws IOException { | ||
| Storage storageClient = createMockStorageClient("crc32c=" + WRONG_CRC32C_BASE64); | ||
|
|
||
| StorageObject from = new StorageObject().setBucket("bucket").setName("blob"); | ||
| ApiaryReadRequest apiaryReadRequest = | ||
| new ApiaryReadRequest(from, ImmutableMap.of(), ByteRangeSpec.nullRange()); | ||
|
|
||
| SettableApiFuture<StorageObject> resultFuture = SettableApiFuture.create(); | ||
| try (ApiaryUnbufferedReadableByteChannel channel = | ||
| new ApiaryUnbufferedReadableByteChannel( | ||
| apiaryReadRequest, | ||
| storageClient, | ||
| resultFuture, | ||
| RetrierWithAlg.attemptOnce(), | ||
| Retrying.neverRetry(), | ||
| Hasher.defaultHasher()); ) { | ||
|
|
||
| ByteBuffer buf = ByteBuffer.allocate(4096); | ||
| Hasher.ChecksumMismatchException expected = | ||
| assertThrows( | ||
| Hasher.ChecksumMismatchException.class, | ||
| () -> { | ||
| while (channel.read(new ByteBuffer[] {buf}, 0, 1) != -1) { | ||
| buf.clear(); | ||
| } | ||
| }); | ||
|
|
||
| assertTrue(expected.getMessage().contains("Mismatch checksum value")); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.