refactor: got rid of GenericRequest

Refs: #2

Author: nergal-perm

src/main/java/ewc/utilities/testableio/core/GenericIoStub.java

@@ -51,15 +51,9 @@ public class GenericIoStub {
      */
     private final Set<Stub> stored = new HashSet<>();
 
-    /**
-     * Returns the next response for the given query.
-     *
-     * @param query The query for which to get the next response.
-     * @return The next response object.
-     */
-    public GenericResponse nextResponseFor(final GenericRequest query) {
+    public GenericResponse nextResponseFor(final ClientId client, final QueryId query) {
         return this.stubs
-            .getOrDefault(query.clientId(), this.stubs.get(GenericIoStub.COMMON_CLIENT))
+            .getOrDefault(client, this.stubs.get(GenericIoStub.COMMON_CLIENT))
             .nextResponseFor(query);
     }
 

src/main/java/ewc/utilities/testableio/core/GenericRequest.java

@@ -40,30 +40,23 @@ class SingleClientStubs {
      */
     private final Map<QueryId, SingleQueryResponses> stubs = new HashMap<>();
 
-    /**
-     * Returns the next response for the given query.
-     *
-     * @param query The query for which to get the next response.
-     * @return The next response object.
-     */
+    public void setSingleResponseFor(final QueryId query, final GenericResponse response) {
+        this.stubs.put(query, new SingleQueryResponses(query.query(), response));
+    }
+
+    public void setMultipleResponsesFor(final String query, final GenericResponse... responses) {
+        this.stubs.put(new QueryId(query), new SingleQueryResponses(query, responses));
+    }
+
     @SneakyThrows
-    public GenericResponse nextResponseFor(final GenericRequest query) {
-        final QueryId key = query.queryId();
-        if (!this.stubs.containsKey(key)) {
+    public GenericResponse nextResponseFor(QueryId query) {
+        if (!this.stubs.containsKey(query)) {
             throw new NoSuchElementException("No responses configured");
         }
-        final GenericResponse response = this.stubs.get(key).next();
+        final GenericResponse response = this.stubs.get(query).next();
         if (response.delay() > 0) {
             Thread.sleep(response.delay());
         }
         return response;
     }
-
-    public void setSingleResponseFor(final QueryId query, final GenericResponse response) {
-        this.stubs.put(query, new SingleQueryResponses(query.query(), response));
-    }
-
-    public void setMultipleResponsesFor(final String query, final GenericResponse... responses) {
-        this.stubs.put(new QueryId(query), new SingleQueryResponses(query, responses));
-    }
 }

src/main/java/ewc/utilities/testableio/core/SingleClientStubs.java

@@ -34,37 +34,40 @@
  * @since 0.1
  */
 final class GenericIoStubTest {
-    /**
-     * The client id for the test.
-     */
-    public static final ClientId SPEC_CLIENT = Mocks.testRequestFromVipClient().clientId();
+    public static final ClientId ANY_CLIENT = new ClientId("any client");
+
+    public static final ClientId VIP_CLIENT = new ClientId("12345");
+
+    public static final ClientId NEW_CLIENT = new ClientId("new client");
+
+    public static final QueryId TEST_REQUEST = new QueryId("test_request");
 
     @Test
     void createDefaultStub() {
         final GenericIoStub target = new GenericIoStub();
         target.addCommonStub(Mocks.defaultStub());
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromAnyClient()))
+        Assertions.assertThat(target.nextResponseFor(ANY_CLIENT, TEST_REQUEST))
             .isEqualTo(Mocks.defaultResponse());
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromVipClient()))
+        Assertions.assertThat(target.nextResponseFor(VIP_CLIENT, TEST_REQUEST))
             .isEqualTo(Mocks.defaultResponse());
     }
 
     @Test
     void createInfiniteStubForSpecificClient() {
         final GenericIoStub target = new GenericIoStub();
         target.addCommonStub(Mocks.defaultStub());
-        target.addClientStub(Mocks.emptyStub(), GenericIoStubTest.SPEC_CLIENT);
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromAnyClient()))
+        target.addClientStub(Mocks.emptyStub(), GenericIoStubTest.VIP_CLIENT);
+        Assertions.assertThat(target.nextResponseFor(ANY_CLIENT, TEST_REQUEST))
             .isEqualTo(Mocks.defaultResponse());
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromVipClient()))
+        Assertions.assertThat(target.nextResponseFor(VIP_CLIENT, TEST_REQUEST))
             .isEqualTo(Mocks.emptyResponse());
     }
 
     @Test
     void shouldAddResponseToStoredResponses() {
         final GenericIoStub target = new GenericIoStub();
         target.addCommonStub(Mocks.defaultStub());
-        target.addClientStub(Mocks.emptyStub(), GenericIoStubTest.SPEC_CLIENT);
+        target.addClientStub(Mocks.emptyStub(), GenericIoStubTest.VIP_CLIENT);
         final Set<Stub> stubs = target.getResponsesFor("test_request");
         Assertions.assertThat(stubs.stream().map(Stub::name).toList())
             .isNotEmpty()
@@ -77,9 +80,9 @@ void shouldAddResponseToStoredResponses() {
     @Test
     void shouldAddTheExceptionAsTheResponse() {
         final GenericIoStub target = new GenericIoStub();
-        target.addClientStub(Mocks.errorStub(), GenericIoStubTest.SPEC_CLIENT);
+        target.addClientStub(Mocks.errorStub(), GenericIoStubTest.VIP_CLIENT);
         Assertions
-            .assertThatThrownBy(() -> target.nextResponseFor(Mocks.testRequestFromVipClient()))
+            .assertThatThrownBy(() -> target.nextResponseFor(VIP_CLIENT, TEST_REQUEST))
             .isInstanceOf(RuntimeException.class)
             .hasMessage("test error");
     }
@@ -88,31 +91,31 @@ void shouldAddTheExceptionAsTheResponse() {
     void shouldActivateOneOfStoredResponses() {
         final GenericIoStub target = new GenericIoStub();
         target.addCommonStub(Mocks.defaultStub());
-        target.addClientStub(Mocks.emptyStub(), GenericIoStubTest.SPEC_CLIENT);
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromVipClient()))
+        target.addClientStub(Mocks.emptyStub(), GenericIoStubTest.VIP_CLIENT);
+        Assertions.assertThat(target.nextResponseFor(VIP_CLIENT, TEST_REQUEST))
             .isEqualTo(Mocks.emptyResponse());
         target.setActiveResponse(
-            GenericIoStubTest.SPEC_CLIENT,
+            GenericIoStubTest.VIP_CLIENT,
             Mocks.defaultStub().query(),
             Mocks.defaultStub().name()
         );
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromVipClient()))
+        Assertions.assertThat(target.nextResponseFor(VIP_CLIENT, TEST_REQUEST))
             .isEqualTo(Mocks.defaultResponse());
     }
 
     @Test
     void shouldActivateStoredResponseForNewClient() {
         final GenericIoStub target = new GenericIoStub();
         target.addCommonStub(Mocks.defaultStub());
-        target.addClientStub(Mocks.emptyStub(), GenericIoStubTest.SPEC_CLIENT);
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromNewClient()))
+        target.addClientStub(Mocks.emptyStub(), GenericIoStubTest.VIP_CLIENT);
+        Assertions.assertThat(target.nextResponseFor(NEW_CLIENT, TEST_REQUEST))
             .isEqualTo(Mocks.defaultResponse());
         target.setActiveResponse(
-            Mocks.testRequestFromNewClient().clientId(),
+            NEW_CLIENT,
             Mocks.emptyStub().query(),
             Mocks.emptyStub().name()
         );
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromNewClient()))
+        Assertions.assertThat(target.nextResponseFor(NEW_CLIENT, TEST_REQUEST))
             .isEqualTo(Mocks.emptyResponse());
     }
 }

