Adding state request matcher (#1)

- also add dependabot

Author: dirkbolte

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: gradle
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "01:00"
+    open-pull-requests-limit: 10
+    assignees:
+      - "dirkbolte"

.github/workflows/build-and-test.yml

@@ -13,7 +13,7 @@ jobs:
     name: Validate Gradle wrapper
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Validate Gradle wrapper
         uses: gradle/wrapper-validation-action@v1
   build:

README.md

@@ -55,7 +55,8 @@ the `GET` won't have any knowledge of the previous post.
 Two extensions have to be registered:
 
 - `StateRecordingAction` to record any state in `postServeActions`
-- `ResponseTemplateTransformer` with `StateHelper` to retrieve a previously recorded state
+- `StateRequestMatcher` to match incoming request against a context using custom master `state-matcher`
+- `ResponseTemplateTransformer` with `StateHelper` to retrieve a previously recorded state for a context
 
 ```java
 public class MySandbox {
@@ -68,6 +69,7 @@ public class MySandbox {
                 .dynamicPort()
                 .extensions(
                     stateRecordingAction,
+                    new StateRequestMatcher(stateRecordingAction),
                     new ResponseTemplateTransformer(true, "state", new StateHelper(stateRecordingAction))
                 )
         );
@@ -156,7 +158,52 @@ The default expiration is 60 minutes. The default value can be overwritten (`0`
 
 ```java
 int expiration=1024;
-    var stateRecordingAction=new StateRecordingAction(expiration);
+var stateRecordingAction=new StateRecordingAction(expiration);
+```
+
+## Match a request against a context
+
+To have a WireMock stub only apply when there's actually a matching context, you can use the `StateRequestMatcher` . This helps to model different
+behavior for requests with and without a matching context. The parameter supports templates.
+
+### Positive match
+
+```json
+{
+  "request": {
+    "method": "GET",
+    "urlPattern": "/test/[^\/]+",
+    "customMatcher": {
+      "name": "state-matcher",
+      "parameters": {
+        "hasContext": "{{request.pathSegments.[1]}}"
+      }
+    }
+  },
+  "response": {
+    "status": 200
+  }
+}
+```
+
+### Negative match
+
+```json
+{
+  "request": {
+    "method": "GET",
+    "urlPattern": "/test/[^\/]+",
+    "customMatcher": {
+      "name": "state-matcher",
+      "parameters": {
+        "hasNotContext": "{{request.pathSegments.[1]}}"
+      }
+    }
+  },
+  "response": {
+    "status": 400
+  }
+}
 ```
 
 ## Retrieve a state

src/main/java/com/github/dirkbolte/wiremock/state/StateRecordingAction.java

@@ -27,6 +27,7 @@
 import com.github.tomakehurst.wiremock.stubbing.ServeEvent;
 import org.apache.commons.lang3.StringUtils;
 
+import javax.swing.text.html.Option;
 import java.time.Duration;
 import java.util.Collections;
 import java.util.Map;
@@ -63,23 +64,28 @@ public void doAction(ServeEvent serveEvent, Admin admin, Parameters parameters)
             "response", ResponseTemplateModel.from(serveEvent.getResponse())
         );
         var context = createContext(model, parameters);
-        storeState(context, model, parameters);
+        storeContextAndState(context, model, parameters);
     }
 
     @Override
     public String getName() {
         return "recordState";
     }
 
-    public Object getState(String context, String property) {
+    Object getState(String context, String property) {
         return cache.getIfPresent(calculateKey(context, property));
     }
 
-    private void storeState(String context, Map<String, Object> model, Parameters parameters) {
+    boolean hasContext(String context) {
+        return cache.getIfPresent(context) != null;
+    }
+
+    private void storeContextAndState(String context, Map<String, Object> model, Parameters parameters) {
         @SuppressWarnings("unchecked") Map<String, Object> state = Optional.ofNullable(parameters.get("state"))
             .filter(it -> it instanceof Map)
             .map(Map.class::cast)
             .orElseThrow(() -> new ConfigurationException("no state specified"));
+        cache.put(context, context);
         state.entrySet()
             .stream()
             .map(entry -> Map.entry(entry.getKey(), renderTemplate(model, entry.getValue().toString())))
@@ -95,7 +101,7 @@ private String createContext(Map<String, Object> model, Parameters parameters) {
         return context;
     }
 
-    private String renderTemplate(Object context, String value) {
+    String renderTemplate(Object context, String value) {
         return templateEngine.getUncachedTemplate(value).apply(context);
     }
 

src/main/java/com/github/dirkbolte/wiremock/state/StateRequestMatcher.java

@@ -0,0 +1,57 @@
+package com.github.dirkbolte.wiremock.state;
+
+import com.github.tomakehurst.wiremock.core.ConfigurationException;
+import com.github.tomakehurst.wiremock.extension.Parameters;
+import com.github.tomakehurst.wiremock.extension.responsetemplating.RequestTemplateModel;
+import com.github.tomakehurst.wiremock.http.Request;
+import com.github.tomakehurst.wiremock.matching.MatchResult;
+import com.github.tomakehurst.wiremock.matching.RequestMatcherExtension;
+
+import java.util.Map;
+import java.util.Optional;
+
+public class StateRequestMatcher extends RequestMatcherExtension {
+
+    private final StateRecordingAction recordingAction;
+
+    public StateRequestMatcher(StateRecordingAction recordingAction) {
+        this.recordingAction = recordingAction;
+    }
+
+    @Override
+    public String getName() {
+        return "state-matcher";
+    }
+
+    @Override
+    public MatchResult match(Request request, Parameters parameters) {
+        if (parameters.size() != 1) {
+            throw new ConfigurationException("Parameters should only contain one entry ('hasContext' or 'hasNotContext'");
+        }
+        var model = Map.of("request", RequestTemplateModel.from(request));
+        return Optional
+            .ofNullable(parameters.getString("hasContext", null))
+            .map(template -> hasContext(model, template))
+            .or(() -> Optional.ofNullable(parameters.getString("hasNotContext", null)).map(template -> hasNotContext(model, template)))
+            .orElseThrow(() -> new ConfigurationException("Parameters should only contain 'hasContext' or 'hasNotContext'"));
+
+    }
+
+    private MatchResult hasContext(Map<String, RequestTemplateModel> model, String template) {
+        var context = recordingAction.renderTemplate(model, template);
+        if (recordingAction.hasContext(context)) {
+            return MatchResult.exactMatch();
+        } else {
+            return MatchResult.noMatch();
+        }
+    }
+
+    private MatchResult hasNotContext(Map<String, RequestTemplateModel> model, String template) {
+        var context = recordingAction.renderTemplate(model, template);
+        if (!recordingAction.hasContext(context)) {
+            return MatchResult.exactMatch();
+        } else {
+            return MatchResult.noMatch();
+        }
+    }
+}

src/test/java/com/github/dirkbolte/wiremock/state/StateTest.java renamed to src/test/java/com/github/dirkbolte/wiremock/state/StateHelperTest.java

@@ -44,11 +44,12 @@
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
 import static io.restassured.RestAssured.given;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.hamcrest.Matchers.equalTo;
 import static org.junit.jupiter.api.parallel.ExecutionMode.SAME_THREAD;
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 @Execution(SAME_THREAD)
-class StateTest {
+class StateHelperTest {
 
     private static final String TEST_URL = "/test";
     private static final StateRecordingAction stateRecordingAction = new StateRecordingAction();
@@ -94,7 +95,7 @@ void test_noExtensionUsage_ok() throws JsonProcessingException, URISyntaxExcepti
             .post(new URI(runtimeInfo.getHttpBaseUrl() + TEST_URL))
             .then()
             .statusCode(HttpStatus.SC_OK)
-            .body("testKey", Matchers.equalTo("testValue"));
+            .body("testKey", equalTo("testValue"));
     }
 
     @Test
@@ -197,12 +198,10 @@ private void getAndAssertContextValue(String context, String contextValue) throw
             .get(new URI(String.format("%s%s/%s", wm.getRuntimeInfo().getHttpBaseUrl(), TEST_URL, context)))
             .then()
             .statusCode(HttpStatus.SC_OK)
-            .body("value", Matchers.notNullValue())
+            .body("value", equalTo(contextValue))
             .extract()
             .body()
             .jsonPath().get("value");
-
-        assertThat(responseValue).describedAs("context value is returned").isEqualTo(contextValue);
     }
 
     private String postAndAssertContextValue(String contextValue) throws URISyntaxException {