.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test::BDD::Cucumber::Executor 3pm"
.TH Test::BDD::Cucumber::Executor 3pm "2023-08-29" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test::BDD::Cucumber::Executor \- Run through Feature and Harness objects
.SH "VERSION"
.IX Header "VERSION"
version 0.86
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Executor runs through Features, matching up the Step Lines with Step
Definitions, and reporting on progress through the passed-in harness.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "matching"
.IX Subsection "matching"
The value of this attribute should be one of \f(CW\*(C`first\*(C'\fR (default), \f(CW\*(C`relaxed\*(C'\fR and \f(CW\*(C`strict\*(C'\fR.
.PP
By default (\f(CW\*(C`first\*(C'\fR), the first matching step is executed immediately,
terminating the search for (further) matching steps. When \f(CW\*(C`matching\*(C'\fR is set
to anything other than \f(CW\*(C`first\*(C'\fR, all steps are checked for matches. When set
to \f(CW\*(C`relaxed\*(C'\fR, a warning will be generated on multiple matches. When set to
\&\f(CW\*(C`strict\*(C'\fR, an exception will be thrown.
.SH "METHODS"
.IX Header "METHODS"
.SS "extensions"
.IX Subsection "extensions"
.SS "add_extensions"
.IX Subsection "add_extensions"
The attributes \f(CW\*(C`extensions\*(C'\fR is an arrayref of
Test::BDD::Cucumber::Extension extensions. Extensions have their
hook-functions called by the Executor at specific points in the \s-1BDD\s0 feature
execution.
.PP
\&\fB\f(CB\*(C`<add_extensions\*(C'\fB\fR adds items in \s-1FIFO\s0 using \fBunshift()\fR>, and are called in
reverse order at the end hook; this means that if you:
.PP
.Vb 2
\&  add_extensions( 1 );
\&  add_extensions( 2, 3 );
.Ve
.PP
The \f(CW\*(C`pre_*\*(C'\fR will be called in order 2, 3, 1, and \f(CW\*(C`post_*\*(C'\fR will be called in
1, 3, 2.
.SS "steps"
.IX Subsection "steps"
.SS "add_steps"
.IX Subsection "add_steps"
The attributes \f(CW\*(C`steps\*(C'\fR is a hashref of arrayrefs, storing steps by their Verb.
\&\f(CW\*(C`add_steps()\*(C'\fR takes step definitions of the item list form:
.PP
.Vb 3
\& (
\&  [ Given => qr//, sub {} ],
\& ),
.Ve
.PP
Or, when metadata is specified with the step, of the form:
.PP
.Vb 3
\& (
\&  [ Given => qr//, { meta => $data }, sub {} ]
\& ),
.Ve
.PP
(where the hashref stores step metadata) and populates \f(CW\*(C`steps\*(C'\fR with them.
.SS "execute"
.IX Subsection "execute"
Execute accepts a feature object, a harness object, and an optional
Cucumber::TagExpressions::ExpressionNode object and for each scenario in the
feature which meets the tag requirements (or all of them, if you
haven't specified one), runs \f(CW\*(C`execute_scenario\*(C'\fR.
.SS "execute_outline"
.IX Subsection "execute_outline"
Accepts a hashref of options and executes each scenario definition in the
scenario outline, or, lacking an outline, executes the single defined
scenario.
.PP
Options:
.PP
\&\f(CW\*(C` feature \*(C'\fR \- A Test::BDD::Cucumber::Model::Feature object
.PP
\&\f(CW\*(C` feature_stash \*(C'\fR \- A hashref that should live the lifetime of
 feature execution
.PP
\&\f(CW\*(C` harness \*(C'\fR \- A Test::BDD::Cucumber::Harness subclass object
.PP
\&\f(CW\*(C` outline \*(C'\fR \- A Test::BDD::Cucumber::Model::Scenario object
.PP
\&\f(CW\*(C` background \*(C'\fR \- An optional Test::BDD::Cucumber::Model::Scenario object
representing the Background
.SS "execute_scenario"
.IX Subsection "execute_scenario"
Accepts a hashref of options, and executes each step in a scenario. Options:
.PP
\&\f(CW\*(C`feature\*(C'\fR \- A Test::BDD::Cucumber::Model::Feature object
.PP
\&\f(CW\*(C`feature_stash\*(C'\fR \- A hashref that should live the lifetime of feature execution
.PP
\&\f(CW\*(C`harness\*(C'\fR \- A Test::BDD::Cucumber::Harness subclass object
.PP
\&\f(CW\*(C`scenario\*(C'\fR \- A Test::BDD::Cucumber::Model::Scenario object
.PP
\&\f(CW\*(C`background_obj\*(C'\fR \- An optional Test::BDD::Cucumber::Model::Scenario object
representing the Background
.PP
\&\f(CW\*(C`scenario_stash\*(C'\fR \- A hashref that lives the lifetime of the scenario execution
.PP
For each step, a Test::BDD::Cucumber::StepContext object is created, and
passed to \f(CW\*(C`dispatch()\*(C'\fR. Nothing is returned \- everything is played back through
the Harness interface.
.SS "add_placeholders"
.IX Subsection "add_placeholders"
Accepts a text string and a hashref, and replaces \f(CW\*(C` <placeholders\*(C'\fR > with the
values in the hashref, returning a string.
.SS "add_table_placeholders"
.IX Subsection "add_table_placeholders"
Accepts a hash with parsed table data and a hashref, and replaces
\&\f(CW\*(C` <placeholders\*(C'\fR > with the values in the hashref, returning a copy of the
parsed table hashref.
.SS "find_and_dispatch"
.IX Subsection "find_and_dispatch"
Accepts a Test::BDD::Cucumber::StepContext object, and searches through
the steps that have been added to the executor object, executing against the
first matching one (unless \f(CW\*(C`$self\-\*(C'\fRmatching> indicates otherwise).
.PP
You can also pass in a boolean 'short\-circuit' flag if the Scenario's remaining
steps should be skipped, and a boolean flag to denote if it's a redispatched
step.
.ie n .SS "dispatch($context, $stepdef, $short_circuit, $redispatch)"
.el .SS "dispatch($context, \f(CW$stepdef\fP, \f(CW$short_circuit\fP, \f(CW$redispatch\fP)"
.IX Subsection "dispatch($context, $stepdef, $short_circuit, $redispatch)"
Accepts a Test::BDD::Cucumber::StepContext object, and a
reference to a step definition triplet (verb, metadata hashref, coderef)
and executes it the coderef.
.PP
You can also pass in a boolean 'short\-circuit' flag if the Scenario's remaining
steps should be skipped.
.SS "skip_step"
.IX Subsection "skip_step"
Accepts a step-context, a result-type, and a textual reason, exercises the
Harness's step start and step_done methods, and returns a skipped-test result.
.SH "AUTHOR"
.IX Header "AUTHOR"
Peter Sergeant \f(CW\*(C`pete@clueball.com\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
.Vb 2
\&  Copyright 2019\-2023, Erik Huelsmann
\&  Copyright 2011\-2019, Peter Sergeant; Licensed under the same terms as Perl
.Ve