Added JUnit Tests and Build Definition Files

Author: Thomas Weise

.travis.yml

@@ -0,0 +1,37 @@
+##
+## Build with Travis.CI
+##
+## https://travis-ci.org/optimizationBenchmarking/documentation-examples-loader
+#
+language: java
+
+# By default, it runs under Java 7
+jdk:
+  - oraclejdk7
+  - openjdk7
+  - oraclejdk8
+    
+# Cache Maven dependencies to speed up builds.
+cache:
+  directories:
+  - $HOME/.m2
+
+# custom build step
+script: ant
+
+before_install:
+  - sudo apt-get -q -y -f update
+# Install the required Ant version
+  - wget "https://raw.githubusercontent.com/optimizationBenchmarking/utils-build/master/antWebInstallerLinux.sh"
+  - chmod 755 antWebInstallerLinux.sh
+  - sudo ./antWebInstallerLinux.sh  
+# fix for buffer overflows in getLocalHostName
+# https://github.com/travis-ci/travis-ci/issues/5227
+  - cat /etc/hosts # optionally check the content *before*
+  - sudo hostname "$(hostname | cut -c1-63)"
+  - sed -e "s/^\\(127\\.0\\.0\\.1.*\\)/\\1 $(hostname | cut -c1-63)/" /etc/hosts | sudo tee /etc/hosts
+  - cat /etc/hosts # optionally check the content *after*
+  
+# prevent Maven from running
+install:
+  - echo "Nothing."

appveyor.yml

