fix: prefixed all the internal variables with _ to prevent collisions with user defined variables (#27)

Author: mimfgg

mockfaster/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>tzatziki-parent</artifactId>
         <groupId>com.decathlon.tzatziki</groupId>
-        <version>1.0.9</version>
+        <version>1.0.10</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -26,7 +26,7 @@
         <dependency>
             <groupId>com.decathlon.tzatziki</groupId>
             <artifactId>tzatziki-common</artifactId>
-            <version>1.0.9</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>org.mock-server</groupId>

pom.xml

@@ -5,7 +5,7 @@
     <groupId>com.decathlon.tzatziki</groupId>
     <artifactId>tzatziki-parent</artifactId>
     <packaging>pom</packaging>
-    <version>1.0.9</version>
+    <version>1.0.10</version>
     <modules>
         <module>tzatziki-common</module>
         <module>tzatziki-core</module>

tzatziki-common/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>tzatziki-parent</artifactId>
         <groupId>com.decathlon.tzatziki</groupId>
-        <version>1.0.9</version>
+        <version>1.0.10</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>tzatziki-common</artifactId>

tzatziki-core/README.md

@@ -411,10 +411,10 @@ This can be handy for not duplicating scenarios just for one additional step.
 The same way, any step can be delayed asynchronously by prefixing it with `after <amount>ms`, for example:
 ```gherkin
 Given that after 100ms user is a User:
-"""
-id: 1
-name: bob
-"""
+    """
+    id: 1
+    name: bob
+    """
 ```
 
 This can be useful to test the resilience of your code.
@@ -424,19 +424,19 @@ This can be useful to test the resilience of your code.
 You can test that something becomes true within a given time by prefixing your step with `within <amount>ms`, for example:
 ```gherkin
 Then within 100ms user is equal to:
-"""
-id: 1
-name: bob
-"""
+    """
+    id: 1
+    name: bob
+    """
 ```
 
 This will wait until the assertion is true! If you want to verify that the assertion is true for the entire period, you can prefix your step with `during <amount>ms`:
 ```gherkin
 Then during 100ms user is equal to:
-"""
-id: 1
-name: bob
-"""
+    """
+    id: 1
+    name: bob
+    """
 ```
 
 ### Chain multiple guards
@@ -456,6 +456,56 @@ Examples:
 
 Moreover, you can chain any number of guards, the only rule is to append guards with a space between them.
 
+### Internal variables in the context
+
+Some internal variables are in the context so that you can access them in a simple way.
+
+By default, if you use a `Scenario Template`, the values from your examples' table are not available in the `Background` of your feature.
+In Tzatziki, the ObjectSteps will actually extract them, and export them as the variable `_examples` so that the following will work:
+
+```gherkin
+Background: 
+  Given that we call "{{_examples.url}}"
+
+Scenario Template:
+  When we ...
+  Then we receive ...
+    ...
+  
+  Example:
+    | url                      |
+    | http://backend1/endpoint |
+    | http://backend2/endpoint |
+```
+
+Following the same logic, you can access the Scenario object itself as `_scenario`:
+
+```gherkin
+@someTag
+Scenario: we can access the tags in a scenario
+  * _scenario.sourceTagNames[0] == "@someTag"
+```
+
+write and read an Environment variable at runtime using `_env`:
+
+```gherkin
+Scenario: we can access the ENVs from the test
+  # see com.decathlon.tzatziki.utils.Env to see how we can set an environment variable at runtime
+  Given that _env.TEST = "something"
+  Then _env.TEST is equal to "something"
+```
+
+or the system properties using `_properties`:
+
+```gherkin
+Scenario: we can access the system properties from the test
+  Given that _properties.test = "something"
+  Then _properties.test is equal to "something"
+```
+
+Generally, Tzatziki internal variables will be prefixed with `_` so that they don't collide with the variables of your tests!
+
+
 ## More examples
 
 For more examples you can have a look at the tests:

tzatziki-core/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.decathlon.tzatziki</groupId>
         <artifactId>tzatziki-parent</artifactId>
-        <version>1.0.9</version>
+        <version>1.0.10</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>tzatziki-core</artifactId>
@@ -14,7 +14,7 @@
         <dependency>
             <groupId>com.decathlon.tzatziki</groupId>
             <artifactId>tzatziki-common</artifactId>
-            <version>1.0.9</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>org.projectlombok</groupId>

tzatziki-core/src/main/java/com/decathlon/tzatziki/steps/ObjectSteps.java

@@ -24,7 +24,6 @@
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.StringUtils;
-import org.assertj.core.api.Assertions;
 import org.jetbrains.annotations.NotNull;
 import org.junit.Assert;
 
@@ -150,8 +149,8 @@ public class ObjectSteps {
     @Before(order = 1)
     public void before(Scenario scenario) {
         Time.setToNow();
-        add("scenario", scenario);
-        add("env", Proxy.newProxyInstance(Map.class.getClassLoader(), new Class[]{Map.class}, (proxy, method, args) -> {
+        add("_scenario", scenario);
+        add("_env", Proxy.newProxyInstance(Map.class.getClassLoader(), new Class[]{Map.class}, (proxy, method, args) -> {
             String name = String.valueOf(args[0]);
             return switch (method.getName()) {
                 case "get" -> System.getenv(name);
@@ -160,7 +159,7 @@ public void before(Scenario scenario) {
                 default -> invoke(new LinkedHashMap<>(), method, args);
             };
         }));
-        add("properties", Proxy.newProxyInstance(Map.class.getClassLoader(), new Class[]{Map.class}, (proxy, method, args) -> {
+        add("_properties", Proxy.newProxyInstance(Map.class.getClassLoader(), new Class[]{Map.class}, (proxy, method, args) -> {
             String key = String.valueOf(args[0]);
             return switch (method.getName()) {
                 case "get" -> System.getProperty(key);
@@ -169,8 +168,8 @@ public void before(Scenario scenario) {
                 default -> invoke(new LinkedHashMap<>(), method, args);
             };
         }));
+        add("_examples", getExamples(scenario));
         add("randomUUID", (Supplier<UUID>) UUID::randomUUID);
-        add("examples", getExamples(scenario));
     }
 
     private Map<String, String> getExamples(Scenario scenario) {

tzatziki-core/src/test/resources/com/decathlon/tzatziki/steps/objects.feature

@@ -230,9 +230,14 @@ Feature: to interact with objects in the context
             - "3039606203C7F24000053624"
       """
 
-  Scenario Template: we can access the tags in a scenario
-    * scenario.sourceTagNames[0] == "@<firstTag>"
-    * scenario.sourceTagNames[1][5-] == "<arg>"
+  @someTag
+  Scenario: we can access the tags in a scenario
+    * _scenario.sourceTagNames[0] == "@someTag"
+
+
+  Scenario Template: we can access the tags in a scenario template
+    * _scenario.sourceTagNames[0] == "@<firstTag>"
+    * _scenario.sourceTagNames[1][5-] == "<arg>"
 
     @test1 @arg=value1
     Examples:
@@ -335,12 +340,12 @@ Feature: to interact with objects in the context
 
   Scenario: we can access the ENVs from the test
     # see com.decathlon.tzatziki.utils.Env to see how we can set an environment variable at runtime
-    Given that env.TEST = "something"
-    Then env.TEST is equal to "something"
+    Given that _env.TEST = "something"
+    Then _env.TEST is equal to "something"
 
   Scenario: we can access the system properties from the test
-    Given that properties.test = "something"
-    Then properties.test is equal to "something"
+    Given that _properties.test = "something"
+    Then _properties.test is equal to "something"
 
   Scenario: we can test that a value is one of a list of values
     Given that object is a Map:
@@ -465,9 +470,9 @@ Feature: to interact with objects in the context
       some value
       """
     Examples:
-      | param     | placeholder            |
-      | {{value}} | {{{[examples.param]}}} |
-      | {{value}} | {{value}}              |
+      | param     | placeholder             |
+      | {{value}} | {{{[_examples.param]}}} |
+      | {{value}} | {{value}}               |
 
   Scenario: we can set an attribute on a map
     Given that bob is a Map:

tzatziki-core/src/test/resources/com/decathlon/tzatziki/steps/scenario-with-background.feature

@@ -3,7 +3,7 @@ Feature: a feature with a background that we template from the examples in the s
   Background:
     Given that map is a Map:
       """yml
-      property: {{{[examples.testValue]}}}
+      property: {{{[_examples.testValue]}}}
       """
     And if map.property == 4 => map.property is equal to 4
 
@@ -25,4 +25,4 @@ Feature: a feature with a background that we template from the examples in the s
       | 4         |
 
   Scenario: another scenario that doesn't have examples
-    Then map.property is equal to "examples.testValue"
+    Then map.property is equal to "_examples.testValue"

tzatziki-http/README.md

@@ -153,18 +153,18 @@ Given that getting on "http://backend/v1/resource/item/(\d+)" will return:
   item_id: $1
   """
 
-# using the request passed in the context
+# using the request passed in the context and saved as _request
 Given that getting on "http://backend/v1/resource/item/(\d+)" will return:
   """
-  item_id: {{request.pathParameterList.0.values.0}}
+  item_id: {{_request.pathParameterList.0.values.0}}
   """
 ```
 
 Split the path/query params to build a list dynamically:
 ```gherkin
 Given that getting on "http://backend/v1/resource/items/(.*)" will return a List:
   """
-  {{#split request.pathParameterList.0.values.0.value [,]}}
+  {{#split _request.pathParameterList.0.values.0.value [,]}}
   - item_id: {{this}}
   {{/split}}
   """
@@ -181,7 +181,7 @@ Or even to use the posted body as an input:
 ```gherkin
 Given that posting on "http://backend/v1/resource/items" will return a List:
   """
-  {{#foreach request.body}}
+  {{#foreach _request.body}}
   - id: {{this.id}}
     name: nameOf{{this.id}}
   {{/foreach}}
@@ -206,10 +206,19 @@ Then we receive:
 #### URL remapping
 
 Each mocked host will be dynamically remapped on the local mockserver.
-This means that `http://backend/users` will actually be `http://localhost:{{mockserver.port}}/http/backend/users`
+This means that `http://backend/users` will actually be `http://localhost:<MockFaster.localPort()>/http/backend/users`
 
 Once you have created the mock, your calls will also be remapped, so that you can call `http://backend/users` and not the remapped url.
 
+When you call a relative url like `/endpoint`, rest-assured will automatically prefix it with `http://localhost:8080`. 
+If you wish to target another host or port, you can override it programmatically with:
+
+```java
+httpSteps.setRelativeUrlRewriter(path -> "http://<host>:<port>%s".formatted(path));
+```
+
+Sometimes it can also be a bit annoying to repeat the targetted host in the tests. 
+
 #### Assert interactions
 
 You can assert that a defined mock has been interacted with, the same way you would do it with mockserver.

tzatziki-http/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.decathlon.tzatziki</groupId>
         <artifactId>tzatziki-parent</artifactId>
-        <version>1.0.9</version>
+        <version>1.0.10</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>tzatziki-http</artifactId>
@@ -24,12 +24,12 @@
         <dependency>
             <groupId>com.decathlon.tzatziki</groupId>
             <artifactId>tzatziki-core</artifactId>
-            <version>1.0.9</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>com.decathlon.tzatziki</groupId>
             <artifactId>tzatziki-logback</artifactId>
-            <version>1.0.9</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>io.rest-assured</groupId>
@@ -38,7 +38,7 @@
         <dependency>
             <groupId>com.decathlon.tzatziki</groupId>
             <artifactId>mockfaster</artifactId>
-            <version>1.0.9</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>io.swagger</groupId>