Add override PATCH conformance proof

Author: kvz

example/build.gradle

@@ -77,3 +77,9 @@ tasks.register('api2DevdockTusRelativeLocationResolution', JavaExec) {
     mainClass = 'io.tus.java.example.Api2DevdockTusRelativeLocationResolution'
     workingDir = rootProject.projectDir
 }
+
+tasks.register('api2DevdockTusOverridePatchMethod', JavaExec) {
+    classpath = sourceSets.main.runtimeClasspath
+    mainClass = 'io.tus.java.example.Api2DevdockTusOverridePatchMethod'
+    workingDir = rootProject.projectDir
+}

example/src/main/java/io/tus/java/example/Api2DevdockTusConformanceServer.java

@@ -22,6 +22,7 @@ final class Api2DevdockTusConformanceServer implements AutoCloseable {
     private final List<JSONObject> requests;
     private final HttpServer server;
     private final List<String> errors;
+    private final List<JSONObject> requestHeaders;
     private final List<String> requestMethods;
     private final List<String> requestUrls;
     private int nextRequestIndex;
@@ -35,6 +36,7 @@ final class Api2DevdockTusConformanceServer implements AutoCloseable {
             requests.add(requestArray.getJSONObject(index));
         }
         this.errors = new ArrayList<String>();
+        this.requestHeaders = new ArrayList<JSONObject>();
         this.requestMethods = new ArrayList<String>();
         this.requestUrls = new ArrayList<String>();
         this.server = HttpServer.create(new InetSocketAddress("127.0.0.1", 0), 0);
@@ -51,6 +53,10 @@ URL endpointUrl() throws IOException {
         return localUrl(endpointOrigin.toString());
     }
 
+    URL localUrlFor(String canonicalUrl) throws IOException {
+        return localUrl(canonicalUrl);
+    }
+
     void assertExhausted() {
         assertNoErrors();
         if (nextRequestIndex == requests.size()) {
@@ -87,6 +93,7 @@ String errorSummary() {
 
     JSONObject result() {
         return new JSONObject()
+                .put("requestHeaders", new JSONArray(requestHeaders))
                 .put("requestMethods", new JSONArray(requestMethods))
                 .put("requestUrls", new JSONArray(requestUrls));
     }
@@ -156,14 +163,12 @@ private int observeRequest(HttpExchange exchange, byte[] body) throws IOExceptio
                             + body.length
             );
         }
-        assertHeaders(
-                requestIndex,
-                requestPlan.getJSONObject("effectiveHeaders"),
-                exchange.getRequestHeaders()
-        );
+        final JSONObject expectedHeaders = requestPlan.getJSONObject("effectiveHeaders");
+        assertHeaders(requestIndex, expectedHeaders, exchange.getRequestHeaders());
 
         requestMethods.add(exchange.getRequestMethod());
         requestUrls.add(actualUrl);
+        requestHeaders.add(capturedHeaders(expectedHeaders, exchange.getRequestHeaders()));
         nextRequestIndex += 1;
 
         return requestIndex;
@@ -190,6 +195,18 @@ private void assertHeaders(int requestIndex, JSONObject expectedHeaders, Headers
         }
     }
 
+    private JSONObject capturedHeaders(JSONObject expectedHeaders, Headers actualHeaders) {
+        final JSONObject result = new JSONObject();
+        for (String name : expectedHeaders.keySet()) {
+            final String value = actualHeaders.getFirst(name);
+            if (value != null) {
+                result.put(name, value);
+            }
+        }
+
+        return result;
+    }
+
     private void writeResponse(HttpExchange exchange, JSONObject requestPlan) throws IOException {
         final JSONObject responsePlan = requestPlan.getJSONObject("response");
         final Headers headers = exchange.getResponseHeaders();

example/src/main/java/io/tus/java/example/Api2DevdockTusOverridePatchMethod.java

@@ -0,0 +1,91 @@
+package io.tus.java.example;
+
+import io.tus.java.client.ProtocolException;
+import io.tus.java.client.TusClient;
+import io.tus.java.client.TusUpload;
+import io.tus.java.client.TusUploader;
+import org.json.JSONObject;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.net.URL;
+
+public final class Api2DevdockTusOverridePatchMethod {
+    /**
+     * Run the API2 devdock TUS PATCH method override example.
+     *
+     * @param args ignored
+     */
+    public static void main(String[] args) {
+        try {
+            final JSONObject scenario = Api2DevdockScenario.loadScenario();
+            final JSONObject conformanceScenario = Api2DevdockScenario.conformanceScenario(scenario);
+            final JSONObject result = uploadWithMethodOverride(conformanceScenario);
+            Api2DevdockScenario.writeResult(result);
+
+            System.out.println(
+                    "Java TUS SDK devdock scenario "
+                            + scenario.getString("scenarioId")
+                            + " uploaded to "
+                            + result.getString("uploadUrl")
+            );
+        } catch (Exception e) {
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private static JSONObject uploadWithMethodOverride(JSONObject conformanceScenario)
+            throws IOException, ProtocolException {
+        final byte[] content = Api2DevdockScenario.conformanceInputSourceBytes(conformanceScenario);
+        final URL endpointUrl = new URL(
+                Api2DevdockScenario.conformanceInputStringOption(
+                        conformanceScenario,
+                        "endpointUrl"
+                )
+        );
+        final String uploadUrl = Api2DevdockScenario.conformanceInputStringOption(
+                conformanceScenario,
+                "uploadUrl"
+        );
+
+        try (Api2DevdockTusConformanceServer conformanceServer =
+                     new Api2DevdockTusConformanceServer(conformanceScenario, endpointUrl)) {
+            final TusClient client = new TusClient();
+
+            final TusUpload upload = new TusUpload();
+            upload.setInputStream(new ByteArrayInputStream(content));
+            upload.setSize(content.length);
+
+            final TusUploader uploader = client.beginOrResumeUploadFromURL(
+                    upload,
+                    conformanceServer.localUrlFor(uploadUrl)
+            );
+            uploader.setChunkSize(content.length);
+            try {
+                int uploadedChunkSize;
+                do {
+                    uploadedChunkSize = uploader.uploadChunk();
+                } while (uploadedChunkSize > -1);
+                uploader.finish();
+            } catch (IOException | ProtocolException error) {
+                throw new IOException(
+                        "PATCH method override conformance failed: "
+                                + conformanceServer.errorSummary(),
+                        error
+                );
+            }
+
+            conformanceServer.assertExhausted();
+            return conformanceServer.result()
+                    .put(
+                            "uploadUrl",
+                            conformanceServer.canonicalUrl(uploader.getUploadURL().toString())
+                    );
+        }
+    }
+
+    private Api2DevdockTusOverridePatchMethod() {
+        throw new IllegalStateException("Utility class");
+    }
+}