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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Test\Integrity;
use Magento\Framework\App\Utility\Files;
/**
* PAY ATTENTION: Current implementation does not support of virtual types
*/
class ObserverImplementationTest extends \PHPUnit\Framework\TestCase
{
/**
* Observer interface
*/
const OBSERVER_INTERFACE = \Magento\Framework\Event\ObserverInterface::class;
/**
* @var array
*/
protected static $observerClasses = [];
public static function setUpBeforeClass()
{
self::$observerClasses = array_merge(
self::getObserverClasses('{*/events.xml,events.xml}', '//observer')
);
}
public function testObserverInterfaceImplementation()
{
$errors = [];
foreach (self::$observerClasses as $observerClass) {
if (!is_subclass_of($observerClass, self::OBSERVER_INTERFACE)) {
$errors[] = $observerClass;
}
}
if ($errors) {
$errors = array_unique($errors);
sort($errors);
$this->fail(
sprintf(
'%d of observers which not implement \Magento\Framework\Event\ObserverInterface: %s',
count($errors),
"\n" . implode("\n", $errors)
)
);
}
}
public function testObserverHasNoExtraPublicMethods()
{
$errors = [];
foreach (self::$observerClasses as $observerClass) {
$reflection = (new \ReflectionClass($observerClass));
$maxCountMethod = $reflection->getConstructor() ? 2 : 1;
if (count($reflection->getMethods(\ReflectionMethod::IS_PUBLIC)) > $maxCountMethod) {
$errors[] = $observerClass;
}
}
if ($errors) {
$errors = array_unique($errors);
sort($errors);
$this->fail(
sprintf(
'%d of observers have extra public methods: %s',
count($errors),
implode("\n", $errors)
)
);
}
}
/**
* @param string $fileNamePattern
* @param string $xpath
* @return array
*/
protected static function getObserverClasses($fileNamePattern, $xpath)
{
$observerClasses = [];
foreach (Files::init()->getConfigFiles($fileNamePattern, [], false) as $configFile) {
foreach (simplexml_load_file($configFile)->xpath($xpath) as $observer) {
$className = (string)$observer->attributes()->instance;
// $className may be empty in cases like this <observer name="observer_name" disabled="true" />
if ($className) {
$observerClasses[] = trim((string)$observer->attributes()->instance, '\\');
}
}
}
$blacklistFiles = str_replace('\\', '/', realpath(__DIR__)) . '/_files/blacklist/observers*.txt';
$blacklistExceptions = [];
foreach (glob($blacklistFiles) as $fileName) {
$blacklistExceptions = array_merge(
$blacklistExceptions,
file($fileName, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES)
);
}
return array_diff(
array_unique($observerClasses),
$blacklistExceptions
);
}
}