gwen-web
API
Generated with
gwen-web/gwen.web/gwen.web.eval/WebEngine

WebEngine

gwen.web.eval.WebEngine
class WebEngine extends EvalEngine[WebContext]

A web engine that uses the Selenium web driver API to automate various web operations.

Attributes

Graph
Supertypes
class EvalEngine[WebContext]
trait GwenInfo
trait StepTranslator[WebContext]
trait UnitEngine[WebContext]
trait GherkinParser
trait StepEngine[WebContext]
trait StepDefEngine[WebContext]
trait ExamplesEngine[WebContext]
trait ScenarioEngine[WebContext]
trait RuleEngine[WebContext]
trait BackgroundEngine[WebContext]
trait SpecNormaliser
trait BehaviorRules
trait SpecEngine[WebContext]
class NodeEventDispatcher
trait LazyLogging
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def defaultConditionTimeoutSecs: Long

Attributes

Definition Classes
EvalEngine
override def defaultRepeatDelay: Duration

Attributes

Definition Classes
EvalEngine
override def init(options: GwenOptions, envState: EnvState): WebContext

Initialises and returns a new evaluation context.

Initialises and returns a new evaluation context.

Value parameters

envState

the initial environment state

options

command line options

Attributes

Definition Classes
EvalEngine
override def translateCompositeStep(step: Step): Option[CompositeStep[WebContext]]

Translates composite web engine steps.

Translates composite web engine steps.

Attributes

Definition Classes
EvalEngine -> StepTranslator
override def translateStep(step: Step): UnitStep[WebContext]

Translates a web engine step. This method matches the incoming step against a set of supported steps and returns an operation that will evaluate those that are successfully matched.

Translates a web engine step. This method matches the incoming step against a set of supported steps and returns an operation that will evaluate those that are successfully matched.

Value parameters

ctx

the web evaluation context

step

the step to evaluate

Attributes

Definition Classes
EvalEngine -> StepTranslator

Inherited methods

def addListener(listener: NodeEventListener): Unit

Attributes

