-
Notifications
You must be signed in to change notification settings - Fork 34
refactor: create dedicated TufGsonSupplier #1287
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
Draft
Changes from all commits
Commits
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
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
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
66 changes: 66 additions & 0 deletions
66
sigstore-java/src/main/java/dev/sigstore/tuf/json/TufGsonSupplier.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,66 @@ | ||
| /* | ||
| * Copyright 2026 The Sigstore Authors. | ||
| * | ||
| * 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 dev.sigstore.tuf.json; | ||
|
|
||
| import com.google.gson.GsonBuilder; | ||
| import com.google.gson.JsonDeserializer; | ||
| import dev.sigstore.forbidden.SuppressForbidden; | ||
| import dev.sigstore.json.GsonByteArrayAdapter; | ||
| import dev.sigstore.json.GsonChecked; | ||
| import dev.sigstore.tuf.model.*; | ||
| import java.time.LocalDateTime; | ||
| import java.time.ZonedDateTime; | ||
| import java.util.function.Supplier; | ||
|
|
||
| /** Supplies a Gson with custom byte to base64 serialization, configured for TUF models. */ | ||
| @SuppressForbidden(reason = "GsonBuilder") | ||
| public enum TufGsonSupplier implements Supplier<GsonChecked> { | ||
| TUF_GSON; | ||
|
|
||
| @SuppressWarnings("ImmutableEnumChecker") | ||
| private final GsonChecked gson = | ||
| new GsonChecked( | ||
| new GsonBuilder() | ||
| .registerTypeAdapter(byte[].class, new GsonByteArrayAdapter()) | ||
| .registerTypeAdapter( | ||
| LocalDateTime.class, | ||
| (JsonDeserializer<LocalDateTime>) | ||
| (json, type, jsonDeserializationContext) -> | ||
| ZonedDateTime.parse(json.getAsJsonPrimitive().getAsString()) | ||
| .toLocalDateTime()) | ||
| // Immutables generated GSON Adapters in alphabetical order | ||
| .registerTypeAdapterFactory(new GsonAdaptersDelegations()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersDelegationRole()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersHashes()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersKey()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersRoot()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersRootMeta()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersRootRole()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersSignature()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersSnapshot()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersSnapshotMeta()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersTargets()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersTargetMeta()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersTimestamp()) | ||
| .registerTypeAdapterFactory(new GsonAdaptersTimestampMeta()) | ||
| .disableHtmlEscaping() | ||
| .create()); | ||
|
|
||
| @Override | ||
| public GsonChecked get() { | ||
| return gson; | ||
| } | ||
| } |
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
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
67 changes: 67 additions & 0 deletions
67
sigstore-java/src/test/java/dev/sigstore/tuf/json/TufGsonSupplierTest.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,67 @@ | ||
| /* | ||
| * Copyright 2026 The Sigstore Authors. | ||
| * | ||
| * 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 dev.sigstore.tuf.json; | ||
|
|
||
| import static dev.sigstore.tuf.json.TufGsonSupplier.TUF_GSON; | ||
|
|
||
| import dev.sigstore.json.GsonChecked; | ||
| import dev.sigstore.json.JsonParseException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.time.LocalDateTime; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class TufGsonSupplierTest { | ||
|
aaronlew02 marked this conversation as resolved.
|
||
| private final GsonChecked gson = TUF_GSON.get(); | ||
|
|
||
| @Test | ||
| public void testWrite() { | ||
| Assertions.assertEquals("\"YWJjZA==\"", gson.toJson("abcd".getBytes(StandardCharsets.UTF_8))); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRead() throws Exception { | ||
| Assertions.assertArrayEquals( | ||
| "abcd".getBytes(StandardCharsets.UTF_8), gson.fromJson("\"YWJjZA==\"", byte[].class)); | ||
| Assertions.assertArrayEquals(new byte[] {}, gson.fromJson("\"\"", byte[].class)); | ||
| Assertions.assertArrayEquals(new byte[] {}, gson.fromJson("null", byte[].class)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testReadException() { | ||
| try { | ||
| gson.fromJson("%", byte[].class); | ||
| Assertions.fail("Expected JsonParseException but got nothing"); | ||
| } catch (JsonParseException e) { | ||
| // pass | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testLocalDateTime_read() throws Exception { | ||
| var expected = LocalDateTime.of(2023, 1, 12, 18, 22, 2); | ||
| Assertions.assertEquals( | ||
| expected, gson.fromJson("\"2023-01-12T18:22:02Z\"", LocalDateTime.class)); | ||
| Assertions.assertEquals( | ||
| expected, gson.fromJson("\"2023-01-12T18:22:02+00:00\"", LocalDateTime.class)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testLocalDateTime_readException() { | ||
| Assertions.assertThrows( | ||
| JsonParseException.class, () -> gson.fromJson("\"not-a-date\"", LocalDateTime.class)); | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.