Skip to content

Handle network aliases without a custom network gracefully #1942

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
eddumelendez merged 2 commits into from
Sep 13, 2022
Merged

Handle network aliases without a custom network gracefully #1942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6caf943
Handle network aliases without a custom network gracefully
Sep 10, 2022
a656358
Remove unrelated part of test
Sep 13, 2022
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
1 change: 1 addition & 0 deletions docker-java-api/src/main/java/com/github/dockerjava/api/model/HostConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,7 @@ public HostConfig withMemorySwappiness(Long memorySwappiness) {
* <li>'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system
* services such as D-bus and is therefore considered insecure.</li>
* </ul>
* Any other value is interpreted as a custom network's name for this container to connect to.
*/
public HostConfig withNetworkMode(String networkMode) {
this.networkMode = networkMode;
Expand Down
2 changes: 1 addition & 1 deletion ...er-java-core/src/main/java/com/github/dockerjava/core/command/CreateContainerCmdImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ public CreateContainerResponse exec() throws NotFoundException, ConflictExceptio
containerNetwork.withAliases(aliases);
}

if (containerNetwork != null) {
if (containerNetwork != null && hostConfig.getNetworkMode() != null) {
networkingConfig = new NetworkingConfig()
.withEndpointsConfig(singletonMap(hostConfig.getNetworkMode(), containerNetwork));
Copy link
Contributor Author

@aidando73 aidando73 Sep 10, 2022

Choose a reason for hiding this comment

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

Exception was being thrown as we were putting:

EndpointsConfig: {
    null: containerNetwork
}

as networkMode is null by default. This can't be serialised by JSON so it throws.

}
Expand Down
12 changes: 12 additions & 0 deletions docker-java/src/test/java/com/github/dockerjava/cmd/CreateContainerCmdIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import com.github.dockerjava.api.model.Link;
import com.github.dockerjava.api.model.LogConfig;
import com.github.dockerjava.api.model.Network;
import com.github.dockerjava.api.model.PortBinding;
import com.github.dockerjava.api.model.Ports;
import com.github.dockerjava.api.model.Ports.Binding;
import com.github.dockerjava.api.model.RestartPolicy;
Expand Down Expand Up @@ -1125,4 +1126,15 @@ public void shouldNotEncodeAuth() {

assertThat(jsonNode.get("authConfig"), nullValue());
}

@Test
public void shouldHandleANetworkAliasWithoutACustomNetworkGracefully() {
// Should not throw
dockerRule.getClient()
.createContainerCmd(DEFAULT_IMAGE)
.withAliases("hello-world")
.withHostConfig(newHostConfig())
.withCmd("sleep", "9999")
.exec();
}
}