fix(issue #119): Escape empty brackets [] when present in query parameters (#121)

* fix(issue #119): Escape empty brackets [] when present

If the url has query parameters and they contain empty brackets, they need to be escaped for the callback function in HttpSteps to complete normally. As done by escapeBrackets in MockFaster.
If the given step, has empty brackets but in the url path this time. Mockserver won't be able to compile the path url to a regex and crash. But for path url you can decode the empty brackets into their UTF-8 encoding, i.e. %5B for [ and %5D for ], and mockserver will still match the request with the mock.
This method of using UTF-8 encoding for the brackets didn't work  for the query parameters, otherwise Mockserver won't be able to match the mock parameter with the real one, so we have to escape them.

Co-authored-by: brian-mulier <[email protected]>

Author: rbarronDecathlon

mockfaster/src/main/java/com/decathlon/tzatziki/utils/MockFaster.java

@@ -50,6 +50,7 @@ public class MockFaster {
             .withReasonPhrase("Not Found Again!")
             .withStatusCode(404);
 
+    public static final String INVALID_REGEX_PATTERN = "(\\[])";
     private static final String PROTOCOL = "(?:([^:]+)://)?";
     private static final String HOST = "([^/]+)?";
     private static final Pattern URI = Pattern.compile("^" + PROTOCOL + HOST + "((/[^?]+)?(?:\\?(.+))?)?$");
@@ -377,4 +378,9 @@ public void respond(ExpectationResponseCallback callback) {
             add_mock(request, callback, comparison);
         }
     }
+
+    public static String escapeBrackets(String string) {
+        Matcher matcher = Pattern.compile(INVALID_REGEX_PATTERN).matcher(string);
+        return matcher.replaceAll("\\\\[\\\\]");
+    }
 }

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

@@ -160,7 +160,7 @@ public void url_is_mocked_as(String path, Interaction interaction, Comparison co
             interaction.consumptionIndex++;
 
             String queryParamPattern = ofNullable(uri.group(5)).filter(s -> !s.isEmpty()).map(s -> "?" + toQueryString(toParameters(s, false))).orElse("");
-            Pattern urlPattern = Pattern.compile(uri.group(4) + queryParamPattern);
+            Pattern urlPattern = Pattern.compile(escapeBrackets(uri.group(4) + queryParamPattern));
             objects.add("_request", request);
 
             AtomicInteger consumptionSum = new AtomicInteger();
@@ -373,7 +373,7 @@ public void we_receive_a_status_and(Guard guard, HttpStatusCode status, Comparis
         we_receive(guard, comparison, type, content);
     }
 
-    @Then(THAT + GUARD + QUOTED_CONTENT + " has received(?: "+ VERIFICATION+")? " + COUNT_OR_VARIABLE + " " + CALL + "(?: " + VARIABLE + ")?$")
+    @Then(THAT + GUARD + QUOTED_CONTENT + " has received(?: " + VERIFICATION + ")? " + COUNT_OR_VARIABLE + " " + CALL + "(?: " + VARIABLE + ")?$")
     public void mockserver_has_received(Guard guard, String path, String verification, String countAsString, Method method, String variable) {
         guard.in(objects, () -> {
             int expectedNbCalls = objects.getCount(countAsString);

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

@@ -1205,6 +1205,11 @@ Feature: to interact with an http service and setup mocks
     """
     Then we received a status OK_200
 
+  Scenario: Brackets should be handled and escaped properly for HTTP mocks
+    Given that getting "http://invalid/regex%5B%5D?re[]toto[]=1" will return a status OK_200
+    When we get "http://invalid/regex[]?re[]toto[]=1"
+    Then we received a status OK_200
+
   Scenario Template: Exceed max amount of expectation
     Given we add 1-1 mocks for id endpoint
     Given we add <mocksRange> mocks for id endpoint
@@ -1216,7 +1221,7 @@ Feature: to interact with an http service and setup mocks
       | mocksRange |
       | 2-150      |
       | 151-250    |
-
+      
   @ignore @run-manually
   Scenario Template: Mocks from other tests should be considered as unhandled requests
     * a root logger set to INFO
@@ -1227,4 +1232,4 @@ Feature: to interact with an http service and setup mocks
     Examples:
       | idx |
       | 1   |
-      | 2   |
+      | 2   |