Merge pull request #35 from tlmiller/SCRUM-3593

Work allows rdap-conformance to be used from within Docker.

Author: tlmiller

.travis.yml

@@ -1 +1,17 @@
 language: java
+jdk:
+    - oraclejdk8
+    - openjdk8
+
+dist: trusty
+sudo: required
+
+services:
+    - docker
+
+deploy:
+    provider: script
+    script: ./scripts/docker-deploy.sh
+    on:
+        branch: master
+        jdk: openjdk8

Dockerfile

@@ -0,0 +1,32 @@
+
+FROM openjdk:8-jdk
+
+ENV MAVEN_VERSION=3.2.5 \
+    M2_HOME=/m2
+
+RUN cd /tmp && \
+    wget http://www-eu.apache.org/dist/maven/maven-3/$MAVEN_VERSION/binaries/apache-maven-$MAVEN_VERSION-bin.tar.gz && \
+    tar xf apache-maven-$MAVEN_VERSION-bin.tar.gz && \
+    mv apache-maven-$MAVEN_VERSION $M2_HOME && \
+    rm -f apache-maven-$MAVEN_VERSION-bin.tar.gz
+
+COPY pom.xml /build/
+
+COPY src/ /build/src/
+COPY repo/ /build/repo/
+RUN cd /build && \
+    $M2_HOME/bin/mvn verify -DskipDocker && \
+    mkdir /app && \
+    cp target/*.jar /app && \
+    cp target/docker-extras/entrypoint.sh /app/ && \
+    chmod 0744 /app/entrypoint.sh && \
+    cd / && \
+    rm -rf /build ${M2_HOME}
+
+WORKDIR /app
+RUN useradd -MrU conformance && \
+    chown -R conformance /app
+
+EXPOSE 8080
+USER conformance
+ENTRYPOINT ["/app/entrypoint.sh", "rdap-configuration.json"]

README.md

@@ -133,6 +133,45 @@ For example:
         } 
     }
 
+Docker
+------
+
+`rdap-conformance` can be executed as a Docker container. The
+container works by having a test configuration file mounted into the
+container's file system. The return code of the container can be used
+to determine test success or failure.
+
+### Building the image
+
+The following command can be used to build an image:
+
+```
+docker build -t apnic/rdap-conformance .
+```
+
+### Running the container
+
+To run the Docker container:
+
+```
+docker run -d -v "{configuration-path}:/app/rdap-configuration.json" \
+           --name rdap-conformance apnic/rdap-conformance
+```
+
+<aside class="notice">
+It's important to note that the configuration file must be mounted
+into the container as a file, not a directory.
+</aside>
+
+### Accessing the return code of the container
+
+The below command can be used to access the return code for the
+container:
+
+```
+docker wait rdap-conformance
+```
+
 License
 -------
 

pom.xml

@@ -6,7 +6,7 @@
     <groupId>net.apnic.rdap</groupId>
     <artifactId>rdap-conformance</artifactId>
     <packaging>jar</packaging>
-    <version>0.4-SNAPSHOT</version>
+    <version>0.4</version>
     <name>rdap-conformance</name>
     <description>RDAP conformance</description>
     <inceptionYear>2014</inceptionYear>
@@ -42,6 +42,34 @@
                     <target>1.5</target>
                 </configuration>
             </plugin>
+
+            <plugin>
+                <artifactId>maven-resources-plugin</artifactId>
+                <configuration>
+                    <escapeString>\</escapeString>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>docker-extras</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>copy-resources</goal>
+                        </goals>
+                        <configuration>
+                            <!-- NOTE: We CANNOT use target/docker as that's being used by the docker-maven-plugin -->
+                            <!-- Recursive copy is not a good thing! -->
+                            <outputDirectory>${project.build.directory}/docker-extras/</outputDirectory>
+                            <resources>
+                                <resource>
+                                    <directory>src/main/docker/</directory>
+                                    <filtering>true</filtering>
+                                </resource>
+                            </resources>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>

scripts/docker-deploy.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+VERSION=`cat pom.xml | grep "^    <version>.*</version>$" | awk -F'[><]' '{print $3}'`
+
+echo "Deploying Docker image for $VERSION"
+
+docker build -t apnic/rdap-conformance:$VERSION \
+             -t apnic/rdap-conformance:latest .
+
+docker login -u "$DOCKER_USERNAME" -p "$DOCKER_PASSWORD"
+docker push apnic/rdap-conformance:$VERSION
+docker push apnic/rdap-conformance:latest

src/main/docker/entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo "Launching with arguments: $@"
+
+exec java -jar @project.artifactId@[email protected]@[email protected]@ "$\@"

src/main/java/net/apnic/rdap/conformance/Application.java

@@ -36,6 +36,7 @@
  * @version 0.4-SNAPSHOT
  */
 public final class Application {
+    private static final int EX_FAILURE = 21;
     private static final int EX_USAGE = 64;
     private static final int EX_NOINPUT = 66;
     private static final int EX_SOFTWARE = 70;
@@ -87,7 +88,7 @@ private static String getJarName() {
         return jarName;
     }
 
-    private static void addSearchTests(final List<Test> tests,
+    private static void addSearchTests(final TestAggregate tests,
                                        final ObjectClass oc,
                                        final SearchTest st,
                                        final String prefix,
@@ -145,7 +146,7 @@ private static Result getDocRefProto(final String document,
     }
 
     private static void addNonRdapTests(final Context c,
-                                        final List<Test> tests) {
+                                        final TestAggregate tests) {
         /* Relative URI in the HTTP request. */
         Result relative = new Result();
         relative.setTestName("common.bad-uri-relative");
@@ -184,7 +185,7 @@ private static void addNonRdapTests(final Context c,
     }
 
     private static void addUnsupportedQueryTypeTests(final Specification s,
-                                                     final List<Test> tests) {
+                                                     final TestAggregate tests) {
         /* Previously, this required that the server return a 400 (Bad
          * Request) for unsupported queries, as per using-http [5.4].
          * However, rdap-query now states that for documented query
@@ -211,7 +212,7 @@ private static void addUnsupportedQueryTypeTests(final Specification s,
     }
 
     private static void addIpTests(final Specification s,
-                                   final List<Test> tests) {
+                                   final TestAggregate tests) {
         ObjectClass ocIp = s.getObjectClass("ip");
         if ((ocIp == null) || !ocIp.isSupported()) {
             return;
@@ -259,7 +260,7 @@ private static void addIpTests(final Specification s,
     }
 
     private static void addAutnumTests(final Specification s,
-                                       final List<Test> tests) {
+                                       final TestAggregate tests) {
         ObjectClass ocAn = s.getObjectClass("autnum");
         if ((ocAn == null) || !ocAn.isSupported()) {
             return;
@@ -296,7 +297,7 @@ private static void addAutnumTests(final Specification s,
     }
 
     private static void addNameserverTests(final Specification s,
-                                           final List<Test> tests)
+                                           final TestAggregate tests)
             throws Exception {
         ObjectClass ocNs = s.getObjectClass("nameserver");
         if ((ocNs == null) || !ocNs.isSupported()) {
@@ -347,7 +348,7 @@ private static void addNameserverTests(final Specification s,
     }
 
     private static void addEntityTests(final Specification s,
-                                       final List<Test> tests)
+                                       final TestAggregate tests)
             throws Exception {
         ObjectClass ocEn = s.getObjectClass("entity");
         if ((ocEn == null) || !ocEn.isSupported()) {
@@ -398,7 +399,7 @@ private static void addEntityTests(final Specification s,
     }
 
     private static void addDomainTests(final Specification s,
-                                       final List<Test> tests)
+                                       final TestAggregate tests)
             throws Exception {
         ObjectClass ocDom = s.getObjectClass("domain");
         if ((ocDom == null) || !ocDom.isSupported()) {
@@ -520,26 +521,26 @@ public static void main(final String[] args) throws Exception {
         }
 
         String path = args[0];
-        Specification s = null;
+        Specification spec = null;
         try {
-            s = Specification.fromPath(path);
+            spec = Specification.fromPath(path);
         } catch (Exception e) {
             System.err.println("Unable to load specification "
                                + "path (" + path + "): "
                                + e.toString());
             System.exit(EX_NOINPUT);
         }
-        if (s == null) {
+        if (spec == null) {
             System.err.println("Specification (" + path + ") is empty.");
             System.exit(EX_NOINPUT);
         }
 
         RateLimiter rateLimiter =
-            (s.getRequestsPerSecond() > 0)
-                ? RateLimiter.create(s.getRequestsPerSecond())
+            (spec.getRequestsPerSecond() > 0)
+                ? RateLimiter.create(spec.getRequestsPerSecond())
                 : null;
 
-        List<Test> tests = new ArrayList();
+        TestAggregate tests = new TestAggregate();
 
         /* For now, the non-RDAP-specific tests are disabled. These
          * are fairly niche, and in many cases can't easily be fixed
@@ -553,7 +554,7 @@ public static void main(final String[] args) throws Exception {
          * than not testing the responses at all, allow for the
          * supported content type to be set in the configuration, and
          * add a result at the beginning indicating this failure. */
-        if (s.getAcceptContentType() != null) {
+        if (spec.getAcceptContentType() != null) {
             Result ctres = new Result();
             ctres.setTestName("common.rdap-specific-content-type");
             ctres.setDocument("rfc7480");
@@ -563,12 +564,12 @@ public static void main(final String[] args) throws Exception {
             System.out.println(ctres.toString());
         }
 
-        addUnsupportedQueryTypeTests(s, tests);
-        addIpTests(s, tests);
-        addAutnumTests(s, tests);
-        addNameserverTests(s, tests);
-        addEntityTests(s, tests);
-        addDomainTests(s, tests);
+        addUnsupportedQueryTypeTests(spec, tests);
+        addIpTests(spec, tests);
+        addAutnumTests(spec, tests);
+        addNameserverTests(spec, tests);
+        addEntityTests(spec, tests);
+        addDomainTests(spec, tests);
 
         tests.add(new net.apnic.rdap.conformance.test.help.Standard());
         AtomicInteger testsRunning = new AtomicInteger(0);
@@ -578,7 +579,7 @@ public static void main(final String[] args) throws Exception {
                                                 .availableProcessors());
         for (final Test t : tests) {
             final Context context =
-                createContext(s, rateLimiter, executorService, testsRunning);
+                createContext(spec, rateLimiter, executorService, testsRunning);
             context.submitTest(t);
         }
 
@@ -598,7 +599,7 @@ public static void main(final String[] args) throws Exception {
                 ctres
             );
         final Context context =
-            createContext(s, rateLimiter, executorService, testsRunning);
+            createContext(spec, rateLimiter, executorService, testsRunning);
         context.setContentType("application/json");
         context.submitTest(test);
 
@@ -614,5 +615,9 @@ public static void main(final String[] args) throws Exception {
         }
 
         executorService.shutdown();
+
+        if(tests.hasFailure()) {
+            System.exit(EX_FAILURE);
+        }
     }
 }

src/main/java/net/apnic/rdap/conformance/Context.java

@@ -249,6 +249,7 @@ public void onSuccess(final HttpResponse httpResponse) {
                                     testsRunning.getAndDecrement();
                                 }
                                 public void onFailure(final Throwable t) {
+                                    System.out.println("**********");
                                     test.setError(t);
                                     test.run();
                                     synchronized (System.out) {

src/main/java/net/apnic/rdap/conformance/Test.java

@@ -34,6 +34,13 @@ public interface Test {
      */
     HttpRequest getRequest();
 
+    /**
+     * <p>isFailure.</p>
+     *
+     * @return boolean indiciator if the test succeeded or passed
+     */
+    boolean hasFailed();
+
     /**
      * <p>setResponse.</p>
      *

src/main/java/net/apnic/rdap/conformance/TestAggregate.java

@@ -0,0 +1,31 @@
+package net.apnic.rdap.conformance;
+
+import java.util.ArrayList;
+
+/**
+ * Container class for holding a list of Test objects.
+ *
+ * This container is a child of java.util.ArrayList<Test> and provides helper
+ * methods on to the list of Test objects.
+ *
+ * Note: Class does not implement any java.util.ArrayList<Test> constructors.
+ * These can be added as needed.
+ */
+public class TestAggregate
+    extends ArrayList<Test>
+{
+    /**
+     * Indicates if the at least one test in this aggregate has failed.
+     *
+     * @return boolean if at least one test in the aggregate has failed.
+     */
+    public boolean hasFailure()
+    {
+        for(Test test : this) {
+            if(test.hasFailed()) {
+                return true;
+            }
+        }
+        return false;
+    }
+}