Improved Logging/Error Messages, Fixed JUnit Test

The JUnit test did not specify a version for downloading files. This
has been fixed: We test now for both project version 0.8.5 and 0.8.6.

Author: thomasWeise

src/main/java/org/optimizationBenchmarking/documentation/examples/_ExampleDownloadJob.java

@@ -1,6 +1,7 @@
 package org.optimizationBenchmarking.documentation.examples;
 
 import java.io.BufferedReader;
+import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.net.URI;
@@ -62,7 +63,7 @@ static final URI _resolveExampleURI(final URI baseUri, final String id) {
 
   /** {@inheritDoc} */
   @Override
-  public final Path call() throws Exception {
+  public final Path call() throws IOException {
     final URI exampleUri;
     final Path destDirectory;
     final Logger logger;
@@ -168,16 +169,16 @@ public final Path call() throws Exception {
    * @param found
    *          did we already create something?
    * @return {@code true} if a file was unpacked, {@code false} otherwise
-   * @throws Exception
+   * @throws IOException
    *           if something goes wrong
    */
   private final boolean __process(final String line, final URI baseUri,
-      final Path destFolder, final boolean found) throws Exception {
+      final Path destFolder, final boolean found) throws IOException {
     final Logger logger;
     final URL url;
     final Path destPath;
     final boolean zip;
-    String path;
+    String path, message;
     int index;
     char ch;
 
@@ -188,9 +189,10 @@ private final boolean __process(final String line, final URI baseUri,
 
     logger = this.getLogger();
     url = baseUri.resolve(path).toURL();
+    message = null;
     if ((logger != null) && (logger.isLoggable(Level.FINE))) {
-      logger.fine((("Now downloading resource '" + url) //$NON-NLS-1$
-          + '\'') + '.');
+      message = (("resource '" + url) + '\'');//$NON-NLS-1$
+      logger.fine(("Now downloading " + message) + '.');//$NON-NLS-1$
     }
 
     if (!(found)) {
@@ -215,10 +217,14 @@ private final boolean __process(final String line, final URI baseUri,
     }
 
     if ((logger != null) && (logger.isLoggable(Level.FINE))) {
-      logger.fine((("Beginning to download resource '" + url + //$NON-NLS-1$
-          (zip ? "' as zip archive into folder '"//$NON-NLS-1$
-              : "' as file into file '")//$NON-NLS-1$
-          + destPath) + '\'') + '.');
+      if (message == null) {
+        message = (("resource '" + url) + '\'');//$NON-NLS-1$
+      }
+      message = (((message + (zip//
+          ? " as zip archive into folder '"//$NON-NLS-1$
+          : " as file into file '"))//$NON-NLS-1$
+          + destPath) + '\'');
+      logger.fine("Beginning to download " + message + '.');//$NON-NLS-1$
     }
 
     try (final InputStream input = url.openStream()) {
@@ -227,11 +233,25 @@ private final boolean __process(final String line, final URI baseUri,
       } else {
         Files.copy(input, destPath);
       }
+    } catch (final Throwable error) {
+      if (message == null) {
+        message = (((("resource '" + url) //$NON-NLS-1$
+            + (zip ? "' as zip archive into folder '"//$NON-NLS-1$
+                : "' as file into file '"))//$NON-NLS-1$
+            + destPath) + '\'');
+      }
+      throw new IOException((("Error while downloading " //$NON-NLS-1$
+          + message) + '.'), error);
     }
 
     if ((logger != null) && (logger.isLoggable(Level.FINE))) {
-      logger.fine((("Finished downloading resource '" + url) //$NON-NLS-1$
-          + '\'') + '.');
+      if (message == null) {
+        message = (((("resource '" + url) //$NON-NLS-1$
+            + (zip ? "' as zip archive into folder '"//$NON-NLS-1$
+                : "' as file into file '"))//$NON-NLS-1$
+            + destPath) + '\'');
+      }
+      logger.fine(("Finished downloading " + message) + '.');//$NON-NLS-1$
     }
 
     return true;

src/main/java/org/optimizationBenchmarking/documentation/examples/_ExampleJobBase.java

@@ -1,5 +1,6 @@
 package org.optimizationBenchmarking.documentation.examples;
 
+import java.io.IOException;
 import java.net.URI;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -45,6 +46,16 @@ abstract class _ExampleJobBase<T> extends ToolJob
         ._checkFailureLevel(this.m_failureLevel = builder.m_failureLevel);
   }
 
+  /**
+   * Perform the example job.
+   *
+   * @return the result object
+   * @throws IOException
+   *           if I/O fails
+   */
+  @Override
+  public abstract T call() throws IOException;
+
   /**
    * Extract the resource part from a given line and return it if the
    * currently set version permits it, return {@code null} otherwise.

src/main/java/org/optimizationBenchmarking/documentation/examples/_ExampleListJob.java

@@ -1,6 +1,7 @@
 package org.optimizationBenchmarking.documentation.examples;
 
 import java.io.BufferedReader;
+import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.net.URL;
@@ -32,7 +33,7 @@ final class _ExampleListJob
 
   /** {@inheritDoc} */
   @Override
-  public final ArrayListView<Example> call() throws Exception {
+  public final ArrayListView<Example> call() throws IOException {
     final Logger logger;
     final ArrayListView<Example> result;
     String name;

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

@@ -6,6 +6,7 @@
 import org.optimizationBenchmarking.documentation.examples.ExampleDownloadJobBuilder;
 import org.optimizationBenchmarking.documentation.examples.ExampleDownloadTool;
 import org.optimizationBenchmarking.utils.io.paths.TempDir;
+import org.optimizationBenchmarking.utils.versioning.Version;
 
 import shared.junit.TestBase;
 
@@ -27,18 +28,40 @@ protected SingleExampleTest() {
   protected abstract void setup(final ExampleDownloadJobBuilder builder);
 
   /**
-   * test the example download
+   * test the example download for version 0.8.5
    *
    * @throws Exception
    *           if I/O fails
    */
   @Test(timeout = 3600000)
-  public void testExampleDownload() throws Exception {
+  public void testExampleDownload_0_8_5() throws Exception {
     ExampleDownloadJobBuilder builder;
 
     builder = ExampleDownloadTool.getInstance().use();
     this.setup(builder);
     builder.setLogger(TestBase.getNullLogger());
+    builder.setVersion(new Version(0, 8, 5, null, null));
+
+    try (final TempDir temp = new TempDir()) {
+      builder.setDestinationPath(temp.getPath());
+      Assert.assertNotNull(builder.create().call());
+    }
+  }
+
+  /**
+   * test the example download for version 0.8.6
+   *
+   * @throws Exception
+   *           if I/O fails
+   */
+  @Test(timeout = 3600000)
+  public void testExampleDownload_0_8_6() throws Exception {
+    ExampleDownloadJobBuilder builder;
+
+    builder = ExampleDownloadTool.getInstance().use();
+    this.setup(builder);
+    builder.setLogger(TestBase.getNullLogger());
+    builder.setVersion(new Version(0, 8, 6, null, null));
 
     try (final TempDir temp = new TempDir()) {
       builder.setDestinationPath(temp.getPath());