Adding demo for extension functionality

- adding sample Vue frontend - adding WireMock docker configuration for demo - udpate README.md
wiremock · Sep 6, 2023 · 96b7449 · 96b7449
1 parent 8572da4
commit 96b7449
Show file tree

Hide file tree

Showing 45 changed files with 8,586 additions and 35 deletions.
diff --git a/.run/WireMock Docker Demo.run.xml b/.run/WireMock Docker Demo.run.xml
@@ -0,0 +1,33 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="WireMock Docker Demo" type="docker-deploy" factoryName="docker-image" server-name="Docker">
+    <deployment type="docker-image">
+      <settings>
+        <option name="imageTag" value="wiremock/wiremock:3x" />
+        <option name="command" value="--global-response-templating --verbose" />
+        <option name="containerName" value="wiremock-extension-state-test" />
+        <option name="portBindings">
+          <list>
+            <DockerPortBindingImpl>
+              <option name="containerPort" value="8080" />
+              <option name="hostPort" value="8080" />
+            </DockerPortBindingImpl>
+          </list>
+        </option>
+        <option name="volumeBindings">
+          <list>
+            <DockerVolumeBindingImpl>
+              <option name="containerPath" value="/var/wiremock/extensions" />
+              <option name="hostPath" value="$PROJECT_DIR$/build/libs" />
+              <option name="readOnly" value="true" />
+            </DockerVolumeBindingImpl>
+            <DockerVolumeBindingImpl>
+              <option name="containerPath" value="/home/wiremock" />
+              <option name="hostPath" value="$PROJECT_DIR$/demo/stubs" />
+            </DockerVolumeBindingImpl>
+          </list>
+        </option>
+      </settings>
+    </deployment>
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/README.md b/README.md
@@ -113,13 +113,16 @@ the `GET` won't have any knowledge of the previous post.
     ```
 
 2`POST` add another new item (`POST /queue`)
+
 - Request:
 
    ```json
    {
   "firstName": "Jane",
   "lastName": "Doe"
+
 }
+
    ```
 
 - Response:
@@ -144,7 +147,9 @@ the `GET` won't have any knowledge of the previous post.
   "id": "kn0ixsaswzrzcfzriytrdupnjnxor1is",
   "firstName": "John",
   "lastName": "Doe"
+
 }
+
   ```
 
 4. `GET` to retrieve the second value (`GET /queue`)
@@ -251,12 +256,11 @@ java -cp "wiremock-state-extension-standalone-0.0.5.jar:wiremock-standalone-3.0.
 
 ### Docker
 
