add patch methods for stub RestClient

Author: xvik

CHANGELOG.md

@@ -4,7 +4,9 @@
     - Add ApacheTestClientFactory: useful to support PATCH methods on jdk > 16
     - Add `useApacheClient` (shortcut) configuration into `@TestGuiceyApp` and `@TestDropwizardApp`
         to simplify usage of ApacheTestClientFactory with annotations
-    - Add `useApacheClient()` (shortcut) method into extension and generic builders 
+    - Add `useApacheClient()` (shortcut) method into extension and generic builders
+* @StubRest RestClient:
+    - Add patch method shortcuts
 
 ### 7.2.1 (2025-05-12)
 * Fix NoClassDefFoundError on guicey startup due to junit classes leak into core (#428)

dropwizard-guicey/src/main/java/ru/vyarus/dropwizard/guice/test/rest/RestClient.java

@@ -1,6 +1,7 @@
 package ru.vyarus.dropwizard.guice.test.rest;
 
 import jakarta.annotation.Nullable;
+import jakarta.ws.rs.HttpMethod;
 import jakarta.ws.rs.client.Client;
 import jakarta.ws.rs.client.Entity;
 import jakarta.ws.rs.client.Invocation;
@@ -64,6 +65,7 @@
  * @author Vyacheslav Rusakov
  * @since 20.02.2025
  */
+@SuppressWarnings("PMD.TooManyMethods")
 public class RestClient {
 
     private static final List<Integer> DEFAULT_OK = Arrays.asList(HttpStatus.OK_200, HttpStatus.NO_CONTENT_204);
@@ -327,6 +329,54 @@ public <T> T put(final String path, final Entity<?> body, final @Nullable Class<
         }
     }
 
+    /**
+     * Simple PATCH call shortcut. Provided path should include only the target rest path.
+     * Body object assumed to be a json entity (would be serialized as json). For file sending use method with generic
+     * entity {@link #put(String, jakarta.ws.rs.client.Entity, Class)}.
+     * <p>
+     * To provide additional headers and query params see {@link #defaultHeader(String, String)}
+     * ({@link #defaultAccept(String...)}) and {@link #defaultQueryParam(String, String)}.
+     * For void responses (result class null) checks response status correctness (see {@link #defaultOk(Integer...)}).
+     * <p>
+     * For response headers validation, use raw {@code Response res = request("/path/").put(Entity.json(body))}.
+     * <p>
+     * IMPORTANT: default jersey client would not support PATCH calls on jdk > 16 because it uses
+     * {@link org.glassfish.jersey.client.HttpUrlConnectorProvider} which supports only HTTP 1.1. Use apache
+     * client to workaround this problem on jdk > 16 (see useApacheClient extension option)
+     *
+     * @param path   target path, relative to rest root
+     * @param body   put body object (serialized as json)
+     * @param result result type (when null, accepts any 200 or 204 responses)
+     * @param <T>    result type
+     * @return mapped result object or null (if class not declared)
+     */
+    public <T> T patch(final String path, final @Nullable Object body, final @Nullable Class<T> result) {
+        return patch(path, Entity.json(body), result);
+    }
+
+    /**
+     * Same as {@link #patch(String, Object, Class)}, but accepts generic entity. Useful for sending multipart
+     * requests.
+     * <p>
+     * IMPORTANT: default jersey client would not support PATCH calls on jdk > 16 because it uses
+     * {@link org.glassfish.jersey.client.HttpUrlConnectorProvider} which supports only HTTP 1.1. Use apache
+     * client to workaround this problem on jdk > 16 (see useApacheClient extension option)
+     *
+     * @param path   target path, relative to rest root
+     * @param body   post body object (serialized as json)
+     * @param result result type (when null, accepts any 200 or 204 responses)
+     * @param <T>    result type
+     * @return mapped result object or null (if class not declared)
+     */
+    public <T> T patch(final String path, final Entity<?> body, final @Nullable Class<T> result) {
+        if (result != null) {
+            return request(path).method(HttpMethod.PATCH, body, result);
+        } else {
+            checkVoidResponse(() -> request(path).method(HttpMethod.PATCH, body));
+            return null;
+        }
+    }
+
     /**
      * Simple DELETE call shortcut. Provided path should include only the target rest path.
      * <p>

dropwizard-guicey/src/test/groovy/ru/vyarus/dropwizard/guice/test/jupiter/setup/rest/RestClientTest.java

@@ -1,6 +1,7 @@
 package ru.vyarus.dropwizard.guice.test.jupiter.setup.rest;
 
 import jakarta.ws.rs.WebApplicationException;
+import jakarta.ws.rs.client.Entity;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import ru.vyarus.dropwizard.guice.test.jupiter.TestGuiceyApp;
@@ -12,7 +13,7 @@
  * @author Vyacheslav Rusakov
  * @since 25.02.2025
  */
-@TestGuiceyApp(RestStubApp.class)
+@TestGuiceyApp(value = RestStubApp.class, useApacheClient = true)
 public class RestClientTest {
 
     @StubRest(disableDropwizardExceptionMappers = true)
@@ -38,6 +39,12 @@ void testClient() {
         rest.post("/1/foo", null, null);
         res = rest.put("/1/foo", "something", String.class);
         Assertions.assertEquals("foo", res);
+
+        // patch body can't be null
+        rest.patch("/1/foo", Entity.text("sample"), null);
+        res = rest.patch("/1/foo", "something", String.class);
+        Assertions.assertEquals("foo", res);
+
         rest.delete("/1/bar", null);
     }
 

dropwizard-guicey/src/test/groovy/ru/vyarus/dropwizard/guice/test/rest/support/Resource1.java

@@ -3,6 +3,7 @@
 import com.google.common.base.Preconditions;
 import jakarta.ws.rs.DELETE;
 import jakarta.ws.rs.GET;
+import jakarta.ws.rs.PATCH;
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.PUT;
 import jakarta.ws.rs.Path;
@@ -37,6 +38,12 @@ public String put(@PathParam("foo") String foo) {
         return foo;
     }
 
+    @PATCH
+    @Path("/{foo}")
+    public String patch(@PathParam("foo") String foo) {
+        return foo;
+    }
+
     @DELETE
     @Path("/{foo}")
     public void delete(@PathParam("foo") String foo) {