Run tests on PHPUnit 9 and update PHPUnit configuration schema for PHPUnit 9.3

.gitattributes

@@ -3,4 +3,5 @@
 /.travis.yml export-ignore
 /examples/ export-ignore
 /phpunit.xml.dist export-ignore
+/phpunit.xml.legacy export-ignore
 /tests/ export-ignore

.travis.yml

@@ -3,7 +3,7 @@ language: php
 # lock distro so new future defaults will not break the build
 dist: trusty
 
-matrix:
+jobs:
   include:
     - php: 5.3
       dist: precise
@@ -24,9 +24,10 @@ install:
   - sudo apt-get --no-install-recommends -qq install -y asterisk
   - sudo cp tests/username.conf /etc/asterisk/manager.d/username.conf
   - sudo /etc/init.d/asterisk reload
-  - composer install --no-interaction
+  - composer install
 
 script:
   - sudo /etc/init.d/asterisk status || sudo /etc/init.d/asterisk start
   - sudo /etc/init.d/asterisk status || sleep 2
-  - vendor/bin/phpunit --coverage-text
+  - if [[ "$TRAVIS_PHP_VERSION" > "7.2" ]]; then vendor/bin/phpunit --coverage-text; fi
+  - if [[ "$TRAVIS_PHP_VERSION" < "7.3" ]]; then vendor/bin/phpunit --coverage-text -c phpunit.xml.legacy; fi

composer.json

@@ -19,7 +19,7 @@
     },
     "require-dev": {
         "clue/block-react": "^1.2",
-        "phpunit/phpunit": "^7.0 || ^6.0 || ^5.0 || ^4.8.35"
+        "phpunit/phpunit": "^9.3 || ^5.7 || ^4.8.35"
     },
     "autoload": {
         "psr-4": { "Clue\\React\\Ami\\": "src/" }

phpunit.xml.dist

@@ -1,14 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<phpunit bootstrap="vendor/autoload.php" colors="true">
+<!-- PHPUnit configuration file with new format for PHPUnit 9.3+ -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         cacheResult="false">
     <testsuites>
         <testsuite name="Asterisk AMI Test Suite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
+    <coverage>
+        <include>
             <directory>./src/</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+        </include>
+    </coverage>
+</phpunit>

phpunit.xml.legacy

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- PHPUnit configuration file with old format for PHPUnit 9.2 or older -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/4.8/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true">
+    <testsuites>
+        <testsuite name="Asterisk AMI Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>./src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

tests/ActionSenderTest.php

@@ -53,7 +53,13 @@ private function createClientMock()
     {
         $stream = $this->getMockBuilder('React\Socket\Connection')->disableOriginalConstructor()->getMock();
 
-        $client = $this->getMockBuilder('Clue\React\Ami\Client')->setMethods(array('createAction'))->setConstructorArgs(array($stream))->getMock();
+        if (method_exists('PHPUnit\Framework\MockObject\MockBuilder', 'onlyMethods')) {
+            // PHPUnit 9+
+            $client = $this->getMockBuilder('Clue\React\Ami\Client')->onlyMethods(array('createAction'))->setConstructorArgs(array($stream))->getMock();
+        } else {
+            // legacy PHPUnit 4 - PHPUnit 8
+            $client = $this->getMockBuilder('Clue\React\Ami\Client')->setMethods(array('createAction'))->setConstructorArgs(array($stream))->getMock();
+        }
 
         return $client;
     }

tests/ClientTest.php

@@ -45,6 +45,12 @@ public function testUnexpectedResponseEmitsErrorAndClosesClient()
 
     private function createStreamMock()
     {
-        return $this->getMockBuilder('React\Socket\Connection')->disableOriginalConstructor()->setMethods(array('write', 'close'))->getMock();
+        if (method_exists('PHPUnit\Framework\MockObject\MockBuilder', 'onlyMethods')) {
+            // PHPUnit 9+
+            return $this->getMockBuilder('React\Socket\Connection')->disableOriginalConstructor()->onlyMethods(array('write', 'close'))->getMock();
+        } else {
+            // legacy PHPUnit 4 - PHPUnit 8
+            return $this->getMockBuilder('React\Socket\Connection')->disableOriginalConstructor()->setMethods(array('write', 'close'))->getMock();
+        }
     }
 }

