ft/receivedRequestsOrderAssertion (#149)

* ft: Ability to assert a request has been received on given paths in a specified order

* Feat/check-order-calls: Now we can assert about the order of several request on different endpoint

---------

Co-authored-by: laujacq <[email protected]>

Author: brian-mulier

tzatziki-http/src/main/java/com/decathlon/tzatziki/steps/HttpSteps.java

@@ -511,6 +511,30 @@ private void mockserver_has_received(Guard guard, Comparison comparison, String
         });
     }
 
+    @Then(THAT + GUARD + "(?:the )?recorded interactions were" + COMPARING_WITH + ":$")
+    public void we_received_a_request_on_paths(Guard guard, Comparison comparison, Object content) {
+        guard.in(objects, () -> {
+            List<Map<String, Object>> expectedRequests = read(objects.resolve(content));
+            expectedRequests.forEach(expectedRequestMap -> {
+                String path = (String) expectedRequestMap.get("path");
+                Matcher withoutFlagInUriMatch = match(mocked(path.replaceFirst("^\\?e ", "")));
+                String uriGroup = withoutFlagInUriMatch.group(4);
+                expectedRequestMap.put("path", (path.startsWith("?e ") ? "?e " : "") + uriGroup);
+                expectedRequestMap.put("queryParameters", toParameters(withoutFlagInUriMatch.group(5)));
+            });
+
+            List<Map<String, Object>> actualRequests = retrieveRecordedRequests(new HttpRequest()).stream()
+                    .map(httpRequest -> {
+                        Map<String, Object> actualRequest = Mapper.read(Mapper.toJson(Interaction.Request.fromHttpRequest(httpRequest)));
+                        actualRequest.put("queryParameters", httpRequest.getQueryStringParameterList());
+                        return actualRequest;
+                    })
+                    .toList();
+
+            comparison.compare(actualRequests, expectedRequests);
+        });
+    }
+
     @And(THAT + GUARD + QUOTED_CONTENT + " has not been called$")
     public void mockserver_has_not_been_called_on(Guard guard, String path) {
         guard.in(objects, () -> {

tzatziki-http/src/main/java/com/decathlon/tzatziki/utils/Interaction.java

@@ -45,6 +45,7 @@ public static String wrapAsInteractionJson(String request) {
     @Builder(toBuilder = true)
     public static class Request {
 
+        public String path;
         @Builder.Default
         public Map<String, String> headers = new LinkedHashMap<>();
         @Builder.Default
@@ -54,6 +55,7 @@ public static class Request {
 
         public static Request fromHttpRequest(HttpRequest httpRequest) {
             return Request.builder()
+                    .path(httpRequest.getPath().toString())
                     .method(Method.of(httpRequest.getMethod().getValue()))
                     .headers(MockFaster.asMap(httpRequest.getHeaderList()))
                     .body(Body.builder().payload(httpRequest.getBodyAsString()).build())

tzatziki-http/src/test/resources/com/decathlon/tzatziki/steps/http.feature

@@ -1361,7 +1361,7 @@ Feature: to interact with an http service and setup mocks
       | {"body":{"payload":{"my-body":{"field":"a bad value"}}}}                                        |
 
   Scenario: Requests count assertion should also work for digit
-    And that getting on "http://backend/pipe/([a-z]*)/([0-9]*)/(\d+)" will return a status OK_200 and:
+    Given that getting on "http://backend/pipe/([a-z]*)/([0-9]*)/(\d+)" will return a status OK_200 and:
     """
     $1|$2|$3
     """
@@ -1376,4 +1376,85 @@ Feature: to interact with an http service and setup mocks
     c|3|4
     """
     And "http://backend/pipe/[a-b]*/1/\d+" has received 1 GET
-    And "http://backend/pipe/.*/\d*/\d+" has received 2 GETs
+    And "http://backend/pipe/.*/\d*/\d+" has received 2 GETs
+
+  Scenario: We can assert the order in which the requests were received
+    Given that getting on "http://backend/firstEndpoint" will return a status OK_200
+    And that posting on "http://backend/secondEndpoint?aParam=1&anotherParam=2" will return a status OK_200
+    And that patching on "http://backend/thirdEndpoint" will return a status OK_200
+    When we get on "http://backend/firstEndpoint"
+    And that we post on "http://backend/secondEndpoint?aParam=1&anotherParam=2" a Request:
+    """
+    headers.some-header: some-header-value
+    body.payload.message: Hello little you!
+    """
+    And that we patch on "http://backend/thirdEndpoint"
+    Then the recorded interactions were in order:
+    """
+    - method: GET
+      path: http://backend/firstEndpoint
+    - method: POST
+      path: http://backend/secondEndpoint?aParam=1&anotherParam=2
+      headers.some-header: some-header-value
+      body:
+        payload:
+          message: Hello little you!
+    - method: PATCH
+      path: ?e http://backend/third.*
+    """
+    And the recorded interactions were:
+    """
+    - method: POST
+      path: http://backend/secondEndpoint?anotherParam=2&aParam=1
+      headers.some-header: ?notNull
+      body:
+        payload:
+          message: Hello little you!
+    - method: PATCH
+      path: ?e http://backend/third.*
+    """
+    But it is not true that the recorded interactions were:
+    """
+    - method: POST
+      path: http://backend/secondEndpoint?anotherParam=2&aParam=1
+      headers.some-header: null
+      body:
+        payload:
+          message: Hello little you!
+    - method: PATCH
+      path: ?e http://backend/third.*
+    """
+    And it is not true that recorded interactions were in order:
+    """
+    - method: POST
+      path: http://backend/secondEndpoint?aParam=1&anotherParam=2
+      body:
+        payload:
+          message: Hello little you!
+    - method: GET
+      path: http://backend/firstEndpoint
+    - method: PATCH
+      path: ?e http://backend/third.*
+    """
+    And it is not true that the recorded interactions were:
+    """
+    - method: POST
+      path: http://backend/secondEndpoint?aParam=1&anotherParam=2
+      body:
+        payload:
+          message: Hello BIG you!
+    - method: GET
+      path: http://backend/firstEndpoint
+    - method: PATCH
+      path: ?e http://backend/third.*
+    """
+    And it is not true that the recorded interactions were only:
+    """
+    - method: GET
+      path: http://backend/firstEndpoint
+    - method: POST
+      path: http://backend/secondEndpoint?aParam=1&anotherParam=2
+      body:
+        payload:
+          message: Hello little you!
+    """