5 if (class_exists('PHPUnit_Runner_Version') && version_compare(\PHPUnit_Runner_Version
::id(), '6.0.0', '<')) {
6 class_alias('Civi\Test\Legacy\CiviTestListener', 'Civi\Test\CiviTestListener');
7 // Using an early return instead of a else does not work when using the PHPUnit phar due to some weird PHP behavior (the class
8 // gets defined without executing the code before it and so the definition is not properly conditional)
10 elseif (version_compare(\PHPUnit\Runner\Version
::id(), '7.0.0', '>=')) {
11 class_alias('Civi\Test\CiviTestListenerPHPUnit7', 'Civi\Test\CiviTestListener');
16 * Class CiviTestListener
19 * CiviTestListener participates in test-execution, looking for test-classes
20 * which have certain tags. If the tags are found, the listener will perform
21 * additional setup/teardown logic.
23 * @see EndToEndInterface
24 * @see HeadlessInterface
27 class CiviTestListener
extends \PHPUnit\Framework\BaseTestListener
{
31 * Ex: $cache['Some_Test_Class']['civicrm_foobar'] = 'hook_civicrm_foobar';
32 * Array(string $testClass => Array(string $hookName => string $methodName)).
37 * @var \CRM_Core_Transaction|null
41 public function startTestSuite(\PHPUnit\Framework\TestSuite
$suite) {
42 $byInterface = $this->indexTestsByInterface($suite->tests());
43 $this->validateGroups($byInterface);
44 $this->autoboot($byInterface);
47 public function endTestSuite(\PHPUnit\Framework\TestSuite
$suite) {
51 public function startTest(\PHPUnit\Framework\Test
$test) {
52 if ($this->isCiviTest($test)) {
53 error_reporting(E_ALL
);
54 $GLOBALS['CIVICRM_TEST_CASE'] = $test;
57 if ($test instanceof HeadlessInterface
) {
58 $this->bootHeadless($test);
61 if ($test instanceof TransactionalInterface
) {
62 $this->tx
= new \
CRM_Core_Transaction(TRUE);
63 $this->tx
->rollback();
69 if ($this->isCiviTest($test) ||
$test instanceof \CiviUnitTestCase
) {
70 \Civi\Test
::eventChecker()->start($test);
74 public function endTest(\PHPUnit\Framework\Test
$test, $time) {
77 if ($this->isCiviTest($test) ||
$test instanceof \CiviUnitTestCase
) {
79 \Civi\Test
::eventChecker()->stop($test);
81 catch (\Exception
$e) {
86 if ($test instanceof TransactionalInterface
) {
87 $this->tx
->rollback()->commit();
90 if ($test instanceof HookInterface
) {
91 \CRM_Utils_Hook
::singleton()->reset();
93 \CRM_Utils_Time
::resetTime();
94 if ($this->isCiviTest($test)) {
95 unset($GLOBALS['CIVICRM_TEST_CASE']);
96 error_reporting(E_ALL
& ~E_NOTICE
);
97 $this->errorScope
= NULL;
106 * @param HeadlessInterface|\PHPUnit\Framework\Test $test
108 protected function bootHeadless($test) {
109 if (CIVICRM_UF
!== 'UnitTests') {
110 throw new \
RuntimeException('HeadlessInterface requires CIVICRM_UF=UnitTests');
113 // Hrm, this seems wrong. Shouldn't we be resetting the entire session?
114 $session = \CRM_Core_Session
::singleton();
115 $session->set('userID', NULL);
117 $test->setUpHeadless();
119 \CRM_Utils_System
::flushCache();
121 \CRM_Core_Session
::singleton()->set('userID', NULL);
123 $config = \CRM_Core_Config
::singleton(TRUE, TRUE);
125 if (property_exists($config->userPermissionClass
, 'permissions')) {
126 $config->userPermissionClass
->permissions
= NULL;
131 * @param \PHPUnit\Framework\Test $test
134 protected function isCiviTest(\PHPUnit\Framework\Test
$test) {
135 return $test instanceof HookInterface ||
$test instanceof HeadlessInterface
;
139 * The first time we come across HeadlessInterface or EndToEndInterface, we'll
142 * Once the system is booted, there's nothing we can do -- we're stuck with that
143 * environment. (Thank you, prolific define()s!) If there's a conflict between a
144 * test-class and the active boot-level, then we'll have to bail.
146 * @param array $byInterface
147 * List of test classes, keyed by major interface (HeadlessInterface vs EndToEndInterface).
149 protected function autoboot($byInterface) {
150 if (defined('CIVICRM_UF')) {
151 // OK, nothing we can do. System has booted already.
153 elseif (!empty($byInterface['HeadlessInterface'])) {
154 putenv('CIVICRM_UF=UnitTests');
156 eval($this->cv('php:boot --level=full', 'phpcode'));
159 elseif (!empty($byInterface['EndToEndInterface'])) {
160 putenv('CIVICRM_UF=');
162 eval($this->cv('php:boot --level=full', 'phpcode'));
166 $blurb = "Tip: Run the headless tests and end-to-end tests separately, e.g.\n"
167 . " $ phpunit5 --group headless\n"
168 . " $ phpunit5 --group e2e \n";
170 if (!empty($byInterface['HeadlessInterface']) && CIVICRM_UF
!== 'UnitTests') {
171 $testNames = implode(', ', array_keys($byInterface['HeadlessInterface']));
172 throw new \
RuntimeException("Suite includes headless tests ($testNames) which require CIVICRM_UF=UnitTests.\n\n$blurb");
174 if (!empty($byInterface['EndToEndInterface']) && CIVICRM_UF
=== 'UnitTests') {
175 $testNames = implode(', ', array_keys($byInterface['EndToEndInterface']));
176 throw new \
RuntimeException("Suite includes end-to-end tests ($testNames) which do not support CIVICRM_UF=UnitTests.\n\n$blurb");
181 * Call the "cv" command.
183 * This duplicates the standalone `cv()` wrapper that is recommended in bootstrap.php.
184 * This duplication is necessary because `cv()` is optional, and downstream implementers
185 * may alter, rename, or omit the wrapper, and (by virtue of its role in bootstrap) there
186 * it is impossible to define it centrally.
189 * The rest of the command to send.
190 * @param string $decode
191 * Ex: 'json' or 'phpcode'.
193 * Response output (if the command executed normally).
194 * @throws \RuntimeException
195 * If the command terminates abnormally.
197 protected function cv($cmd, $decode = 'json') {
199 $descriptorSpec = [0 => ["pipe", "r"], 1 => ["pipe", "w"], 2 => STDERR
];
200 $oldOutput = getenv('CV_OUTPUT');
201 putenv("CV_OUTPUT=json");
202 $process = proc_open($cmd, $descriptorSpec, $pipes, __DIR__
);
203 putenv("CV_OUTPUT=$oldOutput");
205 $result = stream_get_contents($pipes[1]);
207 if (proc_close($process) !== 0) {
208 throw new \
RuntimeException("Command failed ($cmd):\n$result");
215 // If the last output is /*PHPCODE*/, then we managed to complete execution.
216 if (substr(trim($result), 0, 12) !== "/*BEGINPHP*/" ||
substr(trim($result), -10) !== "/*ENDPHP*/") {
217 throw new \
RuntimeException("Command failed ($cmd):\n$result");
222 return json_decode($result, 1);
225 throw new \
RuntimeException("Bad decoder format ($decode)");
233 protected function indexTestsByInterface($tests) {
234 $byInterface = ['HeadlessInterface' => [], 'EndToEndInterface' => []];
235 foreach ($tests as $test) {
236 /** @var \PHPUnit\Framework\Test $test */
237 if ($test instanceof HeadlessInterface
) {
238 $byInterface['HeadlessInterface'][get_class($test)] = 1;
240 if ($test instanceof EndToEndInterface
) {
241 $byInterface['EndToEndInterface'][get_class($test)] = 1;
248 * Ensure that any tests have sensible groups, e.g.
250 * `HeadlessInterface` ==> `group headless`
251 * `EndToEndInterface` ==> `group e2e`
253 * @param array $byInterface
255 protected function validateGroups($byInterface) {
256 foreach ($byInterface['HeadlessInterface'] as $className => $nonce) {
257 $clazz = new \
ReflectionClass($className);
258 $docComment = str_replace("\r\n", "\n", $clazz->getDocComment());
259 if (strpos($docComment, "@group headless\n") === FALSE) {
260 echo "WARNING: Class $className implements HeadlessInterface. It should declare \"@group headless\".\n";
262 if (strpos($docComment, "@group e2e\n") !== FALSE) {
263 echo "WARNING: Class $className implements HeadlessInterface. It should not declare \"@group e2e\".\n";
266 foreach ($byInterface['EndToEndInterface'] as $className => $nonce) {
267 $clazz = new \
ReflectionClass($className);
268 $docComment = str_replace("\r\n", "\n", $clazz->getDocComment());
269 if (strpos($docComment, "@group e2e\n") === FALSE) {
270 echo "WARNING: Class $className implements EndToEndInterface. It should declare \"@group e2e\".\n";
272 if (strpos($docComment, "@group headless\n") !== FALSE) {
273 echo "WARNING: Class $className implements EndToEndInterface. It should not declare \"@group headless\".\n";