✨ added withRequest for remote parameter #2

CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+## [0.6.2] - 2023-09-08
+### Added
+- Added `withRequest` method which can used easily when using remote wiremock server.
+
 ## [0.6.1] - 2023-08-31
 ### Changed
 - Update target jvmVersion 1.8 -> 11

README.md

@@ -30,7 +30,7 @@ repositories {
 }
 
 dependencies {
-    testImplementation 'io.github.nilwurtz:wiremock-graphql-extension:0.6.1'
+    testImplementation 'io.github.nilwurtz:wiremock-graphql-extension:0.6.2'
 }
 ```
 
@@ -40,7 +40,7 @@ dependencies {
 <dependency>
     <groupId>io.github.nilwurtz</groupId>
     <artifactId>wiremock-graphql-extension</artifactId>
-    <version>0.6.1</version>
+    <version>0.6.2</version>
     <scope>test</scope>
 </dependency>
 ```
@@ -103,15 +103,15 @@ Please download `wiremock-graphql-extension-x.y.z-jar-with-dependencies.jar` fro
 docker run -it --rm \
       -p 8080:8080 \
       --name wiremock \
-      -v /path/to/wiremock-graphql-extension-0.6.1-jar-with-dependencies.jar:/var/wiremock/extensions/wiremock-graphql-extension-0.6.1-jar-with-dependencies.jar \
+      -v /path/to/wiremock-graphql-extension-0.6.2-jar-with-dependencies.jar:/var/wiremock/extensions/wiremock-graphql-extension-0.6.2-jar-with-dependencies.jar \
       wiremock/wiremock \
       --extensions io.github.nilwurtz.GraphqlBodyMatcher
 ```
 
 #### When building with `docker build`:
 ```dockerfile
 FROM wiremock/wiremock:latest
-COPY ./wiremock-graphql-extension-0.6.1-jar-with-dependencies.jar /var/wiremock/extensions/wiremock-graphql-extension-0.6.1-jar-with-dependencies.jar
+COPY ./wiremock-graphql-extension-0.6.2-jar-with-dependencies.jar /var/wiremock/extensions/wiremock-graphql-extension-0.6.2-jar-with-dependencies.jar
 CMD ["--extensions", "io.github.nilwurtz.GraphqlBodyMatcher"]
 ```
 
@@ -125,12 +125,14 @@ import com.github.tomakehurst.wiremock.client.WireMock.*
 import io.github.nilwurtz.GraphqlBodyMatcher
 
 fun registerGraphQLWiremock(json: String) {
-     WireMock(8080).register(post(urlPathEqualTo(endPoint))
-        .andMatching(GraphqlBodyMatcher.extensionName, Parameters.one("expectedJson", json))
-        .willReturn(
-            aResponse()
-                 .withStatus(200)
-     ))
+    WireMock(8080).register(
+        post(urlPathEqualTo(endPoint))
+            .andMatching(GraphqlBodyMatcher.extensionName, GraphqlBodyMatcher.withRequest(json))
+            .willReturn(
+                aResponse()
+                    .withStatus(200)
+            )
+    )
 }
 ```
 

e2e/Makefile

@@ -16,6 +16,9 @@ run:
 
 docker: docker/build docker/run
 
+docker/stop:
+	docker stop $$(docker ps -q --filter ancestor=wiremock-graphql-extension:latest)
+
 docker/build:
 	cd ../wiremock-graphql-extension && docker build -t wiremock-graphql-extension:latest .
 

e2e/pom.xml

@@ -13,7 +13,7 @@
         <kotlin.compiler.jvmTarget>${java.version}</kotlin.compiler.jvmTarget>
         <gauge.java.version>0.10.2</gauge.java.version>
         <gauge.maven.version>1.5.0</gauge.maven.version>
-        <wiremock.version>3.0.0</wiremock.version>
+        <wiremock.version>3.0.3</wiremock.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
@@ -22,7 +22,7 @@
         <dependency>
             <artifactId>wiremock-graphql-extension</artifactId>
             <groupId>io.github.nilwurtz</groupId>
-            <version>0.6.1</version>
+            <version>0.6.2</version>
         </dependency>
         <dependency>
             <groupId>com.thoughtworks.gauge</groupId>

