.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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::Manual::Architecture 3pm" .TH Test::BDD::Cucumber::Manual::Architecture 3pm "2018-12-02" "perl v5.28.1" "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::Manual::Architecture \- Structural Overview .SH "VERSION" .IX Header "VERSION" version 0.56 .SH "INTRODUCTION" .IX Header "INTRODUCTION" This short document exists to give you an idea how the different components of this distribution fit together. .SH "MODELS" .IX Header "MODELS" The core of a Cucumber-based test suite are the feature files and the step definitions files. By convention, these are saved under \f(CW\*(C`/features/\*(C'\fR and \&\f(CW\*(C`/features/step_definitions/\*(C'\fR respectively. .PP The feature files are encapsulated by the classes in \&\f(CW\*(C`Test::BDD::Cucumber::Model\*(C'\fR. .PP .Vb 12 \& one to one \& TBCM::Feature<\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\->TBCM::Document \& | | \& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | \& | has many | has a | has many \& V | V \& TBCM::Scenario +\-\-\-\-\->TBCM::Line \& | ^ ^ \& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | \& | has many | \& V | \& TBCM::Step\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ .Ve .SH "EXECUTOR" .IX Header "EXECUTOR" We build up a Test::BDD::Cucumber::Executor object, in to which we load the step definitions. We then pass this in a Test::BDD::Cucumber::Model::Feature object, along with a Test::BDD::Cucumber::Model::Harness object, which controls interaction with the outside world. .SH "EXTENSION" .IX Header "EXTENSION" Extensions allow hooking into the execution of the steps, with pre\- and post hooks for steps, scenarios, features and the entire execution. Extensions can provide additional step directories from which steps will be made available. The feature and scenario stashes are passed to the extension hooks allowing for a means of communication between the hooks and the steps. .PP Extensions \- when loaded by the pherkin test executor \- receive their configuration from the pherkin.yaml configuration file, which works similar to the configuration of extensions in Behat . .PP Note: when using extensions in combination with the \&\f(CW\*(C`TAP::Parser::SourceHandler::Feature\*(C'\fR plugin for \f(CW\*(C`prove\*(C'\fR, there is no guarantee that the \f(CW\*(C`pre_execute\*(C'\fR and \f(CW\*(C`post_execute\*(C'\fR hooks execute exactly once or even execute at all. This is a current limitation to be lifted in a future release. .SH "AUTHOR" .IX Header "AUTHOR" Peter Sergeant \f(CW\*(C`pete@clueball.com\*(C'\fR .SH "LICENSE" .IX Header "LICENSE" Copyright 2011\-2016, Peter Sergeant; Licensed under the same terms as Perl