diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 00000000000..c6feb8bb6f7 Binary files /dev/null and b/.mvn/wrapper/maven-wrapper.jar differ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000000..6637cedb28e --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1 @@ +distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.3.9/apache-maven-3.3.9-bin.zip \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index 7208f5731c6..3c9ea15ebc9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,8 +19,8 @@ before_install: - docker pull mysql:5.6 - docker pull mysql:5.5 - docker pull postgres:latest - - docker pull selenium/standalone-chrome-debug:2.45.0 - - docker pull selenium/standalone-firefox-debug:2.45.0 + - docker pull selenium/standalone-chrome-debug:2.52.0 + - docker pull selenium/standalone-firefox-debug:2.52.0 - docker pull richnorth/vnc-recorder:latest - docker pull nginx:1.9.4 - docker pull dduportal/docker-compose:1.6.0 @@ -32,6 +32,15 @@ before_install: script: - mvn -B test + # Run Docker-in-Docker tests + - | + DOCKER_HOST=unix:///var/run/docker.sock DOCKER_TLS_VERIFY= docker run --rm \ + -v "$HOME/.m2":/root/.m2/ \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v "$(pwd)":"$(pwd)" \ + -w "$(pwd)" \ + openjdk:8-jre \ + ./mvnw -B -pl core test -Dtest=*GenericContainerRuleTest - mvn -B test -f shade-test/pom.xml cache: diff --git a/circle.yml b/circle.yml index 7587c090bf9..9cb5cdce9fa 100644 --- a/circle.yml +++ b/circle.yml @@ -18,6 +18,15 @@ dependencies: test: override: - mvn -B test + # Run Docker-in-Docker tests + - | + DOCKER_HOST=unix:///var/run/docker.sock DOCKER_TLS_VERIFY= docker run --rm \ + -v "$HOME/.m2":/root/.m2/ \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v "$(pwd)":"$(pwd)" \ + -w "$(pwd)" \ + openjdk:8-jre \ + ./mvnw -B -pl core test -Dtest=*GenericContainerRuleTest - mvn -B test -f shade-test/pom.xml post: - mkdir -p $CIRCLE_TEST_REPORTS/junit/ diff --git a/core/src/main/java/org/testcontainers/DockerClientFactory.java b/core/src/main/java/org/testcontainers/DockerClientFactory.java index de34ce2f2e0..6a12aa0acdb 100644 --- a/core/src/main/java/org/testcontainers/DockerClientFactory.java +++ b/core/src/main/java/org/testcontainers/DockerClientFactory.java @@ -1,36 +1,35 @@ package org.testcontainers; import com.github.dockerjava.api.DockerClient; -import com.github.dockerjava.api.command.CreateContainerResponse; +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.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.core.command.LogContainerResultCallback; import com.github.dockerjava.core.command.PullImageResultCallback; -import com.github.dockerjava.core.command.WaitContainerResultCallback; import lombok.Synchronized; -import org.slf4j.Logger; +import lombok.extern.slf4j.Slf4j; import org.testcontainers.dockerclient.*; import java.util.List; import java.util.Optional; +import java.util.function.BiFunction; +import java.util.function.Consumer; import static java.util.Arrays.asList; -import static org.slf4j.LoggerFactory.getLogger; /** * Singleton class that provides initialized Docker clients. *

