Skip to content

Un-shade docker-java-api #2882

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.

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
merged 6 commits into from
Jul 9, 2020
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
5 changes: 0 additions & 5 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,6 @@ subprojects {
for (pkg in packages) {
pkg = pkg.replaceAll('/', '.')

if (pkg.startsWith("com.github.dockerjava.")) {
// Keep docker-java's package inside the final jar
continue;
}

tasks.shadowJar.relocate(pkg, "org.testcontainers.shaded.${pkg}")
}
}
Expand Down
38 changes: 30 additions & 8 deletions core/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,33 @@ task japicmp(type: me.champeau.gradle.japicmp.JapicmpTask) {
"org.testcontainers.containers.wait.WaitAllStrategy",
"org.testcontainers.containers.wait.WaitStrategy",
"org.testcontainers.dockerclient.AuditLoggingDockerClient",
"org.testcontainers.dockerclient.LogToStringContainerCallback",
"org.testcontainers.dockerclient.DockerMachineClientProviderStrategy",
"org.testcontainers.dockerclient.EnvironmentAndSystemPropertyClientProviderStrategy",
"org.testcontainers.dockerclient.NpipeSocketClientProviderStrategy",
"org.testcontainers.dockerclient.ProxiedUnixSocketClientProviderStrategy",
"org.testcontainers.dockerclient.WindowsClientProviderStrategy",
"org.testcontainers.dockerclient.UnixSocketClientProviderStrategy",
"org.testcontainers.dockerclient.auth.AuthDelegatingDockerClientConfig",
"org.testcontainers.containers.GenericContainer\$AbstractWaitStrategy",
"org.testcontainers.dockerclient.transport.okhttp.NamedPipeSocketFactory",
"org.testcontainers.dockerclient.transport.okhttp.OkHttpDockerCmdExecFactory",
"org.testcontainers.dockerclient.transport.okhttp.UnixSocketFactory",
"org.testcontainers.containers.output.FrameConsumerResultCallback",
"org.testcontainers.images.TimeLimitedLoggedPullImageResultCallback",
]

