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
222
223
224
225
226
227
228
229
230
231
232
233
234
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace tests\unit\Util;
use Magento\FunctionalTestingFramework\Suite\Util\SuiteObjectExtractor;
use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
class SuiteDataArrayBuilder
{
/**
* Mock test name
*
* @var string
*/
private $name;
/**
* Mock before action name
*
* @var string
*/
private $testActionBeforeName = 'testActionBefore';
/**
* Mock after action name
*
* @var string
*/
private $testActionAfterName = 'testActionAfter';
/**
* Array containing before hook actions
*
* @var array
*/
private $beforeHook = [];
/**
* Arrat containing after hook actions
*
* @var array
*/
private $afterHook = [];
/**
* Array which contains tests, groups, modules included as part of suite
*
* @var array
*/
private $includes = [];
/**
* Array which contains, tests, groups, module excluded from suite
*
* @var array
*/
private $excludes = [];
/**
* Mock test action type
*
* @var string
*/
public $testActionType = 'testAction';
/**
* Function which sets the name of the mock suite array
*
* @param string $name
* @return $this
*/
public function withName($name)
{
$this->name = $name;
return $this;
}
/**
* Function which takes an array of test names and formats them as included raw suite data
*
* @param array $tests
* @return $this
*/
public function includeTests($tests)
{
$this->includes = $this->appendEntriesToSuiteContents($this->includes, 'test', $tests);
return $this;
}
/**
* Function which takes an array of test names and formats them as excluded raw suite data
*
* @param array $tests
* @return $this
*/
public function excludeTests($tests)
{
$this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'test', $tests);
return $this;
}
/**
* Function which takes an array of group names and formats them as included raw suite data
*
* @param array $groups
* @return $this
*/
public function includeGroups($groups)
{
$this->includes = $this->appendEntriesToSuiteContents($this->includes, 'group', $groups);
return $this;
}
/**
* Function which takes an array of group names and formats them as excluded raw suite data
*
* @param array $groups
* @return $this
*/
public function excludeGroups($groups)
{
$this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'groups', $groups);
return $this;
}
/**
* Function which takes an array of module names and formats them as included raw suite data
*
* @param array $modules
* @return $this
*/
public function includeModules($modules)
{
$this->includes = $this->appendEntriesToSuiteContents($this->includes, 'module', $modules);
return $this;
}
/**
* Function which takes an array of group names and formats them as excluded raw suite data
*
* @param array $modules
* @return $this
*/
public function excludeModules($modules)
{
$this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'module', $modules);
return $this;
}
/**
* Function which takes an array of current include/exclude contents, a type (group, module, or test) and contents
* to be appended to the array and returns a propelry formatted array representative of parsed suite data.
*
* @param array $currentContents
* @param string $type
* @param array $contents
* @return array
*/
private function appendEntriesToSuiteContents($currentContents, $type, $contents)
{
$newContents = $currentContents;
foreach ($contents as $entry) {
$newContents[$entry] = [
SuiteObjectExtractor::NODE_NAME => $type,
SuiteObjectExtractor::NAME => $entry
];
}
return $newContents;
}
/**
* Add an after hook passed in by arg (or default if no arg)
*
* @param null $afterHook
* @return $this
*/
public function withAfterHook($afterHook = null)
{
if ($afterHook == null) {
$this->afterHook = [$this->testActionAfterName => [
ActionObjectExtractor::NODE_NAME => $this->testActionType,
ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionAfterName
]];
} else {
$this->afterHook = $afterHook;
}
return $this;
}
/**
* Add a before hook passed in by arg (or default if no arg)
*
* @param null $beforeHook
* @return $this
*/
public function withBeforeHook($beforeHook = null)
{
if ($beforeHook == null) {
$this->beforeHook = [$this->testActionBeforeName => [
ActionObjectExtractor::NODE_NAME => $this->testActionType,
ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionBeforeName
]];
} else {
$this->beforeHook = $beforeHook;
}
return $this;
}
/**
* Function which takes all class properties set and generates an array representing suite data as parsed from xml.
*
* @return array
*/
public function build()
{
return ['suites' => [
$this->name => [
SuiteObjectExtractor::NAME => $this->name,
TestObjectExtractor::TEST_BEFORE_HOOK => $this->beforeHook,
TestObjectExtractor::TEST_AFTER_HOOK => $this->afterHook,
SuiteObjectExtractor::INCLUDE_TAG_NAME => $this->includes,
SuiteObjectExtractor::EXCLUDE_TAG_NAME => $this->excludes
]
]];
}
}