Add framework to allow test-specific assertions on HTTP response.

pom.xml

@@ -129,6 +129,12 @@
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest</artifactId>
+            <version>2.2</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/test/java/org/icatproject/ids/integration/BaseTest.java

@@ -6,6 +6,7 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.FileVisitResult;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -20,6 +21,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.NoSuchElementException;
 import java.util.Set;
 import java.util.UUID;
 import java.util.zip.CRC32;
@@ -369,6 +371,15 @@ protected void checkStream(InputStream stream, long id) throws IOException {
         assertTrue(found);
     }
 
+    protected long fileLength(long id) {
+        return ids.entrySet().stream()
+                .filter(e -> id == e.getValue())
+                .map(Map.Entry::getKey)
+                .map(fsizes::get)
+                .findFirst()
+                .orElseThrow(() -> new NoSuchElementException("No file with id " + id));
+    }
+
     protected void writeToFile(Datafile df, String content, String key)
             throws IOException, IcatException_Exception, NoSuchAlgorithmException {
         Path path = setup.getStorageDir().resolve(df.getLocation());

src/test/java/org/icatproject/ids/integration/one/GetDataExplicitTest.java

@@ -2,6 +2,7 @@
 
 import java.io.InputStream;
 import java.util.Arrays;
+import org.apache.http.HttpResponse;
 
 import static org.junit.Assert.assertEquals;
 import org.junit.BeforeClass;
@@ -15,6 +16,8 @@
 import org.icatproject.ids.integration.util.client.InsufficientPrivilegesException;
 import org.icatproject.ids.integration.util.client.NotFoundException;
 import org.icatproject.ids.integration.util.client.TestingClient.Flag;
+import static org.icatproject.ids.integration.util.client.TestingClient.isNotChunkedEncoded;
+import static org.icatproject.ids.integration.util.client.TestingClient.hasHeader;
 
 public class GetDataExplicitTest extends BaseTest {
 
@@ -98,52 +101,71 @@ public void forbiddenTest() throws Exception {
 
     @Test
     public void correctBehaviourTestNone() throws Exception {
-        try (InputStream stream = testingClient.getData(sessionId, new DataSelection().addDatafiles(datafileIds),
-                Flag.NONE, 0, 200)) {
+        try (InputStream stream = testingClient
+                .assertingHttpResponse(isNotChunkedEncoded()) // assumes caching
+                .getData(sessionId, new DataSelection().addDatafiles(datafileIds),
+                    Flag.NONE, 0, 200)) {
             checkZipStream(stream, datafileIds, 57L, 0);
         }
 
-        try (InputStream stream = testingClient.getData(sessionId, new DataSelection().addDatafile(datafileIds.get(0)),
-                Flag.NONE, 0, 200)) {
+        var datafileId = datafileIds.get(0);
+        var fileLength = fileLength(datafileId);
+        try (InputStream stream = testingClient
+                .assertingHttpResponse(isNotChunkedEncoded(), // assumes caching
+                                       hasHeader("Content-Length", fileLength))
+                .getData(sessionId, new DataSelection().addDatafile(datafileId),
+                    Flag.NONE, 0, 200)) {
             checkStream(stream, datafileIds.get(0));
         }
     }
 
     @Test
     public void correctBehaviourTestCompress() throws Exception {
-        try (InputStream stream = testingClient.getData(sessionId, new DataSelection().addDatafiles(datafileIds),
-                Flag.COMPRESS, 0, 200)) {
+        try (InputStream stream = testingClient
+                .assertingHttpResponse(isNotChunkedEncoded()) // assumes caching
+                .getData(sessionId, new DataSelection().addDatafiles(datafileIds),
+                    Flag.COMPRESS, 0, 200)) {
             checkZipStream(stream, datafileIds, 36L, 0);
         }
 
-        try (InputStream stream = testingClient.getData(sessionId, new DataSelection().addDatafile(datafileIds.get(0)),
+        try (InputStream stream = testingClient
+                .assertingHttpResponse(isNotChunkedEncoded()) // assumes caching
+                .getData(sessionId, new DataSelection().addDatafile(datafileIds.get(0)),
                 Flag.COMPRESS, 0, 200)) {
             checkStream(stream, datafileIds.get(0));
         }
     }
 
     @Test
     public void correctBehaviourTestZip() throws Exception {
-        try (InputStream stream = testingClient.getData(sessionId, new DataSelection().addDatafiles(datafileIds),
-                Flag.ZIP, 0, 200)) {
+        try (InputStream stream = testingClient
+                .assertingHttpResponse(isNotChunkedEncoded()) // assumes caching
+                .getData(sessionId, new DataSelection().addDatafiles(datafileIds),
+                    Flag.ZIP, 0, 200)) {
             checkZipStream(stream, datafileIds, 57L, 0);
         }
 
-        try (InputStream stream = testingClient.getData(sessionId, new DataSelection().addDatafile(datafileIds.get(0)),
-                Flag.ZIP, 0, 200)) {
+        try (InputStream stream = testingClient
+                .assertingHttpResponse(isNotChunkedEncoded()) // assumes caching
+                .getData(sessionId, new DataSelection().addDatafile(datafileIds.get(0)),
+                    Flag.ZIP, 0, 200)) {
             checkZipStream(stream, datafileIds.subList(0, 1), 57L, 0);
         }
     }
 
     @Test
     public void correctBehaviourTestZipAndCompress() throws Exception {
-        try (InputStream stream = testingClient.getData(sessionId, new DataSelection().addDatafiles(datafileIds),
-                Flag.ZIP_AND_COMPRESS, 0, 200)) {
+        try (InputStream stream = testingClient
+                .assertingHttpResponse(isNotChunkedEncoded()) // assumes caching
+                .getData(sessionId, new DataSelection().addDatafiles(datafileIds),
+                    Flag.ZIP_AND_COMPRESS, 0, 200)) {
             checkZipStream(stream, datafileIds, 36L, 0);
         }
 
-        try (InputStream stream = testingClient.getData(sessionId, new DataSelection().addDatafile(datafileIds.get(0)),
-                Flag.ZIP_AND_COMPRESS, 0, 200)) {
+        try (InputStream stream = testingClient
+                .assertingHttpResponse(isNotChunkedEncoded()) // assumes caching
+                .getData(sessionId, new DataSelection().addDatafile(datafileIds.get(0)),
+                    Flag.ZIP_AND_COMPRESS, 0, 200)) {
             checkZipStream(stream, datafileIds.subList(0, 1), 36L, 0);
         }
     }
@@ -173,5 +195,4 @@ public void correctBehaviourInvestigations() throws Exception {
             checkZipStream(stream, datafileIds.subList(0, 1), 57L, 0);
         }
     }
-
 }

src/test/java/org/icatproject/ids/integration/util/HeaderMatcher.java

@@ -0,0 +1,92 @@
+package org.icatproject.ids.integration.util;
+
+import static java.util.Objects.requireNonNull;
+import org.apache.http.Header;
+import org.apache.http.HttpResponse;
+import org.hamcrest.BaseMatcher;
+import org.hamcrest.Description;
+import org.hamcrest.Matcher;
+import static org.hamcrest.Matchers.equalToIgnoringCase;
+
+/**
+ * A custom header that matches HTTP headers in some HttpResponse object.  It
+ * supports two kind of matches: that the header is missing or that the header
+ * is present and the value matches some other Matcher.
+ */
+public class HeaderMatcher extends BaseMatcher<HttpResponse> {
+
+    private final String headerName;
+    private final Matcher<String> matcher;
+
+    public HeaderMatcher(String headerName, Matcher<String> valueMatcher) {
+        this.headerName = requireNonNull(headerName);
+        this.matcher = valueMatcher;
+    }
+
+    private boolean isHeaderExpected() {
+        return matcher != null;
+    }
+
+    @Override
+    public boolean matches(Object item) {
+        HttpResponse response = (HttpResponse) item; // It is a bug if item is not an HttpResponse.
+
+        Header header = response.getFirstHeader(headerName);
+
+        if (!isHeaderExpected()) {
+            return header == null;
+        }
+
+        if (header == null) {
+            return false;
+        }
+
+        String headerValue = header.getValue();
+
+        return matcher.matches(headerValue);
+    }
+
+    @Override
+    public void describeTo(Description description) {
+        if (isHeaderExpected()) {
+            description.appendText("a '")
+                    .appendText(headerName)
+                    .appendText("' header that ")
+                    .appendDescriptionOf(matcher);
+        } else {
+            description.appendText("no '").appendText(headerName).appendText("' header");
+        }
+    }
+
+    /**
+     * Match an HttpResponse that does not contain the named header.
+     * @param header The name of the HTTP response header.
+     * @return a Matcher that verifies expected response.
+     */
+    public static Matcher<HttpResponse> hasNoHeader(String header) {
+        return new HeaderMatcher(header, null);
+    }
+
+    /**
+     * Match an HttpResponse that contains the named header with a value that
+     * matches the supplied matcher.
+     * @param header The name of the HTTP response header.
+     * @param matcher The matcher for the header value.
+     * @return a Matcher that verifies expected response.
+     */
+    public static Matcher hasHeaderMatching(String header, Matcher<String> matcher) {
+        return new HeaderMatcher(header, matcher);
+    }
+
+    /**
+     * Match an HttpResponse that contains the named header with the specific
+     * value (ignoring case).
+     * @param header The name of the HTTP response header.
+     * @param value The expected value.
+     * @return a Matcher that verifies expected response.
+     */
+    public static Matcher hasHeader(String header, Object value) {
+        Matcher<String> m = equalToIgnoringCase(String.valueOf(value));
+        return hasHeaderMatching(header, m);
+    }
+}

src/test/java/org/icatproject/ids/integration/util/LongValue.java

@@ -0,0 +1,33 @@
+package org.icatproject.ids.integration.util;
+
+import org.hamcrest.Description;
+import org.hamcrest.Matcher;
+import org.hamcrest.TypeSafeMatcher;
+
+/**
+ * A Matcher that checks whether a String argument is a Long value.  The code is
+ * heavily based on an answer from Ezequiel to
+ * <a href="https://stackoverflow.com/questions/58099695/is-there-a-way-in-hamcrest-to-test-for-a-value-to-be-a-number">
+ * a stack overview question</a>.
+ */
+public class LongValue extends TypeSafeMatcher<String> {
+
+    @Override
+    protected boolean matchesSafely(String s) {
+        try {
+            Long.valueOf(s);
+        } catch (NumberFormatException nfe) {
+            return false;
+        }
+        return true;
+    }
+
+    @Override
+    public void describeTo(Description description) {
+        description.appendText("is long");
+    }
+
+    public static Matcher<String> longValue() {
+        return new LongValue();
+    }
+}