com.intuit.karate.core

Class ScenarioContext

java.lang.Object

com.intuit.karate.core.ScenarioContext

public class ScenarioContext
extends Object

Author:

pthomas3

Field Summary

Fields

Modifier and Type	Field and Description
LogAppender	appender
ScriptBindings	bindings
int	callDepth
Collection<ExecutionHook>	executionHooks
FeatureContext	featureContext
Logger	logger
ScenarioContext	parentContext
boolean	perfMode
java.util.function.Function<String,Object>	read
boolean	reuseParentContext
FeatureContext	rootFeatureContext
ScenarioInfo	scenarioInfo
List<String>	tags
Map<String,List<String>>	tagValues
ScriptValueMap	vars

Constructor Summary

Constructors

Constructor and Description
ScenarioContext(FeatureContext featureContext, CallContext call, ClassLoader classLoader, Scenario scenario, LogAppender appender)
ScenarioContext(FeatureContext featureContext, CallContext call, Scenario scenario, LogAppender appender)

Method Summary

Modifier and Type	Method and Description
void	addCallResult(FeatureResult callResult)
void	assertTrue(String expression)
void	assign(AssignType assignType, String name, String exp)
void	call(boolean callonce, String line)
void	capturePerfEvent(PerfEvent event)
void	configure(Config config)
void	configure(String key, ScriptValue value)
void	configure(String key, String exp)
void	cookie(String name, String value)
void	cookies(String expr)
ScenarioContext	copy()
ScenarioContext	copy(ScenarioInfo info)
void	driver(String expression)
void	embed(byte[] bytes, String contentType)
void	embed(Embed embed)
ScriptValue	eval(String exp)
void	formField(String name, List<String> values)
void	formFields(String expr)
List<FeatureResult>	getAndClearCallResults()
List<Embed>	getAndClearEmbeds()
int	getCallDepth()
Config	getConfig()
ScenarioExecutionUnit	getExecutionUnit()
FeatureContext	getFeatureContext()
HttpClient	getHttpClient()
HttpRequest	getPrevRequest()
HttpResponse	getPrevResponse()
HttpRequestBuilder	getRequestBuilder()
URL	getResource(String name)
InputStream	getResourceAsStream(String name)
void	header(String name, List<String> values)
void	headers(String expr)
boolean	hotReload()
void	invokeAfterHookIfConfigured(boolean afterFeature)
boolean	isPrintEnabled()
Object	listen(long timeout, Runnable runnable)
void	logLastPerfEvent(String failureMessage)
void	match(MatchType matchType, String name, String path, String expected)
void	method(String method)
void	multipartField(String name, String value)
void	multipartFields(String expr)
void	multipartFile(String name, String value)
void	multipartFiles(String expr)
void	param(String name, List<String> values)
void	params(String expr)
void	path(List<String> paths)
void	print(List<String> exps)
void	remove(String name, String path)
void	replace(String name, List<Map<String,String>> table)
void	replace(String name, String token, String value)
void	request(ScriptValue body)
void	request(String requestBody)
void	retry(String expression)
void	robot(String expression)
void	set(String name, String path, List<Map<String,String>> table)
void	set(String name, String path, String value)
void	setExecutionUnit(ScenarioExecutionUnit executionUnit)
void	setLogger(Logger logger)
void	setPrevRequest(HttpRequest prevRequest)
void	setPrevResponse(HttpResponse prevResponse)
void	setScenarioError(Throwable error)
void	signal(Object result)
void	soapAction(String action)
void	status(int status)
void	stop(StepResult lastStepResult)
void	table(String name, List<Map<String,String>> table)
void	updateConfigCookies(Map<String,Cookie> cookies)
void	updateResponseVars()
void	url(String expression)
WebSocketClient	webSocket(WebSocketOptions options)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public Logger logger

appender

public LogAppender appender

bindings

public final ScriptBindings bindings

callDepth

public final int callDepth

reuseParentContext

public final boolean reuseParentContext

parentContext

public final ScenarioContext parentContext

tags

public final List<String> tags

tagValues

public final Map<String,List<String>> tagValues

vars

public final ScriptValueMap vars

