Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests;
Chris@0: 
Chris@0: use Drupal\Core\Extension\ExtensionDiscovery;
Chris@0: 
Chris@0: /**
Chris@0:  * Allows test classes to require Drupal modules as dependencies.
Chris@0:  *
Chris@0:  * This trait is assumed to be on a subclass of \PHPUnit_Framework_TestCase, and
Chris@0:  * overrides \PHPUnit_Framework_TestCase::checkRequirements(). This allows the
Chris@0:  * test to be marked as skipped before any kernel boot processes have happened.
Chris@0:  */
Chris@0: trait TestRequirementsTrait {
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the Drupal root directory.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    */
Chris@0:   protected static function getDrupalRoot() {
Chris@0:     return dirname(dirname(substr(__DIR__, 0, -strlen(__NAMESPACE__))));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Check module requirements for the Drupal use case.
Chris@0:    *
Chris@0:    * This method is assumed to override
Chris@0:    * \PHPUnit_Framework_TestCase::checkRequirements().
Chris@0:    *
Chris@0:    * @throws \PHPUnit_Framework_SkippedTestError
Chris@0:    *   Thrown when the requirements are not met, and this test should be
Chris@0:    *   skipped. Callers should not catch this exception.
Chris@0:    */
Chris@0:   protected function checkRequirements() {
Chris@0:     parent::checkRequirements();
Chris@0: 
Chris@0:     $root = static::getDrupalRoot();
Chris@0: 
Chris@0:     // Check if required dependencies exist.
Chris@0:     $annotations = $this->getAnnotations();
Chris@0:     if (!empty($annotations['class']['requires'])) {
Chris@0:       $this->checkModuleRequirements($root, $annotations['class']['requires']);
Chris@0:     }
Chris@0:     if (!empty($annotations['method']['requires'])) {
Chris@0:       $this->checkModuleRequirements($root, $annotations['method']['requires']);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Checks missing module requirements.
Chris@0:    *
Chris@0:    * Iterates through a list of requires annotations and looks for missing
Chris@0:    * modules. The test will be skipped if any of the required modules is
Chris@0:    * missing.
Chris@0:    *
Chris@0:    * @param string $root
Chris@0:    *   The path to the root of the Drupal installation to scan.
Chris@0:    * @param string[] $annotations
Chris@0:    *   A list of requires annotations from either a method or class annotation.
Chris@0:    *
Chris@0:    * @throws \PHPUnit_Framework_SkippedTestError
Chris@0:    *   Thrown when the requirements are not met, and this test should be
Chris@0:    *   skipped. Callers should not catch this exception.
Chris@0:    */
Chris@0:   private function checkModuleRequirements($root, array $annotations) {
Chris@0:     // drupal_valid_ua() might not be loaded.
Chris@0:     require_once $root . '/core/includes/bootstrap.inc';
Chris@0: 
Chris@0:     // Make a list of required modules.
Chris@0:     $required_modules = [];
Chris@0:     foreach ($annotations as $requirement) {
Chris@0:       if (strpos($requirement, 'module ') === 0) {
Chris@0:         $required_modules[] = trim(str_replace('module ', '', $requirement));
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // If there are required modules, check if they're available.
Chris@0:     if (!empty($required_modules)) {
Chris@0:       // Scan for modules.
Chris@0:       $discovery = new ExtensionDiscovery($root, FALSE);
Chris@0:       $discovery->setProfileDirectories([]);
Chris@0:       $list = array_keys($discovery->scan('module'));
Chris@0:       $not_available = array_diff($required_modules, $list);
Chris@0:       if (!empty($not_available)) {
Chris@0:         throw new \PHPUnit_Framework_SkippedTestError('Required modules: ' . implode(', ', $not_available));
Chris@0:       }
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }