Skip to content
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

Add tests for error handling and retry scenarios in RegistryWireMockTest #165

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
90 changes: 90 additions & 0 deletions src/test/java/land/oras/RegistryWireMockTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,23 @@
package land.oras;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
import com.github.tomakehurst.wiremock.junit5.WireMockTest;
import com.github.tomakehurst.wiremock.stubbing.Scenario;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import land.oras.auth.FileStoreAuthenticationProvider;
import land.oras.auth.UsernamePasswordProvider;
import land.oras.credentials.FileStore;
import land.oras.exception.OrasException;
import land.oras.utils.JsonUtils;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
Expand Down Expand Up @@ -146,4 +151,89 @@ void shouldListTagsWithFileStoreAuth(WireMockRuntimeInfo wmRuntimeInfo) throws I
assertEquals("latest", tags.get(0));
assertEquals("0.1.1", tags.get(1));
}

// Errors from registry
@Test
void shouldHandle500Error(WireMockRuntimeInfo wmRuntimeInfo) {
WireMock wireMock = wmRuntimeInfo.getWireMock();
String registryUrl = wmRuntimeInfo.getHttpBaseUrl().replace("http://", "");

// Register the wiremock
wireMock.register(WireMock.get(WireMock.urlEqualTo("/v2/library/error-artifact/tags/list"))
.willReturn(WireMock.serverError().withBody("Internal Server Error")));
Registry registry = Registry.Builder.builder().withInsecure(true).build();

// Now we should have a reference to container
ContainerRef ref = ContainerRef.parse("%s/library/error-artifact".formatted(registryUrl));

// Get exception and assert
OrasException exception = assertThrows(OrasException.class, () -> registry.getTags(ref));
assertEquals(500, exception.getStatusCode());
}

// Timeout with similar structure as previous test and request 408 with different artifact name
@Test
void shouldHandleTimeout(WireMockRuntimeInfo wmRuntimeInfo) {
WireMock wireMock = wmRuntimeInfo.getWireMock();
String registryUrl = wmRuntimeInfo.getHttpBaseUrl().replace("http://", "");

// Using here a unique container reference to avoid conflicts when running in parallel
ContainerRef ref = ContainerRef.parse("%s/library/timeout-artifact".formatted(registryUrl));

// We Set up the stub for the timeout scenario
wireMock.register(WireMock.get(WireMock.urlEqualTo("/v2/library/timeout-artifact/tags/list"))
.willReturn(WireMock.aResponse().withStatus(408).withBody("Request timed out")));

Registry registry = Registry.Builder.builder().withInsecure(true).build();

OrasException exception = assertThrows(OrasException.class, () -> registry.getTags(ref));
assertEquals(408, exception.getStatusCode());
}

// Blob retries and then upload
@Test
void shouldRetryBlobUpload(WireMockRuntimeInfo wmRuntimeInfo) throws IOException {
WireMock wireMock = wmRuntimeInfo.getWireMock();
String registryUrl = wmRuntimeInfo.getHttpBaseUrl().replace("http://", "");
String uploadUrl = "/v2/library/artifact-text/blobs/uploads/";

// First request fails and at last line we set state to upload success
wireMock.register(WireMock.post(WireMock.urlEqualTo(uploadUrl))
.inScenario("upload scenario")
.whenScenarioStateIs(Scenario.STARTED)
.willReturn(WireMock.serverError())
.willSetStateTo("upload success"));

// Second request succeeds
wireMock.register(WireMock.post(WireMock.urlEqualTo(uploadUrl))
.inScenario("upload scenario")
.whenScenarioStateIs("upload success")
.willReturn(WireMock.aResponse().withStatus(202).withHeader("Location", uploadUrl + "12345")));

wireMock.register(
WireMock.put(WireMock.urlMatching(uploadUrl + "12345.*")).willReturn(WireMock.created()));

Registry registry = Registry.Builder.builder().withInsecure(true).build();
ContainerRef ref = ContainerRef.parse("%s/library/artifact-text".formatted(registryUrl));

// Prepare test file
Path testFile = Files.createTempFile("test-data-", ".tmp");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Must use

    @TempDir
    private Path tempDir;

To ensure directory is cleanup after tests

Files.writeString(testFile, "Test Content");

try {
// Now we assert that the first attempt fails
try (InputStream inputStream = Files.newInputStream(testFile)) {
assertThrows(
OrasException.class, () -> registry.pushBlobStream(ref, inputStream, Files.size(testFile)));
}
// Second attempt should succeed
try (InputStream inputStream = Files.newInputStream(testFile)) {
Layer layer = registry.pushBlobStream(ref, inputStream, Files.size(testFile));
assertNotNull(layer);
}

} finally {
Files.delete(testFile);
}
}
}