Drop support for PHPUnit < 8.5

Older PHPUnit versions no longer need to be supported now support for PHP < 7.2 has been dropped.

Includes ensuring that the PHPUnit versions used are beyond a recently published PHPUnit security fix.

Includes removing the `UnitTestCase::assertStringContains()`, `UnitTestCase::expectErrorException()` and `UnitTestCase::expectExceptionMsgRegex()` methods, which are no longer needed now the tests won't need to run on PHPUnit < 8.5 anymore.

Includes updating the example code in the documentation.

Author: jrfnl

README.md

@@ -24,7 +24,7 @@ Via Composer following packages are required:
 
 When installed for development, following packages are also required:
 
-* [phpunit/phpunit](https://packagist.org/packages/phpunit/phpunit) version 5.7 or higher \(BSD-3-Clause\)
+* [phpunit/phpunit](https://packagist.org/packages/phpunit/phpunit) version 8.5 or higher \(BSD-3-Clause\)
 
 ## License
 

composer.json

@@ -32,7 +32,7 @@
         "antecedent/patchwork": "^2.2.3"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7.27 || ^6.5.14 || ^7.5.20 || ^8.5.49 || ^9.6.30",
+        "phpunit/phpunit": "^8.5.52 || ^9.6.34",
         "phpcompatibility/php-compatibility": "^9.3.0",
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0.0"
     },

docs/functions-testing-tools/functions-setup.md

@@ -29,11 +29,11 @@ After Brain Monkey is part of the project \(see _Getting Started / Installation_
 Let's take PHPUnit as example, the average test case class that uses Brain Monkey would be something like:
 
 ```php
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Brain\Monkey;
 
-class MyTestCase extends PHPUnit_Framework_TestCase
+class MyTestCase extends TestCase
 {
     // Adds Mockery expectations to the PHPUnit assertions count.
     use MockeryPHPUnitIntegration;
@@ -46,7 +46,7 @@ class MyTestCase extends PHPUnit_Framework_TestCase
 }
 ```
 
-After that for all test classes can extend this class instead of directly extending `PHPUnit_Framework_TestCase`.
+After that, all test classes can extend this class instead of directly extending `PHPUnit\Framework\TestCase`.
 
 That's all. Again, I used PHPUnit for the example, but any testing framework can be used.
 

docs/wordpress-specific-tools/wordpress-setup.md

@@ -22,11 +22,11 @@ These two functions are:
 PHPUnit users will probably want to add these methods to a custom test case class:
 
 ```php
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Brain\Monkey;
 
-class MyTestCase extends PHPUnit_Framework_TestCase {
+class MyTestCase extends TestCase {
 
     // Adds Mockery expectations to the PHPUnit assertions count.
     use MockeryPHPUnitIntegration;
@@ -43,7 +43,7 @@ class MyTestCase extends PHPUnit_Framework_TestCase {
 }
 ```
 
-and then extend various test classes from it instead of directly extend `PHPUnit_Framework_TestCase`.
+and then extend various test classes from it instead of directly extending `PHPUnit\Framework\TestCase`.
 
 That's all. You are ready to use all Brain Monkey features.
 

phpunit.xml.dist

@@ -1,5 +1,5 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.5/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.5/phpunit.xsd"
          beStrictAboutTestsThatDoNotTestAnything="false"
          bootstrap="tests/bootstrap.php"
          colors="true"

tests/bootstrap.php

@@ -16,10 +16,3 @@
     echo 'Autoload file not found. Please run `composer install`.';
     die(1);
 }
-
-// PHPUnit cross version compatibility.
-if (class_exists('PHPUnit_Framework_Error') === true
-    && class_exists('PHPUnit\Framework\Error\Error') === false
-) {
-    class_alias('PHPUnit_Framework_Error', 'PHPUnit\Framework\Error\Error');
-}

tests/cases/unit/Api/FunctionsTest.php

@@ -151,7 +151,7 @@ public function testUndefinedFunctionThrowsExceptionRightAfterDefinition()
     {
         $this->expectException(MissingFunctionExpectations::class);
         Functions\when('since_i_am_not_defined_i_will_throw_exception');
-        $this->expectExceptionMsgRegex('/since_i_am_not_defined_i_will_throw_exception.+not defined/');
+        $this->expectExceptionMessageMatches('/since_i_am_not_defined_i_will_throw_exception.+not defined/');
         /** @noinspection PhpUndefinedFunctionInspection */
         since_i_am_not_defined_i_will_throw_exception();
     }
@@ -170,7 +170,7 @@ public function testUndefinedFunctionSurviveTests()
     public function testSurvivedFunctionStillThrowsException()
     {
         $this->expectException(MissingFunctionExpectations::class);
-        $this->expectExceptionMsgRegex('/since_i_am_not_defined_i_will_throw_exception.+not defined/');
+        $this->expectExceptionMessageMatches('/since_i_am_not_defined_i_will_throw_exception.+not defined/');
         /** @noinspection PhpUndefinedFunctionInspection */
         since_i_am_not_defined_i_will_throw_exception();
     }
@@ -191,7 +191,7 @@ public function testNothingJustMockASurvivedFunction()
     public function testSurvivedFunctionStillThrowsExceptionAfterBeingMocked()
     {
         $this->expectException(MissingFunctionExpectations::class);
-        $this->expectExceptionMsgRegex('/since_i_am_not_defined_i_will_throw_exception.+not defined/');
+        $this->expectExceptionMessageMatches('/since_i_am_not_defined_i_will_throw_exception.+not defined/');
         /** @noinspection PhpUndefinedFunctionInspection */
         since_i_am_not_defined_i_will_throw_exception();
     }

tests/cases/unit/Expectation/Exception/ExpectationArgsRequiredTest.php

@@ -29,7 +29,7 @@ public function testBecauseOf($type, $message_part)
             new ExpectationTarget($type, 'foo')
         )->getMessage();
 
