Package com.intuit.karate.core

Class ScenarioEngine

java.lang.Object

com.intuit.karate.core.ScenarioEngine

public class ScenarioEngine
extends Object

Author:

pthomas3

Field Summary

Fields

Modifier and Type	Field	Description
protected Driver	driver
ScenarioFileReader	fileReader
protected JsEngine	JS
Logger	logger
static String	REQUEST
static String	REQUEST_HEADERS
static String	REQUEST_METHOD
static String	REQUEST_URI
static String	REQUEST_URL_BASE
protected HttpRequestBuilder	requestBuilder
static String	RESPONSE
static String	RESPONSE_HEADERS
static String	RESPONSE_STATUS
protected Plugin	robot
ScenarioRuntime	runtime
Map<String,Variable>	vars

Constructor Summary

Constructors

Constructor	Description
ScenarioEngine(Config config, ScenarioRuntime runtime, Map<String,Variable> vars, Logger logger)

Method Summary

Modifier and Type	Method	Description
void	assertTrue(String expression)
void	assign(AssignType assignType, String name, String exp, boolean docString)
Variable	call(boolean callOnce, String exp, boolean sharedScope)
Variable	call(Variable called, Variable arg, boolean sharedScope)
Object	callFeature(FeatureCall featureCall, Variable arg, int index, boolean sharedScope)
void	capturePerfEvent(PerfEvent event)
void	compareImage(String exp)
protected Map<String,Object>	compareImageInternal(Map<String,Object> params)
void	configure(String key, Variable v)
void	configure(String key, String exp)
void	cookie(String name, String exp)
void	cookies(String exp)
void	doc(String exp)
protected String	docInternal(Map<String,Object> options)
void	driver(String exp)
Variable	evalEmbeddedExpressions(Variable value, boolean forMatch)
Variable	evalJs(String js)
Variable	evalJsonPath(Variable v, String path)
Variable	evalJsonPathOnVariableByName(String name, String path)
Variable	evalKarateExpression(String text)
Variable	evalKarateExpression(String text, boolean forMatch)
static Variable	evalXmlPath(Variable xml, String path)
Variable	evalXmlPathOnVariableByName(String name, String path)
Variable	executeFunction(Variable var, Object... args)
Command	fork(boolean useLineFeed, String line)
Command	fork(boolean useLineFeed, List<String> args)
Command	fork(boolean useLineFeed, Map<String,Object> options)
void	formField(String name, String exp)
void	formFields(String exp)
static ScenarioEngine	forTempUse(HttpClientFactory hcf)
static ScenarioEngine	get()
Map<String,Object>	getAllVariablesAsMap()
Config	getConfig()
Throwable	getFailedReason()
HttpRequest	getHttpRequest()
KeyStore	getKeyStore(String trustStoreFile, String password, String type)
protected <T> Map<String,T>	getOrEvalAsMap(Variable var, Object... args)
Request	getRequest()
HttpRequestBuilder	getRequestBuilder()
Response	getResponse()
Object	getVariable(String key)
static boolean	hasJavaScriptPlacehoder(String exp)
void	header(String name, String exp)
void	headers(String expr)
Response	httpInvoke()
void	init()
void	invokeAfterHookIfConfigured(boolean afterFeature)
boolean	isAborted()
static boolean	isCallOnceSyntax(String text)
static boolean	isCallSyntax(String text)
static boolean	isDollarPrefixed(String text)
static boolean	isDollarPrefixedJsonPath(String text)
boolean	isFailed()
static boolean	isGetSyntax(String text)
boolean	isIgnoringStepErrors()
static boolean	isJavaScriptFunction(String text)
static boolean	isJson(String text)
static boolean	isJsonPath(String text)
static boolean	isValidVariableName(String name)
static boolean	isVariable(String text)
static boolean	isVariableAndSpaceAndPath(String text)
static boolean	isWithinParentheses(String text)
static boolean	isXml(String text)
static boolean	isXmlPath(String text)
static boolean	isXmlPathFunction(String text)
void	listen(String exp)
void	logLastPerfEvent(String failureMessage)
Match.Result	match(Match.Type matchType, Object actual, Object expected)
Match.Result	match(Match.Type matchType, String expression, String path, String rhs)
void	matchResult(Match.Type matchType, String expression, String path, String expected)
void	method(String method)
void	mockAfterScenario()
Map<String,Object>	mockConfigureHeaders()
void	mockProceed(String requestUrlBase)
void	multipartField(String name, String value)
void	multipartFields(String exp)
void	multipartFile(String name, String exp)
void	multipartFiles(String exp)
void	param(String name, String exp)
void	params(String expr)
static StringUtils.Pair	parseCallArgs(String line)
static StringUtils.Pair	parseVariableAndPath(String text)
void	path(String exp)
void	print(String exp)
protected static void	remove()
void	remove(String name, String path)
String	renderHtml(Map<String,Object> options)
void	replace(String name, String token, String value)
String	replacePlaceholderText(String text, String token, String replaceWith)
void	replaceTable(String text, List<Map<String,String>> list)
void	request(String body)
void	retry(String condition)
void	robot(String exp)
static void	set(ScenarioEngine se)
void	set(String name, String path, Variable value)
void	set(String name, String path, String exp)
void	setAborted(boolean aborted)
void	setConfig(Config config)
void	setDriver(Driver driver)
void	setDriverToNull()
void	setFailedReason(Throwable failedReason)
void	setHiddenVariable(String key, Object value)
void	setRequest(Request request)
void	setResourceResolver(ResourceResolver resourceResolver)
void	setRobot(Plugin robot)
void	setVariable(String key, Object value)
void	setVariables(Map<String,Object> map)
void	setViaTable(String name, String path, List<Map<String,String>> list)
protected Map<String,Variable>	shallowCloneVariables()
void	signal(Object result)
void	soapAction(String exp)
void	status(int status)
void	stop(StepResult lastStepResult)
void	table(String name, List<Map<String,String>> rows)
void	url(String exp)
WebSocketClient	webSocket(WebSocketOptions options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESPONSE

public static final String RESPONSE

See Also:

Constant Field Values

RESPONSE_HEADERS

public static final String RESPONSE_HEADERS

See Also:

Constant Field Values

RESPONSE_STATUS

public static final String RESPONSE_STATUS

See Also:

Constant Field Values

REQUEST

public static final String REQUEST

See Also:

Constant Field Values

REQUEST_URL_BASE

public static final String REQUEST_URL_BASE

See Also:

Constant Field Values

REQUEST_URI

public static final String REQUEST_URI

See Also:

Constant Field Values

REQUEST_METHOD

public static final String REQUEST_METHOD

See Also:

Constant Field Values

REQUEST_HEADERS

public static final String REQUEST_HEADERS

See Also:

Constant Field Values

runtime

public final ScenarioRuntime runtime

fileReader

public final ScenarioFileReader fileReader

vars

public final Map<String,Variable> vars

logger

public final Logger logger

JS

protected JsEngine JS

requestBuilder

protected HttpRequestBuilder requestBuilder

driver

protected Driver driver

robot

protected Plugin robot

Constructor Detail

ScenarioEngine

public ScenarioEngine(Config config,
                      ScenarioRuntime runtime,
                      Map<String,Variable> vars,
                      Logger logger)

Method Detail

forTempUse

public static ScenarioEngine forTempUse(HttpClientFactory hcf)

get

public static ScenarioEngine get()

set

public static void set(ScenarioEngine se)

remove

protected static void remove()

isAborted

public boolean isAborted()

setAborted

public void setAborted(boolean aborted)

isFailed

public boolean isFailed()

isIgnoringStepErrors

public boolean isIgnoringStepErrors()

setFailedReason

public void setFailedReason(Throwable failedReason)

getFailedReason

public Throwable getFailedReason()

matchResult

public void matchResult(Match.Type matchType,
                        String expression,
                        String path,
                        String expected)

set

public void set(String name,
                String path,
                String exp)

remove

public void remove(String name,
                   String path)

table

public void table(String name,
                  List<Map<String,String>> rows)

replace

public void replace(String name,
                    String token,
                    String value)

assertTrue

public void assertTrue(String expression)

print

public void print(String exp)

invokeAfterHookIfConfigured

public void invokeAfterHookIfConfigured(boolean afterFeature)

logLastPerfEvent

public void logLastPerfEvent(String failureMessage)

capturePerfEvent

public void capturePerfEvent(PerfEvent event)

getConfig

public Config getConfig()

setConfig

public void setConfig(Config config)

setRequest

public void setRequest(Request request)

getRequest

public Request getRequest()

getHttpRequest

public HttpRequest getHttpRequest()

getResponse

public Response getResponse()

getRequestBuilder

public HttpRequestBuilder getRequestBuilder()

configure

public void configure(String key,
                      String exp)

configure

public void configure(String key,
                      Variable v)

url

public void url(String exp)

path

public void path(String exp)

param

public void param(String name,
                  String exp)

params

public void params(String expr)

header

public void header(String name,
                   String exp)

headers

public void headers(String expr)

cookie

public void cookie(String name,
                   String exp)

cookies

public void cookies(String exp)

formField

public void formField(String name,
                      String exp)

formFields

public void formFields(String exp)

multipartField

public void multipartField(String name,
                           String value)

multipartFields

public void multipartFields(String exp)

multipartFile

public void multipartFile(String name,
                          String exp)

multipartFiles

public void multipartFiles(String exp)

request

public void request(String body)

soapAction

public void soapAction(String exp)

retry

public void retry(String condition)

method

public void method(String method)

httpInvoke

public Response httpInvoke()

status

public void status(int status)

getKeyStore

public KeyStore getKeyStore(String trustStoreFile,
                            String password,
                            String type)

mockProceed

public void mockProceed(String requestUrlBase)

mockConfigureHeaders

public Map<String,Object> mockConfigureHeaders()

mockAfterScenario

public void mockAfterScenario()

webSocket

public WebSocketClient webSocket(WebSocketOptions options)

signal

public void signal(Object result)

listen

public void listen(String exp)

fork

public Command fork(boolean useLineFeed,
                    List<String> args)

fork

public Command fork(boolean useLineFeed,
                    String line)

fork

public Command fork(boolean useLineFeed,
                    Map<String,Object> options)

driver

public void driver(String exp)

robot

public void robot(String exp)

setDriverToNull

public void setDriverToNull()

setDriver

public void setDriver(Driver driver)

setRobot

public void setRobot(Plugin robot)

stop

public void stop(StepResult lastStepResult)

setResourceResolver

public void setResourceResolver(ResourceResolver resourceResolver)

renderHtml

public String renderHtml(Map<String,Object> options)

doc

public void doc(String exp)

docInternal

protected String docInternal(Map<String,Object> options)

compareImage

public void compareImage(String exp)

compareImageInternal

protected Map<String,Object> compareImageInternal(Map<String,Object> params)

init

public void init()

shallowCloneVariables

protected Map<String,Variable> shallowCloneVariables()

getOrEvalAsMap

protected <T> Map<String,T> getOrEvalAsMap(Variable var,
                                                 Object... args)

executeFunction

public Variable executeFunction(Variable var,
                                Object... args)

evalJs

public Variable evalJs(String js)

setHiddenVariable

public void setHiddenVariable(String key,
                              Object value)

getVariable

public Object getVariable(String key)

setVariable

public void setVariable(String key,
                        Object value)

setVariables

public void setVariables(Map<String,Object> map)

getAllVariablesAsMap

public Map<String,Object> getAllVariablesAsMap()

assign

public void assign(AssignType assignType,
                   String name,
                   String exp,
                   boolean docString)

evalEmbeddedExpressions

public Variable evalEmbeddedExpressions(Variable value,
                                        boolean forMatch)

replacePlaceholderText

public String replacePlaceholderText(String text,
                                     String token,
                                     String replaceWith)

replaceTable

public void replaceTable(String text,
                         List<Map<String,String>> list)

set

public void set(String name,
                String path,
                Variable value)

setViaTable

public void setViaTable(String name,
                        String path,
                        List<Map<String,String>> list)

parseVariableAndPath

public static StringUtils.Pair parseVariableAndPath(String text)

match

public Match.Result match(Match.Type matchType,
                          String expression,
                          String path,
                          String rhs)

match

public Match.Result match(Match.Type matchType,
                          Object actual,
                          Object expected)

isJavaScriptFunction

public static boolean isJavaScriptFunction(String text)

isValidVariableName

public static boolean isValidVariableName(String name)

hasJavaScriptPlacehoder

public static boolean hasJavaScriptPlacehoder(String exp)

isVariableAndSpaceAndPath

public static final boolean isVariableAndSpaceAndPath(String text)

isVariable

public static final boolean isVariable(String text)

isWithinParentheses

public static final boolean isWithinParentheses(String text)

isCallSyntax

public static final boolean isCallSyntax(String text)

isCallOnceSyntax

public static final boolean isCallOnceSyntax(String text)

isGetSyntax

public static final boolean isGetSyntax(String text)

isJson

public static final boolean isJson(String text)

isXml

public static final boolean isXml(String text)

isXmlPath

public static boolean isXmlPath(String text)

isXmlPathFunction

public static boolean isXmlPathFunction(String text)

isJsonPath

public static final boolean isJsonPath(String text)

isDollarPrefixed

public static final boolean isDollarPrefixed(String text)

isDollarPrefixedJsonPath

public static final boolean isDollarPrefixedJsonPath(String text)

parseCallArgs

public static StringUtils.Pair parseCallArgs(String line)

call

public Variable call(Variable called,
                     Variable arg,
                     boolean sharedScope)

call

public Variable call(boolean callOnce,
                     String exp,
                     boolean sharedScope)

callFeature

public Object callFeature(FeatureCall featureCall,
                          Variable arg,
                          int index,
                          boolean sharedScope)

evalJsonPath

public Variable evalJsonPath(Variable v,
                             String path)

evalXmlPath

public static Variable evalXmlPath(Variable xml,
                                   String path)

evalJsonPathOnVariableByName

public Variable evalJsonPathOnVariableByName(String name,
                                             String path)

evalXmlPathOnVariableByName

public Variable evalXmlPathOnVariableByName(String name,
                                            String path)

evalKarateExpression

public Variable evalKarateExpression(String text)

evalKarateExpression

public Variable evalKarateExpression(String text,
                                     boolean forMatch)