tests/FactoryTest.php

@@ -11,7 +11,10 @@ class FactoryTest extends TestCase
     private $tcp;
     private $factory;
 
-    public function setUp()
+    /**
+     * @before
+     */
+    public function setUpFactory()
     {
         $this->loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
         $this->tcp = $this->getMockBuilder('React\Socket\ConnectorInterface')->getMock();

tests/FunctionalTest.php

@@ -13,13 +13,19 @@ class FunctionalTest extends TestCase
     private static $address = false;
     private static $loop;
 
-    public static function setUpBeforeClass()
+    /**
+     * @beforeClass
+     */
+    public static function setUpLoopBeforeClass()
     {
         self::$address = getenv('LOGIN');
         self::$loop = \React\EventLoop\Factory::create();
     }
 
-    public function setUp()
+    /**
+     * @before
+     */
+    public function setUpSkipTest()
     {
         if (self::$address === false) {
             $this->markTestSkipped('No ENV named LOGIN found. Please use "export LOGIN=\'user:pass@host\'.');
@@ -54,10 +60,10 @@ public function testPing(Client $client)
     /**
      * @depends testConnection
      * @param Client $client
-     * @expectedException Exception
      */
     public function testInvalidCommandGetsRejected(Client $client)
     {
+        $this->setExpectedException('Exception');
         $this->waitFor($client->request($client->createAction('Invalid')));
     }
 
@@ -85,10 +91,10 @@ public function testActionSenderLogoffDisconnects(Client $client)
     /**
      * @depends testActionSenderLogoffDisconnects
      * @param Client $client
-     * @expectedException Exception
      */
     public function testSendRejectedAfterClose(Client $client)
     {
+        $this->setExpectedException('Exception');
         $this->waitFor($client->request($client->createAction('Ping')));
     }
 

tests/Protocol/ParserTest.php

@@ -132,14 +132,12 @@ public function testParsingResponseIsNotCommandResponse()
         $this->assertEquals('Some message--END COMMAND--', $first->getFieldValue('Message'));
     }
 
-    /**
-     * @expectedException UnexpectedValueException
-     */
     public function testParsingInvalidResponseFails()
     {
         $parser = new Parser();
         $this->assertEquals(array(), $parser->push("Asterisk Call Manager/1.3\r\n"));
 
+        $this->setExpectedException('UnexpectedValueException');
         $parser->push("invalid response\r\n\r\n");
     }
 

tests/TestCase.php

@@ -18,6 +18,29 @@ protected function expectCallableOnce()
 
     protected function createCallableMock()
     {
-        return $this->getMockBuilder('stdClass')->setMethods(array('__invoke'))->getMock();
+        if (method_exists('PHPUnit\Framework\MockObject\MockBuilder', 'addMethods')) {
+            // PHPUnit 9+
+            return $this->getMockBuilder('stdClass')->addMethods(array('__invoke'))->getMock();
+        } else {
+            // legacy PHPUnit 4 - PHPUnit 8
+            return $this->getMockBuilder('stdClass')->setMethods(array('__invoke'))->getMock();
+        }
+    }
+
+    public function setExpectedException($exception, $exceptionMessage = '', $exceptionCode = null)
+    {
+        if (method_exists($this, 'expectException')) {
+            // PHPUnit 5+
+            $this->expectException($exception);
+            if ($exceptionMessage !== '') {
+                $this->expectExceptionMessage($exceptionMessage);
+            }
+            if ($exceptionCode !== null) {
+                $this->expectExceptionCode($exceptionCode);
+            }
+        } else {
+            // legacy PHPUnit 4
+            parent::setExpectedException($exception, $exceptionMessage, $exceptionCode);
+        }
     }
 }