-
Notifications
You must be signed in to change notification settings - Fork 1k
fix(docker): fix retrofit2 docker client which is replacing ? with %3F causing api failure
#6354
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
0f7e209
test(docker): add two test classes, one to demonstrate how real docke…
kirangodishala 5e32a8a
fix(docker): fix the issue of retrofit2 replacing `?` with `%3F` caus…
kirangodishala 9240756
fix(docker): address review comments on the fix to the issue of retro…
kirangodishala 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
205 changes: 205 additions & 0 deletions
205
...netflix/spinnaker/clouddriver/docker/registry/api/v2/client/DockerRegistryClientTest.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,205 @@ | ||
| /* | ||
| * Copyright 2025 OpsMx, Inc. | ||
| * | ||
| * 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.netflix.spinnaker.clouddriver.docker.registry.api.v2.client; | ||
|
|
||
| import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; | ||
| import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching; | ||
| import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertIterableEquals; | ||
| import static org.mockito.ArgumentMatchers.anyString; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.github.tomakehurst.wiremock.client.WireMock; | ||
| import com.github.tomakehurst.wiremock.junit5.WireMockExtension; | ||
| import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.auth.DockerBearerToken; | ||
| import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.auth.DockerBearerTokenService; | ||
| import com.netflix.spinnaker.config.DefaultServiceClientProvider; | ||
| import com.netflix.spinnaker.config.okhttp3.DefaultOkHttpClientBuilderProvider; | ||
| import com.netflix.spinnaker.config.okhttp3.OkHttpClientProvider; | ||
| import com.netflix.spinnaker.kork.client.ServiceClientProvider; | ||
| import com.netflix.spinnaker.kork.retrofit.ErrorHandlingExecutorCallAdapterFactory; | ||
| import com.netflix.spinnaker.kork.retrofit.Retrofit2ServiceFactory; | ||
| import com.netflix.spinnaker.kork.retrofit.Retrofit2ServiceFactoryAutoConfiguration; | ||
| import com.netflix.spinnaker.okhttp.OkHttpClientConfigurationProperties; | ||
| import java.util.Arrays; | ||
| import java.util.Map; | ||
| import okhttp3.OkHttpClient; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
| import org.mockito.Mockito; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.boot.test.context.SpringBootTest; | ||
| import org.springframework.boot.test.mock.mockito.MockBean; | ||
| import org.springframework.http.HttpStatus; | ||
| import retrofit2.Retrofit; | ||
| import retrofit2.converter.jackson.JacksonConverterFactory; | ||
|
|
||
| @SpringBootTest( | ||
| classes = { | ||
| OkHttpClientConfigurationProperties.class, | ||
| Retrofit2ServiceFactory.class, | ||
| ServiceClientProvider.class, | ||
| OkHttpClientProvider.class, | ||
| OkHttpClient.class, | ||
| DefaultServiceClientProvider.class, | ||
| DefaultOkHttpClientBuilderProvider.class, | ||
| Retrofit2ServiceFactoryAutoConfiguration.class, | ||
| ObjectMapper.class | ||
| }, | ||
| webEnvironment = SpringBootTest.WebEnvironment.NONE) | ||
| public class DockerRegistryClientTest { | ||
|
|
||
| @RegisterExtension | ||
| static WireMockExtension wmDockerRegistry = | ||
| WireMockExtension.newInstance().options(wireMockConfig().dynamicPort()).build(); | ||
|
|
||
| static DockerRegistryClient.DockerRegistryService dockerRegistryService; | ||
| @MockBean DockerBearerTokenService dockerBearerTokenService; | ||
| static DockerRegistryClient dockerRegistryClient; | ||
| @Autowired ServiceClientProvider serviceClientProvider; | ||
| ObjectMapper objectMapper = new ObjectMapper(); | ||
| Map<String, Object> tagsResponse; | ||
| String tagsResponseString; | ||
| String tagsSecondResponseString; | ||
| String tagsThirdResponseString; | ||
| Map<String, Object> catalogResponse; | ||
| String catalogResponseString; | ||
| String catalogSecondResponseString; | ||
| String catalogThirdResponseString; | ||
|
|
||
| @BeforeEach | ||
| public void init() throws JsonProcessingException { | ||
| tagsResponse = | ||
| Map.of( | ||
| "name", | ||
| "library/nginx", | ||
| "tags", | ||
| new String[] {"1", "1-alpine", "1-alpine-otel", "1-alpine-perl", "1-alpine-slim"}); | ||
| catalogResponse = | ||
| Map.of( | ||
| "repositories", | ||
| new String[] { | ||
| "library/repo-a-1", | ||
| "library/repo-b-1", | ||
| "library/repo-c-1", | ||
| "library/repo-d-1", | ||
| "library/repo-e-1" | ||
| }); | ||
| tagsResponseString = objectMapper.writeValueAsString(tagsResponse); | ||
| tagsSecondResponseString = tagsResponseString.replaceAll("1", "2"); | ||
| tagsThirdResponseString = tagsResponseString.replaceAll("1", "3"); | ||
|
|
||
| catalogResponseString = objectMapper.writeValueAsString(catalogResponse); | ||
| catalogSecondResponseString = catalogResponseString.replaceAll("1", "2"); | ||
| catalogThirdResponseString = catalogResponseString.replaceAll("1", "3"); | ||
|
|
||
| DockerBearerToken bearerToken = new DockerBearerToken(); | ||
| bearerToken.setToken("someToken"); | ||
| bearerToken.setAccess_token("someToken"); | ||
| Mockito.when(dockerBearerTokenService.getToken(anyString())).thenReturn(bearerToken); | ||
| dockerRegistryService = | ||
| buildService(DockerRegistryClient.DockerRegistryService.class, wmDockerRegistry.baseUrl()); | ||
| dockerRegistryClient = | ||
| new DockerRegistryClient( | ||
| wmDockerRegistry.baseUrl(), 5, "", "", dockerRegistryService, dockerBearerTokenService); | ||
| } | ||
|
|
||
| private static <T> T buildService(Class<T> type, String baseUrl) { | ||
| return new Retrofit.Builder() | ||
| .baseUrl(baseUrl) | ||
| .client(new OkHttpClient()) | ||
| .addCallAdapterFactory(ErrorHandlingExecutorCallAdapterFactory.getInstance()) | ||
| .addConverterFactory(JacksonConverterFactory.create()) | ||
| .build() | ||
| .create(type); | ||
| } | ||
|
|
||
| @Test | ||
| public void getTagsWithoutNextLink() { | ||
| wmDockerRegistry.stubFor( | ||
| WireMock.get(urlMatching("/v2/library/nginx/tags/list")) | ||
| .willReturn( | ||
| aResponse().withStatus(HttpStatus.OK.value()).withBody(tagsResponseString))); | ||
|
|
||
| DockerRegistryTags dockerRegistryTags = dockerRegistryClient.getTags("library/nginx"); | ||
| String[] tags = (String[]) tagsResponse.get("tags"); | ||
| assertIterableEquals(Arrays.asList(tags), dockerRegistryTags.getTags()); | ||
| } | ||
|
|
||
| @Test | ||
| public void getTagsWithNextLink() { | ||
| wmDockerRegistry.stubFor( | ||
| WireMock.get(urlMatching("/v2/library/nginx/tags/list")) | ||
| .willReturn( | ||
| aResponse() | ||
| .withStatus(HttpStatus.OK.value()) | ||
| .withHeader( | ||
| "link", | ||
| "</v2/library/nginx/tags/list?last=1-alpine-slim&n=5>; rel=\"next\"") | ||
| .withBody(tagsResponseString))); | ||
| wmDockerRegistry.stubFor( | ||
| WireMock.get(urlMatching("/v2/library/nginx/tags/list\\?last=1-alpine-slim&n=5")) | ||
| .willReturn( | ||
| aResponse() | ||
| .withStatus(HttpStatus.OK.value()) | ||
| .withHeader( | ||
| "link", | ||
| // to test the logic when `?` is not present in the link header | ||
| "</v2/library/nginx/tags/list1>; rel=\"next\"") | ||
| .withBody(tagsSecondResponseString))); | ||
| wmDockerRegistry.stubFor( | ||
| WireMock.get(urlMatching("/v2/library/nginx/tags/list1")) | ||
| .willReturn( | ||
| aResponse().withStatus(HttpStatus.OK.value()).withBody(tagsThirdResponseString))); | ||
|
|
||
| DockerRegistryTags dockerRegistryTags = dockerRegistryClient.getTags("library/nginx"); | ||
| assertEquals(15, dockerRegistryTags.getTags().size()); | ||
| } | ||
|
|
||
| @Test | ||
| public void getCatalogWithNextLink() { | ||
| wmDockerRegistry.stubFor( | ||
| WireMock.get(urlMatching("/v2/_catalog\\?n=5")) | ||
| .willReturn( | ||
| aResponse() | ||
| .withStatus(HttpStatus.OK.value()) | ||
| .withHeader("link", "</v2/_catalog?last=repo1&n=5>; rel=\"next\"") | ||
| .withBody(catalogResponseString))); | ||
| wmDockerRegistry.stubFor( | ||
| WireMock.get(urlMatching("/v2/_catalog\\?last=repo1&n=5")) | ||
| .willReturn( | ||
| aResponse() | ||
| .withStatus(HttpStatus.OK.value()) | ||
| .withHeader( | ||
| "link", | ||
| // to test the logic when `?` is not present in the link header | ||
| "</v2/_catalog1>; rel=\"next\"") | ||
| .withBody(catalogSecondResponseString))); | ||
| wmDockerRegistry.stubFor( | ||
| WireMock.get(urlMatching("/v2/_catalog1\\?n=5")) | ||
| .willReturn( | ||
| aResponse() | ||
| .withStatus(HttpStatus.OK.value()) | ||
| .withBody(catalogThirdResponseString))); | ||
|
|
||
| DockerRegistryCatalog dockerRegistryCatalog = dockerRegistryClient.getCatalog(); | ||
| assertEquals(15, dockerRegistryCatalog.getRepositories().size()); | ||
| } | ||
| } |
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.