All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.intuit.karate.core.Config Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright 2022 Karate Labs Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.intuit.karate.core;
import com.intuit.karate.FileUtils;
import com.intuit.karate.StringUtils;
import com.intuit.karate.driver.DockerTarget;
import com.intuit.karate.driver.Target;
import com.intuit.karate.http.Cookies;
import com.intuit.karate.http.HttpLogModifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.reflect.Method;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**
* @author pthomas3
*/
public class Config {
private static final Logger logger = LoggerFactory.getLogger(Config.class);
public static final int DEFAULT_RETRY_INTERVAL = 3000;
public static final int DEFAULT_RETRY_COUNT = 3;
public static final int DEFAULT_TIMEOUT = 30000;
public static final int DEFAULT_HIGHLIGHT_DURATION = 3000;
private String url;
private boolean sslEnabled = false;
private String sslAlgorithm = "TLS";
private String sslKeyStore;
private String sslKeyStorePassword;
private String sslKeyStoreType;
private String sslTrustStore;
private String sslTrustStorePassword;
private String sslTrustStoreType;
private boolean sslTrustAll = true;
private boolean followRedirects = true;
private int readTimeout = DEFAULT_TIMEOUT;
private int connectTimeout = DEFAULT_TIMEOUT;
private Charset charset = StandardCharsets.UTF_8;
private String proxyUri;
private String proxyUsername;
private String proxyPassword;
private List nonProxyHosts;
private String localAddress;
private int responseDelay;
private boolean xmlNamespaceAware = false;
private boolean lowerCaseResponseHeaders = false;
private boolean corsEnabled = false;
private boolean logPrettyRequest;
private boolean logPrettyResponse;
private boolean printEnabled = true;
private boolean pauseIfNotPerf = false;
private boolean abortedStepsShouldPass = false;
private Target driverTarget;
private Map driverOptions;
private Map robotOptions; // TODO make generic plugin model
private HttpLogModifier logModifier;
private Variable afterScenario = Variable.NULL;
private Variable afterFeature = Variable.NULL;
private Variable headers = Variable.NULL;
private Variable cookies = Variable.NULL;
private Variable responseHeaders = Variable.NULL;
private List continueOnStepFailureMethods = new ArrayList<>();
private boolean continueAfterContinueOnStepFailure;
private boolean abortSuiteOnFailure;
// retry config
private int retryInterval = DEFAULT_RETRY_INTERVAL;
private int retryCount = DEFAULT_RETRY_COUNT;
// report config
private boolean showLog = true;
private boolean showAllSteps = true;
// call single cache config
private int callSingleCacheMinutes = 0;
private String callSingleCacheDir = FileUtils.getBuildDir();
// image comparison config
private Map imageComparisonOptions;
// ntlm authentication
private boolean ntlmEnabled = false;
private String ntlmUsername;
private String ntlmPassword;
private String ntlmDomain;
private String ntlmWorkstation;
public Config() {
// zero arg constructor
}
private static T get(Map map, String key, T defaultValue) {
Object o = map.get(key);
return o == null ? defaultValue : (T) o;
}
public boolean configure(String key, Variable value) { // TODO use enum
key = StringUtils.trimToEmpty(key);
switch (key) {
case "url":
url = value.getAsString();
return false;
case "headers":
headers = value;
return false;
case "cookies":
if (!value.isNull()) {
value = new Variable(Cookies.normalize(value.getValue()));
}
cookies = value;
return false;
case "responseHeaders":
responseHeaders = value;
return false;
case "responseDelay":
responseDelay = value.isNull() ? 0 : value.getAsInt();
return false;
case "xmlNamespaceAware":
xmlNamespaceAware = value.isTrue();
return false;
case "lowerCaseResponseHeaders":
lowerCaseResponseHeaders = value.isTrue();
return false;
case "cors":
corsEnabled = value.isTrue();
return false;
case "logPrettyResponse":
logPrettyResponse = value.isTrue();
return false;
case "logPrettyRequest":
logPrettyRequest = value.isTrue();
return false;
case "printEnabled":
printEnabled = value.isTrue();
return false;
case "afterScenario":
afterScenario = value;
return false;
case "afterFeature":
afterFeature = value;
return false;
case "report":
if (value.isMap()) {
Map map = value.getValue();
showLog = get(map, "showLog", showLog);
showAllSteps = get(map, "showAllSteps", showAllSteps);
} else if (value.isTrue()) {
showLog = true;
showAllSteps = true;
} else {
showLog = false;
showAllSteps = false;
}
return false;
case "driver":
driverOptions = value.getValue();
return false;
case "robot":
robotOptions = value.getValue();
return false;
case "driverTarget":
if (value.isMap()) {
Map map = value.getValue();
if (map.containsKey("docker")) {
// todo add the working dir here
driverTarget = new DockerTarget(map);
} else {
throw new RuntimeException("bad driverTarget config, expected key 'docker': " + map);
}
} else {
driverTarget = value.getValue();
}
return false;
case "retry":
if (value.isMap()) {
Map map = value.getValue();
retryInterval = get(map, "interval", retryInterval);
retryCount = get(map, "count", retryCount);
}
return false;
case "pauseIfNotPerf":
pauseIfNotPerf = value.isTrue();
return false;
case "abortedStepsShouldPass":
abortedStepsShouldPass = value.isTrue();
return false;
case "abortSuiteOnFailure":
abortSuiteOnFailure = value.isTrue();
return false;
case "callSingleCache":
if (value.isMap()) {
Map map = value.getValue();
callSingleCacheMinutes = get(map, "minutes", callSingleCacheMinutes);
callSingleCacheDir = get(map, "dir", callSingleCacheDir);
}
return false;
case "logModifier":
logModifier = value.getValue();
return false;
case "imageComparison":
imageComparisonOptions = value.getValue();
return false;
case "continueOnStepFailure":
continueOnStepFailureMethods.clear(); // clears previous configuration - in case someone is trying to chain these and forgets resetting the previous one
boolean enableContinueOnStepFailureFeature = false;
Boolean continueAfterIgnoredFailure = null;
List stepKeywords = null;
if (value.isMap()) {
Map map = value.getValue();
stepKeywords = (List) map.get("keywords");
continueAfterIgnoredFailure = (Boolean) map.get("continueAfter");
enableContinueOnStepFailureFeature = map.get("enabled") != null && (Boolean) map.get("enabled");
}
if (value.isTrue() || enableContinueOnStepFailureFeature) {
continueOnStepFailureMethods.addAll(stepKeywords == null ? StepRuntime.METHOD_MATCH : StepRuntime.findMethodsByKeywords(stepKeywords));
} else {
if (stepKeywords == null) {
continueOnStepFailureMethods.clear();
} else {
continueOnStepFailureMethods.removeAll(StepRuntime.findMethodsByKeywords(stepKeywords));
}
}
if (continueAfterIgnoredFailure != null) {
continueAfterContinueOnStepFailure = continueAfterIgnoredFailure;
}
return false;
// here on the http client has to be re-constructed ================
// and we return true instead of false
case "charset":
charset = value.isNull() ? null : Charset.forName(value.getAsString());
return true;
case "ssl":
if (value.isString()) {
sslEnabled = true;
sslAlgorithm = value.getAsString();
} else if (value.isMap()) {
sslEnabled = true;
Map map = value.getValue();
sslKeyStore = (String) map.get("keyStore");
sslKeyStorePassword = (String) map.get("keyStorePassword");
sslKeyStoreType = (String) map.get("keyStoreType");
sslTrustStore = (String) map.get("trustStore");
sslTrustStorePassword = (String) map.get("trustStorePassword");
sslTrustStoreType = (String) map.get("trustStoreType");
Boolean trustAll = (Boolean) map.get("trustAll");
if (trustAll != null) {
sslTrustAll = trustAll;
}
sslAlgorithm = (String) map.get("algorithm");
} else {
sslEnabled = value.isTrue();
}
return true;
case "followRedirects":
followRedirects = value.isTrue();
return true;
case "connectTimeout":
connectTimeout = value.getAsInt();
return true;
case "readTimeout":
readTimeout = value.getAsInt();
return true;
case "proxy":
if (value.isNull()) {
proxyUri = null;
} else if (value.isString()) {
proxyUri = value.getAsString();
} else {
Map map = value.getValue();
proxyUri = (String) map.get("uri");
proxyUsername = (String) map.get("username");
proxyPassword = (String) map.get("password");
nonProxyHosts = (List) map.get("nonProxyHosts");
}
return true;
case "localAddress":
localAddress = value.getAsString();
return true;
case "ntlmAuth":
if (value.isNull()) {
ntlmEnabled = false;
} else {
Map map = value.getValue();
ntlmEnabled = true;
ntlmUsername = (String) map.get("username");
ntlmPassword = (String) map.get("password");
ntlmDomain = (String) map.get("domain");
ntlmWorkstation = (String) map.get("workstation");
}
return true;
default:
throw new RuntimeException("unexpected 'configure' key: '" + key + "'");
}
}
public Config(Config parent) {
url = parent.url;
sslEnabled = parent.sslEnabled;
sslAlgorithm = parent.sslAlgorithm;
sslTrustStore = parent.sslTrustStore;
sslTrustStorePassword = parent.sslTrustStorePassword;
sslTrustStoreType = parent.sslTrustStoreType;
sslKeyStore = parent.sslKeyStore;
sslKeyStorePassword = parent.sslKeyStorePassword;
sslKeyStoreType = parent.sslKeyStoreType;
sslTrustAll = parent.sslTrustAll;
followRedirects = parent.followRedirects;
readTimeout = parent.readTimeout;
connectTimeout = parent.connectTimeout;
charset = parent.charset;
proxyUri = parent.proxyUri;
proxyUsername = parent.proxyUsername;
proxyPassword = parent.proxyPassword;
nonProxyHosts = parent.nonProxyHosts;
localAddress = parent.localAddress;
responseDelay = parent.responseDelay;
xmlNamespaceAware = parent.xmlNamespaceAware;
lowerCaseResponseHeaders = parent.lowerCaseResponseHeaders;
corsEnabled = parent.corsEnabled;
logPrettyRequest = parent.logPrettyRequest;
logPrettyResponse = parent.logPrettyResponse;
printEnabled = parent.printEnabled;
driverOptions = parent.driverOptions;
robotOptions = parent.robotOptions;
driverTarget = parent.driverTarget;
showLog = parent.showLog;
showAllSteps = parent.showAllSteps;
retryInterval = parent.retryInterval;
retryCount = parent.retryCount;
pauseIfNotPerf = parent.pauseIfNotPerf;
abortedStepsShouldPass = parent.abortedStepsShouldPass;
logModifier = parent.logModifier;
callSingleCacheMinutes = parent.callSingleCacheMinutes;
callSingleCacheDir = parent.callSingleCacheDir;
headers = parent.headers;
cookies = parent.cookies;
responseHeaders = parent.responseHeaders;
afterScenario = parent.afterScenario;
afterFeature = parent.afterFeature;
continueOnStepFailureMethods = parent.continueOnStepFailureMethods;
continueAfterContinueOnStepFailure = parent.continueAfterContinueOnStepFailure;
abortSuiteOnFailure = parent.abortSuiteOnFailure;
imageComparisonOptions = parent.imageComparisonOptions;
ntlmEnabled = parent.ntlmEnabled;
ntlmUsername = parent.ntlmUsername;
ntlmPassword = parent.ntlmPassword;
ntlmDomain = parent.ntlmDomain;
ntlmWorkstation = parent.ntlmWorkstation;
}
public void setUrl(String url) {
this.url = url;
}
public String getUrl() {
return url;
}
public void setCookies(Variable cookies) {
this.cookies = cookies;
}
public boolean isSslEnabled() {
return sslEnabled;
}
public String getSslAlgorithm() {
return sslAlgorithm;
}
public String getSslKeyStore() {
return sslKeyStore;
}
public String getSslKeyStorePassword() {
return sslKeyStorePassword;
}
public String getSslKeyStoreType() {
return sslKeyStoreType;
}
public String getSslTrustStore() {
return sslTrustStore;
}
public String getSslTrustStorePassword() {
return sslTrustStorePassword;
}
public String getSslTrustStoreType() {
return sslTrustStoreType;
}
public boolean isSslTrustAll() {
return sslTrustAll;
}
public boolean isFollowRedirects() {
return followRedirects;
}
public int getReadTimeout() {
return readTimeout;
}
public int getConnectTimeout() {
return connectTimeout;
}
public Charset getCharset() {
return charset;
}
public String getProxyUri() {
return proxyUri;
}
public String getProxyUsername() {
return proxyUsername;
}
public String getProxyPassword() {
return proxyPassword;
}
public List getNonProxyHosts() {
return nonProxyHosts;
}
public String getLocalAddress() {
return localAddress;
}
public Variable getHeaders() {
return headers;
}
public Variable getCookies() {
return cookies;
}
public Variable getResponseHeaders() {
return responseHeaders;
}
public int getResponseDelay() {
return responseDelay;
}
public boolean isXmlNamespaceAware() {
return xmlNamespaceAware;
}
public boolean isLowerCaseResponseHeaders() {
return lowerCaseResponseHeaders;
}
public boolean isCorsEnabled() {
return corsEnabled;
}
public boolean isLogPrettyRequest() {
return logPrettyRequest;
}
public boolean isLogPrettyResponse() {
return logPrettyResponse;
}
public boolean isPrintEnabled() {
return printEnabled;
}
public Map getDriverOptions() {
return driverOptions;
}
public Map getRobotOptions() {
return robotOptions;
}
public Variable getAfterScenario() {
return afterScenario;
}
public void setAfterScenario(Variable afterScenario) {
this.afterScenario = afterScenario;
}
public Variable getAfterFeature() {
return afterFeature;
}
public void setAfterFeature(Variable afterFeature) {
this.afterFeature = afterFeature;
}
public boolean isShowLog() {
return showLog;
}
public void setShowLog(boolean showLog) {
this.showLog = showLog;
}
public boolean isShowAllSteps() {
return showAllSteps;
}
public void setShowAllSteps(boolean showAllSteps) {
this.showAllSteps = showAllSteps;
}
public int getRetryInterval() {
return retryInterval;
}
public void setRetryInterval(int retryInterval) {
this.retryInterval = retryInterval;
}
public int getRetryCount() {
return retryCount;
}
public void setRetryCount(int retryCount) {
this.retryCount = retryCount;
}
public boolean isPauseIfNotPerf() {
return pauseIfNotPerf;
}
public boolean isAbortedStepsShouldPass() {
return abortedStepsShouldPass;
}
public Target getDriverTarget() {
return driverTarget;
}
public void setDriverTarget(Target driverTarget) {
this.driverTarget = driverTarget;
}
public HttpLogModifier getLogModifier() {
return logModifier;
}
public String getCallSingleCacheDir() {
return callSingleCacheDir;
}
public int getCallSingleCacheMinutes() {
return callSingleCacheMinutes;
}
public List getContinueOnStepFailureMethods() {
return continueOnStepFailureMethods;
}
public void setContinueOnStepFailureMethods(List continueOnStepFailureMethods) {
this.continueOnStepFailureMethods = continueOnStepFailureMethods;
}
public boolean isContinueAfterContinueOnStepFailure() {
return continueAfterContinueOnStepFailure;
}
public void setContinueAfterContinueOnStepFailure(boolean continueAfterContinueOnStepFailure) {
this.continueAfterContinueOnStepFailure = continueAfterContinueOnStepFailure;
}
public void setAbortSuiteOnFailure(boolean abortSuiteOnFailure) {
this.abortSuiteOnFailure = abortSuiteOnFailure;
}
public boolean isAbortSuiteOnFailure() {
return abortSuiteOnFailure;
}
public Map getImageComparisonOptions() {
return imageComparisonOptions;
}
public boolean isNtlmEnabled() {
return ntlmEnabled;
}
public void setNtlmEnabled(boolean ntlmEnabled) {
this.ntlmEnabled = ntlmEnabled;
}
public String getNtlmUsername() {
return ntlmUsername;
}
public void setNtlmUsername(String ntlmUsername) {
this.ntlmUsername = ntlmUsername;
}
public String getNtlmPassword() {
return ntlmPassword;
}
public void setNtlmPassword(String ntlmPassword) {
this.ntlmPassword = ntlmPassword;
}
public String getNtlmDomain() {
return ntlmDomain;
}
public void setNtlmDomain(String ntlmDomain) {
this.ntlmDomain = ntlmDomain;
}
public String getNtlmWorkstation() {
return ntlmWorkstation;
}
public void setNtlmWorkstation(String ntlmWorkstation) {
this.ntlmWorkstation = ntlmWorkstation;
}
}
