Merge pull request #45 from Nordstrom/pr/fix-artifact-path

Pr/fix artifact path

Author: sbabcoc

README.md

@@ -441,9 +441,9 @@ import org.slf4j.LoggerFactory;
 
 import com.nordstrom.automation.junit.ArtifactType;
 
-public class MyArtifactType implements ArtifactType {
+public class MyArtifactType extends ArtifactType {
 
-    private static final Path ARTIFACT_PATH = Paths.get("artifacts");
+    private static final String ARTIFACT_PATH = "artifacts";
     private static final String EXTENSION = "txt";
     private static final String ARTIFACT = "This text artifact was captured for '%s'";
     private static final Logger LOGGER = LoggerFactory.getLogger(MyArtifactType.class);
@@ -465,7 +465,7 @@ public class MyArtifactType implements ArtifactType {
 
     @Override
     public Path getArtifactPath() {
-        return ARTIFACT_PATH;
+        return super.getArtifactPath(instance).resolve(ARTIFACT_PATH);
     }
 
     @Override

src/main/java/com/nordstrom/automation/junit/ArtifactCollector.java

@@ -125,23 +125,7 @@ public Optional<Path> captureArtifact(Throwable reason) {
      */
     private Path getCollectionPath() {
         Path collectionPath = PathUtils.ReportsDirectory.getPathForObject(getInstance());
-        return collectionPath.resolve(getArtifactPath(getInstance()));
-    }
-    
-    /**
-     * Get the path at which to store artifacts.
-     * <p>
-     * <b>NOTE</b>: The returned path can be either relative or absolute.
-     * 
-     * @param instance JUnit test class instance
-     * @return artifact storage path
-     */
-    private Path getArtifactPath(Object instance) {
-        Path artifactPath = provider.getArtifactPath(instance);
-        if (artifactPath == null) {
-            artifactPath = PathUtils.ReportsDirectory.getPathForObject(instance);
-        }
-        return artifactPath;
+        return collectionPath.resolve(provider.getArtifactPath(getInstance()));
     }
 
     /**

src/main/java/com/nordstrom/automation/junit/ArtifactType.java

@@ -3,6 +3,8 @@
 import java.nio.file.Path;
 import org.slf4j.Logger;
 
+import com.nordstrom.common.file.PathUtils;
+
 /**
  * This interface defines the contract fulfilled by artifact capture providers. Instances of this interface supply the
  * scenario-specific implementation for artifact capture through the {@link ArtifactCollector} listener.
@@ -19,7 +21,7 @@
  * 
  * import com.nordstrom.automation.junit.ArtifactType;
  * 
- * public class MyArtifactType implements ArtifactType {
+ * public class MyArtifactType extends ArtifactType {
  *     
  *     private static final String ARTIFACT_PATH = "artifacts";
  *     private static final String EXTENSION = "txt";
@@ -37,8 +39,8 @@
  *     }
  *     
  *     @Override
- *     public Page getArtifactPath(Object instance) {
- *         return ArtifactType.super.getArtifactPath(instance).resolve(ARTIFACT_PATH);
+ *     public Path getArtifactPath(Object instance) {
+ *         return super.getArtifactPath(instance).resolve(ARTIFACT_PATH);
  *     }
  * 
  *     @Override
@@ -66,22 +68,24 @@
  * }
  * </code></pre>
  */
-public interface ArtifactType {
+public abstract class ArtifactType {
 
     /**
      * Get the SLF4J {@link Logger} for this artifact type.
      * 
      * @return logger for this artifact (may be {@code null})
      */
-    Logger getLogger();
+    public Logger getLogger() {
+        return null;
+    }
 
     /**
      * Determine if artifact capture is available in the specified context.
      * 
      * @param instance JUnit test class instance
      * @return 'true' if capture is available; otherwise 'false'
      */
-    boolean canGetArtifact(Object instance);
+    public abstract boolean canGetArtifact(Object instance);
 
     /**
      * Capture an artifact from the specified context.
@@ -90,23 +94,25 @@ public interface ArtifactType {
      * @param reason impetus for capture request; may be 'null'
      * @return byte array containing the captured artifact; if capture fails, an empty array is returned
      */
-    byte[] getArtifact(Object instance, Throwable reason);
+    public abstract byte[] getArtifact(Object instance, Throwable reason);
 
     /**
      * Get the path at which to store artifacts.
      * <p>
      * <b>NOTE</b>: The returned path can be either relative or absolute.
      * 
      * @param instance JUnit test class instance
-     * @return artifact storage path; {@code null} to accept default path
+     * @return artifact storage path
      */
-    Path getArtifactPath(Object instance);
+    public Path getArtifactPath(Object instance) {
+        return PathUtils.ReportsDirectory.getPathForObject(instance);
+    }
 
     /**
      * Get the extension for artifact files of this type.
      * 
      * @return artifact file extension
      */
-    String getArtifactExtension();
+    public abstract String getArtifactExtension();
 
 }

src/test/java/com/nordstrom/automation/junit/UnitTestArtifact.java

@@ -1,11 +1,10 @@
 package com.nordstrom.automation.junit;
 
-import java.nio.file.Path;
 import java.util.Map.Entry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class UnitTestArtifact implements ArtifactType {
+public class UnitTestArtifact extends ArtifactType {
 
     private boolean captureDisabled;
     private boolean captureCrippled;
@@ -53,11 +52,6 @@ public byte[] getArtifact(Object instance, Throwable reason) {
         }
     }
 
-    @Override
-    public Path getArtifactPath(Object instance) {
-        return null;
-    }
-
     @Override
     public String getArtifactExtension() {
         return EXTENSION;