-Using the extension with docker is similar to its usage with usage [standalone](#standalone): it just has to be available on 
+Using the extension with docker is similar to its usage with usage [standalone](#standalone): it just has to be available on
 the classpath to be loaded automatically - it does not have to be added via `--extensions` .
 
 **Note:** This extension depends on the current WireMock beta development, thus the tag `3x` has to be used:
 
-
 ```bash
 docker run -it --rm \
 -p 8080:8080 \
@@ -418,16 +422,18 @@ To append a state to a list:
 
 ### Accessing the previous state
 
-You can use the `state` helper to temporarily access the previous state. Use the `state` helper in the same way as you would use it when you [retrieve a state](#retrieve-a-state).
+You can use the `state` helper to temporarily access the previous state. Use the `state` helper in the same way as you would use it when
+you [retrieve a state](#retrieve-a-state).
 
 **Note:** This extension does not keep a history in itself but it's an effect of the evaluation order.
 As templates are evaluated before the state is written, the state you access in `recordState` is the one before you store the new one
-(so there might be none - you might want to use `default` for these cases). In case you have multiple `recordState` `serveEventListeners`, you will have new states
+(so there might be none - you might want to use `default` for these cases). In case you have multiple `recordState` `serveEventListeners`, you will have new
+states
 being created in between, thus the previous state is the last stored one (so: not the one before the request).
 
 1. listener 1 is executed
-   1. accesses state n
-   2. stores state n+1
+    1. accesses state n
+    2. stores state n+1
 2. listener 2 is executed
     1. accesses state n+1
     2. stores state n+2
@@ -455,7 +461,6 @@ The evaluation order of listeners within a stub as well as across stubs is not g
 }
 ```
 
-
 ## Deleting a state
 
 Similar to recording a state, its deletion can be initiated in  `serveEventListeners` of a stub.
@@ -505,50 +510,62 @@ Dictionary - only one option is interpreted (top to bottom as listed here)
 - ```json
   { 
     "name": "deleteState",
-    "list": {
-      "deleteFirst": true
+    "parameters": {
+      "list": {
+        "deleteFirst": true
+      }
     }
   }
   ```
 - ```json
   { 
     "name": "deleteState",
-    "list": {
-      "deleteLast": true
+    "parameters": {
+      "list": {
+        "deleteLast": true
+      }
     }
   }
   ```
 - ```json
   { 
     "name": "deleteState",
-    "list": {
-      "deleteIndex": "1"
+    "parameters": {
+      "list": {
+        "deleteIndex": "1"
+      }
     }
   }
   ```
 - ```json
   { 
     "name": "deleteState",
-    "list": {
-      "deleteIndex": "-1"
+    "parameters": {
+      "list": {
+        "deleteIndex": "-1"
+      }
     }
   }
   ```
 - ```json
   { 
     "name": "deleteState",
-    "list": {
-      "deleteIndex": "{{request.pathSegments.[1]}}"
+    "parameters": {
+      "list": {
+        "deleteIndex": "{{request.pathSegments.[1]}}"
+      }
     }
   }
   ```
 - ```json
   { 
     "name": "deleteState",
-    "list": {
-      "deleteWhere": {
-        "property": "myProperty",
-        "value": "{{request.pathSegments.[2]}}"
+    "parameters": {
+      "list": {
+        "deleteWhere": {
+          "property": "myProperty",
+          "value": "{{request.pathSegments.[2]}}"
+        }
       }
     }
   }
@@ -740,7 +757,7 @@ The handler has the following parameters:
       The number matches the one described in [Context update count match](#context-update-count-match)
     - `property='listSize` retrieves the number of entries of `list`
     - `property='list` get the whole list as array, e.g. to use it with [handlebars #each](https://handlebarsjs.com/guide/builtin-helpers.html#each)
-      - this property always has a default value (empty list), which can be overwritten with a JSON list
+        - this property always has a default value (empty list), which can be overwritten with a JSON list
 - `list`: Getting an entry of the context's `list`, identified via a JSON path. Examples:
     - getting the first state in the list: `list='[0].myProperty`
     - getting the last state in the list: `list='[-1].myProperty`
@@ -751,7 +768,7 @@ You have to choose either `property` or `list` (otherwise, you will get a config
 
 To retrieve a full body, use tripple braces: `{{{state context=request.pathSegments.[1] property='fullBody'}}}` .
 
-When registering this extension, this helper is available via  WireMock's [response templating](https://wiremock.org/3.x/docs/response-templating/) as well as 
+When registering this extension, this helper is available via WireMock's [response templating](https://wiremock.org/3.x/docs/response-templating/) as well as
 in all configuration options of this extension.
 
 ### List operations
@@ -761,30 +778,60 @@ You can use [handlebars #each](https://handlebarsjs.com/guide/builtin-helpers.ht
 Things to consider:
 
 - this syntax only works with `body`. It DOES NOT work with `jsonBody`
-  - as this might get ugly, consider using `bodyFileName` / `withBodyFile()` have proper indentation
+    - as this might get ugly, consider using `bodyFileName` / `withBodyFile()` have proper indentation
 - the default response for non-existant context as well as non-existant list in a context is an empty list. These states cannot be differentiated here
-  - if you still want a different response, consider using a [StateRequestMatcher](#negative-context-exists-match)
+    - if you still want a different response, consider using a [StateRequestMatcher](#negative-context-exists-match)
 - the default value for this property has to be a valid JSON list - otherwise you will get an error log and the empty list response
 - JSON does not allow trailing commas, so in order to create a valid JSON list, use `{{#unless @last}},{{/unless}` before `{{/each}}`
 
+Example with inline body:
+
+```json
+{
+  "request": {
+    "urlPathPattern": "/listing",
+    "method": "GET"
+  },
+  "response": {
+    "status": 200,
+    "body": "[\n{{# each (state context='list' property='list' default='[]') }}  {\n    \"id\": \"{{id}}\",\n    \"firstName\": \"{{firstName}}\",\n    \"lastName\": \"{{lastName}}\"  }{{#unless @last}},{{/unless}}\n{{/each}}]",
+    "headers": {
+      "content-type": "application/json"
+    }
+  }
+}
+```
+
+Example with bodyFileName:
 
-Example:
 ```json
 {
-  "request" : {
-    "urlPathPattern" : "/listing",
-    "method" : "GET"
+  "request": {
+    "urlPathPattern": "/listing",
+    "method": "GET"
   },
-  "response" : {
-    "status" : 200,
-    "body" : "[\n{{# each (state context=list property='list' default='[]') }}  {\n    \"id\": \"{{id}}\",\n    \"firstName\": \"{{firstName}}\",\n    \"firstName\": \"{{firstName}}\"  }{{#unless @last}},{{/unless}}\n{{/each}}]",
-    "headers" : {
-      "content-type" : "application/json"
+  "response": {
+    "status": 200,
+    "bodyFileName": "body.json",
+    "headers": {
+      "content-type": "application/json"
     }
   }
 }
 ```
 
+```json
+[
+  {{# each (state context='list' property='list' default='[]') }}  
+  {
+    "id": {{id}},    
+    "firstName": "{{firstName}}",   
+    "lastName": "{{lastName}}"
+  }{{#unless @last}},{{/unless}}
+  {{/each}}
+]
+```
+
 ### Error handling
 
 Missing Helper properties as well as unknown context properties are reported as error. WireMock renders them in the field, itself, so there won't be an
@@ -800,7 +847,8 @@ Example response with error:
 }
 ```
 
-To avoid errors, you can specify a `default` for the state helper: `"clientId": "{{state context=request.pathSegments.[1] property='firstname' default='John'}}",`
+To avoid errors, you can specify a `default` for the state
+helper: `"clientId": "{{state context=request.pathSegments.[1] property='firstname' default='John'}}",`
 
 # Debugging
 

diff --git a/demo/stubs/__files/new-todo-item-response.json b/demo/stubs/__files/new-todo-item-response.json
@@ -0,0 +1,5 @@
+{
+  "id": {{randomInt lower=1 upper=10000}},
+  "title": "{{jsonPath request.body '$.title'}}",
+  "description": "{{jsonPath request.body '$.description'}}"
+}
diff --git a/demo/stubs/__files/todo-list-response.json b/demo/stubs/__files/todo-list-response.json
@@ -0,0 +1,9 @@
+[
+  {{# each (state context='todolist' property='list' default='[]') }}
+    {
+      "id": {{id}},
+      "title": "{{title}}",
+      "description": "{{description}}"
+  }{{#unless @last}},{{/unless}}
+  {{/each}}
+]
diff --git a/demo/stubs/mappings/profile.json b/demo/stubs/mappings/profile.json
@@ -0,0 +1,52 @@
+{
+  "mappings": [
+    {
+      "request": {
+        "urlPathPattern": "/api/v1/profile",
+        "method": "GET"
+      },
+      "response": {
+        "status": 200,
+        "jsonBody": {
+          "firstName": "{{state context='profile' property='firstName' default=''}}",
+          "familyName": "{{state context='profile' property='familyName' default=''}}",
+          "street": "{{state context='profile' property='street' default=''}}",
+          "city": "{{state context='profile' property='city' default=''}}"
+        },
+        "headers": {
+          "content-type": "application/json"
+        }
+      }
+    },
+    {
+      "request": {
+        "urlPathPattern": "/api/v1/profile",
+        "method": "POST"
+      },
+      "response": {
+        "status": 200,
+        "jsonBody": {
+          "firstName" : "{{jsonPath request.body '$.firstName'}}",
+          "familyName" : "{{jsonPath request.body '$.familyName'}}",
+          "street" : "{{jsonPath request.body '$.street'}}",
+          "city" : "{{jsonPath request.body '$.city'}}"
+        },
+        "headers": {
+          "content-type": "application/json"
+        }
+      },
+      "serveEventListeners" : [ {
+        "name" : "recordState",
+        "parameters" : {
+          "state" : {
+            "firstName" : "{{jsonPath request.body '$.firstName'}}",
+            "familyName" : "{{jsonPath request.body '$.familyName'}}",
+            "street" : "{{jsonPath request.body '$.street'}}",
+            "city" : "{{jsonPath request.body '$.city'}}"
+          },
+          "context" : "profile"
+        }
+      } ]
+    }
+  ]
+}