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.

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

Jump to bottom

Respect DOCKER_CONFIG environment variable when finding credentials #2402

Merged
merged 5 commits into from
Apr 14, 2020
Merged

Respect DOCKER_CONFIG environment variable when finding credentials #2402

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89ef61f
Respect DOCKER_CONFIG environment variable when finding credentials
TadCordle Apr 14, 2020
990b22a
Changelog
TadCordle Apr 14, 2020
cd2b581
Code compression
TadCordle Apr 14, 2020
7855ef3
Feedback
TadCordle Apr 14, 2020
bf33b16
Fix
TadCordle Apr 14, 2020
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
27 changes: 20 additions & 7 deletions .../src/main/java/com/google/cloud/tools/jib/plugins/common/DefaultCredentialRetrievers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
* <li>{@link CredentialRetrieverFactory#dockerCredentialHelper} for a known credential helper, if
* set
* <li>{@link CredentialRetrieverFactory#known} for known inferred credential, if set
* <li>{@link CredentialRetrieverFactory#dockerConfig} for {@code
* <li>{@link CredentialRetrieverFactory#dockerConfig} for {@code $DOCKER_CONFIG/config.json},
* {@code $DOCKER_CONFIG/.dockerconfigjson}, {@code $DOCKER_CONFIG/.dockercfg},
* System.get("user.home")/.docker/config.json}, {@code
* System.get("user.home")/.docker/.dockerconfigjson}, {@code
* System.get("user.home")/.docker/.dockercfg}, {@code $HOME/.docker/config.json}, {@code
Expand All @@ -57,11 +58,10 @@ public class DefaultCredentialRetrievers {
* See <a
* href="https://docs.docker.com/engine/reference/commandline/login/#privileged-user-requirement">https://docs.docker.com/engine/reference/commandline/login/#privileged-user-requirement</a>.
*/
private static final Path DOCKER_CONFIG_FILE = Paths.get(".docker", "config.json");
private static final Path DOCKER_CONFIG_FILE = Paths.get("config.json");
// For Kubernetes: https://github.com/GoogleContainerTools/jib/issues/2260
private static final Path KUBERNETES_DOCKER_CONFIG_FILE =
Paths.get(".docker", ".dockerconfigjson");
private static final Path LEGACY_DOCKER_CONFIG_FILE = Paths.get(".docker", ".dockercfg");
private static final Path KUBERNETES_DOCKER_CONFIG_FILE = Paths.get(".dockerconfigjson");
private static final Path LEGACY_DOCKER_CONFIG_FILE = Paths.get(".dockercfg");

/**
* Creates a new {@link DefaultCredentialRetrievers} with a given {@link
Expand Down Expand Up @@ -166,10 +166,23 @@ public List<CredentialRetriever> asList() throws FileNotFoundException {
credentialRetrievers.add(inferredCredentialRetriever);
}

String dockerConfigEnv = environment.get("DOCKER_CONFIG");
if (dockerConfigEnv != null) {
Path dockerConfigsPath = Paths.get(dockerConfigEnv);
credentialRetrievers.add(
credentialRetrieverFactory.dockerConfig(dockerConfigsPath.resolve(DOCKER_CONFIG_FILE)));
credentialRetrievers.add(
credentialRetrieverFactory.dockerConfig(
dockerConfigsPath.resolve(KUBERNETES_DOCKER_CONFIG_FILE)));
credentialRetrievers.add(
credentialRetrieverFactory.legacyDockerConfig(
dockerConfigsPath.resolve(LEGACY_DOCKER_CONFIG_FILE)));
loosebazooka marked this conversation as resolved.
Show resolved Hide resolved
}

String homeProperty = systemProperties.getProperty("user.home");
String homeEnvVar = environment.get("HOME");
if (homeProperty != null) {
TadCordle marked this conversation as resolved.
Show resolved Hide resolved
Path home = Paths.get(homeProperty);
Path home = Paths.get(homeProperty).resolve(".docker");
TadCordle marked this conversation as resolved.
Show resolved Hide resolved
credentialRetrievers.add(
credentialRetrieverFactory.dockerConfig(home.resolve(DOCKER_CONFIG_FILE)));
credentialRetrievers.add(
Expand All @@ -178,7 +191,7 @@ public List<CredentialRetriever> asList() throws FileNotFoundException {
credentialRetrieverFactory.legacyDockerConfig(home.resolve(LEGACY_DOCKER_CONFIG_FILE)));
}
if (homeEnvVar != null && !homeEnvVar.equals(homeProperty)) {
TadCordle marked this conversation as resolved.
Show resolved Hide resolved
Path home = Paths.get(homeEnvVar);
Path home = Paths.get(homeEnvVar).resolve(".docker");
credentialRetrievers.add(
credentialRetrieverFactory.dockerConfig(home.resolve(DOCKER_CONFIG_FILE)));
credentialRetrievers.add(
Expand Down
33 changes: 32 additions & 1 deletion .../test/java/com/google/cloud/tools/jib/plugins/common/DefaultCredentialRetrieversTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ public class DefaultCredentialRetrieversTest {
@Mock private CredentialRetriever mockKnownCredentialRetriever;
@Mock private CredentialRetriever mockInferredCredentialRetriever;
@Mock private CredentialRetriever mockWellKnownCredentialHelpersCredentialRetriever;
@Mock private CredentialRetriever mockDockerConfigEnvDockerConfigCredentialRetriever;
@Mock private CredentialRetriever mockDockerConfigEnvKubernetesDockerConfigCredentialRetriever;
@Mock private CredentialRetriever mockDockerConfigEnvLegacyDockerConfigCredentialRetriever;
@Mock private CredentialRetriever mockSystemHomeDockerConfigCredentialRetriever;
@Mock private CredentialRetriever mockSystemHomeKubernetesDockerConfigCredentialRetriever;
@Mock private CredentialRetriever mockSystemHomeLegacyDockerConfigCredentialRetriever;
Expand All @@ -69,7 +72,12 @@ public class DefaultCredentialRetrieversTest {
public void setUp() {
properties = new Properties();
properties.setProperty("user.home", Paths.get("/system/home").toString());
environment = ImmutableMap.of("HOME", Paths.get("/env/home").toString());
environment =
ImmutableMap.of(
"HOME",
Paths.get("/env/home").toString(),
"DOCKER_CONFIG",
Paths.get("/docker_config").toString());

Mockito.when(mockCredentialRetrieverFactory.dockerCredentialHelper(Mockito.anyString()))
.thenReturn(mockDockerCredentialHelperCredentialRetriever);
Expand All @@ -80,6 +88,17 @@ public void setUp() {
.thenReturn(mockInferredCredentialRetriever);
Mockito.when(mockCredentialRetrieverFactory.wellKnownCredentialHelpers())
.thenReturn(mockWellKnownCredentialHelpersCredentialRetriever);
Mockito.when(
mockCredentialRetrieverFactory.dockerConfig(Paths.get("/docker_config/config.json")))
.thenReturn(mockDockerConfigEnvDockerConfigCredentialRetriever);
Mockito.when(
mockCredentialRetrieverFactory.dockerConfig(
Paths.get("/docker_config/.dockerconfigjson")))
.thenReturn(mockDockerConfigEnvKubernetesDockerConfigCredentialRetriever);
Mockito.when(
mockCredentialRetrieverFactory.legacyDockerConfig(
Paths.get("/docker_config/.dockercfg")))
.thenReturn(mockDockerConfigEnvLegacyDockerConfigCredentialRetriever);
Mockito.when(
mockCredentialRetrieverFactory.dockerConfig(
Paths.get("/system/home/.docker/config.json")))
Expand Down Expand Up @@ -114,6 +133,9 @@ public void testAsList() throws FileNotFoundException {
.asList();
Assert.assertEquals(
Arrays.asList(
mockDockerConfigEnvDockerConfigCredentialRetriever,
mockDockerConfigEnvKubernetesDockerConfigCredentialRetriever,
mockDockerConfigEnvLegacyDockerConfigCredentialRetriever,
mockSystemHomeDockerConfigCredentialRetriever,
mockSystemHomeKubernetesDockerConfigCredentialRetriever,
mockSystemHomeLegacyDockerConfigCredentialRetriever,
Expand All @@ -138,6 +160,9 @@ public void testAsList_all() throws FileNotFoundException {
mockKnownCredentialRetriever,
mockDockerCredentialHelperCredentialRetriever,
mockInferredCredentialRetriever,
mockDockerConfigEnvDockerConfigCredentialRetriever,
mockDockerConfigEnvKubernetesDockerConfigCredentialRetriever,
mockDockerConfigEnvLegacyDockerConfigCredentialRetriever,
mockSystemHomeDockerConfigCredentialRetriever,
mockSystemHomeKubernetesDockerConfigCredentialRetriever,
mockSystemHomeLegacyDockerConfigCredentialRetriever,
Expand Down Expand Up @@ -166,6 +191,9 @@ public void testAsList_credentialHelperPath() throws IOException {
Assert.assertEquals(
Arrays.asList(
mockDockerCredentialHelperCredentialRetriever,
mockDockerConfigEnvDockerConfigCredentialRetriever,
mockDockerConfigEnvKubernetesDockerConfigCredentialRetriever,
mockDockerConfigEnvLegacyDockerConfigCredentialRetriever,
mockSystemHomeDockerConfigCredentialRetriever,
mockSystemHomeKubernetesDockerConfigCredentialRetriever,
mockSystemHomeLegacyDockerConfigCredentialRetriever,
Expand Down Expand Up @@ -210,6 +238,9 @@ public void testDockerConfigRetrievers_noDuplicateRetrievers() throws FileNotFou
.asList();
Assert.assertEquals(
Arrays.asList(
mockDockerConfigEnvDockerConfigCredentialRetriever,
mockDockerConfigEnvKubernetesDockerConfigCredentialRetriever,
mockDockerConfigEnvLegacyDockerConfigCredentialRetriever,
mockEnvHomeDockerConfigCredentialRetriever,
mockEnvHomeKubernetesDockerConfigCredentialRetriever,
mockEnvHomeLegacyDockerConfigCredentialRetriever,
Expand Down