methodExcludes = [
"org.testcontainers.dockerclient.DockerClientConfigUtils#getDetectedDockerHostIp()",
"org.testcontainers.dockerclient.DockerClientConfigUtils#getDockerHostIpAddress(com.github.dockerjava.core.DockerClientConfig)",

"org.testcontainers.dockerclient.DockerClientProviderStrategy#checkOSType()",
"org.testcontainers.dockerclient.DockerClientProviderStrategy#getClientForConfig(com.github.dockerjava.core.DockerClientConfig)",
"org.testcontainers.dockerclient.DockerClientProviderStrategy#ping(com.github.dockerjava.api.DockerClient, int)",
"org.testcontainers.dockerclient.DockerClientProviderStrategy#test()",

"org.testcontainers.dockerclient.UnixSocketClientProviderStrategy#tryConfiguration(java.lang.String)",

"org.testcontainers.utility.ResourceReaper#start(java.lang.String, com.github.dockerjava.api.DockerClient, boolean)",

"org.testcontainers.containers.Container#fetchDockerDaemonInfo()",
Expand All @@ -126,6 +142,10 @@ task japicmp(type: me.champeau.gradle.japicmp.JapicmpTask) {
"org.testcontainers.containers.GenericContainer#containerId",
"org.testcontainers.containers.GenericContainer#containerName",
"org.testcontainers.containers.GenericContainer#dockerDaemonInfo",

"org.testcontainers.dockerclient.DockerClientProviderStrategy#LOGGER",
"org.testcontainers.dockerclient.DockerClientProviderStrategy#client",
"org.testcontainers.dockerclient.DockerClientProviderStrategy#config",
]

onlyBinaryIncompatibleModified = true
Expand All @@ -150,25 +170,27 @@ dependencies {
exclude(group: 'org.jetbrains', module: 'annotations')
}

compile ('org.rnorth.visible-assertions:visible-assertions:2.1.2') {
// Excluded in favor of jna-platform below
exclude(group: "net.java.dev.jna", module: "jna")
}
compile 'org.rnorth.visible-assertions:visible-assertions:2.1.2'

compile "net.java.dev.jna:jna-platform:5.5.0"
compile "com.github.docker-java:docker-java-api:3.2.3"

shaded ('com.github.docker-java:docker-java-transport-okhttp:3.2.5') {
exclude(group: 'net.java.dev.jna')
shaded ('com.github.docker-java:docker-java-core:3.2.5') {
exclude(group: 'com.github.docker-java', module: 'docker-java-api')
exclude(group: 'com.github.docker-java', module: 'docker-java-transport')
exclude(group: 'com.fasterxml.jackson.core', module: 'jackson-annotations')
exclude(group: 'com.google.code.findbug')
exclude(group: 'org.slf4j')
exclude(group: 'org.apache.commons', module: 'commons-compress')
}

shaded ('com.github.docker-java:docker-java-transport-zerodep:3.2.5') {
shaded ('com.github.docker-java:docker-java-transport-okhttp:3.2.5') {
exclude(group: 'com.github.docker-java', module: 'docker-java-core')
exclude(group: 'net.java.dev.jna')
exclude(group: 'org.slf4j')
}

compile 'com.github.docker-java:docker-java-transport-zerodep:3.2.5'

shaded "org.yaml:snakeyaml:1.25"

shaded 'org.glassfish.main.external:trilead-ssh2-repackaged:4.1.2'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,12 @@ public class JarFileShadingTest extends AbstractJarFileTest {
public void testPackages() throws Exception {
assertThatFileList(root).containsOnly(
"org",
"META-INF",
"com"
"META-INF"
);

assertThatFileList(root.resolve("org")).containsOnly(
"testcontainers"
);

assertThatFileList(root.resolve("com")).containsOnly(
"github"
);

assertThatFileList(root.resolve("com").resolve("github")).containsOnly(
"dockerjava"
);
}

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,11 @@ public FileVisitResult visitFile(Path path, BasicFileAttributes attrs) throws IO

@Before
public void setUp() {
Assume.assumeFalse(classNode.name.startsWith("com.github.dockerjava."));
switch (classNode.name) {
// TODO should go to docker-java project
case "org/testcontainers/dockerclient/auth/AuthDelegatingDockerClientConfig":
// Necessary evil
case "org/testcontainers/dockerclient/UnixSocketClientProviderStrategy":
case "org/testcontainers/dockerclient/DockerClientProviderStrategy":
case "org/testcontainers/dockerclient/WindowsClientProviderStrategy":
Assume.assumeTrue(false);
}
}
Expand Down
27 changes: 23 additions & 4 deletions core/src/main/java/org/testcontainers/DockerClientFactory.java
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
package org.testcontainers;

import com.github.dockerjava.api.DockerClient;
import com.github.dockerjava.api.async.ResultCallback;
import com.github.dockerjava.api.command.CreateContainerCmd;
import com.github.dockerjava.api.exception.InternalServerErrorException;
import com.github.dockerjava.api.exception.NotFoundException;
import com.github.dockerjava.api.model.AccessMode;
import com.github.dockerjava.api.model.Bind;
import com.github.dockerjava.api.model.Frame;
import com.github.dockerjava.api.model.Image;
import com.github.dockerjava.api.model.Info;
import com.github.dockerjava.api.model.Version;
import com.github.dockerjava.api.model.Volume;
import com.github.dockerjava.core.command.ExecStartResultCallback;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableMap;
import lombok.Getter;
Expand All @@ -26,6 +27,7 @@
import org.testcontainers.utility.TestcontainersConfiguration;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
Expand Down Expand Up @@ -148,7 +150,7 @@ public DockerClient client() {

String hostIpAddress = strategy.getDockerHostIpAddress();
log.info("Docker host IP address is {}", hostIpAddress);
final DockerClient client = new DelegatingDockerClient(strategy.getClient()) {
final DockerClient client = new DelegatingDockerClient(strategy.getDockerClient()) {
@Override
public void close() {
throw new IllegalStateException("You should never close the global DockerClient!");
Expand Down Expand Up @@ -228,7 +230,24 @@ private void checkDiskSpace(DockerClient dockerClient, String id) {
try {
dockerClient
.execStartCmd(dockerClient.execCreateCmd(id).withAttachStdout(true).withCmd("df", "-P").exec().getId())
.exec(new ExecStartResultCallback(outputStream, null))
.exec(new ResultCallback.Adapter<Frame>() {
@Override
public void onNext(Frame frame) {
if (frame == null) {
return;
}
switch (frame.getStreamType()) {
case RAW:
case STDOUT:
try {
outputStream.write(frame.getPayload());
outputStream.flush();
} catch (IOException e) {
onError(e);
}
}
}
})
.awaitCompletion();
} catch (Exception e) {
log.debug("Can't exec disk checking command", e);
Expand Down Expand Up @@ -295,7 +314,7 @@ public String dockerHostIpAddress() {

public <T> T runInsideDocker(Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {
// We can't use client() here because it might create an infinite loop
return runInsideDocker(getOrInitializeStrategy().getClient(), createContainerCmdConsumer, block);
return runInsideDocker(getOrInitializeStrategy().getDockerClient(), createContainerCmdConsumer, block);
}

private <T> T runInsideDocker(DockerClient client, Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import com.github.dockerjava.api.model.PortBinding;
import com.github.dockerjava.api.model.Volume;
import com.github.dockerjava.api.model.VolumesFrom;
import com.github.dockerjava.core.DefaultDockerClientConfig;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
Expand Down Expand Up @@ -514,12 +515,15 @@ void checksumFile(File file, Checksum checksum) {
@UnstableAPI
@SneakyThrows(JsonProcessingException.class)
final String hash(CreateContainerCmd createCommand) {
// TODO add Testcontainers' version to the hash
byte[] commandJson = new ObjectMapper()
DefaultDockerClientConfig dockerClientConfig = DefaultDockerClientConfig.createDefaultConfigBuilder().build();

byte[] commandJson = dockerClientConfig.getObjectMapper()
.copy()
.enable(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY)
.enable(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS)
.writeValueAsBytes(createCommand);

// TODO add Testcontainers' version to the hash
return Hashing.sha1().hashBytes(commandJson).toString();
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package org.testcontainers.containers.output;


import com.github.dockerjava.api.async.ResultCallbackTemplate;
import com.github.dockerjava.api.model.Frame;
import com.github.dockerjava.api.model.StreamType;
import com.github.dockerjava.core.async.ResultCallbackTemplate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down
Loading