Docker images (#527)

with this change we're adding generation of 2 docker images - verifier and stub runner we also added a project `spring-cloud-contract-stub-runner-boot` which contains a far jar with stub runner boot fixes gh-526, gh-516
2018-01-24 17:07:22 +01:00
parent a5bdb32b7c
commit 37d7e8cfd3
24 changed files with 1652 additions and 1 deletions
--- a/docker/spring-cloud-contract-docker/Dockerfile
+++ b/docker/spring-cloud-contract-docker/Dockerfile
@@ -0,0 +1,12 @@
+FROM anapsix/alpine-java:8_jdk
+
+MAINTAINER Marcin Grzejszczak <mgrzejszczak@pivotal.io>
+
+COPY project /spring-cloud-contract/
+WORKDIR /spring-cloud-contract/
+# Let's copy the downloaded deps to .m2 and the gradle cache
+COPY target/maven_dependencies /root/.m2/repository/
+COPY target/gradle_dependencies /root/.gradle/
+# Let's download gradle wrapper if for some reason it hasn't been downloaded
+RUN ./gradlew clean build --stacktrace -x copyOutput || echo "Expected to fail"
+CMD ["./build.sh"]
--- a/docker/spring-cloud-contract-docker/get_dependencies.sh
+++ b/docker/spring-cloud-contract-docker/get_dependencies.sh
@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+WRAPPER_VERSION="4.4.1"
+GRADLE_BIN_DIR="gradle-${WRAPPER_VERSION}-bin"
+GRADLE_WRAPPER_DIR="${HOME}/.gradle/wrapper/dists/${GRADLE_BIN_DIR}"
+CURRENT_DIR="$( pwd )"
+GRADLE_OUTPUT_DIR="${CURRENT_DIR}/target/gradle_dependencies/"
+pushd project
+rm -rf .gradle
+./gradlew wrapper --gradle-version "${WRAPPER_VERSION}"
+./gradlew clean build -g "${GRADLE_OUTPUT_DIR}" -x copyOutput || echo "Expected to fail the build"
+if [ -d "${GRADLE_WRAPPER_DIR}" ]; then
+    echo "Copying Gradle Wrapper version [${WRAPPER_VERSION}]"
+    mkdir -p "${GRADLE_OUTPUT_DIR}/wrapper/dists/"
+    cp -r "${GRADLE_WRAPPER_DIR}" "${GRADLE_OUTPUT_DIR}/wrapper/dists/"
+else
+    echo "Gradle Wrapper [${GRADLE_WRAPPER_DIR}] not found. Will not copy it"
+fi
+rm -rf build
+popd
--- a/docker/spring-cloud-contract-docker/pom.xml
+++ b/docker/spring-cloud-contract-docker/pom.xml
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<parent>
+		<groupId>org.springframework.cloud</groupId>
+		<artifactId>spring-cloud-contract-docker-parent</artifactId>
+		<version>1.2.3.BUILD-SNAPSHOT</version>
+		<relativePath>..</relativePath>
+	</parent>
+
+	<artifactId>spring-cloud-contract-docker</artifactId>
+	<packaging>pom</packaging>
+	<version>1.2.3.BUILD-SNAPSHOT</version>
+	<name>Spring Cloud Contract Docker</name>
+	<description>Spring Cloud Contract Docker</description>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy-all</artifactId>
+			<scope>compile</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy-ant</artifactId>
+			<scope>compile</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy-groovydoc</artifactId>
+			<scope>compile</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-starter-contract-verifier</artifactId>
+			<scope>compile</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-contract-gradle-plugin</artifactId>
+			<scope>runtime</scope>
+		</dependency>
+		<dependency>
+			<groupId>io.spring.gradle</groupId>
+			<artifactId>dependency-management-plugin</artifactId>
+			<version>1.0.4.RELEASE</version>
+			<scope>runtime</scope>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+			  <groupId>org.apache.maven.plugins</groupId>
+			  <artifactId>maven-dependency-plugin</artifactId>
+			  <version>3.0.0</version>
+			  <executions>
+			    <execution>
+			      <id>copy-dependencies</id>
+			      <phase>package</phase>
+			      <goals>
+			        <goal>copy-dependencies</goal>
+			      </goals>
+			      <configuration>
+			        <outputDirectory>${project.build.directory}/maven_dependencies</outputDirectory>
+			        <overWriteReleases>false</overWriteReleases>
+			        <overWriteSnapshots>true</overWriteSnapshots>
+			        <overWriteIfNewer>true</overWriteIfNewer>
+							<useRepositoryLayout>true</useRepositoryLayout>
+			      </configuration>
+			    </execution>
+			  </executions>
+			</plugin>
+			<plugin>
+				<groupId>org.codehaus.mojo</groupId>
+				<artifactId>exec-maven-plugin</artifactId>
+				<version>1.6.0</version>
+				<executions>
+					<execution>
+						<id>gradle</id>
+						<phase>package</phase>
+						<configuration>
+							<executable>./get_dependencies.sh</executable>
+						</configuration>
+						<goals>
+							<goal>exec</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>com.spotify</groupId>
+			  <artifactId>dockerfile-maven-plugin</artifactId>
+			  <version>1.3.7</version>
+			  <executions>
+			    <execution>
+			      <id>default</id>
+			      <goals>
+			        <goal>build</goal>
+			        <goal>push</goal>
+			      </goals>
+			    </execution>
+			  </executions>
+			  <configuration>
+			    <repository>${docker.registry.organization}/spring-cloud-contract</repository>
+			    <tag>${project.version}</tag>
+	        <username>${env.DOCKER_HUB_USERNAME}</username>
+	        <password>${env.DOCKER_HUB_PASSWORD}</password>
+			  </configuration>
+			</plugin>
+		</plugins>
+	</build>
+</project>
--- a/docker/spring-cloud-contract-docker/project/build.gradle
+++ b/docker/spring-cloud-contract-docker/project/build.gradle
@@ -0,0 +1,114 @@
+buildscript {
+	repositories {
+		mavenLocal()
+		mavenCentral()
+		if (!"${verifierVersion}".contains("RELEASE")) {
+			maven { url "http://repo.spring.io/snapshot" }
+			maven { url "http://repo.spring.io/milestone" }
+			maven { url "http://repo.spring.io/release" }
+		}
+	}
+
+	dependencies {
+		classpath "io.spring.gradle:dependency-management-plugin:1.0.4.RELEASE"
+		classpath "org.springframework.cloud:spring-cloud-contract-gradle-plugin:${verifierVersion}"
+	}
+}
+
+group = getProp("PROJECT_GROUP") ?: 'com.example'
+version = getProp("PROJECT_VERSION") ?: '0.0.1-SNAPSHOT'
+
+repositories {
+	mavenLocal()
+	mavenCentral()
+		if (!"${verifierVersion}".contains("RELEASE")) {
+			maven { url "http://repo.spring.io/snapshot" }
+			maven { url "http://repo.spring.io/milestone" }
+			maven { url "http://repo.spring.io/release" }
+		}
+}
+
+apply plugin: 'groovy'
+apply plugin: 'io.spring.dependency-management'
+apply plugin: 'spring-cloud-contract'
+apply plugin: 'maven-publish'
+
+dependencyManagement {
+	imports {
+		mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:${verifierVersion}"
+	}
+}
+
+dependencies {
+	testCompile("org.springframework.cloud:spring-cloud-starter-contract-verifier")
+}
+
+test {
+	testLogging {
+		exceptionFormat = 'full'
+		afterSuite { desc, result ->
+			if (!desc.parent) {
+				println "Results: (${result.testCount} tests, ${result.successfulTestCount} successes, ${result.failedTestCount} failures, ${result.skippedTestCount} skipped)"
+				if (result.testCount == 0) {
+					throw new IllegalStateException("No tests were found. Failing the build")
+				}
+			}
+		}
+	}
+}
+
+// tests - contracts
+contracts {
+	baseClassForTests = "contracts.RestBase"
+	testMode = "EXPLICIT"
+	contractsDslDir = new File("/contracts")
+}
+
+task wrapper(type: Wrapper) {
+	gradleVersion = '4.4.1'
+}
+
+task cleanOutput(type: Delete) {
+	def dirName = "/spring-cloud-contract-output"
+  file(dirName).list().each {
+      f -> delete "${dirName}/${f}"
+  }
+}
+
+task copyOutput(type: Copy) {
+	dependsOn("cleanOutput")
+	from 'build'
+	into '/spring-cloud-contract-output'
+}
+
+test.finalizedBy("copyOutput")
+
+publishing {
+	repositories {
+		maven {
+			url getProp('REPO_WITH_BINARIES_URL') ?: 'http://localhost:8081/artifactory/libs-release-local'
+			credentials {
+				username getProp('REPO_WITH_BINARIES_USERNAME') ?: 'admin'
+				password getProp('REPO_WITH_BINARIES_PASSWORD') ?: 'password'
+			}
+		}
+	}
+	publications {
+		mavenJava(MavenPublication) {
+			from components.java
+		}
+	}
+}
+
+// explicitly disable artifacts publication
+String publishArtifacts = getProp("PUBLISH_ARTIFACTS") ?: "true"
+boolean publishEnabled = Boolean.parseBoolean(publishArtifacts)
+publish.setEnabled(publishEnabled)
+
+project.tasks.findAll { it.name.startsWith('publish') }*.setEnabled(publishEnabled)
+
+String getProp(String propName) {
+	return hasProperty(propName) ?
+			(getProperty(propName) ?: System.properties[propName]) : System.properties[propName] ?:
+			System.getenv(propName)
+}
--- a/docker/spring-cloud-contract-docker/project/build.sh
+++ b/docker/spring-cloud-contract-docker/project/build.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+export PROJECT_NAME="${PROJECT_NAME:-example}"
+echo "Setting project name to [${PROJECT_NAME}]"
+echo "rootProject.name='${PROJECT_NAME}'" >> settings.gradle
+echo "Running the build"
+./gradlew clean build publish --stacktrace
--- a/docker/spring-cloud-contract-docker/project/gradle.properties
+++ b/docker/spring-cloud-contract-docker/project/gradle.properties
@@ -0,0 +1,3 @@
+org.gradle.daemon=false
+verifierVersion=1.2.3.BUILD-SNAPSHOT
+bootVersion=1.5.9.RELEASE
--- a/docker/spring-cloud-contract-docker/project/gradle/wrapper/gradle-wrapper.jar
+++ b/docker/spring-cloud-contract-docker/project/gradle/wrapper/gradle-wrapper.jar
--- a/docker/spring-cloud-contract-docker/project/gradle/wrapper/gradle-wrapper.properties
+++ b/docker/spring-cloud-contract-docker/project/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.4.1-bin.zip
--- a/docker/spring-cloud-contract-docker/project/gradlew
+++ b/docker/spring-cloud-contract-docker/project/gradlew
@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+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
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+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
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"
--- a/docker/spring-cloud-contract-docker/project/gradlew.bat
+++ b/docker/spring-cloud-contract-docker/project/gradlew.bat
@@ -0,0 +1,84 @@
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
--- a/docker/spring-cloud-contract-docker/project/src/test/java/contracts/RestBase.java
+++ b/docker/spring-cloud-contract-docker/project/src/test/java/contracts/RestBase.java
@@ -0,0 +1,41 @@
+package contracts;
+
+import io.restassured.RestAssured;
+import org.junit.Before;
+import org.junit.ClassRule;
+import org.junit.runner.RunWith;
+import org.junit.validator.ValidateWith;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.util.StringUtils;
+
+/**
+ * @author Marcin Grzejszczak
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest(classes = RestBase.Config.class,
+		webEnvironment = SpringBootTest.WebEnvironment.NONE)
+public abstract class RestBase {
+
+	@Value("${APPLICATION_BASE_URL}") String url;
+	@Value("${APPLICATION_USERNAME:}") String username;
+	@Value("${APPLICATION_PASSWORD:}") String password;
+
+	@Before
+	public void setup() {
+		RestAssured.baseURI = this.url;
+		if (StringUtils.hasText(this.username)) {
+			RestAssured.authentication =
+					RestAssured.basic(this.username, this.password);
+		}
+	}
+
+	@Configuration
+	@EnableAutoConfiguration
+	protected static class Config {
+
+	}
+}