Inherited from:
NodeEventDispatcher
def afterBackground(background: Background, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def afterExamples(examples: Examples, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def afterRule(rule: Rule, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def afterScenario(scenario: Scenario, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def afterSpec(result: SpecResult, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def afterStep(step: Step, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def afterStepDef(stepDef: Scenario, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def afterUnit(unit: FeatureUnit, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def beforeBackground(background: Background, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def beforeExamples(examples: Examples, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def beforeRule(rule: Rule, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def beforeScenario(scenario: Scenario, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def beforeSpec(spec: Spec, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def beforeStep(step: Step, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def beforeStepDef(stepDef: Scenario, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def beforeUnit(unit: FeatureUnit, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def callStepDef(parent: GwenNode, iStepDef: Scenario, step: Step, ctx: WebContext): Step

Attributes

Inherited from:
StepDefEngine
def checkBackgroundRules(background: Background, specType: SpecType): Unit

Checks that a background satisfies behavior rules before evaluation.

Checks that a background satisfies behavior rules before evaluation.

Value parameters

background

the background to check

specType

the spec type currently being evaluated

Attributes

Inherited from:
BehaviorRules
def checkScenarioRules(scenario: Scenario, specType: SpecType): Unit

Checks that a scenario or stepdef satisfies behavior rules before evaluation.

Checks that a scenario or stepdef satisfies behavior rules before evaluation.

Value parameters

scenario

the scenario to check

specType

the spec type currently being evaluated

Attributes

Inherited from:
BehaviorRules
def checkStepDefRules(step: Step, env: Environment): Unit

Checks that a step def called in a feature satisfies behavoiur rules at evaluation.

Checks that a step def called in a feature satisfies behavoiur rules at evaluation.

Value parameters

env

the environment context

step

the step to check

Attributes

Inherited from:
BehaviorRules
def checkStepRules(step: Step, actualBehavior: BehaviorType, env: Environment): Unit

Checks that a step called in a feature satisfies behavoiur rules at evaluation.

Checks that a step called in a feature satisfies behavoiur rules at evaluation.

Value parameters

actualBehavior

the actual behavior type of the step

env

the environment context

step

the step to check

Attributes

Inherited from:
BehaviorRules
def defaultRepeatTimeout(delay: Duration): Duration

Attributes

Inherited from:
EvalEngine
def evaluateExamples(parent: GwenNode, examples: List[Examples], ctx: WebContext): List[Examples]

Attributes

Inherited from:
ExamplesEngine
def evaluateStep(parent: GwenNode, step: Step, ctx: WebContext): Step

Evaluates a step.

Evaluates a step.

Attributes

Inherited from:
StepEngine
def evaluateSteps(parent: GwenNode, steps: List[Step], ctx: WebContext): List[Step]

Evaluates a list of steps.

Evaluates a list of steps.

Attributes

Inherited from:
StepEngine
def evaluateUnit(unit: FeatureUnit, ctx: WebContext): Option[SpecResult]

Interprets a feature unit.

Interprets a feature unit.

Value parameters

ctx

the evaluation context

unit

the feature unit to process

Attributes

Inherited from:
UnitEngine
def finaliseStep(step: Step, tryStatus: Option[EvalStatus], ctx: WebContext): Step

Binds all accumulated attachments to the given step.

Binds all accumulated attachments to the given step.

Value parameters

step

the step to bind attachments to

Attributes

Returns

the step with accumulated attachments

Inherited from:
StepEngine
def healthCheck(step: Step, env: Environment): Unit

Attributes

Inherited from:
NodeEventDispatcher
def interpretStep(stepExpression: String, ctx: WebContext): Try[Step]

Interprets and evaluates single step expression.

Interprets and evaluates single step expression.

Value parameters

ctx

the evaluation context

stepExpression

the input step expression

Attributes

Returns

the evaluated step (or an exception if a runtime error occurs)

Inherited from:
StepEngine
def logStatus(options: GwenOptions, node: GherkinNode): Unit

Attributes

Inherited from:
EvalEngine
def normaliseScenarioOutline(outline: Scenario, background: Option[Background], dataRecord: Option[DataRecord], dryRun: Boolean): Scenario

Attributes

Inherited from:
SpecNormaliser
def normaliseSpec(spec: Spec, dataRecord: Option[DataRecord], dryRun: Boolean): Spec

Normalises a parsed feature.

Normalises a parsed feature.

Value parameters

dataRecord

optional feature level data record

dryRun

true if dry run; false otherwise

spec

the feature spec

Attributes

Inherited from:
SpecNormaliser
def parseSpec(feature: String): Try[Spec]

Produces a complete feature spec tree (this method is used to parse entire features).

Produces a complete feature spec tree (this method is used to parse entire features).

Attributes

Inherited from:
GherkinParser
def parseSpec(specFile: File, verbatim: Boolean): Try[Spec]

Parses a Gherkin feature specification

Parses a Gherkin feature specification

Attributes

Inherited from:
GherkinParser
def parseStep(step: String): Try[Step]

Produces a step node (this method is used by the REPL to read in invididual steps only)

Produces a step node (this method is used by the REPL to read in invididual steps only)

Attributes

Inherited from:
GherkinParser
def pauseListeners(parent: GwenNode): Unit

Attributes

Inherited from:
NodeEventDispatcher
def removeListener(listener: NodeEventListener): Unit

Attributes

Inherited from:
NodeEventDispatcher
def resumeListeners(): Unit

Attributes

Inherited from:
NodeEventDispatcher
def transitionBackground(background: Background, toStatus: EvalStatus, env: Environment): Background

Attributes

Inherited from:
NodeEventDispatcher
def transitionExamples(examples: Examples, toStatus: EvalStatus, env: Environment): Examples

Attributes

Inherited from:
NodeEventDispatcher
def transitionRule(rule: Rule, toStatus: EvalStatus, env: Environment): Rule

Attributes

Inherited from:
NodeEventDispatcher
def transitionScenario(scenario: Scenario, toStatus: EvalStatus, env: Environment): Scenario

Attributes

Inherited from:
NodeEventDispatcher
def transitionStep(step: Step, toStatus: EvalStatus, env: Environment): Step

Attributes

Inherited from:
NodeEventDispatcher
def transitionSteps(steps: List[Step], toStatus: EvalStatus, env: Environment): List[Step]

Attributes

Inherited from:
NodeEventDispatcher

Inherited fields

lazy val gwenHome: String

Attributes

Inherited from:
GwenInfo
lazy val implHome: String

Attributes

Inherited from:
GwenInfo
lazy val implName: String

Attributes

Inherited from:
GwenInfo
lazy val implVersion: String

Attributes

Inherited from:
GwenInfo
lazy protected val logger: Logger

Attributes

Inherited from:
LazyLogging
lazy val noticeMsg: Option[String]

Attributes

Inherited from:
GwenInfo
lazy val releaseNotesUrl: Option[String]

Attributes

Inherited from:
GwenInfo
Generated with