From 42b0b05af14f9b546e3f304e717955ee1cc9996a Mon Sep 17 00:00:00 2001 From: Jay Modi Date: Mon, 10 Apr 2017 12:10:01 -0400 Subject: [PATCH] Test: add support for replacing stashed values within headers of REST tests (#24014) This commit adds support for replacing a stashed value within a header of a REST test. This is useful for requests that may want to use a value previously obtained within a header. --- .../yaml/ClientYamlTestExecutionContext.java | 19 ++++-- .../ClientYamlTestExecutionContextTests.java | 60 +++++++++++++++++++ 2 files changed, 74 insertions(+), 5 deletions(-) create mode 100644 test/framework/src/test/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContextTests.java diff --git a/test/framework/src/main/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContext.java b/test/framework/src/main/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContext.java index a2e03a063cf..c2c0f57c942 100644 --- a/test/framework/src/main/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContext.java +++ b/test/framework/src/main/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContext.java @@ -56,7 +56,7 @@ public class ClientYamlTestExecutionContext { private final boolean randomizeContentType; - public ClientYamlTestExecutionContext(ClientYamlTestClient clientYamlTestClient, boolean randomizeContentType) { + ClientYamlTestExecutionContext(ClientYamlTestClient clientYamlTestClient, boolean randomizeContentType) { this.clientYamlTestClient = clientYamlTestClient; this.randomizeContentType = randomizeContentType; } @@ -68,7 +68,7 @@ public class ClientYamlTestExecutionContext { public ClientYamlTestResponse callApi(String apiName, Map params, List> bodies, Map headers) throws IOException { //makes a copy of the parameters before modifying them for this specific request - HashMap requestParams = new HashMap<>(params); + Map requestParams = new HashMap<>(params); requestParams.putIfAbsent("error_trace", "true"); // By default ask for error traces, this my be overridden by params for (Map.Entry entry : requestParams.entrySet()) { if (stash.containsStashedValue(entry.getValue())) { @@ -76,9 +76,17 @@ public class ClientYamlTestExecutionContext { } } - HttpEntity entity = createEntity(bodies, headers); + //make a copy of the headers before modifying them for this specific request + Map requestHeaders = new HashMap<>(headers); + for (Map.Entry entry : requestHeaders.entrySet()) { + if (stash.containsStashedValue(entry.getValue())) { + entry.setValue(stash.getValue(entry.getValue()).toString()); + } + } + + HttpEntity entity = createEntity(bodies, requestHeaders); try { - response = callApiInternal(apiName, requestParams, entity, headers); + response = callApiInternal(apiName, requestParams, entity, requestHeaders); return response; } catch(ClientYamlTestResponseException e) { response = e.getRestTestResponse(); @@ -143,7 +151,8 @@ public class ClientYamlTestExecutionContext { } } - private ClientYamlTestResponse callApiInternal(String apiName, Map params, + // pkg-private for testing + ClientYamlTestResponse callApiInternal(String apiName, Map params, HttpEntity entity, Map headers) throws IOException { return clientYamlTestClient.callApi(apiName, params, entity, headers); } diff --git a/test/framework/src/test/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContextTests.java b/test/framework/src/test/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContextTests.java new file mode 100644 index 00000000000..2150baf59ea --- /dev/null +++ b/test/framework/src/test/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContextTests.java @@ -0,0 +1,60 @@ +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.elasticsearch.test.rest.yaml; + +import org.apache.http.HttpEntity; +import org.elasticsearch.test.ESTestCase; + +import java.io.IOException; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.atomic.AtomicReference; + +public class ClientYamlTestExecutionContextTests extends ESTestCase { + + public void testHeadersSupportStashedValueReplacement() throws IOException { + final AtomicReference> headersRef = new AtomicReference<>(); + final ClientYamlTestExecutionContext context = + new ClientYamlTestExecutionContext(null, randomBoolean()) { + @Override + ClientYamlTestResponse callApiInternal(String apiName, Map params, + HttpEntity entity, + Map headers) { + headersRef.set(headers); + return null; + } + }; + final Map headers = new HashMap<>(); + headers.put("foo", "$bar"); + headers.put("foo1", "baz ${c}"); + + context.stash().stashValue("bar", "foo2"); + context.stash().stashValue("c", "bar1"); + + assertNull(headersRef.get()); + context.callApi("test", Collections.emptyMap(), Collections.emptyList(), headers); + assertNotNull(headersRef.get()); + assertNotEquals(headers, headersRef.get()); + + assertEquals("foo2", headersRef.get().get("foo")); + assertEquals("baz bar1", headersRef.get().get("foo1")); + } +}