http: resource header support (#1444)

Author: MykolaGolubyev

webtau-docs/znai/HTTP/HTTP-resource.md

@@ -113,3 +113,23 @@ Java:
   surroundedBy: "full-text-response"
 }
 ```
+
+# HTTP Header
+
+Use `http.resource` optional second parameter to pass HTTP header:
+
+```tabs
+Groovy:
+:include-file: org/testingisdocumenting/webtau/http/HttpResourceGroovyTest.groovy {
+  title: "resource header",
+  surroundedBy: "pass-header",
+  replace: [["full-echo", "end-point"], ['get\\("x-prop"\\)', 'path']]
+}
+
+Java:
+:include-file: org/testingisdocumenting/webtau/http/HttpResourceJavaTest.java {
+  title: "resource header",
+  surroundedBy: "pass-header",
+  replace: [["full-echo", "end-point"], ['"x-prop"', '"path"']]
+}
+```

webtau-http/src/main/java/org/testingisdocumenting/webtau/http/Http.java

@@ -89,11 +89,23 @@ public class Http {
      * WebTau has a way to define a lazy value associated with <code>HTTP GET</code> response. After that it can be used in multiple tests, <code>should</code> and <code>waitTo</code> on it.
      * <p>
      * Value can be associated with static urls like <code>/info</code> or dynamic urls like <code>/price/:ticker</code>
-     * @param definitionGet resource defintion with optional placeholders
+     * @param definitionGet resource definition with optional placeholders
      * @return resource definition
      */
     public HttpResource resource(String definitionGet) {
-        return new HttpResource(definitionGet);
+        return new HttpResource(definitionGet, HttpHeader.EMPTY);
+    }
+
+    /**
+     * WebTau has a way to define a lazy value associated with <code>HTTP GET</code> response. After that it can be used in multiple tests, <code>should</code> and <code>waitTo</code> on it.
+     * <p>
+     * Value can be associated with static urls like <code>/info</code> or dynamic urls like <code>/price/:ticker</code>
+     * @param definitionGet resource definition with optional placeholders
+     * @param header header to use for the calls
+     * @return resource definition
+     */
+    public HttpResource resource(String definitionGet, HttpHeader header) {
+        return new HttpResource(definitionGet, header);
     }
 
     public boolean ping(String url) {

webtau-http/src/main/java/org/testingisdocumenting/webtau/http/resource/HttpLazyResponseValue.java

@@ -23,6 +23,7 @@
 import org.testingisdocumenting.webtau.http.Http;
 import org.testingisdocumenting.webtau.data.datanode.DataNodeId;
 import org.testingisdocumenting.webtau.data.datanode.DataNodeReturnNoConversionWrapper;
+import org.testingisdocumenting.webtau.http.HttpHeader;
 import org.testingisdocumenting.webtau.reporter.StepReportOptions;
 import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
 import org.testingisdocumenting.webtau.utils.CollectionUtils;
@@ -34,12 +35,14 @@
 import static org.testingisdocumenting.webtau.WebTauCore.*;
 
 public class HttpLazyResponseValue implements ActualValueExpectations, ActualValueAware, ActualPathAndDescriptionAware {
+    private final HttpHeader _webtauInternalHeader;
     // we use _webtauInternal to avoid automatic groovy properties resolution and clash when using shortcut like resource.list[0].id
     private final DataNodeId _webtauInternalId;
     private final HttpResourceDefinition _webtauInternalResourceDefinition;
 
-    HttpLazyResponseValue(HttpResourceDefinition resourceDefinition, DataNodeId id) {
+    HttpLazyResponseValue(HttpResourceDefinition resourceDefinition, HttpHeader header, DataNodeId id) {
         this._webtauInternalResourceDefinition = resourceDefinition;
+        this._webtauInternalHeader = header;
         this._webtauInternalId = id;
     }
 
@@ -49,7 +52,7 @@ public class HttpLazyResponseValue implements ActualValueExpectations, ActualVal
      * @return lazy response value
      */
     public HttpLazyResponseValue get(String path) {
-        return new HttpLazyResponseValue(_webtauInternalResourceDefinition, _webtauInternalId.concat(path));
+        return new HttpLazyResponseValue(_webtauInternalResourceDefinition, _webtauInternalHeader, _webtauInternalId.concat(path));
     }
 
     /**
@@ -58,7 +61,7 @@ public HttpLazyResponseValue get(String path) {
      * @return lazy response value
      */
     public HttpLazyResponseValue get(int idx) {
-        return new HttpLazyResponseValue(_webtauInternalResourceDefinition, _webtauInternalId.peer(idx));
+        return new HttpLazyResponseValue(_webtauInternalResourceDefinition, _webtauInternalHeader, _webtauInternalId.peer(idx));
     }
 
     /**
@@ -82,9 +85,11 @@ public boolean isDisabledMatcherStepOutput() {
 
     @Override
     public Object actualValue() {
-        DataNodeReturnNoConversionWrapper returnWrapper = Http.http.get(_webtauInternalResourceDefinition.buildUrl(), (header, body) -> _webtauInternalId.getPath().isEmpty() ?
-                new DataNodeReturnNoConversionWrapper(body):
-                new DataNodeReturnNoConversionWrapper(body.get(_webtauInternalId.getPath())));
+        DataNodeReturnNoConversionWrapper returnWrapper = Http.http.get(_webtauInternalResourceDefinition.buildUrl(),
+                _webtauInternalHeader,
+                (header, body) -> _webtauInternalId.getPath().isEmpty() ?
+                        new DataNodeReturnNoConversionWrapper(body):
+                        new DataNodeReturnNoConversionWrapper(body.get(_webtauInternalId.getPath())));
 
         return returnWrapper.getDataNode();
     }
@@ -129,11 +134,11 @@ public HttpLazyResponseValue of(Map<String, Object> routeParams) {
                     paramNames + ", given: " + routeParams.keySet());
         }
 
-        return new HttpLazyResponseValue(_webtauInternalResourceDefinition.withRouteParams(routeParams), _webtauInternalId);
+        return new HttpLazyResponseValue(_webtauInternalResourceDefinition.withRouteParams(routeParams), _webtauInternalHeader, _webtauInternalId);
     }
 
     public String fullTextResponse() {
-        return Http.http.get(_webtauInternalResourceDefinition.buildUrl(), (header, body) -> {
+        return Http.http.get(_webtauInternalResourceDefinition.buildUrl(), _webtauInternalHeader, (header, body) -> {
             return body.getTextContent();
         });
     }

webtau-http/src/main/java/org/testingisdocumenting/webtau/http/resource/HttpResource.java

@@ -17,15 +17,17 @@
 package org.testingisdocumenting.webtau.http.resource;
 
 import org.testingisdocumenting.webtau.data.datanode.DataNodeId;
+import org.testingisdocumenting.webtau.http.HttpHeader;
 
 import java.util.Collections;
 
 public class HttpResource {
     public final HttpLazyResponseValue body;
 
-    public HttpResource(String definitionGet) {
+    public HttpResource(String definitionGet, HttpHeader header) {
         this.body = new HttpLazyResponseValue(
                 new HttpResourceDefinition(definitionGet, Collections.emptyMap()),
+                header,
                 new DataNodeId());
     }
 

webtau-http/src/test/groovy/org/testingisdocumenting/webtau/http/HttpResourceGroovyTest.groovy

@@ -91,4 +91,12 @@ class HttpResourceGroovyTest extends HttpTestBase {
         responseAsText.should == "{\"price\": 100}"
         // full-text-response
     }
+
+    @Test
+    void "header"() {
+        // pass-header
+        def responseValue = http.resource("/full-echo", http.header("x-prop", "x-value")).get("x-prop")
+        // pass-header
+        responseValue.should(equal("x-value"))
+    }
 }

webtau-http/src/test/java/org/testingisdocumenting/webtau/http/HttpResourceJavaTest.java

@@ -232,4 +232,12 @@ public void extractTextResponse() {
         actual(responseAsText, "response").should(equal("{\"price\": 100}"));
         // full-text-response
     }
+
+    @Test
+    public void header() {
+        // pass-header
+        HttpLazyResponseValue responseValue = http.resource("/full-echo", http.header("x-prop", "x-value")).get("x-prop");
+        // pass-header
+        responseValue.should(equal("x-value"));
+    }
 }