src/test/java/ewc/utilities/testableio/core/GenericIoStubTest.java

@@ -24,8 +24,6 @@
 
 package ewc.utilities.testableio.core;
 
-import java.util.Map;
-
 /**
  * The utility class providing several predefined test objects.
  *
@@ -36,18 +34,6 @@ private Mocks() {
         // Prevent instantiation of the utility class
     }
 
-    static GenericRequest testRequestFromAnyClient() {
-        return Mocks.testFromClient("any client");
-    }
-
-    static GenericRequest testRequestFromVipClient() {
-        return Mocks.testFromClient("12345");
-    }
-
-    static GenericRequest testRequestFromNewClient() {
-        return Mocks.testFromClient("new client");
-    }
-
     /**
      * A test response object that can be used for testing purposes. It contains an empty map of
      * metadata, a delay of 0 milliseconds and a simple string as the contents.
@@ -106,17 +92,4 @@ static Stub defaultStub() {
             .build();
     }
 
-    /**
-     * The test utility method to create a request object with "test_request" as query ID.
-     *
-     * @param client String representing the client ID.
-     * @return A GenericRequest object for the specified client ID.
-     */
-    private static GenericRequest testFromClient(final String client) {
-        return GenericRequest.builder()
-            .client(r -> client)
-            .query(r -> "test_request")
-            .parameters(Map.of())
-            .build();
-    }
 }

src/test/java/ewc/utilities/testableio/core/GenericRequestTest.java

@@ -26,6 +26,7 @@
 
 import java.util.Map;
 import java.util.NoSuchElementException;
+import javax.management.Query;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 
@@ -36,6 +37,9 @@
  * @since 0.1
  */
 final class SingleClientStubsTest {
+
+    public static final QueryId TEST_REQUEST = new QueryId("test_request");
+
     @Test
     void couldBeInstantiated() {
         final SingleClientStubs target = new SingleClientStubs();
@@ -45,9 +49,8 @@ void couldBeInstantiated() {
     @Test
     void throwsIfNoResponsesConfigured() {
         final SingleClientStubs target = new SingleClientStubs();
-        final GenericRequest request = Mocks.testRequestFromAnyClient();
         Assertions.assertThatExceptionOfType(NoSuchElementException.class)
-            .isThrownBy(() -> target.nextResponseFor(request))
+            .isThrownBy(() -> target.nextResponseFor(TEST_REQUEST))
             .withMessage("No responses configured");
     }
 
@@ -60,11 +63,11 @@ void returnsTheResponseThatCorrespondsToTheRequest() {
         target.setSingleResponseFor(
             new QueryId("test_request"), new GenericResponse("Recommendations page", 1000, Map.of())
         );
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromAnyClient()))
+        Assertions.assertThat(target.nextResponseFor(TEST_REQUEST))
             .isNotNull()
             .extracting("contents").isEqualTo("Recommendations page");
         final long now = System.currentTimeMillis();
-        Assertions.assertThat(target.nextResponseFor(Mocks.testRequestFromVipClient()))
+        Assertions.assertThat(target.nextResponseFor(TEST_REQUEST))
             .isNotNull()
             .extracting("contents").isEqualTo("Recommendations page");
         Assertions.assertThat(System.currentTimeMillis() - now)