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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Test\Integrity\Modular;
use Magento\Framework\App\Filesystem\DirectoryList;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class DiConfigFilesTest extends \PHPUnit\Framework\TestCase
{
/**
* Primary DI configs from app/etc
* @var array
*/
protected static $_primaryFiles = [];
/**
* Global DI configs from all modules
* @var array
*/
protected static $_moduleGlobalFiles = [];
/**
* Area DI configs from all modules
* @var array
*/
protected static $_moduleAreaFiles = [];
protected function _prepareFiles()
{
//init primary configs
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var $filesystem \Magento\Framework\Filesystem */
$filesystem = $objectManager->get(\Magento\Framework\Filesystem::class);
$configDirectory = $filesystem->getDirectoryRead(DirectoryList::CONFIG);
$fileIteratorFactory = $objectManager->get(\Magento\Framework\Config\FileIteratorFactory::class);
$search = [];
foreach ($configDirectory->search('{*/di.xml,di.xml}') as $path) {
$search[] = $configDirectory->getAbsolutePath($path);
}
self::$_primaryFiles = $fileIteratorFactory->create($search);
//init module global configs
/** @var $modulesReader \Magento\Framework\Module\Dir\Reader */
$modulesReader = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
->get(\Magento\Framework\Module\Dir\Reader::class);
self::$_moduleGlobalFiles = $modulesReader->getConfigurationFiles('di.xml');
//init module area configs
$areas = ['adminhtml', 'frontend'];
foreach ($areas as $area) {
$moduleAreaFiles = $modulesReader->getConfigurationFiles($area . '/di.xml');
self::$_moduleAreaFiles[$area] = $moduleAreaFiles;
}
}
/**
* @param string $filePath
* @param string $xml
* @throws \Exception
* @dataProvider linearFilesProvider
*/
public function testDiConfigFileWithoutMerging($filePath, $xml)
{
/** @var \Magento\Framework\ObjectManager\Config\SchemaLocator $schemaLocator */
$schemaLocator = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(
\Magento\Framework\ObjectManager\Config\SchemaLocator::class
);
$dom = new \DOMDocument();
$dom->loadXML($xml);
libxml_use_internal_errors(true);
$result = \Magento\Framework\Config\Dom::validateDomDocument($dom, $schemaLocator->getSchema());
libxml_use_internal_errors(false);
if (!empty($result)) {
$this->fail(
'File ' . $filePath . ' has invalid xml structure. '
. implode("\n", $result)
);
}
}
public function linearFilesProvider()
{
if (empty(self::$_primaryFiles)) {
$this->_prepareFiles();
}
$common = array_merge(self::$_primaryFiles->toArray(), self::$_moduleGlobalFiles->toArray());
foreach (self::$_moduleAreaFiles as $files) {
$common = array_merge($common, $files->toArray());
}
$output = [];
foreach ($common as $path => $content) {
$output[] = [substr($path, strlen(BP)), $content];
}
return $output;
}
/**
* @param array $files
* @dataProvider mixedFilesProvider
*/
public function testMergedDiConfig(array $files)
{
$mapperMock = $this->createMock(\Magento\Framework\ObjectManager\Config\Mapper\Dom::class);
$fileResolverMock = $this->getMockBuilder(\Magento\Framework\Config\FileResolverInterface::class)
->setMethods(['read'])
->getMockForAbstractClass();
$fileResolverMock->expects($this->any())->method('read')->will($this->returnValue($files));
$validationStateMock = $this->createPartialMock(
\Magento\Framework\Config\ValidationStateInterface::class,
['isValidationRequired']
);
$validationStateMock->expects($this->any())->method('isValidationRequired')->will($this->returnValue(true));
/** @var \Magento\Framework\ObjectManager\Config\SchemaLocator $schemaLocator */
$schemaLocator = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(
\Magento\Framework\ObjectManager\Config\SchemaLocator::class
);
new \Magento\Framework\ObjectManager\Config\Reader\Dom(
$fileResolverMock,
$mapperMock,
$schemaLocator,
$validationStateMock
);
}
public function mixedFilesProvider()
{
if (empty(self::$_primaryFiles)) {
$this->_prepareFiles();
}
foreach (self::$_primaryFiles->toArray() as $file) {
$primaryFiles[] = [[$file]];
}
$primaryFiles['all primary config files'] = [self::$_primaryFiles->toArray()];
foreach (self::$_moduleGlobalFiles->toArray() as $file) {
$moduleFiles[] = [[$file]];
}
$moduleFiles['all module global config files'] = [self::$_moduleGlobalFiles->toArray()];
$areaFiles = [];
foreach (self::$_moduleAreaFiles as $area => $files) {
foreach ($files->toArray() as $file) {
$areaFiles[] = [[$file]];
}
$areaFiles["all {$area} config files"] = [self::$_moduleAreaFiles[$area]->toArray()];
}
return $primaryFiles + $moduleFiles + $areaFiles;
}
}