@@ -0,0 +1,34 @@
+##
+## Build with appveyor
+##
+## https://ci.appveyor.com/project/thomasWeise/documentation-examples-loader
+#  
+environment:
+  matrix:
+    - JAVA_HOME: C:\Program Files\Java\jdk1.7.0
+    - JAVA_HOME: C:\Program Files\Java\jdk1.8.0
+
+install:
+  - ps: if(!(Test-Path -Path 'C:\bin\apache-maven-3.2.5\' )){ cinst maven -Version 3.2.5 }
+  - ps: if(!(Test-Path -Path 'C:\ProgramData\chocolatey\lib\ant\apache-ant-1.9.6\' )){ cinst ant -i -Version 1.9.6 }
+  # choco does not set the PATH environment variable correctly
+  # so we do it manually, like
+  # https://github.com/abelsromero/asciidoctor-maven-plugin/blob/master/appveyor.yml
+  - cmd: SET PATH=C:\ProgramData\chocolatey\lib\ant\apache-ant-1.9.6\bin;C:\bin\apache-maven-3.2.5\bin;%JAVA_HOME%\bin;%PATH%
+  
+cache:
+  - C:\bin\apache-maven-3.2.5\
+  - C:\ProgramData\chocolatey\lib\ant\apache-ant-1.9.6
+
+platform:
+  - x86
+  - x64
+  
+configuration:
+  - Release
+    
+build_script:
+  - ant
+  
+test_script:
+  - echo "Nothing."

circle.yml

@@ -0,0 +1,40 @@
+##
+## Build with CircleCI
+##
+## https://circleci.com/gh/optimizationBenchmarking/documentation-examples-loader
+#
+machine:
+# Install the newest version of ant.
+  pre:
+# Install the required Ant version
+  - sudo apt-get -q -y -f update
+  - wget "https://raw.githubusercontent.com/optimizationBenchmarking/utils-build/master/antWebInstallerLinux.sh"
+  - chmod 755 antWebInstallerLinux.sh
+  - sudo ./antWebInstallerLinux.sh
+  environment:
+# We set the environment variable JAVA_OPTS to reduce
+# the memory footprint in order to prevent unexpected
+# test termination.
+    JAVA_OPTS: -Xms1536m -Xmx1536m
+    MAVEN_OPTS: -Xms1536m -Xmx1536m
+    _JAVA_OPTIONS: -Xms1536m -Xmx1536m
+    
+    
+# We do nothing here.
+dependencies:
+  override:
+    - echo "Nothing"
+      
+# We set a high timeout to prevent the test from being
+# terminated unexpectedly.
+test:
+  override:
+    - ant:
+        timeout: 10000
+        
+# The branches to be ignored
+general:
+  branches:
+    ignore:
+      - gh-pages
+      - documentation

shippable.yml

@@ -0,0 +1,40 @@
+##
+## Build with Shippable
+##
+## https://app.shippable.com/projects/ TODO
+#
+#
+language: java
+#
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
+#
+# install maven
+before_install:
+  - if [[ $SHIPPABLE_JDK_VERSION == "openjdk7" ]] ; then export JAVA_HOME="/usr/lib/jvm/java-7-openjdk-amd64"; export PATH="$PATH:/usr/lib/jvm/java-7-openjdk-amd64/bin"; export java_path="/usr/lib/jvm/java-7-openjdk-amd64/jre/bin/java"; fi
+  - if [[ $SHIPPABLE_JDK_VERSION == "oraclejdk7" ]] ; then export JAVA_HOME="/usr/lib/jvm/java-7-oracle"; export PATH="$PATH:/usr/lib/jvm/java-7-oracle/bin"; export java_path="/usr/lib/jvm/java-7-oracle/jre/bin/java"; fi
+  - if [[ $SHIPPABLE_JDK_VERSION == "openjdk6" ]] ; then export JAVA_HOME="/usr/lib/jvm/java-6-openjdk-amd64"; export PATH="$PATH:/usr/lib/jvm/java-6-openjdk-amd64/bin"; export java_path="/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java"; fi
+  - if [[ $SHIPPABLE_JDK_VERSION == "oraclejdk8" ]] ; then export JAVA_HOME="/usr/lib/jvm/java-8-oracle"; export PATH="$PATH:/usr/lib/jvm/java-8-oracle/bin"; export java_path="/usr/lib/jvm/java-8-oracle/jre/bin/java"; fi
+  - update-alternatives --set java $java_path
+  - java -version
+# Install the required Ant and Maven version
+  - shippable_retry sudo apt-get -q -y update
+  - shippable_retry sudo apt-get -y install maven
+  - shippable_retry wget "https://raw.githubusercontent.com/optimizationBenchmarking/utils-build/master/antWebInstallerLinux.sh"
+  - chmod 755 antWebInstallerLinux.sh
+  - shippable_retry sudo ./antWebInstallerLinux.sh --purgeAnt=false
+  
+# install override
+install:
+  - echo "Nothing to do here."
+#
+script:
+  - if [[ $SHIPPABLE_JDK_VERSION == "openjdk7" ]] ; then export JAVA_HOME="/usr/lib/jvm/java-7-openjdk-amd64"; export PATH="$PATH:/usr/lib/jvm/java-7-openjdk-amd64/bin"; export java_path="/usr/lib/jvm/java-7-openjdk-amd64/jre/bin/java"; fi
+  - if [[ $SHIPPABLE_JDK_VERSION == "oraclejdk7" ]] ; then export JAVA_HOME="/usr/lib/jvm/java-7-oracle"; export PATH="$PATH:/usr/lib/jvm/java-7-oracle/bin"; export java_path="/usr/lib/jvm/java-7-oracle/jre/bin/java"; fi
+  - if [[ $SHIPPABLE_JDK_VERSION == "openjdk6" ]] ; then export JAVA_HOME="/usr/lib/jvm/java-6-openjdk-amd64"; export PATH="$PATH:/usr/lib/jvm/java-6-openjdk-amd64/bin"; export java_path="/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java"; fi
+  - if [[ $SHIPPABLE_JDK_VERSION == "oraclejdk8" ]] ; then export JAVA_HOME="/usr/lib/jvm/java-8-oracle"; export PATH="$PATH:/usr/lib/jvm/java-8-oracle/bin"; export java_path="/usr/lib/jvm/java-8-oracle/jre/bin/java"; fi
+  - update-alternatives --set java $java_path
+  - java -version
+  - ant

src/test/java/test/junit/org/optimizationBenchmarking/documentation/examples/BBOBExampleTest.java

@@ -0,0 +1,24 @@
+package test.junit.org.optimizationBenchmarking.documentation.examples;
+
+import org.junit.experimental.categories.Category;
+import org.optimizationBenchmarking.documentation.examples.ExampleDownloadJobBuilder;
+
+import shared.junit.CategorySlowTests;
+
+/**
+ * The test of downloading and installing the BBOB example
+ */
+@Category(CategorySlowTests.class)
+public final class BBOBExampleTest extends SingleExampleTest {
+
+  /** create */
+  public BBOBExampleTest() {
+    super();
+  }
+
+  /** {@inheritDoc} */
+  @Override
+  protected final void setup(final ExampleDownloadJobBuilder builder) {
+    builder.setExampleId("bbob"); //$NON-NLS-1$
+  }
+}

src/test/java/test/junit/org/optimizationBenchmarking/documentation/examples/ExampleDownloadToolTest.java

@@ -0,0 +1,15 @@
+package test.junit.org.optimizationBenchmarking.documentation.examples;
+
+import org.optimizationBenchmarking.documentation.examples.ExampleDownloadTool;
+
+import shared.junit.org.optimizationBenchmarking.utils.tools.ToolTest;
+
+/** the test of the example download tool */
+public class ExampleDownloadToolTest
+    extends ToolTest<ExampleDownloadTool> {
+
+  /** create the test */
+  public ExampleDownloadToolTest() {
+    super(ExampleDownloadTool.getInstance());
+  }
+}

src/test/java/test/junit/org/optimizationBenchmarking/documentation/examples/MaxSatExampleTest.java

@@ -0,0 +1,21 @@
+package test.junit.org.optimizationBenchmarking.documentation.examples;
+
+import org.optimizationBenchmarking.documentation.examples.ExampleDownloadJobBuilder;
+
+/**
+ * The test of downloading and installing the maximum satisfiability
+ * example
+ */
+public final class MaxSatExampleTest extends SingleExampleTest {
+
+  /** create */
+  public MaxSatExampleTest() {
+    super();
+  }
+
+  /** {@inheritDoc} */
+  @Override
+  protected final void setup(final ExampleDownloadJobBuilder builder) {
+    builder.setExampleId("maxSat"); //$NON-NLS-1$
+  }
+}

src/test/java/test/junit/org/optimizationBenchmarking/documentation/examples/SingleExampleTest.java

@@ -0,0 +1,48 @@
+package test.junit.org.optimizationBenchmarking.documentation.examples;
+
+import org.junit.Assert;
+import org.junit.Ignore;
+import org.junit.Test;
+import org.optimizationBenchmarking.documentation.examples.ExampleDownloadJobBuilder;
+import org.optimizationBenchmarking.documentation.examples.ExampleDownloadTool;
+import org.optimizationBenchmarking.utils.io.paths.TempDir;
+
+import shared.junit.TestBase;
+
+/** A base class for testing example installations. */
+@Ignore
+public abstract class SingleExampleTest {
+
+  /** create the installer test */
+  protected SingleExampleTest() {
+    super();
+  }
+
+  /**
+   * setup the job builder
+   *
+   * @param builder
+   *          the job builder
+   */
+  protected abstract void setup(final ExampleDownloadJobBuilder builder);
+
+  /**
+   * test the example download
+   *
+   * @throws Exception
+   *           if I/O fails
+   */
+  @Test(timeout = 3600000)
+  public void testExampleDownload() throws Exception {
+    ExampleDownloadJobBuilder builder;
+
+    builder = ExampleDownloadTool.getInstance().use();
+    this.setup(builder);
+    builder.setLogger(TestBase.getNullLogger());
+
+    try (final TempDir temp = new TempDir()) {
+      builder.setDestinationPath(temp.getPath());
+      Assert.assertNotNull(builder.create().call());
+    }
+  }
+}

src/test/java/test/junit/org/optimizationBenchmarking/documentation/examples/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * The the tests of the example downloader package.
+ */
+package test.junit.org.optimizationBenchmarking.documentation.examples;

src/test/java/test/junit/org/optimizationBenchmarking/documentation/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * In this package, we provide the tests of the documentation classes that
+ * are used in many <a href="http://www.optimizationBenchmarking.org/">
+ * optimizationBenchmarking.org</a> tools.
+ */
+package test.junit.org.optimizationBenchmarking.documentation;

src/test/java/test/junit/org/optimizationBenchmarking/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * In this package, we provide the tests of the
+ * <a href="http://www.optimizationBenchmarking.org/">
+ * optimizationBenchmarking.org</a> tools.
+ */
+package test.junit.org.optimizationBenchmarking;

src/test/java/test/junit/org/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <p>
+ * A package that holds other packages with
+ * <a href="http://junit.org/">JUnit</a> tests but itself is empty (as
+ * there are no classes that could be tested at the {@code org} level).
+ * </p>
+ */
+package test.junit.org;

src/test/java/test/junit/package-info.java

@@ -0,0 +1,27 @@
+/**
+ * In this package we keep all the <a href="http://junit.org/">JUnit</a>
+ * tests for our source codes.
+ * </p>
+ * <p>
+ * Unit tests are classes that can automatically be executed by a testing
+ * framework. Each unit test class can have multiple test cases and each
+ * such test case checks whether one particular method or interaction of a
+ * tested class behaves as it should behave. For example, one could test
+ * the {@link java.lang.String#concat(java.lang.String)} method by creating
+ * two strings {@code a} and {@code b} and checking whether a
+ * <code>a.concat(b).equals(a + b)</code>. Unit testing frameworks are able
+ * to run many such tests and to create reports. If a test fails, it means
+ * that there is an error. If no test fails, it does not mean that there is
+ * no error. Still, having many test cases and having them succeed is a
+ * good indicator for a healthy project. The more aspects and classes of a
+ * project are covered with tests, the better.
+ * </p>
+ * <p>
+ * The hierarchy of the sub-packages within this package reflects the
+ * source package hierarchy, i.e., package
+ * {@link test.junit.org.optimizationBenchmarking.utils.text.transformations}
+ * contains the tests for the classes in package
+ * {@link org.optimizationBenchmarking.utils.text.transformations}.
+ * </p>
+ */
+package test.junit;

src/test/java/test/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * In this package we keep all test code for our sources. Test classes are
+ * in package names corresponding to the packages they test. For example,
+ * in package {@code test.junit.org.optimizationBenchmarking.utils} you
+ * will find all tests for the classes from package
+ * {@code org.optimizationBenchmarking.utils}.
+ */
+package test;

wercker.yml

@@ -0,0 +1,12 @@
+##
+## Build with Wercker
+##
+## https://app.wercker.com/#applications/ TODO
+#
+box: optimizationbenchmarking/linux-evaluator-build
+#
+build:
+    steps:
+        - script:
+            name: Ant-based Maven Build
+            code: ant