eval

Type Members

class DataRecord extends AnyRef

Captures a data record used to initialise feature level data bindings
class EnvContext extends LazyLogging with ExecutionContext with InterpolationSupport

Base environment context providing access to all resources and services to engines.
Base environment context providing access to all resources and services to engines. Specific evaluation engines can define and use their own specific context by extending this one.
Access to page scope data is provided through a dataScope method.
trait EvalEngine[T <: EnvContext] extends LazyLogging

Base trait for gwen evaluation engines.
Base trait for gwen evaluation engines. An evaluation engine performs the actual processing work required to evaluate individual Step expressions. This work can be done using various available frameworks and technologies. This trait serves as a base for concrete engine implementations coupled to specific such frameworks or technologies.
Evaluation engines are never invoked directly, but are rather invoked by the GwenInterpreter. This interpreter can mix in any evaluation engine that has this trait.
trait ExecutionContext extends AnyRef

The context in which all engine instructions execute.
The context in which all engine instructions execute. The purpose of this context is to provide a place where common logic can be inserted before, after, or around an instruction.
class FeatureResult extends AnyRef

Captures the results of an evaluated feature.
class FeatureSet extends Iterator[FeatureUnit] with LazyLogging

Returns an iteration of feature units for each entry in a given data file.
case class FeatureSummary(results: List[FeatureResult], scenarioCounts: Map[dsl.StatusKeyword.Value, Int], stepCounts: Map[dsl.StatusKeyword.Value, Int]) extends Product with Serializable

Captures the feature summary results of an evaluated feature.
Captures the feature summary results of an evaluated feature.
scenarioCounts
number of scenarios by status
stepCounts
number of steps by status
case class FeatureUnit(featureFile: File, metaFiles: List[File], dataRecord: Option[DataRecord]) extends Product with Serializable

Captures a feature file and its associated meta as a unit.
Captures a feature file and its associated meta as a unit.
featureFile
the feature file
metaFiles
the associated meta files (if any)
dataRecord
optional data record
class GwenApp[T <: EnvContext] extends App

Gwen interpreter application.
class GwenInterpreter[T <: EnvContext] extends GwenInfo with GherkinParser with SpecNormaliser with LazyLogging

Interprets incoming feature specs by parsing and evaluating them.
Interprets incoming feature specs by parsing and evaluating them. All parsing is performed in the inherited gwen.dsl.GherkinParser. All evaluation is dispatched to a mixed in gwen.eval.EvalEngine.
class GwenLauncher[T <: EnvContext] extends LazyLogging

Launches the gwen interpreter.
case class GwenOptions(batch: Boolean = false, parallel: Boolean = false, reportDir: Option[File] = None, reportFormats: List[report.ReportFormat.Value] = Nil, properties: List[File] = Nil, tags: List[(Tag, Boolean)] = Nil, dryRun: Boolean = false, dataFile: Option[File] = None, metaFiles: List[File] = Nil, features: List[File] = Nil, args: Option[Array[String]] = None) extends Product with Serializable

Captures gwen command line options.
Captures gwen command line options.
batch
true to run in batch mode, false for interactive REPL (default is false)
parallel
true to run each given file/dir entry in parallel, false for serial (default is false)
reportDir
optional directory to generate evaluation report into
properties
list of properties files to load into system properties
tags
list of tags to include and exclude (tag, True=include|False=exclude)
dryRun
true to not evaluate steps on engine (and validate for correctness only)
dataFile
optional CSV file for data driven testing (must include column headers in 1st line)
metaFiles
optional list of meta file overrides
features
optional list of feature file and/or directory paths
class GwenREPL[T <: EnvContext] extends AnyRef

Read-Eval-Print-Loop console.
class HybridEnvContext[A <: EnvContext, B <: EnvContext] extends EnvContext

Merges two contexts into one.
trait HybridEvalEngine[A <: EnvContext, B <: EnvContext] extends EvalEngine[HybridEnvContext[A, B]]

Hybrid engine trait.
class LocalDataStack extends AnyRef

Manages and maintains an in memory stack of ScopedData objects for storing locally scoped StepDef parameters.
class ScopedData extends LazyLogging

