Add support for Docker networks. #372
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| package org.testcontainers.containers; | ||
|
|
||
| import com.github.dockerjava.api.command.CreateNetworkCmd; | ||
| import lombok.*; | ||
| import org.junit.rules.ExternalResource; | ||
| import org.junit.rules.TestRule; | ||
| import org.testcontainers.DockerClientFactory; | ||
| import org.testcontainers.utility.ResourceReaper; | ||
|
|
||
| import java.util.LinkedHashSet; | ||
| import java.util.Set; | ||
| import java.util.UUID; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
| import java.util.function.Consumer; | ||
| import java.util.function.Supplier; | ||
|
|
||
| public interface Network extends AutoCloseable, TestRule { | ||
|
|
||
| String getId(); | ||
|
|
||
| String getName(); | ||
|
|
||
| Boolean getEnableIpv6(); | ||
|
|
||
| String getDriver(); | ||
|
|
||
| boolean isCreated(); | ||
|
|
||
| default boolean create() { | ||
| return getId() != null; | ||
|
There was a problem hiding this comment. I would leave out the default implementation- it's too magic: you need to guess that getId is doing the actual create. There was a problem hiding this comment. default implementation here assumes that there is kinda no need to create a network. If id is known then what else to "create"? The method returns boolean instead of an exception because it's up to the consumer how to react on that. However, I agree that There was a problem hiding this comment. Personally, I prefer the previous approach with There was a problem hiding this comment. In the impl you placed the logic of creating the network in getId() - that was my point. In the default implementation you assumed getId will be called this create the network if needed. Am I missing something? There was a problem hiding this comment. I think @asafm point is, that There was a problem hiding this comment.
Example: class ExistingNetwork implements Network {
String getId() {
return "some-predefined-id";
}
} |
||
| } | ||
|
|
||
| @Override | ||
| default void close() { | ||
| if (isCreated()) { | ||
| ResourceReaper.instance().removeNetworks(getName()); | ||
| } | ||
| } | ||
|
|
||
| @SneakyThrows | ||
| @SuppressWarnings("unchecked") | ||
| default <T extends Network> T as(Class<T> type) { | ||
|
There was a problem hiding this comment. I'm curious to that purpose of this class, which is related to another question I had: why have an interface? Do we plan on users extending and supplying their own Network implementation? |
||
| return type.getDeclaredConstructor(Network.class).newInstance(this); | ||
| } | ||
|
|
||
| static Network newNetwork() { | ||
| return builder().build(); | ||
| } | ||
|
|
||
| static NetworkImpl.NetworkImplBuilder builder() { | ||
| return NetworkImpl.builder(); | ||
| } | ||
|
|
||
| @Builder | ||
| @Getter | ||
| class NetworkImpl extends ExternalResource implements Network { | ||
|
|
||
| private final String name = UUID.randomUUID().toString(); | ||
|
|
||
| private Boolean enableIpv6; | ||
|
There was a problem hiding this comment. Same thing with the There was a problem hiding this comment. null here means "the value wasn't provided and |
||
|
|
||
| private String driver; | ||
|
|
||
| @Singular | ||
| private Set<Consumer<CreateNetworkCmd>> createNetworkCmdModifiers = new LinkedHashSet<>(); | ||
|
|
||
| @Getter(lazy = true) | ||
| private final String id = ((Supplier<String>) () -> { | ||
|
There was a problem hiding this comment. I don't understand why a variable of type String receives a lambda function, casted to a Suplier of String and then executed? I mean - what's going on? There was a problem hiding this comment.
|
||
| ResourceReaper.instance().registerNetworkForCleanup(getName()); | ||
|
There was a problem hiding this comment. I'd prefer to have this in a private method. |
||
|
|
||
| CreateNetworkCmd createNetworkCmd = DockerClientFactory.instance().client().createNetworkCmd(); | ||
|
|
||
| createNetworkCmd.withName(getName()); | ||
| createNetworkCmd.withCheckDuplicate(true); | ||
|
|
||
| if (getEnableIpv6() != null) { | ||
| createNetworkCmd.withEnableIpv6(getEnableIpv6()); | ||
| } | ||
|
|
||
| if (getDriver() != null) { | ||
| createNetworkCmd.withDriver(getDriver()); | ||
| } | ||
|
|
||
| for (Consumer<CreateNetworkCmd> consumer : createNetworkCmdModifiers) { | ||
| consumer.accept(createNetworkCmd); | ||
| } | ||
|
|
||
| return createNetworkCmd.exec().getId(); | ||
| }).get(); | ||
|
|
||
| @Override | ||
| public boolean isCreated() { | ||
| // Lombok with @Getter(lazy = true) will use AtomicReference as a field type for id | ||
| return ((AtomicReference<String>) (Object) id).get() != null; | ||
|
There was a problem hiding this comment. Just a personal opinion - that's too much magic for such a simple thing as having a field called Id of type String. Maybe it will more clear if for this field, Lombok won't be used. |
||
| } | ||
|
|
||
| @Override | ||
| protected void before() throws Throwable { | ||
| create(); | ||
| } | ||
|
|
||
| @Override | ||
| protected void after() { | ||
| close(); | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| package org.testcontainers.containers; | ||
|
|
||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.experimental.runners.Enclosed; | ||
| import org.junit.runner.RunWith; | ||
| import org.testcontainers.DockerClientFactory; | ||
|
|
||
| import static org.rnorth.visibleassertions.VisibleAssertions.*; | ||
| import static org.testcontainers.containers.Network.newNetwork; | ||
|
|
||
| @RunWith(Enclosed.class) | ||
|
There was a problem hiding this comment. Neat - I didn't know about this! |
||
| public class NetworkTest { | ||
|
|
||
| public static class WithRules { | ||
|
|
||
| @Rule | ||
| public Network network = newNetwork(); | ||
|
|
||
| @Rule | ||
| public GenericContainer foo = new GenericContainer() | ||
| .withNetwork(network) | ||
| .withNetworkAliases("foo") | ||
| .withCommand("/bin/sh", "-c", "while true ; do printf 'HTTP/1.1 200 OK\\n\\nyay' | nc -l -p 8080; done"); | ||
|
|
||
| @Rule | ||
| public GenericContainer bar = new GenericContainer() | ||
| .withNetwork(network) | ||
| .withCommand("top"); | ||
|
|
||
| @Test | ||
| public void testNetworkSupport() throws Exception { | ||
| String response = bar.execInContainer("wget", "-O", "-", "http://foo:8080").getStdout(); | ||
| assertEquals("received response", "yay", response); | ||
| } | ||
| } | ||
|
|
||
| public static class WithoutRules { | ||
|
|
||
| @Test | ||
| public void testNetworkSupport() throws Exception { | ||
| try ( | ||
| Network network = newNetwork(); | ||
|
|
||
| GenericContainer foo = new GenericContainer() | ||
| .withNetwork(network) | ||
| .withNetworkAliases("foo") | ||
| .withCommand("/bin/sh", "-c", "while true ; do printf 'HTTP/1.1 200 OK\\n\\nyay' | nc -l -p 8080; done"); | ||
|
|
||
| GenericContainer bar = new GenericContainer() | ||
| .withNetwork(network) | ||
| .withCommand("top") | ||
| ) { | ||
| foo.start(); | ||
| bar.start(); | ||
|
|
||
| String response = bar.execInContainer("wget", "-O", "-", "http://foo:8080").getStdout(); | ||
| assertEquals("received response", "yay", response); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testBuilder() throws Exception { | ||
| try ( | ||
| Network network = Network.builder() | ||
| .driver("macvlan") | ||
| .build(); | ||
| ) { | ||
| network.create(); | ||
| assertEquals( | ||
| "Flag is set", | ||
| "macvlan", | ||
| DockerClientFactory.instance().client().inspectNetworkCmd().withNetworkId(network.getName()).exec().getDriver() | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testModifiers() throws Exception { | ||
| try ( | ||
| Network network = Network.builder() | ||
| .createNetworkCmdModifier(cmd -> cmd.withDriver("macvlan")) | ||
| .build(); | ||
| ) { | ||
| network.create(); | ||
| assertEquals( | ||
| "Flag is set", | ||
| "macvlan", | ||
| DockerClientFactory.instance().client().inspectNetworkCmd().withNetworkId(network.getName()).exec().getDriver() | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testLaziness() throws Exception { | ||
| try ( | ||
| Network network = newNetwork() | ||
| ) { | ||
| assertFalse("Not created by default", network.isCreated()); | ||
| assertNotNull("Returns an id", network.getId()); | ||
| assertTrue("Is created after id request", network.isCreated()); | ||
| } | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you really want a
Boolean?