1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
<?php
namespace Codeception\Test;
use Behat\Gherkin\Node\FeatureNode;
use Behat\Gherkin\Node\ScenarioNode;
use Behat\Gherkin\Node\ScenarioInterface;
use Behat\Gherkin\Node\StepNode;
use Behat\Gherkin\Node\TableNode;
use Codeception\Lib\Di;
use Codeception\Lib\Generator\GherkinSnippets;
use Codeception\Scenario;
use Codeception\Step\Comment;
use Codeception\Step\Meta;
use Codeception\Test\Interfaces\Reported;
use Codeception\Test\Interfaces\ScenarioDriven;
class Gherkin extends Test implements ScenarioDriven, Reported
{
protected $steps = [];
/**
* @var FeatureNode
*/
protected $featureNode;
/**
* @var ScenarioNode
*/
protected $scenarioNode;
/**
* @var Scenario
*/
protected $scenario;
public function __construct(FeatureNode $featureNode, ScenarioInterface $scenarioNode, $steps = [])
{
$this->featureNode = $featureNode;
$this->scenarioNode = $scenarioNode;
$this->steps = $steps;
$this->setMetadata(new Metadata());
$this->scenario = new Scenario($this);
$this->getMetadata()->setName($featureNode->getTitle());
$this->getMetadata()->setFeature($scenarioNode->getTitle());
$this->getMetadata()->setFilename($featureNode->getFile());
}
public function preload()
{
$this->getMetadata()->setGroups($this->featureNode->getTags());
$this->getMetadata()->setGroups($this->scenarioNode->getTags());
$this->scenario->setMetaStep(null);
if ($background = $this->featureNode->getBackground()) {
foreach ($background->getSteps() as $step) {
$this->validateStep($step);
}
}
foreach ($this->scenarioNode->getSteps() as $step) {
$this->validateStep($step);
}
if ($this->getMetadata()->getIncomplete()) {
$this->getMetadata()->setIncomplete($this->getMetadata()->getIncomplete() . "\nRun gherkin:snippets to define missing steps");
}
}
public function getSignature()
{
return basename($this->getFileName(), '.feature') . ':' . $this->getFeature();
}
public function test()
{
$this->makeContexts();
$description = explode("\n", $this->featureNode->getDescription());
foreach ($description as $line) {
$this->getScenario()->runStep(new Comment($line));
}
if ($background = $this->featureNode->getBackground()) {
foreach ($background->getSteps() as $step) {
$this->runStep($step);
}
}
foreach ($this->scenarioNode->getSteps() as $step) {
$this->runStep($step);
}
}
protected function validateStep(StepNode $stepNode)
{
$stepText = $stepNode->getText();
if (GherkinSnippets::stepHasPyStringArgument($stepNode)) {
$stepText .= ' ""';
}
foreach ($this->steps as $pattern => $context) {
$res = preg_match($pattern, $stepText);
if (!$res) {
continue;
}
return;
}
$incomplete = $this->getMetadata()->getIncomplete();
$this->getMetadata()->setIncomplete("$incomplete\nStep definition for `$stepText` not found in contexts");
}
protected function runStep(StepNode $stepNode)
{
$params = [];
if ($stepNode->hasArguments()) {
$args = $stepNode->getArguments();
$table = $args[0];
if ($table instanceof TableNode) {
$params = [$table->getTableAsString()];
}
}
$meta = new Meta($stepNode->getText(), $params);
$meta->setPrefix($stepNode->getKeyword());
$this->scenario->setMetaStep($meta); // enable metastep
$stepText = $stepNode->getText();
$hasPyStringArg = GherkinSnippets::stepHasPyStringArgument($stepNode);
if ($hasPyStringArg) {
// pretend it is inline argument
$stepText .= ' ""';
}
$this->getScenario()->comment(null); // make metastep to be printed even if no steps in it
foreach ($this->steps as $pattern => $context) {
$matches = [];
if (!preg_match($pattern, $stepText, $matches)) {
continue;
}
array_shift($matches);
if ($hasPyStringArg) {
// get rid off last fake argument
array_pop($matches);
}
if ($stepNode->hasArguments()) {
$matches = array_merge($matches, $stepNode->getArguments());
}
call_user_func_array($context, $matches); // execute the step
break;
}
$this->scenario->setMetaStep(null); // disable metastep
}
protected function makeContexts()
{
/** @var $di Di **/
$di = $this->getMetadata()->getService('di');
$di->set($this->getScenario());
$actorClass = $this->getMetadata()->getCurrent('actor');
if ($actorClass) {
$di->set(new $actorClass($this->getScenario()));
}
foreach ($this->steps as $pattern => $step) {
$di->instantiate($step[0]);
$this->steps[$pattern][0] = $di->get($step[0]);
}
}
public function toString()
{
return $this->featureNode->getTitle() . ': ' . $this->getFeature();
}
public function getFeature()
{
return $this->getMetadata()->getFeature();
}
/**
* @return \Codeception\Scenario
*/
public function getScenario()
{
return $this->scenario;
}
public function getScenarioText($format = 'text')
{
return file_get_contents($this->getFileName());
}
public function getSourceCode()
{
}
/**
* @return ScenarioNode
*/
public function getScenarioNode()
{
return $this->scenarioNode;
}
/**
* @return FeatureNode
*/
public function getFeatureNode()
{
return $this->featureNode;
}
/**
* Field values for XML/JSON/TAP reports
*
* @return array
*/
public function getReportFields()
{
return [
'file' => $this->getFileName(),
'name' => $this->toString(),
'feature' => $this->getFeature()
];
}
}