* The correct client configuration to use will be determined on first use, and cached thereafter. */ +@Slf4j public class DockerClientFactory { + private static final String TINY_IMAGE = "alpine:3.2"; private static DockerClientFactory instance; - private static final Logger LOGGER = getLogger(DockerClientFactory.class); // Cached client configuration private DockerClientProviderStrategy strategy; @@ -80,6 +79,8 @@ public DockerClient client() { } strategy = DockerClientProviderStrategy.getFirstValidStrategy(CONFIGURATION_STRATEGIES); + + log.info("Docker host IP address is {}", strategy.getDockerHostIpAddress()); DockerClient client = strategy.getClient(); if (!preconditionsChecked) { @@ -87,13 +88,20 @@ public DockerClient client() { Version version = client.versionCmd().exec(); activeApiVersion = version.getApiVersion(); activeExecutionDriver = dockerInfo.getExecutionDriver(); - LOGGER.info("Connected to docker: \n" + + log.info("Connected to docker: \n" + " Server Version: " + dockerInfo.getServerVersion() + "\n" + " API Version: " + activeApiVersion + "\n" + " Operating System: " + dockerInfo.getOperatingSystem() + "\n" + " Total Memory: " + dockerInfo.getMemTotal() / (1024 * 1024) + " MB"); checkVersion(version.getVersion()); + + List images = client.listImagesCmd().exec(); + // Pull the image we use to perform some checks + if (images.stream().noneMatch(it -> it.getRepoTags() != null && asList(it.getRepoTags()).contains(TINY_IMAGE))) { + client.pullImageCmd(TINY_IMAGE).exec(new PullImageResultCallback()).awaitSuccess(); + } + checkDiskSpaceAndHandleExceptions(client); preconditionsChecked = true; } @@ -121,7 +129,7 @@ private void checkDiskSpaceAndHandleExceptions(DockerClient client) { } catch (NotEnoughDiskSpaceException e) { throw e; } catch (Exception e) { - LOGGER.warn("Encountered and ignored error while checking disk space", e); + log.warn("Encountered and ignored error while checking disk space", e); } } @@ -130,44 +138,47 @@ private void checkDiskSpaceAndHandleExceptions(DockerClient client) { * @param client an active Docker client */ private void checkDiskSpace(DockerClient client) { + DiskSpaceUsage df = runInsideDocker(client, cmd -> cmd.withCmd("df", "-P"), (dockerClient, id) -> { + String logResults = dockerClient.logContainerCmd(id) + .withStdOut(true) + .exec(new LogToStringContainerCallback()) + .toString(); + + return parseAvailableDiskSpace(logResults); + }); + + log.info("Disk utilization in Docker environment is {} ({} )", + df.usedPercent.map(x -> x + "%").orElse("unknown"), + df.availableMB.map(x -> x + " MB available").orElse("unknown available")); + + if (df.availableMB.orElseThrow(NotAbleToGetDiskSpaceUsageException::new) < 2048) { + log.error("Docker environment has less than 2GB free - execution is unlikely to succeed so will be aborted."); + throw new NotEnoughDiskSpaceException("Not enough disk space in Docker environment"); + } + } - List images = client.listImagesCmd().exec(); - if (!images.stream().anyMatch(it -> it.getRepoTags() != null && asList(it.getRepoTags()).contains("alpine:3.2"))) { - PullImageResultCallback callback = client.pullImageCmd("alpine:3.2").exec(new PullImageResultCallback()); - callback.awaitSuccess(); + public T runInsideDocker(Consumer createContainerCmdConsumer, BiFunction block) { + if (strategy == null) { + client(); } + // We can't use client() here because it might create an infinite loop + return runInsideDocker(strategy.getClient(), createContainerCmdConsumer, block); + } - CreateContainerResponse createContainerResponse = client.createContainerCmd("alpine:3.2").withCmd("df", "-P").exec(); - String id = createContainerResponse.getId(); + private T runInsideDocker(DockerClient client, Consumer createContainerCmdConsumer, BiFunction block) { + CreateContainerCmd createContainerCmd = client.createContainerCmd(TINY_IMAGE); + createContainerCmdConsumer.accept(createContainerCmd); + String id = createContainerCmd.exec().getId(); client.startContainerCmd(id).exec(); - LogContainerResultCallback callback = client.logContainerCmd(id).withStdOut(true).exec(new LogContainerCallback()); try { - - WaitContainerResultCallback waitCallback = new WaitContainerResultCallback(); - client.waitContainerCmd(id).exec(waitCallback); - waitCallback.awaitStarted(); - - callback.awaitCompletion(); - String logResults = callback.toString(); - - DiskSpaceUsage df = parseAvailableDiskSpace(logResults); - LOGGER.info("Disk utilization in Docker environment is {} ({} )", - df.usedPercent.map(x -> x.toString() + "%").orElse("unknown"), - df.availableMB.map(x -> x.toString() + " MB available").orElse("unknown available")); - - if (df.availableMB.orElseThrow(NotAbleToGetDiskSpaceUsageException::new) < 2048) { - LOGGER.error("Docker environment has less than 2GB free - execution is unlikely to succeed so will be aborted."); - throw new NotEnoughDiskSpaceException("Not enough disk space in Docker environment"); - } - } catch (InterruptedException e) { - throw new RuntimeException(e); + return block.apply(client, id); } finally { try { client.removeContainerCmd(id).withRemoveVolumes(true).withForce(true).exec(); } catch (NotFoundException | InternalServerErrorException ignored) { - + log.debug("", ignored); } } } @@ -231,18 +242,3 @@ private static class NotAbleToGetDiskSpaceUsageException extends RuntimeExceptio } } } - -class LogContainerCallback extends LogContainerResultCallback { - private final StringBuffer log = new StringBuffer(); - - @Override - public void onNext(Frame frame) { - log.append(new String(frame.getPayload())); - super.onNext(frame); - } - - @Override - public String toString() { - return log.toString(); - } -} \ No newline at end of file diff --git a/core/src/main/java/org/testcontainers/dockerclient/DockerClientConfigUtils.java b/core/src/main/java/org/testcontainers/dockerclient/DockerClientConfigUtils.java index fb32dd6630f..979b8f93a4e 100644 --- a/core/src/main/java/org/testcontainers/dockerclient/DockerClientConfigUtils.java +++ b/core/src/main/java/org/testcontainers/dockerclient/DockerClientConfigUtils.java @@ -1,18 +1,53 @@ package org.testcontainers.dockerclient; import com.github.dockerjava.core.DockerClientConfig; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang.StringUtils; +import org.testcontainers.DockerClientFactory; +import java.io.File; +import java.util.Optional; + +@Slf4j public class DockerClientConfigUtils { + + // See https://github.com/docker/docker/blob/a9fa38b1edf30b23cae3eade0be48b3d4b1de14b/daemon/initlayer/setup_unix.go#L25 + public static final boolean IN_A_CONTAINER = new File("/.dockerenv").exists(); + + @Getter(lazy = true) + private static final Optional detectedDockerHostIp = Optional + .of(IN_A_CONTAINER) + .filter(it -> it) + .map(file -> DockerClientFactory.instance().runInsideDocker( + cmd -> cmd.withCmd("sh", "-c", "ip route|awk '/default/ { print $3 }'"), + (client, id) -> { + try { + return client.logContainerCmd(id) + .withStdOut(true) + .exec(new LogToStringContainerCallback()) + .toString(); + } catch (Exception e) { + log.warn("Can't parse the default gateway IP", e); + return null; + } + } + )) + .map(StringUtils::trimToEmpty) + .filter(StringUtils::isNotBlank); + public static String getDockerHostIpAddress(DockerClientConfig config) { - switch (config.getDockerHost().getScheme()) { - case "http": - case "https": - case "tcp": - return config.getDockerHost().getHost(); - case "unix": - return "localhost"; - default: - return null; - } + return getDetectedDockerHostIp().orElseGet(() -> { + switch (config.getDockerHost().getScheme()) { + case "http": + case "https": + case "tcp": + return config.getDockerHost().getHost(); + case "unix": + return "localhost"; + default: + return null; + } + }); } } diff --git a/core/src/main/java/org/testcontainers/dockerclient/EnvironmentAndSystemPropertyClientProviderStrategy.java b/core/src/main/java/org/testcontainers/dockerclient/EnvironmentAndSystemPropertyClientProviderStrategy.java index 4b414b70d5e..918f341f6b8 100644 --- a/core/src/main/java/org/testcontainers/dockerclient/EnvironmentAndSystemPropertyClientProviderStrategy.java +++ b/core/src/main/java/org/testcontainers/dockerclient/EnvironmentAndSystemPropertyClientProviderStrategy.java @@ -27,7 +27,6 @@ public void test() throws InvalidConfigurationException { } LOGGER.info("Found docker client settings from environment"); - LOGGER.info("Docker host IP address is {}", DockerClientConfigUtils.getDockerHostIpAddress(config)); } @Override diff --git a/core/src/main/java/org/testcontainers/dockerclient/LogToStringContainerCallback.java b/core/src/main/java/org/testcontainers/dockerclient/LogToStringContainerCallback.java new file mode 100644 index 00000000000..e0ffce7c3a1 --- /dev/null +++ b/core/src/main/java/org/testcontainers/dockerclient/LogToStringContainerCallback.java @@ -0,0 +1,24 @@ +package org.testcontainers.dockerclient; + +import com.github.dockerjava.api.model.Frame; +import com.github.dockerjava.core.command.LogContainerResultCallback; + +public class LogToStringContainerCallback extends LogContainerResultCallback { + private final StringBuffer log = new StringBuffer(); + + @Override + public void onNext(Frame frame) { + log.append(new String(frame.getPayload())); + super.onNext(frame); + } + + @Override + public String toString() { + try { + awaitCompletion(); + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + return log.toString(); + } +} diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 900cb28788a..e0f8eefcb40 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -8,6 +8,7 @@ * [Usage modes](usage.md#usage-modes) * [Maven dependencies](usage.md#maven-dependencies) * [Logging](usage.md#logging) + * [Docker in Docker](usage/dind.md) ## Generic containers @@ -52,4 +53,4 @@ ## * [License](index.md#license) * [Attributions](index.md#attributions) -* [Contributing](index.md#contributing) \ No newline at end of file +* [Contributing](index.md#contributing) diff --git a/docs/compatibility.md b/docs/compatibility.md index 4a8b1c2c973..a3418fa3c77 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -5,7 +5,8 @@ | Linux - general | Docker v1.10 | | | Linux - Travis CI | Docker v1.10 | See [example .travis.yml](https://raw.githubusercontent.com/testcontainers/testcontainers-java/master/.travis.yml) for baseline Travis CI configuration | | Linux - Circle CI (LXC driver) | Docker v1.9.1 | The `exec` feature is not compatible with Circle CI. See [example circle.yml](../circle.yml) for baseline CircleCI configuration | +| Linux - Docker in Docker | Docker v1.12 | See [Docker-in-Docker](usage/dind.md) for the detailed configuration | | Mac OS X - Docker Toolbox | Docker Machine v0.8.0 | | | Mac OS X - Docker for Mac | 1.12.0 | *Support is best-efforts at present*. `getTestHostIpAddress()` is [not currently supported](https://github.com/testcontainers/testcontainers-java/issues/166) due to limitations in Docker for Mac. | | Windows - Docker Toolbox | | *Support is limited at present and this is not currently tested on a regular basis*. | -| Windows - Docker for Windows Beta | | *Not currently supported*. | \ No newline at end of file +| Windows - Docker for Windows Beta | | *Not currently supported*. | diff --git a/docs/usage.md b/docs/usage.md index a60ddc15095..0b4a65ed429 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -19,6 +19,7 @@ Testcontainers will try to connect to a Docker daemon using the following strate * `DOCKER_TLS_VERIFY=1` * `DOCKER_CERT_PATH=~/.docker` * If Docker Machine is installed, the docker machine environment for the *first* machine found. Docker Machine needs to be on the PATH for this to succeed. +* If you're going to run your tests inside a container, please read [Docker in Docker](usage/dind.md) first. ### Usage modes @@ -97,4 +98,4 @@ should be included in your classpath to show a reasonable level of log output: -``` \ No newline at end of file +``` diff --git a/docs/usage/dind.md b/docs/usage/dind.md new file mode 100644 index 00000000000..ded3c0f7de7 --- /dev/null +++ b/docs/usage/dind.md @@ -0,0 +1,49 @@ +# Docker in Docker + +> Since 1.1.8 + +Testcontainers itself can be used from inside a container. +This is very useful for different CI scenarios like running everything in containers on Jenkins, or Docker-based CI tools such as Drone. + +TestContainers will automatically detect if it's inside a container and instead of "localhost" will use the default gateway's IP. + +However, additional configuration is required if you use [volume mapping](options.md#volume-mapping). The following points need to be considered: + +* The docker socket must be available via a volume mount +* The 'local' source code directory must be volume mounted *at the same path* inside the container that Testcontainers runs in, so that Testcontainers is able to set up the correct volume mounts for the containers it spawns. + +## Docker-only example +If you run the tests with just `docker run ...` then make sure you add `-v $PWD:$PWD -w $PWD -v /var/run/docker.sock:/var/run/docker.sock` to the command, so it will look like this: +```bash +$ tree . +. +├── pom.xml +└── src + └── test + └── java + └── MyTestWithTestContainers.java + +$ docker run -it --rm -v $PWD:$PWD -w $PWD -v /var/run/docker.sock:/var/run/docker.sock maven:3 mvn test +``` + +Where: +* `-v $PWD:$PWD` will add your current directory as a volume inside the container +* `-w $PWD` will set the current directory to this volume +* `-v /var/run/docker.sock:/var/run/docker.sock` will map the Docker socket + +## Docker Compose example +The same can be achived with Docker Compose: +```yaml +tests: + image: maven:3 + stop_signal: SIGKILL + stdin_open: true + tty: true + working_dir: $PWD + volumes: + - $PWD:$PWD + - /var/run/docker.sock:/var/run/docker.sock + # Maven cache (optional) + - ~/.m2:/root/.m2 + command: mvn test +``` diff --git a/mvnw b/mvnw new file mode 100755 index 00000000000..6ecc150ae0a --- /dev/null +++ b/mvnw @@ -0,0 +1,236 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Maven2 Start Up Batch script +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# M2_HOME - location of maven2's installed home dir +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "`uname`" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # + # Look for the Apple JDKs first to preserve the existing behaviour, and then look + # for the new JDKs provided by Oracle. + # + if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK ] ; then + # + # Apple JDKs + # + export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Java/JavaVirtualMachines/CurrentJDK ] ; then + # + # Apple JDKs + # + export JAVA_HOME=/System/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -L "/Library/Java/JavaVirtualMachines/CurrentJDK" ] ; then + # + # Oracle JDKs + # + export JAVA_HOME=/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -x "/usr/libexec/java_home" ]; then + # + # Apple JDKs + # + export JAVA_HOME=`/usr/libexec/java_home` + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +if [ -z "$M2_HOME" ] ; then + ## resolve links - $0 may be a link to maven's home + PRG="$0" + + # need this for relative symlinks + while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --unix "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --unix "$CLASSPATH"` +fi + +# For Migwn, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" + # TODO classpath? +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="`which javac`" + if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=`which readlink` + if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then + if $darwin ; then + javaHome="`dirname \"$javaExecutable\"`" + javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" + else + javaExecutable="`readlink -f \"$javaExecutable\"`" + fi + javaHome="`dirname \"$javaExecutable\"`" + javaHome=`expr "$javaHome" : '\(.*\)/bin'` + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="`which java`" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + local basedir=$(pwd) + local wdir=$(pwd) + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + wdir=$(cd "$wdir/.."; pwd) + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-$(find_maven_basedir)} +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --windows "$CLASSPATH"` + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# avoid using MAVEN_CMD_LINE_ARGS below since that would loose parameter escaping in $@ +exec "$JAVACMD" \ + $MAVEN_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 00000000000..8bb82754165 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,146 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Maven2 Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" +if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +set MAVEN_CMD_LINE_ARGS=%MAVEN_CONFIG% %* + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" + +set WRAPPER_JAR=""%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# avoid using MAVEN_CMD_LINE_ARGS below since that would loose parameter escaping in %* +%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" +if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%" == "on" pause + +if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% + +exit /B %ERROR_CODE%