Add unit tests for NightfallClient (#23)

Author: evanfuller

pom.xml

@@ -187,6 +187,35 @@
                     </checkModificationExcludes>
                 </configuration>
             </plugin>
+
+            <!-- these plugins are for junit tests -->
+            <plugin>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.22.2</version>
+            </plugin>
+            <plugin>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>2.22.2</version>
+            </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.8.7</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>report</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
@@ -211,9 +240,21 @@
 
         <!-- test dependencies -->
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.13.2</version>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>5.8.1</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-migrationsupport</artifactId>
+            <version>5.8.1</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.squareup.okhttp3</groupId>
+            <artifactId>mockwebserver</artifactId>
+            <version>4.9.2</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

src/main/java/ai/nightfall/scan/NightfallClient.java

@@ -43,20 +43,20 @@
 public class NightfallClient implements Closeable {
 
     private static final ObjectMapper objectMapper = new ObjectMapper();
-
     private static final long wakeupDurationMillis = Duration.ofSeconds(15).toMillis();
-
     private static final int DEFAULT_RETRY_COUNT = 5;
-
     private static final String API_HOST = "https://api.nightfall.ai";
 
+    private final String apiHost;
     private final String apiKey;
     private final int fileUploadConcurrency;
     private final int retryCount;
     private final ExecutorService executor;
     private final OkHttpClient httpClient;
 
-    private NightfallClient(String apiKey, int fileUploadConcurrency, OkHttpClient httpClient) {
+    // package-visible for testing
+    NightfallClient(String apiHost, String apiKey, int fileUploadConcurrency, OkHttpClient httpClient) {
+        this.apiHost = apiHost;
         this.apiKey = apiKey;
         this.fileUploadConcurrency = fileUploadConcurrency;
         this.retryCount = DEFAULT_RETRY_COUNT;
@@ -351,7 +351,7 @@ private ScanFileResponse scanUploadedFile(ScanFileRequest request, UUID fileID)
      */
     private <E> E issueRequest(
             String path, String method, MediaType mediaType, byte[] body, Headers headers, Class<E> responseClass) {
-        String url = API_HOST + path;
+        String url = this.apiHost + path;
         Request.Builder builder = new Request.Builder().url(url);
 
         if (headers != null) {
@@ -399,7 +399,7 @@ private <E> E issueRequest(
                 return objectMapper.readValue(response.body().bytes(), responseClass);
             } catch (IOException e) {
                 // If OkHTTP times out, allow retries
-                if (e.getMessage().equals("timeout")) {
+                if (e.getMessage().equalsIgnoreCase("timeout") || e.getMessage().equalsIgnoreCase("read timed out")) {
                     if (attempt >= this.retryCount - 1) {
                         throw new NightfallRequestTimeoutException("request timed out");
                     }
@@ -430,7 +430,6 @@ private <E> E issueRequest(
      * A builder class that configures, validates, then creates instances of a Nightfall Client.
      */
     public static class Builder {
-
         private String apiKey;
         private int fileUploadConcurrency = 1;
 
@@ -456,7 +455,7 @@ public static NightfallClient defaultClient() {
                     .writeTimeout(Duration.ofSeconds(60))
                     .connectionPool(cxnPool)
                     .build();
-            return new NightfallClient(readAPIKeyFromEnvironment(), 1, httpClient);
+            return new NightfallClient(API_HOST, readAPIKeyFromEnvironment(), 1, httpClient);
         }
 
         /**
@@ -589,7 +588,7 @@ public NightfallClient build() {
                     .writeTimeout(this.writeTimeout)
                     .connectionPool(cxnPool)
                     .build();
-            return new NightfallClient(this.apiKey, this.fileUploadConcurrency, httpClient);
+            return new NightfallClient(API_HOST, this.apiKey, this.fileUploadConcurrency, httpClient);
         }
 
         private static String readAPIKeyFromEnvironment() {

src/main/java/ai/nightfall/scan/model/NightfallErrorResponse.java

@@ -1,8 +1,10 @@
 package ai.nightfall.scan.model;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 import java.util.Map;
+import java.util.Objects;
 
 /**
  * The error model returned by Nightfall API requests that are unsuccessful. This object is generally returned
@@ -22,6 +24,24 @@ public class NightfallErrorResponse {
     @JsonProperty("additionalData")
     private Map<String, String> additionalData;
 
+    // appease jackson serialization
+    public NightfallErrorResponse() {}
+
+    /**
+     * Builds a new NightfallErrorResponse object.
+     *
+     * @param code the error code
+     * @param message the error message
+     * @param description further description
+     * @param additionalData a map of key-value pairs that contain even further debugging information
+     */
+    public NightfallErrorResponse(int code, String message, String description, Map<String, String> additionalData) {
+        this.code = code;
+        this.message = message;
+        this.description = description;
+        this.additionalData = additionalData;
+    }
+
     /**
      * Get the error code.
      *
@@ -67,4 +87,23 @@ public String toString() {
                 + ", additionalData=" + additionalData
                 + '}';
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        NightfallErrorResponse that = (NightfallErrorResponse) o;
+        return code == that.code && Objects.equals(message, that.message)
+                && Objects.equals(description, that.description)
+                && Objects.equals(additionalData, that.additionalData);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(code, message, description, additionalData);
+    }
 }

src/main/java/ai/nightfall/scan/model/ScanFileResponse.java

@@ -15,6 +15,20 @@ public class ScanFileResponse {
     @JsonProperty("message")
     private String message;
 
+    // appease jackson serialization
+    public ScanFileResponse() {}
+
+    /**
+     * Construct a new ScanFileResponse object.
+     *
+     * @param id the ID of the file to-be-scanned
+     * @param message the status message
+     */
+    public ScanFileResponse(UUID id, String message) {
+        this.id = id;
+        this.message = message;
+    }
+
     /**
      * Get the file ID.
      *

src/test/java/ai/nightfall/scan/NightfallClientBuilderTest.java

@@ -0,0 +1,68 @@
+package ai.nightfall.scan;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+import java.time.Duration;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.fail;
+
+/**
+ * Unit tests for the NightfallClient.Builder.
+ */
+public class NightfallClientBuilderTest {
+
+    @Test
+    public void testHappyPath() {
+        NightfallClient client = new NightfallClient.Builder()
+                .withAPIKey("foo") // only argument for builder with no default value
+                .build();
+        assertNotNull(client);
+    }
+
+    @Test
+    public void testDefault_missingAPIKey() {
+        assertThrows(IllegalArgumentException.class, NightfallClient.Builder::defaultClient);
+    }
+
+    @ParameterizedTest
+    @CsvSource(value = {
+        // invalid upload concurrency
+        "-1, 60, 50, 40, 30, 20",
+        "0, 60, 50, 40, 30, 20",
+        "101, 60, 50, 40, 30, 20",
+        // invalid connection timeout
+        "100, -1, 50, 40, 30, 20",
+        "100, 61, 50, 40, 30, 20",
+        // invalid read timeout
+        "100, 60, -1, 40, 30, 20",
+        "100, 60, 121, 40, 30, 20",
+        // invalid write timeout
+        "100, 60, 50, -1, 30, 20",
+        "100, 60, 50, 121, 30, 20",
+        // invalid max idle connections
+        "100, 60, 50, 40, 0, 20",
+        "100, 60, 50, 40, 501, 20",
+        // invalid keep alive
+        "100, 60, 50, 40, 30, -1",
+        "100, 60, 50, 40, 30, 121",
+    })
+    public void testInvalid(int uploadConcurrency, int connTimeout, int readTimeout,
+                            int writeTimeout, int maxIdleConns, int keepAliveSec) {
+        assertThrows(IllegalArgumentException.class, () -> {
+            new NightfallClient.Builder()
+                    .withAPIKey("foo")
+                    .withFileUploadConcurrency(uploadConcurrency)
+                    .withConnectionTimeout(Duration.ofSeconds(connTimeout))
+                    .withReadTimeout(Duration.ofSeconds(readTimeout))
+                    .withWriteTimeout(Duration.ofSeconds(writeTimeout))
+                    .withMaxIdleConnections(maxIdleConns)
+                    .withKeepAliveDuration(Duration.ofSeconds(keepAliveSec))
+                    .build();
+            fail("build should not have succeeded");
+        });
+    }
+}