-        static::assertStringContains($message_part, $message);
+        static::assertStringContainsString($message_part, $message);
     }
 
     public function expectationTargets()

tests/src/UnitTestCase.php

@@ -11,7 +11,6 @@
 namespace Brain\Monkey\Tests;
 
 use Brain\Monkey;
-use PHPUnit\Framework\Error\Error as PHPUnit_Error;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -49,60 +48,6 @@ protected function tearDownFixtures()
         $this->tearDownMakingSureExpectedExceptionIsThrown();
     }
 
-    /**
-     * PHPUnit cross-version support.
-     *
-     * @param string $needle
-     * @param string $haystack
-     * @param string $message
-     * @return void
-     */
-    public static function assertStringContains($needle, $haystack, $message = '') {
-
-        if (method_exists(TestCase::class, 'assertStringContainsString')) {
-            // PHPUnit 7.5+.
-            TestCase::assertStringContainsString($needle, $haystack, $message);
-
-            return;
-        }
-
-        // PHPUnit < 7.5.
-        static::assertContains($needle, $haystack, $message);
-    }
-
-    /**
-     * PHPUnit cross-version support.
-     */
-    protected function expectErrorException()
-    {
-        if (method_exists($this, 'expectError')) {
-            // PHPUnit 8.4+.
-            $this->expectError();
-            return;
-        }
-
-        // PHPUnit < 8.4.
-        $this->expectException(PHPUnit_Error::class);
-    }
-
-    /**
-     * PHPUnit cross-version support.
-     *
-     * @param string $msgRegex
-     * @return void
-     */
-    protected function expectExceptionMsgRegex($msgRegex)
-    {
-        if (method_exists($this, 'expectExceptionMessageMatches')) {
-            // PHPUnit 8.4+.
-            $this->expectExceptionMessageMatches($msgRegex);
-            return;
-        }
-
-        // PHPUnit < 8.4.
-        $this->expectExceptionMessageRegExp($msgRegex);
-    }
-
     /**
      * We can't use PHPUnit expectException() because we need to wait for `Monkey\tearDown` and that
      * does not work for `expectException()`.
@@ -123,13 +68,8 @@ protected function tearDownMakingSureExpectedExceptionIsThrown()
                 $this->expect_mockery_exception
             );
 
-            if (class_exists('PHPUnit\\Framework\\ExpectationFailedException')) {
-                // PHPUnit 6.0+.
-                throw new \PHPUnit\Framework\ExpectationFailedException($message);
-            } else {
-                // PHPUnit 5.x.
-                throw new \PHPUnit_Framework_ExpectationFailedException($message);
-            }
+            throw new \PHPUnit\Framework\ExpectationFailedException($message);
+
         } catch (\Throwable $e) {
             if (get_class($e) !== $this->expect_mockery_exception) {
                 throw $e;
@@ -148,13 +88,7 @@ protected function expectMockeryException($class)
                 $class
             );
 
-            if (class_exists('PHPUnit\\Framework\\Exception')) {
-                // PHPUnit 6.0+.
-                throw new \PHPUnit\Framework\Exception($message);
-            } else {
-                // PHPUnit 5.x.
-                throw new \PHPUnit_Framework_Exception($message);
-            }
+            throw new \PHPUnit\Framework\Exception($message);
         }
 
         $this->expect_mockery_exception = $class;