Return unclosed InputStreams for binary and optional<binary> endpoints

changelog/@unreleased/pr-570.v2.yml

@@ -0,0 +1,7 @@
+type: fix
+fix:
+  description: Conjure endpoints returning `binary` or `optional<binary>` now correctly
+    return unclosed InputStreams. Users must be careful to close these InputStreams,
+    otherwise resources will be leaked.
+  links:
+  - https://github.com/palantir/dialogue/pull/570

dialogue-client-test-lib/src/main/java/com/palantir/dialogue/CloseRecordingInputStream.java

@@ -0,0 +1,92 @@
+/*
+ * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.palantir.dialogue;
+
+import com.palantir.logsafe.exceptions.SafeRuntimeException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Optional;
+import org.assertj.core.api.Assertions;
+
+/** A test-only inputstream which can only be closed once. */
+public final class CloseRecordingInputStream extends InputStream {
+
+    private final InputStream delegate;
+    private Optional<Throwable> closeCalled = Optional.empty();
+
+    public CloseRecordingInputStream(InputStream delegate) {
+        this.delegate = delegate;
+    }
+
+    public boolean isClosed() {
+        return closeCalled.isPresent();
+    }
+
+    public void assertNotClosed() {
+        if (closeCalled.isPresent()) {
+            Assertions.fail("Expected CloseRecordingInputStream to be open but was closed", closeCalled.get());
+        }
+    }
+
+    @Override
+    public int read() throws IOException {
+        assertNotClosed();
+        return delegate.read();
+    }
+
+    @Override
+    public int read(byte[] bytes) throws IOException {
+        assertNotClosed();
+        return delegate.read(bytes);
+    }
+
+    @Override
+    public int read(byte[] bytes, int off, int len) throws IOException {
+        assertNotClosed();
+        return delegate.read(bytes, off, len);
+    }
+
+    @Override
+    public int available() throws IOException {
+        assertNotClosed();
+        return delegate.available();
+    }
+
+    @Override
+    public void reset() throws IOException {
+        assertNotClosed();
+        delegate.reset();
+    }
+
+    @Override
+    public void mark(int readlimit) {
+        assertNotClosed();
+        delegate.mark(readlimit);
+    }
+
+    @Override
+    public long skip(long num) throws IOException {
+        assertNotClosed();
+        return delegate.skip(num);
+    }
+
+    @Override
+    public void close() throws IOException {
+        closeCalled = Optional.of(new SafeRuntimeException("close was called here"));
+        delegate.close();
+    }
+}

dialogue-client-test-lib/src/main/java/com/palantir/dialogue/TestResponse.java

@@ -0,0 +1,84 @@
+/*
+ * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.palantir.dialogue;
+
+import com.google.common.collect.ImmutableListMultimap;
+import com.google.common.collect.ListMultimap;
+import com.google.errorprone.annotations.CheckReturnValue;
+import com.palantir.logsafe.exceptions.SafeRuntimeException;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.util.Optional;
+import javax.ws.rs.core.HttpHeaders;
+
+public final class TestResponse implements Response {
+
+    private final CloseRecordingInputStream inputStream =
+            new CloseRecordingInputStream(new ByteArrayInputStream(new byte[] {}));
+
+    private Optional<Throwable> closeCalled = Optional.empty();
+    private int code = 0;
+    private ListMultimap<String, String> headers = ImmutableListMultimap.of();
+
+    @Override
+    public CloseRecordingInputStream body() {
+        return inputStream;
+    }
+
+    @Override
+    public int code() {
+        return code;
+    }
+
+    @CheckReturnValue
+    public TestResponse code(int value) {
+        this.code = value;
+        return this;
+    }
+
+    @Override
+    public ListMultimap<String, String> headers() {
+        return headers;
+    }
+
+    @Override
+    public void close() {
+        checkNotClosed();
+        try {
+            closeCalled = Optional.of(new SafeRuntimeException("Close called here"));
+            inputStream.close();
+        } catch (IOException e) {
+            throw new SafeRuntimeException("Failed to close", e);
+        }
+    }
+
+    public boolean isClosed() {
+        return closeCalled.isPresent();
+    }
+
+    private void checkNotClosed() {
+        if (closeCalled.isPresent()) {
+            throw new SafeRuntimeException("Please don't close twice", closeCalled.get());
+        }
+    }
+
+    @CheckReturnValue
+    public TestResponse contentType(String contentType) {
+        this.headers = ImmutableListMultimap.of(HttpHeaders.CONTENT_TYPE, contentType);
+        return this;
+    }
+}

dialogue-client-verifier/build.gradle

@@ -30,11 +30,13 @@ dependencies {
     testImplementation project('verification-server-api')
     testImplementation project(':dialogue-apache-hc4-client')
     testImplementation project(':dialogue-serde')
+    testImplementation project(':dialogue-example:dialogue-example-dialogue')
     testImplementation 'junit:junit'
     testImplementation 'org.assertj:assertj-core'
     testImplementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml'
     testImplementation 'org.apache.commons:commons-lang3'
-    testCompile 'com.palantir.conjure.java.runtime:keystores'
+    testImplementation 'com.palantir.conjure.java.runtime:keystores'
+    testImplementation 'io.undertow:undertow-core'
 
     testRuntimeOnly 'org.apache.logging.log4j:log4j-slf4j-impl'
     testRuntimeOnly 'org.apache.logging.log4j:log4j-core'