Add fixed delay per request

Author: tommysitu

.java-version

@@ -0,0 +1 @@
+11.0

docs/pages/corefunctionality/dsl.rst

@@ -55,7 +55,7 @@ Per-request delay can be set as follows:
     SimulationSource.dsl(
         service("www.not-so-slow-service.com")
             .get("/api/bookings")
-            .willReturn(success().withDelay(1, TimeUnit.SECONDS))
+            .willReturn(success().withFixedDelay(1, TimeUnit.SECONDS))
         )
     )
 
@@ -83,4 +83,4 @@ There is an implementation which lets you write inline JSON body efficiently wit
 .. code-block:: java
 
     .body(jsonWithSingleQuotes("{'bookingId':'1'}"))
-    .body(jsonWithSingleQuotes("{'merchantName':'Jame\\'s'}"))  // escape single quote in your data if necessary
+    .body(jsonWithSingleQuotes("{'merchantName':'Jame\\'s'}"))  // escape single quote in your data if necessary

src/main/java/io/specto/hoverfly/junit/core/model/Response.java

@@ -33,25 +33,30 @@ public class Response {
     private final Map<String, List<String>> headers;
     private final Map<String, String> transitionsState;
     private final List<String> removesState;
+    private final Integer fixedDelay;
+
 
     @JsonCreator
-    public Response(@JsonProperty("status") Integer status,
-                    @JsonProperty("body") String body,
-                    @JsonProperty("encodedBody") boolean encodedBody,
-                    @JsonProperty("templated") boolean templated,
-                    @JsonProperty("headers") Map<String, List<String>> headers,
-                    @JsonProperty("transitionsState") Map<String, String> transitionsState,
-                    @JsonProperty("removesState") List<String> removesState) {
+    public Response(
+        @JsonProperty("status") Integer status,
+        @JsonProperty("body") String body,
+        @JsonProperty("encodedBody") boolean encodedBody,
+        @JsonProperty("templated") boolean templated,
+        @JsonProperty("headers") Map<String, List<String>> headers,
+        @JsonProperty("transitionsState") Map<String, String> transitionsState,
+        @JsonProperty("removesState") List<String> removesState,
+        @JsonProperty("fixedDelay") Integer fixedDelay) {
         this.status = status;
         this.body = body;
         this.encodedBody = encodedBody;
         this.templated = templated;
         this.headers = headers;
         this.transitionsState = transitionsState;
         this.removesState = removesState;
+        this.fixedDelay = fixedDelay;
     }
 
-    public int getStatus() {
+    public Integer getStatus() {
         return status;
     }
 
@@ -80,6 +85,10 @@ public List<String> getRemovesState() {
         return removesState;
     }
 
+    public Integer getFixedDelay() {
+        return fixedDelay;
+    }
+
     static class Builder {
         private Integer status;
         private String body;
@@ -88,6 +97,7 @@ static class Builder {
         private Map<String, List<String>> headers;
         private Map<String, String> transitionsState;
         private List<String> removesState;
+        private Integer fixedDelay;
 
         Builder status(int status) {
             this.status = status;
@@ -124,8 +134,13 @@ Builder removesState(List<String> removesState) {
             return this;
         }
 
+        Builder fixedDelay(int fixedDelay) {
+            this.fixedDelay = fixedDelay;
+            return this;
+        }
+
         Response build() {
-            return new Response(status, body, encodedBody, templated, headers, transitionsState, removesState);
+            return new Response(status, body, encodedBody, templated, headers, transitionsState, removesState, fixedDelay);
         }
     }
 
@@ -143,4 +158,4 @@ public int hashCode() {
     public String toString() {
         return ToStringBuilder.reflectionToString(this);
     }
-}
+}

src/main/java/io/specto/hoverfly/junit/dsl/ResponseBuilder.java

@@ -36,6 +36,10 @@ public class ResponseBuilder {
     private final Map<String, String> transitionsState = new HashMap<>();
     private final List<String> removesState = new ArrayList<>();
 
+    private int fixedDelay;
+    private TimeUnit fixedDelayTimeUnit;
+
+    // Deprecated: For global delay settings
     private int delay;
     private TimeUnit delayTimeUnit;
 
@@ -108,7 +112,8 @@ public ResponseBuilder andRemoveState(final String stateToRemove) {
      * @return the response
      */
     Response build() {
-        return new Response(status, body, false, templated, headers, transitionsState, removesState);
+        int fixedDelayInMillis = fixedDelayTimeUnit == null ? 0 : (int) fixedDelayTimeUnit.toMillis(fixedDelay);
+        return new Response(status, body, false, templated, headers, transitionsState, removesState, fixedDelayInMillis);
     }
 
     public ResponseBuilder body(final HttpBodyConverter httpBodyConverter) {
@@ -123,12 +128,19 @@ public ResponseBuilder disableTemplating() {
         return this;
     }
 
+    public ResponseBuilder withFixedDelay(int delay, TimeUnit delayTimeUnit) {
+        fixedDelay = delay;
+        fixedDelayTimeUnit = delayTimeUnit;
+        return this;
+    }
+
     /**
      * Sets delay parameters.
      * @param delay amount of delay
      * @param delayTimeUnit time unit of delay (e.g. SECONDS)
      * @return the {@link ResponseBuilder for further customizations}
      */
+    @Deprecated
     public ResponseBuilder withDelay(int delay, TimeUnit delayTimeUnit) {
         this.delay = delay;
         this.delayTimeUnit = delayTimeUnit;

src/test/java/io/specto/hoverfly/junit/core/model/SimulationTest.java

@@ -83,7 +83,8 @@ private Simulation getLatestSimulation() {
                 .requiresState(ImmutableMap.of("requiresStateKey", "requiresStateValue"));
         Response.Builder responseBuilder = getTestResponseBuilder()
                 .transitionsState(ImmutableMap.of("transitionsStateKey", "transitionsStateValue"))
-                .removesState(ImmutableList.of("removesStateKey"));
+                .removesState(ImmutableList.of("removesStateKey"))
+                .fixedDelay(3000);
         HoverflyData data = getTestHoverflyData(requestBuilder, responseBuilder);
         HoverflyMetaData meta = new HoverflyMetaData();
         return new Simulation(data, meta);

src/test/java/io/specto/hoverfly/ruletest/HoverflyDslWithDelayTest.java

@@ -15,6 +15,7 @@
 import static io.specto.hoverfly.junit.dsl.ResponseCreators.success;
 import static io.specto.hoverfly.junit.dsl.matchers.HoverflyMatchers.contains;
 import static io.specto.hoverfly.junit.dsl.matchers.HoverflyMatchers.endsWith;
+import static io.specto.hoverfly.junit.dsl.matchers.HoverflyMatchers.equalsTo;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class HoverflyDslWithDelayTest {
@@ -39,10 +40,10 @@ public class HoverflyDslWithDelayTest {
 
                     .andDelay(3, TimeUnit.SECONDS).forMethod("POST"),
 
-            // Delay based on URL
+            // Fixed delay for a particular request
             service("www.not-so-slow-service.com")
                     .get("/api/bookings")
-                    .willReturn(success().withDelay(1, TimeUnit.SECONDS))
+                    .willReturn(success().withFixedDelay(1, TimeUnit.SECONDS))
 
     )).printSimulationData();
 
@@ -91,7 +92,7 @@ public void shouldBeAbleToDelayRequestByHttpMethod() {
     }
 
     @Test
-    public void shouldBeAbleToDelayRequest() {
+    public void shouldBeAbleToAddFixedDelayPerRequest() {
 
         // When
         StopWatch stopWatch = new StopWatch();

src/test/resources/simulations/v5-simulation-with-unknown-fields.json

@@ -75,7 +75,8 @@
 					},
 					"removesState": [
 						"removesStateKey"
-					]
+					],
+					"fixedDelay": 3000
 				}
 			}
 		],

src/test/resources/simulations/v5-simulation.json

@@ -74,7 +74,8 @@
 					},
 					"removesState": [
 						"removesStateKey"
-					]
+					],
+					"fixedDelay": 3000
 				}
 			}
 		],