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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Integration\Test\Unit\Model\Config\Integration;
/**
* Test for validation rules implemented by XSD schema for API integration configuration.
*/
class XsdTest extends \PHPUnit\Framework\TestCase
{
/**
* @var string
*/
protected $schemaFile;
protected function setUp()
{
if (!function_exists('libxml_set_external_entity_loader')) {
$this->markTestSkipped('Skipped on HHVM. Will be fixed in MAGETWO-45033');
}
$urnResolver = new \Magento\Framework\Config\Dom\UrnResolver();
$this->schemaFile = $urnResolver->getRealPath(
'urn:magento:module:Magento_Integration:etc/integration/api.xsd'
);
}
/**
* @param string $fixtureXml
* @param array $expectedErrors
* @dataProvider exemplarXmlDataProvider
*/
public function testExemplarXml($fixtureXml, array $expectedErrors)
{
$validationStateMock = $this->createMock(\Magento\Framework\Config\ValidationStateInterface::class);
$validationStateMock->method('isValidationRequired')
->willReturn(true);
$messageFormat = '%message%';
$dom = new \Magento\Framework\Config\Dom($fixtureXml, $validationStateMock, [], null, null, $messageFormat);
$actualResult = $dom->validate($this->schemaFile, $actualErrors);
$this->assertEquals(empty($expectedErrors), $actualResult, "Validation result is invalid.");
$this->assertEquals($expectedErrors, $actualErrors, "Validation errors does not match.");
}
/**
* @return array
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
public function exemplarXmlDataProvider()
{
return [
/** Valid configurations */
'valid' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
</integrations>',
[],
],
'valid with several entities' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
<integration name="TestIntegration2">
<resources>
<resource name="Magento_Catalog::product_read" />
</resources>
</integration>
</integrations>',
[],
],
/** Missing required nodes */
'empty root node' => [
'<integrations/>',
["Element 'integrations': Missing child element(s). Expected is ( integration )."],
],
'empty integration' => [
'<integrations>
<integration name="TestIntegration" />
</integrations>',
["Element 'integration': Missing child element(s). Expected is ( resources )."],
],
'empty resources' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
</resources>
</integration>
</integrations>',
["Element 'resources': Missing child element(s). Expected is ( resource )."],
],
'irrelevant root node' => [
'<integration name="TestIntegration"/>',
["Element 'integration': No matching global declaration available for the validation root."],
],
/** Excessive nodes */
'irrelevant node in root' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
<invalid/>
</integrations>',
["Element 'invalid': This element is not expected. Expected is ( integration )."],
],
'irrelevant node in integration' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
<invalid/>
</integration>
</integrations>',
["Element 'invalid': This element is not expected."],
],
'irrelevant node in resources' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
<invalid/>
</resources>
</integration>
</integrations>',
["Element 'invalid': This element is not expected. Expected is ( resource )."],
],
'irrelevant node in resource' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online">
<invalid/>
</resource>
</resources>
</integration>
</integrations>',
[
"Element 'resource': Element content is not allowed, " .
"because the content type is a simple type definition."
],
],
/** Excessive attributes */
'invalid attribute in root' => [
'<integrations invalid="invalid">
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
</integrations>',
["Element 'integrations', attribute 'invalid': The attribute 'invalid' is not allowed."],
],
'invalid attribute in integration' => [
'<integrations>
<integration name="TestIntegration1" invalid="invalid">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
</integrations>',
["Element 'integration', attribute 'invalid': The attribute 'invalid' is not allowed."],
],
'invalid attribute in resources' => [
'<integrations>
<integration name="TestIntegration1">
<resources invalid="invalid">
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
</integrations>',
["Element 'resources', attribute 'invalid': The attribute 'invalid' is not allowed."],
],
'invalid attribute in resource' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" invalid="invalid" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
</integrations>',
["Element 'resource', attribute 'invalid': The attribute 'invalid' is not allowed."],
],
/** Missing or empty required attributes */
'integration without name' => [
'<integrations>
<integration>
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
</integrations>',
["Element 'integration': The attribute 'name' is required but missing."],
],
'integration with empty name' => [
'<integrations>
<integration name="">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="Magento_Customer::online" />
</resources>
</integration>
</integrations>',
[
"Element 'integration', attribute 'name': [facet 'minLength'] The value '' has a length of '0'; " .
"this underruns the allowed minimum length of '2'.",
"Element 'integration', attribute 'name': " .
"'' is not a valid value of the atomic type 'integrationNameType'."
],
],
'resource without name' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource />
</resources>
</integration>
</integrations>',
["Element 'resource': The attribute 'name' is required but missing."],
],
'resource with empty name' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::manage" />
<resource name="" />
</resources>
</integration>
</integrations>',
[
"Element 'resource', attribute 'name': [facet 'pattern'] " .
"The value '' is not accepted by the pattern '.+_.+::.+'.",
"Element 'resource', attribute 'name': '' " .
"is not a valid value of the atomic type 'resourceNameType'."
],
],
/** Invalid values */
'resource with invalid name' => [
'<integrations>
<integration name="TestIntegration1">
<resources>
<resource name="Magento_Customer::online" />
<resource name="customer_manage" />
</resources>
</integration>
</integrations>',
[
"Element 'resource', attribute 'name': [facet 'pattern'] " .
"The value 'customer_manage' is not accepted by the pattern '.+_.+::.+'.",
"Element 'resource', attribute 'name': 'customer_manage' " .
"is not a valid value of the atomic type 'resourceNameType'."
],
]
];
}
}