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
<?php
/**
* Implementation of the magentoApiDataFixture DocBlock annotation.
*
* The difference of magentoApiDataFixture from magentoDataFixture is
* that no transactions should be used for API data fixtures.
* Otherwise fixture data will not be accessible to Web API functional tests.
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\TestFramework\Annotation;
class ApiDataFixture
{
/**
* @var string
*/
protected $_fixtureBaseDir;
/**
* Fixtures that have been applied
*
* @var array
*/
private $_appliedFixtures = [];
/**
* Constructor
*
* @param string $fixtureBaseDir
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function __construct($fixtureBaseDir)
{
if (!is_dir($fixtureBaseDir)) {
throw new \Magento\Framework\Exception\LocalizedException(
__("Fixture base directory '%1' does not exist.", $fixtureBaseDir)
);
}
$this->_fixtureBaseDir = realpath($fixtureBaseDir);
}
/**
* Handler for 'startTest' event
*
* @param \PHPUnit\Framework\TestCase $test
*/
public function startTest(\PHPUnit\Framework\TestCase $test)
{
\Magento\TestFramework\Helper\Bootstrap::getInstance()->reinitialize();
/** Apply method level fixtures if thy are available, apply class level fixtures otherwise */
$this->_applyFixtures($this->_getFixtures('method', $test) ?: $this->_getFixtures('class', $test));
}
/**
* Handler for 'endTest' event
*/
public function endTest()
{
$this->_revertFixtures();
/** @var $objectManager \Magento\TestFramework\ObjectManager */
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$objectManager->get(\Magento\Customer\Model\Metadata\AttributeMetadataCache::class)->clean();
}
/**
* Retrieve fixtures from annotation
*
* @param string $scope 'class' or 'method'
* @param \PHPUnit\Framework\TestCase $test
* @return array
* @throws \Magento\Framework\Exception\LocalizedException
*/
protected function _getFixtures($scope, \PHPUnit\Framework\TestCase $test)
{
$annotations = $test->getAnnotations();
$result = [];
if (!empty($annotations[$scope]['magentoApiDataFixture'])) {
foreach ($annotations[$scope]['magentoApiDataFixture'] as $fixture) {
if (strpos($fixture, '\\') !== false) {
// usage of a single directory separator symbol streamlines search across the source code
throw new \Magento\Framework\Exception\LocalizedException(
__('Directory separator "\\" is prohibited in fixture declaration.')
);
}
$fixtureMethod = [get_class($test), $fixture];
if (is_callable($fixtureMethod)) {
$result[] = $fixtureMethod;
} else {
$result[] = $this->_fixtureBaseDir . '/' . $fixture;
}
}
}
return $result;
}
/**
* Execute single fixture script
*
* @param string|array $fixture
* @throws \Throwable
*/
protected function _applyOneFixture($fixture)
{
try {
if (is_callable($fixture)) {
call_user_func($fixture);
} else {
require $fixture;
}
} catch (\Exception $e) {
throw new \Exception(
sprintf(
"Exception occurred when running the %s fixture: \n%s",
(\is_array($fixture) || is_scalar($fixture) ? json_encode($fixture) : 'callback'),
$e->getMessage()
)
);
}
$this->_appliedFixtures[] = $fixture;
}
/**
* Execute fixture scripts if any
*
* @param array $fixtures
* @throws \Magento\Framework\Exception\LocalizedException
*/
protected function _applyFixtures(array $fixtures)
{
/* Execute fixture scripts */
foreach ($fixtures as $oneFixture) {
/* Skip already applied fixtures */
if (!in_array($oneFixture, $this->_appliedFixtures, true)) {
$this->_applyOneFixture($oneFixture);
}
}
}
/**
* Revert changes done by fixtures
*/
protected function _revertFixtures()
{
$appliedFixtures = array_reverse($this->_appliedFixtures);
foreach ($appliedFixtures as $fixture) {
if (is_callable($fixture)) {
$fixture[1] .= 'Rollback';
if (is_callable($fixture)) {
$this->_applyOneFixture($fixture);
}
} else {
$fileInfo = pathinfo($fixture);
$extension = '';
if (isset($fileInfo['extension'])) {
$extension = '.' . $fileInfo['extension'];
}
$rollbackScript = $fileInfo['dirname'] . '/' . $fileInfo['filename'] . '_rollback' . $extension;
if (file_exists($rollbackScript)) {
$this->_applyOneFixture($rollbackScript);
}
}
}
$this->_appliedFixtures = [];
}
}