Skip to content

Ensure index is copied as blob #196

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

Merged
jonesbusy merged 1 commit into from
Mar 5, 2025
Merged

Ensure index is copied as blob #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions src/main/java/land/oras/Registry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,14 @@ public Manifest pushArtifact(
private void writeIndex(Index index, Path folder) throws IOException {
Path indexFile = folder.resolve(Const.OCI_LAYOUT_INDEX);
Files.writeString(indexFile, index.getJson() != null ? index.getJson() : index.toJson());
if (index.getJson() != null) {
Path blobs = folder.resolve(Const.OCI_LAYOUT_BLOBS);
String indexDigest = index.getDescriptor().getDigest();
SupportedAlgorithm manifestAlgorithm = SupportedAlgorithm.fromDigest(indexDigest);
Files.writeString(
blobs.resolve(manifestAlgorithm.getPrefix()).resolve(SupportedAlgorithm.getDigest(indexDigest)),
index.getJson());
}
}

private void writeManifest(Manifest manifest, Path folder) throws IOException {
Expand Down
81 changes: 71 additions & 10 deletions src/test/java/land/oras/RegistryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,11 +592,29 @@ void testNotFailToPullArtifactFromImage() {
}

@Test
void testShouldCopyImageIntoOciLayout() throws IOException {
Registry registry = Registry.Builder.builder().defaults().build();
void testShouldCopyImageIntoOciLayoutWithoutIndex() {

// Use zot image
ContainerRef containerRef = ContainerRef.parse("ghcr.io/project-zot/zot-linux-amd64");
Registry registry = Registry.Builder.builder()
.defaults("myuser", "mypass")
.withInsecure(true)
.build();

ContainerRef containerRef =
ContainerRef.parse("%s/library/image-no-index".formatted(this.registry.getRegistry()));

Layer layer1 = registry.pushBlob(containerRef, Layer.empty().getDataBytes());
Layer layer2 = registry.pushBlob(containerRef, "foobar".getBytes());

Manifest emptyManifest = Manifest.empty()
.withLayers(List.of(Layer.fromDigest(layer1.getDigest(), 2), Layer.fromDigest(layer2.getDigest(), 6)));
String manifestDigest =
SupportedAlgorithm.SHA256.digest(emptyManifest.toJson().getBytes(StandardCharsets.UTF_8));
String configDigest =
SupportedAlgorithm.SHA256.digest(Config.empty().toJson().getBytes(StandardCharsets.UTF_8));

// Push config and manifest
registry.pushConfig(containerRef.withDigest(configDigest), Config.empty());
Manifest pushedManifest = registry.pushManifest(containerRef, emptyManifest);

// Copy to oci layout
registry.copy(containerRef, ociLayout);
Expand All @@ -608,10 +626,48 @@ void testShouldCopyImageIntoOciLayout() throws IOException {

// Check index exists
assertTrue(Files.exists(ociLayout.resolve("index.json")));
Index index = JsonUtils.fromJson(ociLayout.resolve("index.json"), Index.class);
assertEquals(2, index.getSchemaVersion());
assertEquals(1, index.getManifests().size());
assertEquals(Const.DEFAULT_INDEX_MEDIA_TYPE, index.getMediaType());
JsonUtils.fromJson(ociLayout.resolve("index.json"), Index.class);

// Check manifest exists
assertTrue(Files.exists(ociLayout
.resolve("blobs")
.resolve("sha256")
.resolve(SupportedAlgorithm.getDigest(
pushedManifest.getDescriptor().getDigest()))));

// Ensure manifest serialized correctly (check sha256)
String computedManifestDigest = DigestUtils.digest(
"sha256",
ociLayout
.resolve("blobs")
.resolve("sha256")
.resolve(SupportedAlgorithm.getDigest(
pushedManifest.getDescriptor().getDigest())));
assertEquals(
SupportedAlgorithm.getDigest(pushedManifest.getDescriptor().getDigest()),
SupportedAlgorithm.getDigest(computedManifestDigest),
"Manifest digest should match");

// Ensure layer1 is copied
assertTrue(Files.exists(ociLayout
.resolve("blobs")
.resolve("sha256")
.resolve(SupportedAlgorithm.getDigest(layer1.getDigest()))));
// Ensure layer2 is copied
assertTrue(Files.exists(ociLayout
.resolve("blobs")
.resolve("sha256")
.resolve(SupportedAlgorithm.getDigest(layer2.getDigest()))));

// Copy to oci layout again
registry.copy(containerRef, ociLayout);

// Check manifest exists
assertTrue(Files.exists(ociLayout
.resolve("blobs")
.resolve("sha256")
.resolve(SupportedAlgorithm.getDigest(
pushedManifest.getDescriptor().getDigest()))));
}

@Test
Expand All @@ -638,7 +694,7 @@ void testShouldCopyImageIntoOciLayoutWithIndex() {
// Push config and manifest
registry.pushConfig(containerRef.withDigest(configDigest), Config.empty());
Manifest pushedManifest = registry.pushManifest(containerRef.withDigest(manifestDigest), emptyManifest);
registry.pushIndex(containerRef, Index.fromManifests(List.of(pushedManifest.getDescriptor())));
Index index = registry.pushIndex(containerRef, Index.fromManifests(List.of(pushedManifest.getDescriptor())));

// Copy to oci layout
registry.copy(containerRef, ociLayoutWithIndex);
Expand All @@ -650,7 +706,7 @@ void testShouldCopyImageIntoOciLayoutWithIndex() {

// Check index exists
assertTrue(Files.exists(ociLayoutWithIndex.resolve("index.json")));
Index index = JsonUtils.fromJson(ociLayoutWithIndex.resolve("index.json"), Index.class);
JsonUtils.fromJson(ociLayoutWithIndex.resolve("index.json"), Index.class);
assertEquals(2, index.getSchemaVersion());
assertEquals(1, index.getManifests().size());
assertEquals(Const.DEFAULT_INDEX_MEDIA_TYPE, index.getMediaType());
Expand Down Expand Up @@ -685,6 +741,11 @@ void testShouldCopyImageIntoOciLayoutWithIndex() {
.resolve("blobs")
.resolve("sha256")
.resolve(SupportedAlgorithm.getDigest(layer2.getDigest()))));
// Ensure index is also copied as blob
assertTrue(Files.exists(ociLayoutWithIndex
.resolve("blobs")
.resolve("sha256")
.resolve(SupportedAlgorithm.getDigest(index.getDescriptor().getDigest()))));

// Copy to oci layout again
registry.copy(containerRef, ociLayoutWithIndex);
Expand Down