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.

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

Introduce an abstraction over files and classpath resources. #279

Merged
merged 2 commits into from
Mar 12, 2017
Merged
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import org.apache.commons.lang.SystemUtils;
import org.jetbrains.annotations.Nullable;
import org.junit.runner.Description;
import org.rnorth.ducttape.ratelimits.RateLimiter;
Expand All @@ -35,7 +34,6 @@

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.time.Duration;
Expand Down Expand Up @@ -482,16 +480,8 @@ public void addEnv(String key, String value) {
@Override
public void addFileSystemBind(String hostPath, String containerPath, BindMode mode) {

if (hostPath.contains(".jar!")) {
// the host file is inside a JAR resource - copy to a temporary location that Docker can read
hostPath = PathUtils.extractClassPathResourceToTempLocation(hostPath);
}

if (SystemUtils.IS_OS_WINDOWS) {
hostPath = PathUtils.createMinGWPath(hostPath);
}

binds.add(new Bind(hostPath, new Volume(containerPath), mode.accessMode));
final MountableFile mountableFile = MountableFile.forHostPath(hostPath);
binds.add(new Bind(mountableFile.getResolvedPath(), new Volume(containerPath), mode.accessMode));
}

/**
Expand Down Expand Up @@ -623,14 +613,9 @@ public SELF withNetworkMode(String networkMode) {
*/
@Override
public SELF withClasspathResourceMapping(String resourcePath, String containerPath, BindMode mode) {
URL resource = GenericContainer.class.getClassLoader().getResource(resourcePath);

if (resource == null) {
throw new IllegalArgumentException("Could not find classpath resource at provided path: " + resourcePath);
}
String resourceFilePath = resource.getFile();
final MountableFile mountableFile = MountableFile.forClasspathResource(resourcePath);

this.addFileSystemBind(resourceFilePath, containerPath, mode);
this.addFileSystemBind(mountableFile.getResolvedPath(), containerPath, mode);

return self();
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package org.testcontainers.images.builder.traits;

import java.io.File;
import java.net.URL;
import org.testcontainers.utility.MountableFile;

import java.nio.file.Paths;

/**
Expand All @@ -11,14 +11,8 @@
public interface ClasspathTrait<SELF extends ClasspathTrait<SELF> & BuildContextBuilderTrait<SELF> & FilesTrait<SELF>> {

default SELF withFileFromClasspath(String path, String resourcePath) {
URL resource = ClasspathTrait.class.getClassLoader().getResource(resourcePath);

if (resource == null) {
throw new IllegalArgumentException("Could not find classpath resource at provided path: " + resourcePath);
}

String resourceFilePath = new File(resource.getFile()).getAbsolutePath();
final MountableFile mountableFile = MountableFile.forClasspathResource(resourcePath);

return ((SELF) this).withFileFromPath(path, Paths.get(resourceFilePath));
return ((SELF) this).withFileFromPath(path, Paths.get(mountableFile.getResolvedPath()));
}
}
196 changes: 196 additions & 0 deletions core/src/main/java/org/testcontainers/utility/MountableFile.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
package org.testcontainers.utility;

import com.google.common.base.Charsets;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang.SystemUtils;
import org.jetbrains.annotations.NotNull;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLDecoder;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

import static lombok.AccessLevel.PRIVATE;
import static org.testcontainers.utility.PathUtils.recursiveDeleteDir;

/**
* An abstraction over files and classpath resources aimed at encapsulating all the complexity of generating
* a path that the Docker daemon is about to create a volume mount for.
*/
@RequiredArgsConstructor(access = PRIVATE)
@Slf4j
public class MountableFile {

private final String path;

@Getter(lazy = true)
private final String resolvedPath = resolvePath();

/**
* Obtains a {@link MountableFile} corresponding to a resource on the classpath (including resources in JAR files)
*
* @param resourceName the classpath path to the resource
* @return a {@link MountableFile} that may be used to obtain a mountable path
*/
public static MountableFile forClasspathResource(@NotNull final String resourceName) {
return new MountableFile(getClasspathResource(resourceName, new HashSet<>()).toString());
}

/**
* Obtains a {@link MountableFile} corresponding to a file on the docker host filesystem.
*
* @param path the path to the resource
* @return a {@link MountableFile} that may be used to obtain a mountable path
*/
public static MountableFile forHostPath(@NotNull final String path) {
return new MountableFile(new File(path).toURI().toString());
}

/**
* Obtain a path that the Docker daemon should be able to use to volume mount a file/resource
* into a container. If this is a classpath resource residing in a JAR, it will be extracted to
* a temporary location so that the Docker daemon is able to access it.
*
* @return a volume-mountable path.
*/
private String resolvePath() {
String result;
if (path.contains(".jar!")) {
result = extractClassPathResourceToTempLocation(this.path);
} else {
result = unencodeResourceURIToFilePath(path);
}

if (SystemUtils.IS_OS_WINDOWS) {
result = PathUtils.createMinGWPath(result);
}

return result;
}

@NotNull
private static URL getClasspathResource(@NotNull final String resourcePath, @NotNull final Set<ClassLoader> classLoaders) {

final Set<ClassLoader> classLoadersToSearch = new HashSet<>(classLoaders);
// try context and system classloaders as well
classLoadersToSearch.add(Thread.currentThread().getContextClassLoader());
classLoadersToSearch.add(ClassLoader.getSystemClassLoader());
classLoadersToSearch.add(MountableFile.class.getClassLoader());

for (final ClassLoader classLoader : classLoadersToSearch) {
URL resource = classLoader.getResource(resourcePath);
if (resource != null) {
return resource;
}

// Be lenient if an absolute path was given
if (resourcePath.startsWith("/")) {
resource = classLoader.getResource(resourcePath.replaceFirst("/", ""));
if (resource != null) {
return resource;
}
}
}

throw new IllegalArgumentException("Resource with path " + resourcePath + " could not be found on any of these classloaders: " + classLoaders);
}

private static String unencodeResourceURIToFilePath(@NotNull final String resource) {
try {
// Convert any url-encoded characters (e.g. spaces) back into unencoded form
return new URI(resource).getPath();
} catch (URISyntaxException e) {
throw new IllegalStateException(e);
}
}

/**
* Extract a file or directory tree from a JAR file to a temporary location.
* This allows Docker to mount classpath resources as files.
*
* @param hostPath the path on the host, expected to be of the format 'file:/path/to/some.jar!/classpath/path/to/resource'
* @return the path of the temporary file/directory
*/
private String extractClassPathResourceToTempLocation(final String hostPath) {
File tmpLocation = new File(".testcontainers-tmp-" + Base58.randomString(5));
//noinspection ResultOfMethodCallIgnored
tmpLocation.delete();

String jarPath = hostPath.replaceFirst("jar:", "").replaceFirst("file:", "").replaceAll("!.*", "");
String urldecodedJarPath;
try {
urldecodedJarPath = URLDecoder.decode(jarPath, Charsets.UTF_8.name());
} catch (UnsupportedEncodingException e) {
throw new IllegalArgumentException("Could not URLDecode path with UTF-8 encoding: " + hostPath, e);
}
String internalPath = hostPath.replaceAll("[^!]*!/", "");

try (JarFile jarFile = new JarFile(urldecodedJarPath)) {
Copy link
Member

Choose a reason for hiding this comment

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

starting from Java 7 we can use Jar (aka zip) FileSystem provider:
http://docs.oracle.com/javase/7/docs/technotes/guides/io/fsp/zipfilesystemprovider.html

it also might contain path escaping OOTB (not sure here, have to re-check)

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah great - I missed this. This should make things quite a bit easier. Thanks!

Copy link
Member Author

Choose a reason for hiding this comment

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

I tried this, but it ended up not being any clearer, so I kept as-is!

Enumeration<JarEntry> entries = jarFile.entries();

while (entries.hasMoreElements()) {
JarEntry entry = entries.nextElement();
final String name = entry.getName();
if (name.startsWith(internalPath)) {
log.debug("Copying classpath resource(s) from {} to {} to permit Docker to bind",
hostPath,
tmpLocation);
copyFromJarToLocation(jarFile, entry, internalPath, tmpLocation);
}
}

} catch (IOException e) {
throw new IllegalStateException("Failed to process JAR file when extracting classpath resource: " + hostPath, e);
}

// Mark temporary files/dirs for deletion at JVM shutdown
deleteOnExit(tmpLocation.toPath());

return tmpLocation.getAbsolutePath();
}

@SuppressWarnings("ResultOfMethodCallIgnored")
private void copyFromJarToLocation(final JarFile jarFile,
final JarEntry entry,
final String fromRoot,
final File toRoot) throws IOException {

String destinationName = entry.getName().replaceFirst(fromRoot, "");
File newFile = new File(toRoot, destinationName);

log.debug("Copying resource {} from JAR file {}",
fromRoot,
jarFile.getName());

if (!entry.isDirectory()) {
// Create parent directories
newFile.mkdirs();
newFile.delete();
newFile.deleteOnExit();

try (InputStream is = jarFile.getInputStream(entry)) {
Files.copy(is, newFile.toPath());
} catch (IOException e) {
log.error("Failed to extract classpath resource " + entry.getName() + " from JAR file " + jarFile.getName(), e);
throw e;
}
}
}

private void deleteOnExit(final Path path) {
Runtime.getRuntime().addShutdownHook(new Thread(() -> recursiveDeleteDir(path)));
}
}
Loading