rootFeatureContext

public final FeatureContext rootFeatureContext

featureContext

public final FeatureContext featureContext

executionHooks

public final Collection<ExecutionHook> executionHooks

perfMode

public final boolean perfMode

scenarioInfo

public final ScenarioInfo scenarioInfo

read

public final java.util.function.Function<String,Object> read

Constructor Detail

ScenarioContext

public ScenarioContext(FeatureContext featureContext,
                       CallContext call,
                       Scenario scenario,
                       LogAppender appender)

ScenarioContext

public ScenarioContext(FeatureContext featureContext,
                       CallContext call,
                       ClassLoader classLoader,
                       Scenario scenario,
                       LogAppender appender)

Method Detail

setLogger

public void setLogger(Logger logger)

logLastPerfEvent

public void logLastPerfEvent(String failureMessage)

capturePerfEvent

public void capturePerfEvent(PerfEvent event)

getAndClearCallResults

public List<FeatureResult> getAndClearCallResults()

addCallResult

public void addCallResult(FeatureResult callResult)

getExecutionUnit

public ScenarioExecutionUnit getExecutionUnit()

setExecutionUnit

public void setExecutionUnit(ScenarioExecutionUnit executionUnit)

setScenarioError

public void setScenarioError(Throwable error)

setPrevRequest

public void setPrevRequest(HttpRequest prevRequest)

setPrevResponse

public void setPrevResponse(HttpResponse prevResponse)

getRequestBuilder

public HttpRequestBuilder getRequestBuilder()

getPrevRequest

public HttpRequest getPrevRequest()

getPrevResponse

public HttpResponse getPrevResponse()

getHttpClient

public HttpClient getHttpClient()

getCallDepth

public int getCallDepth()

getFeatureContext

public FeatureContext getFeatureContext()

getConfig

public Config getConfig()

getResource

public URL getResource(String name)

getResourceAsStream

public InputStream getResourceAsStream(String name)

hotReload

public boolean hotReload()

updateConfigCookies

public void updateConfigCookies(Map<String,Cookie> cookies)

isPrintEnabled

public boolean isPrintEnabled()

copy

public ScenarioContext copy(ScenarioInfo info)

copy

public ScenarioContext copy()

configure

public void configure(Config config)

configure

public void configure(String key,
                      ScriptValue value)

updateResponseVars

public void updateResponseVars()

invokeAfterHookIfConfigured

public void invokeAfterHookIfConfigured(boolean afterFeature)

configure

public void configure(String key,
                      String exp)

url

public void url(String expression)

path

public void path(List<String> paths)

param

public void param(String name,
                  List<String> values)

params

public void params(String expr)

cookie

public void cookie(String name,
                   String value)

cookies

public void cookies(String expr)

header

public void header(String name,
                   List<String> values)

headers

public void headers(String expr)

formField

public void formField(String name,
                      List<String> values)

formFields

public void formFields(String expr)

request

public void request(ScriptValue body)

request

public void request(String requestBody)

table

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

replace

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

replace

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

assign

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

assertTrue

public void assertTrue(String expression)

method

public void method(String method)

retry

public void retry(String expression)

soapAction

public void soapAction(String action)

multipartField

public void multipartField(String name,
                           String value)

multipartFields

public void multipartFields(String expr)

multipartFile

public void multipartFile(String name,
                          String value)

multipartFiles

public void multipartFiles(String expr)

print

public void print(List<String> exps)

status

public void status(int status)

match

public void match(MatchType matchType,
                  String name,
                  String path,
                  String expected)

set

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

set

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

remove

public void remove(String name,
                   String path)

call

public void call(boolean callonce,
                 String line)

eval

public ScriptValue eval(String exp)

getAndClearEmbeds

public List<Embed> getAndClearEmbeds()

embed

public void embed(byte[] bytes,
                  String contentType)

embed

public void embed(Embed embed)

webSocket

public WebSocketClient webSocket(WebSocketOptions options)

signal

public void signal(Object result)

listen

public Object listen(long timeout,
                     Runnable runnable)

driver

public void driver(String expression)

robot

public void robot(String expression)

stop

public void stop(StepResult lastStepResult)