Binds data attributes to an arbitrary scope that has a name.
Binds data attributes to an arbitrary scope that has a name. Attributes are stored as name value pairs in a JSON sequence as follows:
```
{
  "scope" : "name"
  "atts" : {
    "name1" : "value1",
    "name2" : "value2",
    ...
    "nameN" : "valueN"
  }
}
```
When a new data attribute is added to the scope, it is appended to the end of the atts sequence. This is done internally. The order in which attributes are stored reflects the same order in which they were added. Once an attribute is added, it is never removed. If a same named attribute is added more than once, then it will appear in the scope multiple times (once for each time it is added).
When an attribute is looked up, its most recent (latest) entry is returned. For example, if the scope contains two attribute entries with the same name, then the value of the second entry is returned.
Data attributes are internally stored in immutable JSON data structures.
class ScopedDataStack extends AnyRef

Manages and maintains an in memory stack of ScopedData objects for a particular scope and provides convenient access to all attributes.
Manages and maintains an in memory stack of ScopedData objects for a particular scope and provides convenient access to all attributes. Individual steps utilise this to access any data in the stack at any time. Collaborating steps can pass data to each other through this stack.
The scope at the top of the stack is always the currently active one. When a new scope is created, it is always added to the top of the stack. Therefore, newly created scope automatically becomes the currently active scope, and the previously active scope (and any others beneath it) move down one level in the stack.
Attributes are always bound to the currently active scope (the one at the top of the stack). They cannot be bound to any of the other non active scopes lower in the stack. Once an attribute is bound to a scope it is never removed from that scope, and therefore cannot be replaced. It can be overshadowed though by another attribute of the same name in a higher scope. In such cases where a scope contains multiple attributes of the same name, the most recently added scope always shadows the former when a lookup is performed.
Attributes can be looked up in one of two ways:
- By currently active scope: using the get method
  - This lookup scans the currently active scope and all other scopes below it in the stack that have the same name.
- Or by a nominated scope: using the getIn method
  - This lookup scans all scopes in the stack that have the nominated scope name.
Although their visibilities are different, both lookups return the first attribute found and scan from the top most visible scope down to the lowest. This ensures that the most recently bound value for an attribute is always returned if found.
class StepFailure extends RuntimeException

Signals a step that failed to execute.

Value Members

object FeatureResult

Feature result factory.
object FeatureStream extends LazyLogging

Reads and streams individual features and feature suites from the file system.
Reads and streams individual features and feature suites from the file system. An individual feature is a single feature file and optional meta file pair, whereas a feature suite is a directory containing one or many feature files, an optional meta file, and zero or many sub directories repeating the same structure. Both individual features and feature suites are streamed as [FeatureUnit] units. The former yields only one element and the latter yields many.
object FeatureSummary extends Serializable

Feature summary factory.
object GwenOptions extends Serializable
object GwenREPL
object ScopedData

ScopedData factory.
object ScopedDataStack
object TagsFilter

Checks that a feature satisfies all user provided include/exclude tags.
Checks that a feature satisfies all user provided include/exclude tags. Features that do not satisfy any of the provided tags are filtered out and returned as None types. Features having scenarios that satisfy all tags are pruned of all scenarios that do not and are wrapped and returned as Some types.
package support

package eval

Type Members

class DataRecord extends AnyRef

class EnvContext extends LazyLogging with ExecutionContext with InterpolationSupport

trait EvalEngine[T <: EnvContext] extends LazyLogging

trait ExecutionContext extends AnyRef

class FeatureResult extends AnyRef

class FeatureSet extends Iterator[FeatureUnit] with LazyLogging

case class FeatureSummary(results: List[FeatureResult], scenarioCounts: Map[dsl.StatusKeyword.Value, Int], stepCounts: Map[dsl.StatusKeyword.Value, Int]) extends Product with Serializable

case class FeatureUnit(featureFile: File, metaFiles: List[File], dataRecord: Option[DataRecord]) extends Product with Serializable

class GwenApp[T <: EnvContext] extends App

class GwenInterpreter[T <: EnvContext] extends GwenInfo with GherkinParser with SpecNormaliser with LazyLogging

class GwenLauncher[T <: EnvContext] extends LazyLogging

class GwenREPL[T <: EnvContext] extends AnyRef

class HybridEnvContext[A <: EnvContext, B <: EnvContext] extends EnvContext

trait HybridEvalEngine[A <: EnvContext, B <: EnvContext] extends EvalEngine[HybridEnvContext[A, B]]

class LocalDataStack extends AnyRef

class ScopedData extends LazyLogging

class ScopedDataStack extends AnyRef

class StepFailure extends RuntimeException

Value Members

object FeatureResult

object FeatureStream extends LazyLogging

object FeatureSummary extends Serializable

object GwenOptions extends Serializable

object GwenREPL

object ScopedData

object ScopedDataStack

object TagsFilter

package support

Ungrouped