Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests;
Chris@0: 
Chris@0: /**
Chris@0:  * Makes Drupal's test API forward compatible with multiple versions of PHPUnit.
Chris@0:  */
Chris@0: trait PhpunitCompatibilityTrait {
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a mock object for the specified class using the available method.
Chris@0:    *
Chris@0:    * The getMock method does not exist in PHPUnit 6. To provide backward
Chris@0:    * compatibility this trait provides the getMock method and uses createMock if
Chris@0:    * this method is available on the parent class.
Chris@0:    *
Chris@0:    * @param string $originalClassName
Chris@0:    *   Name of the class to mock.
Chris@0:    * @param array|null $methods
Chris@0:    *   When provided, only methods whose names are in the array are replaced
Chris@0:    *   with a configurable test double. The behavior of the other methods is not
Chris@0:    *   changed. Providing null means that no methods will be replaced.
Chris@0:    * @param array $arguments
Chris@0:    *   Parameters to pass to the original class' constructor.
Chris@0:    * @param string $mockClassName
Chris@0:    *   Class name for the generated test double class.
Chris@0:    * @param bool $callOriginalConstructor
Chris@0:    *   Can be used to disable the call to the original class' constructor.
Chris@0:    * @param bool $callOriginalClone
Chris@0:    *   Can be used to disable the call to the original class' clone constructor.
Chris@0:    * @param bool $callAutoload
Chris@0:    *   Can be used to disable __autoload() during the generation of the test
Chris@0:    *   double class.
Chris@0:    * @param bool $cloneArguments
Chris@0:    *   Enables the cloning of arguments passed to mocked methods.
Chris@0:    * @param bool $callOriginalMethods
Chris@0:    *   Enables the invocation of the original methods.
Chris@0:    * @param object $proxyTarget
Chris@0:    *   Sets the proxy target.
Chris@0:    *
Chris@0:    * @see \PHPUnit_Framework_TestCase::getMock
Chris@0:    * @see https://github.com/sebastianbergmann/phpunit/wiki/Release-Announcement-for-PHPUnit-5.4.0
Chris@0:    *
Chris@0:    * @return \PHPUnit_Framework_MockObject_MockObject
Chris@0:    *
Chris@0:    * @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0.
Chris@0:    *   Use \Drupal\Tests\PhpunitCompatibilityTrait::createMock() instead.
Chris@0:    *
Chris@0:    * @see https://www.drupal.org/node/2907725
Chris@0:    */
Chris@0:   public function getMock($originalClassName, $methods = [], array $arguments = [], $mockClassName = '', $callOriginalConstructor = TRUE, $callOriginalClone = TRUE, $callAutoload = TRUE, $cloneArguments = FALSE, $callOriginalMethods = FALSE, $proxyTarget = NULL) {
Chris@0:     if (!$this->supports('getMock')) {
Chris@0:       $mock = $this->getMockBuilder($originalClassName)
Chris@0:         ->setMethods($methods)
Chris@0:         ->setConstructorArgs($arguments)
Chris@0:         ->setMockClassName($mockClassName)
Chris@0:         ->setProxyTarget($proxyTarget);
Chris@0:       if ($callOriginalConstructor) {
Chris@0:         $mock->enableOriginalConstructor();
Chris@0:       }
Chris@0:       else {
Chris@0:         $mock->disableOriginalConstructor();
Chris@0:       }
Chris@0:       if ($callOriginalClone) {
Chris@0:         $mock->enableOriginalClone();
Chris@0:       }
Chris@0:       else {
Chris@0:         $mock->disableOriginalClone();
Chris@0:       }
Chris@0:       if ($callAutoload) {
Chris@0:         $mock->enableAutoload();
Chris@0:       }
Chris@0:       else {
Chris@0:         $mock->disableAutoload();
Chris@0:       }
Chris@0:       if ($cloneArguments) {
Chris@0:         $mock->enableArgumentCloning();
Chris@0:       }
Chris@0:       else {
Chris@0:         $mock->disableArgumentCloning();
Chris@0:       }
Chris@0:       if ($callOriginalMethods) {
Chris@0:         $mock->enableProxyingToOriginalMethods();
Chris@0:       }
Chris@0:       else {
Chris@0:         $mock->disableProxyingToOriginalMethods();
Chris@0:       }
Chris@0:       return $mock->getMock();
Chris@0:     }
Chris@0:     else {
Chris@0:       return parent::getMock($originalClassName, $methods, $arguments, $mockClassName, $callOriginalConstructor, $callOriginalClone, $callAutoload, $cloneArguments, $callOriginalMethods, $proxyTarget);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a mock object for the specified class using the available method.
Chris@0:    *
Chris@0:    * The createMock method does not exist in PHPUnit 4. To provide forward
Chris@0:    * compatibility this trait provides the createMock method and uses createMock
Chris@0:    * if this method is available on the parent class or falls back to getMock if
Chris@0:    * it isn't.
Chris@0:    *
Chris@0:    * @param string $originalClassName
Chris@0:    *   Name of the class to mock.
Chris@0:    *
Chris@0:    * @see \PHPUnit_Framework_TestCase::getMock
Chris@0:    *
Chris@0:    * @return \PHPUnit_Framework_MockObject_MockObject
Chris@0:    */
Chris@0:   public function createMock($originalClassName) {
Chris@0:     if ($this->supports('createMock')) {
Chris@0:       return parent::createMock($originalClassName);
Chris@0:     }
Chris@0:     else {
Chris@0:       return $this->getMock($originalClassName, [], [], '', FALSE, FALSE);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
Chris@0:    *
Chris@0:    * @param mixed $class
Chris@0:    *   The expected exception class.
Chris@0:    * @param string $message
Chris@0:    *   The expected exception message.
Chris@0:    * @param int $exception_code
Chris@0:    *   The expected exception code.
Chris@0:    */
Chris@0:   public function setExpectedException($class, $message = '', $exception_code = NULL) {
Chris@0:     if (method_exists($this, 'expectException')) {
Chris@0:       $this->expectException($class);
Chris@0:       if (!empty($message)) {
Chris@0:         $this->expectExceptionMessage($message);
Chris@0:       }
Chris@0:       if ($exception_code !== NULL) {
Chris@0:         $this->expectExceptionCode($exception_code);
Chris@0:       }
Chris@0:     }
Chris@0:     else {
Chris@0:       parent::setExpectedException($class, $message, $exception_code);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Checks if the trait is used in a class that has a method.
Chris@0:    *
Chris@0:    * @param string $method
Chris@0:    *   Method to check.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the method is supported, FALSE if not.
Chris@0:    */
Chris@0:   private function supports($method) {
Chris@0:     // Get the parent class of the currently running test class.
Chris@0:     $parent = get_parent_class($this);
Chris@0:     // Ensure that the method_exists() check on the createMock method is carried
Chris@0:     // out on the first parent of $this that does not have access to this
Chris@0:     // trait's methods. This is because the trait also has a method called
Chris@0:     // createMock(). Most often the check will be made on
Chris@0:     // \PHPUnit\Framework\TestCase.
Chris@0:     while (method_exists($parent, 'supports')) {
Chris@0:       $parent = get_parent_class($parent);
Chris@0:     }
Chris@0:     return method_exists($parent, $method);
Chris@0:   }
Chris@0: 
Chris@0: }