Skip to content

Relax email requirement in auth config #1207

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
KostyaSha merged 1 commit into from
Jul 8, 2019
Merged

Relax email requirement in auth config #1207

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
3 changes: 1 addition & 2 deletions src/main/java/com/github/dockerjava/core/DefaultDockerClientConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,8 +252,7 @@ public DockerConfigFile getDockerConfig() {

private AuthConfig getAuthConfig() {
AuthConfig authConfig = null;
if (getRegistryUsername() != null && getRegistryPassword() != null && getRegistryEmail() != null
&& getRegistryUrl() != null) {
if (getRegistryUsername() != null && getRegistryPassword() != null && getRegistryUrl() != null) {
Copy link
Copy Markdown
Member

@KostyaSha KostyaSha Jul 2, 2019

Choose a reason for hiding this comment

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

maybe better fill all non-null values into authconfig without combining them?

Copy link
Copy Markdown
Contributor Author

@tobiasstadler tobiasstadler Jul 2, 2019

Choose a reason for hiding this comment

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

something like

AuthConfig authConfig = new AuthConfig;
if (getRegistryUsername() != null) {
    authConfig.setRegistryUsername(getRegistryUsername());
}
if(getRegistryPassword() != nul) {
    authConfig.setRegistryPassword(getRegistryPassword());
}
...

Copy link
Copy Markdown
Member

@KostyaSha KostyaSha Jul 2, 2019

Choose a reason for hiding this comment

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

Objects.nonNull() and even in one liner

Copy link
Copy Markdown
Contributor Author

@tobiasstadler tobiasstadler Jul 3, 2019

Choose a reason for hiding this comment

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

Ok, but in effectiveAuthConfig() the return value of getAuthConfig() is checked for null. This will no longer work with your approach

Copy link
Copy Markdown
Member

@KostyaSha KostyaSha Jul 5, 2019

Choose a reason for hiding this comment

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

Then it will be empty, but not null...

Copy link
Copy Markdown
Contributor Author

@tobiasstadler tobiasstadler Jul 7, 2019

Choose a reason for hiding this comment

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

yes and because it is not null the empty config will be used for authetification instead of getting the auth config from the docker config file. So in effectiveAuthConfig() we need to check if the auth config returned by getAuthConfig() is empty. Which I think is ugly.

Maybe we should change the && in ||:
if (getRegistryUsername() != null || getRegistryPassword() != null || getRegistryEmail() != null || getRegistryUrl() != null)

@KostyaSha What di you think?

Copy link
Copy Markdown
Member

@KostyaSha KostyaSha Jul 8, 2019

Choose a reason for hiding this comment

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

well, if email optional, then ok as is

authConfig = new AuthConfig()
.withUsername(getRegistryUsername())
.withPassword(getRegistryPassword())
Expand Down
15 changes: 15 additions & 0 deletions src/test/java/com/github/dockerjava/cmd/PullImageCmdIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,20 @@ public void testPullImageWithValidAuth() throws Exception {
.awaitCompletion(30, TimeUnit.SECONDS);
}

@Test
public void testPullImageWithValidAuthAndEmail() throws Exception {
AuthConfig authConfig = RegistryUtils.runPrivateRegistry(dockerRule.getClient())
.withEmail("foo@bar.de");

String imgName = RegistryUtils.createPrivateImage(dockerRule, "pull-image-with-valid-auth");

// stream needs to be fully read in order to close the underlying connection
dockerRule.getClient().pullImageCmd(imgName)
.withAuthConfig(authConfig)
.exec(new PullImageResultCallback())
.awaitCompletion(30, TimeUnit.SECONDS);
}

@Test
public void testPullImageWithNoAuth() throws Exception {
RegistryUtils.runPrivateRegistry(dockerRule.getClient());
Expand All @@ -130,6 +144,7 @@ public void testPullImageWithNoAuth() throws Exception {
.awaitCompletion(30, TimeUnit.SECONDS);
}


@Test
public void testPullImageWithInvalidAuth() throws Exception {
AuthConfig validAuthConfig = RegistryUtils.runPrivateRegistry(dockerRule.getClient());
Expand Down
1 change: 0 additions & 1 deletion src/test/java/com/github/dockerjava/utils/RegistryUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ public static synchronized AuthConfig runPrivateRegistry(DockerClient dockerClie
privateRegistryAuthConfig = new AuthConfig()
.withUsername("testuser")
.withPassword("testpassword")
.withEmail("foo@bar.de")
.withRegistryAddress("localhost:" + port);
}

Expand Down