-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(artifacts/github): Fix threading bug in github artifact resolver (…
…#3386) * test(artifacts/github): Add tests to Github artifact resolving * fix(artifacts/github): Fix threading bug in github artifact resolver GithubArtifactCredentials is storing a Request.Builder in an instance variable. This means that when multiple threads are concurrently downloading Github artifacts, it's possible for one thread to download an artifact from another thread's URL.
- Loading branch information
Showing
2 changed files
with
174 additions
and
30 deletions.
There are no files selected for viewing
This file contains 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
134 changes: 134 additions & 0 deletions
134
...ava/com/netflix/spinnaker/clouddriver/artifacts/github/GithubArtifactCredentialsTest.java
This file contains 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,134 @@ | ||
| /* | ||
| * Copyright 2019 Google, 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.artifacts.github; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.github.tomakehurst.wiremock.WireMockServer; | ||
| import com.github.tomakehurst.wiremock.client.MappingBuilder; | ||
| import com.netflix.spinnaker.kork.artifacts.model.Artifact; | ||
| import com.squareup.okhttp.OkHttpClient; | ||
| import org.apache.commons.io.Charsets; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.junitpioneer.jupiter.TempDirectory; | ||
| import ru.lanwen.wiremock.ext.WiremockResolver; | ||
|
|
||
| import java.io.ByteArrayInputStream; | ||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.function.Function; | ||
|
|
||
| import static com.github.tomakehurst.wiremock.client.WireMock.*; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| @ExtendWith({WiremockResolver.class, TempDirectory.class}) | ||
| class GithubArtifactCredentialsTest { | ||
| private final ObjectMapper objectMapper = new ObjectMapper(); | ||
| private final OkHttpClient okHttpClient = new OkHttpClient(); | ||
|
|
||
| private final String METADATA_PATH = "/repos/spinnaker/testing/manifest.yml"; | ||
| private final String FILE_CONTENTS = "file contents"; | ||
|
|
||
| @Test | ||
| void downloadWithToken(@WiremockResolver.Wiremock WireMockServer server) throws IOException { | ||
| GitHubArtifactAccount account = new GitHubArtifactAccount(); | ||
| account.setName("my-github-account"); | ||
| account.setToken("abc"); | ||
|
|
||
| runTestCase(server, account, m -> m.withHeader("Authorization", equalTo("token abc"))); | ||
| } | ||
|
|
||
| @Test | ||
| void downloadWithTokenFromFile(@TempDirectory.TempDir Path tempDir, @WiremockResolver.Wiremock WireMockServer server) throws IOException { | ||
| Path authFile = tempDir.resolve("auth-file"); | ||
| Files.write(authFile, "zzz".getBytes()); | ||
|
|
||
| GitHubArtifactAccount account = new GitHubArtifactAccount(); | ||
| account.setName("my-github-account"); | ||
| account.setTokenFile(authFile.toAbsolutePath().toString()); | ||
|
|
||
| runTestCase(server, account, m -> m.withHeader("Authorization",equalTo("token zzz"))); | ||
| } | ||
|
|
||
| @Test | ||
| void downloadWithBasicAuth(@WiremockResolver.Wiremock WireMockServer server) throws IOException { | ||
| GitHubArtifactAccount account = new GitHubArtifactAccount(); | ||
| account.setName("my-github-account"); | ||
| account.setUsername("user"); | ||
| account.setPassword("passw0rd"); | ||
|
|
||
| runTestCase(server, account, m -> m.withBasicAuth("user", "passw0rd")); | ||
| } | ||
|
|
||
| @Test | ||
| void downloadWithBasicAuthFromFile(@TempDirectory.TempDir Path tempDir, @WiremockResolver.Wiremock WireMockServer server) throws IOException { | ||
| Path authFile = tempDir.resolve("auth-file"); | ||
| Files.write(authFile, "someuser:somepassw0rd!".getBytes()); | ||
|
|
||
| GitHubArtifactAccount account = new GitHubArtifactAccount(); | ||
| account.setName("my-github-account"); | ||
| account.setUsernamePasswordFile(authFile.toAbsolutePath().toString()); | ||
|
|
||
| runTestCase(server, account, m -> m.withBasicAuth("someuser", "somepassw0rd!")); | ||
| } | ||
|
|
||
| @Test | ||
| void downloadWithNoAuth(@WiremockResolver.Wiremock WireMockServer server) throws IOException { | ||
| GitHubArtifactAccount account = new GitHubArtifactAccount(); | ||
| account.setName("my-github-account"); | ||
|
|
||
| runTestCase(server, account, m -> m.withHeader("Authorization",absent())); | ||
| } | ||
|
|
||
|
|
||
| private void runTestCase(WireMockServer server, GitHubArtifactAccount account, Function<MappingBuilder, MappingBuilder> expectedAuth) throws IOException { | ||
| GitHubArtifactCredentials credentials = new GitHubArtifactCredentials(account, okHttpClient, objectMapper); | ||
|
|
||
| Artifact artifact = Artifact.builder() | ||
| .reference(server.baseUrl() + METADATA_PATH) | ||
| .version("master") | ||
| .build(); | ||
|
|
||
| prepareServer(server, expectedAuth); | ||
|
|
||
| assertThat(credentials.download(artifact)) | ||
| .hasSameContentAs(new ByteArrayInputStream(FILE_CONTENTS.getBytes(Charsets.UTF_8))); | ||
| assertThat(server.findUnmatchedRequests().getRequests()).isEmpty(); | ||
| } | ||
|
|
||
| private void prepareServer(WireMockServer server, Function<MappingBuilder, MappingBuilder> withAuth) throws IOException { | ||
| final String downloadPath = "/download/spinnaker/testing/master/manifest.yml"; | ||
|
|
||
| GitHubArtifactCredentials.ContentMetadata contentMetadata = new GitHubArtifactCredentials.ContentMetadata().setDownloadUrl(server.baseUrl() + downloadPath); | ||
|
|
||
| server.stubFor( | ||
| withAuth.apply( | ||
| any(urlPathEqualTo(METADATA_PATH)) | ||
| .withQueryParam("ref", equalTo("master")) | ||
| .willReturn(aResponse().withBody(objectMapper.writeValueAsString(contentMetadata))) | ||
| ) | ||
| ); | ||
|
|
||
| server.stubFor( | ||
| withAuth.apply( | ||
| any(urlPathEqualTo(downloadPath)) | ||
| .willReturn(aResponse().withBody(FILE_CONTENTS)) | ||
| ) | ||
| ); | ||
| } | ||
| } |