e2e/src/test/kotlin/Steps.kt

@@ -1,5 +1,4 @@
 import com.github.tomakehurst.wiremock.client.WireMock.*
-import com.github.tomakehurst.wiremock.extension.Parameters
 import com.thoughtworks.gauge.Step
 import io.github.nilwurtz.GraphqlBodyMatcher
 import java.net.URI
@@ -12,11 +11,11 @@ class Steps {
     fun setupGraphqlJsonStub(json: String) {
         // for remote
         Datastore.client()?.register(post(urlEqualTo("/graphql"))
-            .andMatching(GraphqlBodyMatcher.extensionName, Parameters.one("expectedJson", json)).willReturn(ok()))
+            .andMatching(GraphqlBodyMatcher.extensionName, GraphqlBodyMatcher.withRequest(json)).willReturn(ok()))
         // for local
         Datastore.localServer()
             ?.stubFor(post(urlEqualTo("/graphql"))
-                .andMatching(GraphqlBodyMatcher.extensionName, Parameters.one("expectedJson", json)).willReturn(ok()))
+                .andMatching(GraphqlBodyMatcher.extensionName, GraphqlBodyMatcher.withRequest(json)).willReturn(ok()))
     }
 
     @Step("Register a stub to return 200 upon receiving the query<query>")

wiremock-graphql-extension/pom.xml

@@ -6,7 +6,7 @@
 
     <artifactId>wiremock-graphql-extension</artifactId>
     <groupId>io.github.nilwurtz</groupId>
-    <version>0.6.1</version>
+    <version>0.6.2</version>
     <packaging>jar</packaging>
     <name>wiremock-graphql-extension</name>
     <description>A WireMock extension for handling GraphQL requests, allowing for easy mocking of GraphQL APIs in
@@ -36,7 +36,7 @@
         <gpg.skip>true</gpg.skip>
         <kotlin.version>1.9.10</kotlin.version>
         <junit.version>5.10.0</junit.version>
-        <wiremock.version>3.0.0</wiremock.version>
+        <wiremock.version>3.0.3</wiremock.version>
         <graphql-java.version>21.0</graphql-java.version>
         <json.version>20230618</json.version>
         <mockk.version>1.13.7</mockk.version>

wiremock-graphql-extension/src/main/kotlin/io/github/nilwurtz/GraphqlBodyMatcher.kt

@@ -55,6 +55,18 @@ class GraphqlBodyMatcher() : RequestMatcherExtension() {
                 initExpectedRequestJson(expectedJson)
             }
         }
+
+        /**
+        * Creates a Parameters instance containing the given raw JSON string expected in the GraphQL request.
+        *
+        * This method is used to set up JSON expected in remote requests. The expectedJson parameter should be a raw JSON string that encapsulates the expected query and optionally variables for the GraphQL request. This string is used to create a parameters object utilized internally in the GraphqlBodyMatcher.
+        *
+        * @param expectedJson A raw JSON string that contains the GraphQL query and optionally variables expected in the requests.
+        * @return A Parameters instance created based on the expected JSON string.
+        */
+        fun withRequest(expectedJson: String): Parameters {
+           return Parameters.one(expectedJsonKey, expectedJson)
+        }
     }
 
     private lateinit var expectedRequestJson: JSONObject

wiremock-graphql-extension/src/test/kotlin/io/github/nilwurtz/GraphqlBodyMatcherTest.kt

@@ -286,4 +286,23 @@ class GraphqlBodyMatcherTest {
             assertTrue(actual.isExactMatch)
         }
     }
+
+    @Nested
+    @DisplayName("test `withRemoteRequestJson`")
+    inner class WithRemoteRequestJson {
+        @Test
+        @DisplayName("returns Parameters with expectedJsonKey")
+        fun testMatchedIdentical() {
+            // language=json
+            val json = """
+            {
+                "query": "{ hero { name friends { name }}}"
+            }
+        """.trimIndent()
+
+            val actual = GraphqlBodyMatcher.withRequest(json)
+            assertTrue(actual.containsKey("expectedJson"))
+            assertEquals(json, actual.getString("expectedJson"))
+        }
+    }
 }