KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

How to use headers method of com.intuit.karate.ScenarioActions class

Best Karate code snippet using com.intuit.karate.ScenarioActions.headers

Source:MockHandler.java

1/*2 * The MIT License3 *4 * Copyright 2020 Intuit Inc.5 *6 * Permission is hereby granted, free of charge, to any person obtaining a copy7 * of this software and associated documentation files (the "Software"), to deal8 * in the Software without restriction, including without limitation the rights9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell10 * copies of the Software, and to permit persons to whom the Software is11 * furnished to do so, subject to the following conditions:12 *13 * The above copyright notice and this permission notice shall be included in14 * all copies or substantial portions of the Software.15 *16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN22 * THE SOFTWARE.23 */24package com.intuit.karate.core;25import com.intuit.karate.ScenarioActions;26import com.intuit.karate.Suite;27import com.intuit.karate.StringUtils;28import com.intuit.karate.Json;29import com.intuit.karate.KarateException;30import com.intuit.karate.graal.JsValue;31import com.intuit.karate.http.HttpUtils;32import com.intuit.karate.http.Request;33import com.intuit.karate.http.ResourceType;34import com.intuit.karate.http.Response;35import com.intuit.karate.http.ServerHandler;36import java.util.*;37import java.util.function.BiFunction;38import java.util.function.Function;39import org.slf4j.Logger;40import org.slf4j.LoggerFactory;41/**42 *43 * @author pthomas344 */45public class MockHandler implements ServerHandler {46    private static final Logger logger = LoggerFactory.getLogger(MockHandler.class);47    private static final String REQUEST_BYTES = "requestBytes";48    private static final String REQUEST_PARAMS = "requestParams";49    private static final String REQUEST_PARTS = "requestParts";50    private static final String RESPONSE_DELAY = "responseDelay";51    private static final String PATH_MATCHES = "pathMatches";52    private static final String METHOD_IS = "methodIs";53    private static final String TYPE_CONTAINS = "typeContains";54    private static final String ACCEPT_CONTAINS = "acceptContains";55    private static final String HEADER_CONTAINS = "headerContains";56    private static final String PARAM_VALUE = "paramValue";57    private static final String PARAM_EXISTS = "paramExists";58    private static final String PATH_PARAMS = "pathParams";59    private static final String BODY_PATH = "bodyPath";60    private final LinkedHashMap<Feature, ScenarioRuntime> features = new LinkedHashMap<>(); // feature + holds global config and vars61    private final Map<String, Variable> globals = new HashMap<>();62    private boolean corsEnabled;63    protected static final ThreadLocal<Request> LOCAL_REQUEST = new ThreadLocal<>();64    private String prefix = "";65    public MockHandler withPrefix(String prefix) {66        this.prefix = prefix;67        return this;68    }69    public MockHandler(Feature feature) {70        this(feature, null);71    }72    public MockHandler(Feature feature, Map<String, Object> args) {73        this(Collections.singletonList(feature), args);74    }75    public MockHandler(List<Feature> features) {76        this(features, null);77    }78    public MockHandler(List<Feature> features, Map<String, Object> args) {79        for (Feature feature : features) {80            FeatureRuntime featureRuntime = FeatureRuntime.of(Suite.forTempUse(), feature, args);81            FeatureSection section = new FeatureSection();82            section.setIndex(-1); // TODO util for creating dummy scenario83            Scenario dummy = new Scenario(feature, section, -1);84            section.setScenario(dummy);85            ScenarioRuntime runtime = new ScenarioRuntime(featureRuntime, dummy);86            initRuntime(runtime);87            if (feature.isBackgroundPresent()) {88                // if we are within a scenario already e.g. karate.start(), preserve context89                ScenarioEngine prevEngine = ScenarioEngine.get();90                try {91                    ScenarioEngine.set(runtime.engine);92                    for (Step step : feature.getBackground().getSteps()) {93                        Result result = StepRuntime.execute(step, runtime.actions);94                        if (result.isFailed()) {95                            String message = "mock-server background failed - " + feature + ":" + step.getLine();96                            runtime.logger.error(message);97                            throw new KarateException(message, result.getError());98                        }99                    }100                } finally {101                    ScenarioEngine.set(prevEngine);102                }103            }104            corsEnabled = corsEnabled || runtime.engine.getConfig().isCorsEnabled();105            globals.putAll(runtime.engine.detachVariables());106            runtime.logger.info("mock server initialized: {}", feature);107            this.features.put(feature, runtime);108        }109    }110    private void initRuntime(ScenarioRuntime runtime) {111        runtime.engine.setVariable(PATH_MATCHES, (Function<String, Boolean>) this::pathMatches);112        runtime.engine.setVariable(PARAM_EXISTS, (Function<String, Boolean>) this::paramExists);113        runtime.engine.setVariable(PARAM_VALUE, (Function<String, String>) this::paramValue);114        runtime.engine.setVariable(METHOD_IS, (Function<String, Boolean>) this::methodIs);115        runtime.engine.setVariable(TYPE_CONTAINS, (Function<String, Boolean>) this::typeContains);116        runtime.engine.setVariable(ACCEPT_CONTAINS, (Function<String, Boolean>) this::acceptContains);117        runtime.engine.setVariable(HEADER_CONTAINS, (BiFunction<String, String, Boolean>) this::headerContains);118        runtime.engine.setVariable(BODY_PATH, (Function<String, Object>) this::bodyPath);119        runtime.engine.init();120    }121    private static final Result PASSED = Result.passed(0);122    private static final String ALLOWED_METHODS = "GET, HEAD, POST, PUT, DELETE, PATCH";123    @Override124    public synchronized Response handle(Request req) { // note the [synchronized]125        if (corsEnabled && "OPTIONS".equals(req.getMethod())) {126            Response response = new Response(200);127            response.setHeader("Allow", ALLOWED_METHODS);128            response.setHeader("Access-Control-Allow-Origin", "*");129            response.setHeader("Access-Control-Allow-Methods", ALLOWED_METHODS);130            List<String> requestHeaders = req.getHeaderValues("Access-Control-Request-Headers");131            if (requestHeaders != null) {132                response.setHeader("Access-Control-Allow-Headers", requestHeaders);133            }134            return response;135        }136        String path = req.getPath();137        if (!path.isEmpty()) {138            req.setPath(path.substring(prefix.length()));139        }140        for (Map.Entry<Feature, ScenarioRuntime> entry : this.features.entrySet()) {141            Feature feature = entry.getKey();142            ScenarioRuntime runtime = entry.getValue();143            // important for graal to work properly144            Thread.currentThread().setContextClassLoader(runtime.featureRuntime.suite.classLoader);145            LOCAL_REQUEST.set(req);146            req.processBody();147            ScenarioEngine engine = createScenarioEngine(req, runtime);148            Map<String, List<Map<String, Object>>> parts = req.getMultiParts();149            if (parts != null) {150                engine.setHiddenVariable(REQUEST_PARTS, parts);151            }152            for (FeatureSection fs : feature.getSections()) {153                if (fs.isOutline()) {154                    runtime.logger.warn("skipping scenario outline - {}:{}", feature, fs.getScenarioOutline().getLine());155                    break;156                }157                Scenario scenario = fs.getScenario();158                if (isMatchingScenario(scenario, engine)) {159                    Map<String, Object> configureHeaders;160                    Variable response, responseStatus, responseHeaders, responseDelay;161                    ScenarioActions actions = new ScenarioActions(engine);162                    Result result = PASSED;163                    result = executeScenarioSteps(feature, runtime, scenario, actions, result);164                    engine.mockAfterScenario();165                    configureHeaders = engine.mockConfigureHeaders();166                    response = engine.vars.remove(ScenarioEngine.RESPONSE);167                    responseStatus = engine.vars.remove(ScenarioEngine.RESPONSE_STATUS);168                    responseHeaders = engine.vars.remove(ScenarioEngine.RESPONSE_HEADERS);169                    responseDelay = engine.vars.remove(RESPONSE_DELAY);170                    globals.putAll(engine.detachVariables());171                    Response res = new Response(200);172                    if (result.isFailed()) {173                        response = new Variable(result.getError().getMessage());174                        responseStatus = new Variable(500);175                    } else {176                        if (corsEnabled) {177                            res.setHeader("Access-Control-Allow-Origin", "*");178                        }179                        res.setHeaders(configureHeaders);180                        if (responseHeaders != null && responseHeaders.isMap()) {181                            res.setHeaders(responseHeaders.getValue());182                        }183                        if (responseDelay != null) {184                            res.setDelay(responseDelay.getAsInt());185                        }186                    }187                    if (response != null && !response.isNull()) {188                        res.setBody(response.getAsByteArray());189                        if (res.getContentType() == null) {190                            ResourceType rt = ResourceType.fromObject(response.getValue());191                            if (rt != null) {192                                res.setContentType(rt.contentType);193                            }194                        }195                    }196                    if (responseStatus != null) {197                        res.setStatus(responseStatus.getAsInt());198                    }199                    return res;200                }201            }202        }203        logger.warn("no scenarios matched, returning 404: {}", req); // NOTE: not logging with engine.logger204        return new Response(404);205    }206    private Result executeScenarioSteps(Feature feature, ScenarioRuntime runtime, Scenario scenario, ScenarioActions actions, Result result) {207        for (Step step : scenario.getSteps()) {208            result = StepRuntime.execute(step, actions);209            if (result.isAborted()) {210                runtime.logger.debug("abort at {}:{}", feature, step.getLine());211                break;212            }213            if (result.isFailed()) {214                String message = "server-side scenario failed, " + feature + ":" + step.getLine()215                        + "\n" + step.toString() + "\n" + result.getError().getMessage();216                runtime.logger.error(message);217                break;218            }219        }220        return result;221    }222    private ScenarioEngine createScenarioEngine(Request req, ScenarioRuntime runtime) {223        ScenarioEngine engine = new ScenarioEngine(runtime, new HashMap<>(globals));224        ScenarioEngine.set(engine);225        engine.init();226        engine.setVariable(ScenarioEngine.REQUEST_URL_BASE, req.getUrlBase());227        engine.setVariable(ScenarioEngine.REQUEST_URI, req.getPath());228        engine.setVariable(ScenarioEngine.REQUEST_METHOD, req.getMethod());229        engine.setVariable(ScenarioEngine.REQUEST_HEADERS, req.getHeaders());230        engine.setVariable(ScenarioEngine.REQUEST, req.getBodyConverted());231        engine.setVariable(REQUEST_PARAMS, req.getParams());232        engine.setVariable(REQUEST_BYTES, req.getBody());233        return engine;234    }235    private boolean isMatchingScenario(Scenario scenario, ScenarioEngine engine) {236        String expression = StringUtils.trimToNull(scenario.getName() + scenario.getDescription());237        if (expression == null) {238            engine.logger.debug("default scenario matched at line: {}", scenario.getLine());239            return true;240        }241        try {242            Variable v = engine.evalJs(expression);243            if (v.isTrue()) {244                engine.logger.debug("scenario matched at line {}: {}", scenario.getLine(), expression);245                return true;246            } else {247                engine.logger.trace("scenario skipped at line {}: {}", scenario.getLine(), expression);248                return false;249            }250        } catch (Exception e) {251            engine.logger.warn("scenario match evaluation failed at line {}: {} - {}", scenario.getLine(), expression, e + "");252            return false;253        }254    }255    public boolean pathMatches(String pattern) {256        String uri = LOCAL_REQUEST.get().getPath();257        Map<String, String> pathParams = HttpUtils.parseUriPattern(pattern, uri);258        if (pathParams == null) {259            return false;260        } else {261            ScenarioEngine.get().setVariable(PATH_PARAMS, pathParams);262            return true;263        }264    }265    public boolean paramExists(String name) {266        Map<String, List<String>> params = LOCAL_REQUEST.get().getParams();267        return params != null && params.containsKey(name);268    }269    public String paramValue(String name) {270        return LOCAL_REQUEST.get().getParam(name);271    }272    public boolean methodIs(String name) { // TODO no more supporting array arg273        return LOCAL_REQUEST.get().getMethod().equalsIgnoreCase(name);274    }275    public boolean typeContains(String text) {276        String contentType = LOCAL_REQUEST.get().getContentType();277        return contentType != null && contentType.contains(text);278    }279    public boolean acceptContains(String text) {280        String acceptHeader = LOCAL_REQUEST.get().getHeader("Accept");281        return acceptHeader != null && acceptHeader.contains(text);282    }283    public boolean headerContains(String name, String value) {284        List<String> values = LOCAL_REQUEST.get().getHeaderValues(name);285        if (values != null) {286            for (String v : values) {287                if (v.contains(value)) {288                    return true;289                }290            }291        }292        return false;293    }294    public Object bodyPath(String path) {295        Object body = LOCAL_REQUEST.get().getBodyConverted();296        if (body == null) {297            return null;298        }299        if (path.startsWith("/")) {300            Variable v = ScenarioEngine.evalXmlPath(new Variable(body), path);301            if (v.isNotPresent()) {302                return null;303            } else {304                return JsValue.fromJava(v.getValue());305            }306        } else {307            Json json = Json.of(body);308            Object result;309            try {310                result = json.get(path);311            } catch (Exception e) {312                return null;313            }314            return JsValue.fromJava(result);315        }316    }317}...

headers

Using AI Code Generation

1And match response == { 'Content-Type': '#string' }2And match response == { 'Content-Type': '#string', 'Content-Length': '#number' }3And match response == { 'Content-Type': '#string', 'Content-Length': '#number', 'Date': '#string' }4And match response == { 'Content-Type': '#string', 'Content-Length': '#number', 'Date': '#string', 'Server': '#string' }5And match response == { 'Content-Type': '#string', 'Content-Length': '#number', 'Date': '#string', 'Server': '#string', 'Connection': '#string' }6And match response == { 'Content-Type': '#string', 'Content-Length': '#number', 'Date': '#string', 'Server': '#string', 'Connection': '#string', 'X-Powered-By': '#string' }7And match response == { 'Content-Type': '#string', 'Content-Length': '#number', 'Date': '#string', 'Server': '#string', 'Connection': '#string', 'X-Powered-By': '#string', 'X-Frame-Options': '#string' }8And match response == { 'Content-Type': '#string', 'Content-Length': '#number', 'Date': '#string', 'Server': '#string', 'Connection': '#string', 'X-Powered-By': '#string', 'X-Frame-Options': '#string', 'X-XSS-Protection': '#string' }9And match response == { 'Content-Type': '#string', 'Content-Length': '#number', 'Date': '#string', 'Server': '#string', 'Connection': '#string', 'X-Powered-By': '#string', 'X-Frame-Options': '#string', 'X-XSS-Protection': '#string', 'X-Content-Type-Options': '#string' }10And match response == { 'Content-Type': '#string', 'Content-Length': '#number', 'Date': '#string', 'Server': '#string', 'Connection': '#string', 'X-Powered-By': '#string', 'X-Frame-Options': '#string', 'X-XSS-Protection': '#string', 'X-Content-Type-Options': '#string', 'Strict-Transport-Security': '#string' }

headers

Using AI Code Generation

1And match response.headers == { 'Content-Type': '#(containsString('application/json'))' }2And match headers == { 'Content-Type': '#(containsString('application/json'))' }3And match headers == { 'Content-Type': '#(containsString('application/json'))' }4And match headers == { 'Content-Type': '#(containsString('application/json'))' }5And match headers == { 'Content-Type': '#(containsString('application/json'))' }6And match headers == { 'Content-Type': '#(containsString('application/json'))' }7And match headers == { 'Content-Type': '#(containsString('application/json'))' }8And match headers == { 'Content-Type': '#(containsString('application/json'))' }

headers

Using AI Code Generation

1* match $ == {Content-Type: 'application/json'}2* match $ == {Accept: 'application/json'}3* match $ == {Connection: 'keep-alive'}4* def response = get()5* match response.headers == {Content-Type: 'text/html; charset=ISO-8859-1'}6* def response = get()7* match response.headers['Content-Type'] == 'text/html; charset=ISO-8859-1'8* def response = get()9* match response.headers['content-type'] == 'text/html; charset=ISO-8859-1'10* def response = get()11* match response.headers['CONTENT-TYPE'] == 'text/html; charset=ISO-8859-1'12* def response = get()13* match response.headers['content-type'] == 'text/html; charset=ISO-8859-1'14* def response = get()15* match response.headers['content-type'] == 'text/html; charset=ISO-8859-1'16* def response = get()

headers

Using AI Code Generation

1def headers = { 'Content-Type': 'application/json' }2def request = { 'name': 'test', 'salary': '123', 'age': '23' }3def response = call read('classpath:post.feature'), request, headers4def headers = { 'Content-Type': 'application/json' }5def request = { 'name': 'test', 'salary': '123', 'age': '23' }6def response = call read('classpath:post.feature'), request, headers7def headers = { 'Content-Type': 'application/json' }8def request = { 'name': 'test', 'salary': '123', 'age': '23' }9def response = call read('classpath:post.feature'), request, headers10def headers = { 'Content-Type': 'application/json' }11def request = { 'name': 'test', 'salary': '123', 'age': '23' }12def response = call read('classpath:post.feature'), request, headers13def headers = { 'Content-Type': 'application/json' }14def request = { 'name': 'test', 'salary': '123', 'age': '23' }15def response = call read('classpath:post.feature'), request, headers16def headers = { 'Content-Type': 'application/json' }17def request = { 'name': 'test', 'salary': '123', 'age': '23' }18def response = call read('classpath:post.feature'), request, headers

headers

Using AI Code Generation

1* def headers = { 'Accept-Encoding' : 'gzip, deflate' }2* headers['User-Agent'] = 'Apache-HttpClient/4.5.2 (Java/1.8.0_66)'3* def headers3 = headers.clone()4* def headers4 = headers.clone()5* headers4.clear()6* headers.clear()7* headers.clearHeaders()8* headers.clearHeaders()9* headers.clearHeaders()10* headers.clearHeaders()11* headers.clearHeaders()12* headers.clearHeaders()13* headers.clearHeaders()14* headers.clearHeaders()15* headers.clearHeaders()

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.