Merge pull request #94 from SimonFrings/tests

clue · web-flow · commit 306886e5492d · 2020-10-02T10:11:16.000+02:00
Run tests on PHPUnit 9 and update PHPUnit configuration schema for PHPUnit 9.3
diff --git a/.gitattributes b/.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
diff --git a/.travis.yml b/.travis.yml
@@ -3,7 +3,7 @@ language: php
 # lock distro so future defaults will not break the build
 dist: trusty
 
-matrix:
+jobs:
   include:
     - php: 5.3
       dist: precise
@@ -19,10 +19,9 @@ matrix:
   allow_failures:
     - php: hhvm-3.18
 
-sudo: false
-
 install:
-  - composer install --no-interaction
+  - composer install
 
 script:
-  - 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
diff --git a/composer.json b/composer.json
@@ -29,7 +29,7 @@
     "require-dev": {
         "clue/arguments": "^2.0",
         "clue/commander": "^1.2",
-        "phpunit/phpunit": "^7.0 || ^6.4 || ^5.7 || ^4.8.35"
+        "phpunit/phpunit": "^9.3 || ^5.7 || ^4.8.35"
     },
     "config": {
         "sort-packages": true
diff --git a/phpunit.xml.dist b/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="Stdio React Test Suite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
+    <coverage>
+        <include>
             <directory>./src/</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+        </include>
+    </coverage>
+</phpunit>
diff --git a/phpunit.xml.legacy b/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="Stdio React Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>./src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>
diff --git a/tests/FunctionalExampleTest.php b/tests/FunctionalExampleTest.php
@@ -8,28 +8,28 @@ public function testPeriodicExampleWithPipedInputEndsBecauseInputEnds()
     {
         $output = $this->execExample('echo hello | php 01-periodic.php');
 
-        $this->assertContains('you just said: hello\n', $output);
+        $this->assertContainsString('you just said: hello\n', $output);
     }
 
     public function testPeriodicExampleWithNullInputQuitsImmediately()
     {
         $output = $this->execExample('php 01-periodic.php < /dev/null');
 
-        $this->assertNotContains('you just said:', $output);
+        $this->assertNotContainsString('you just said:', $output);
     }
 
     public function testPeriodicExampleWithNoInputQuitsImmediately()
     {
         $output = $this->execExample('true | php 01-periodic.php');
 
-        $this->assertNotContains('you just said:', $output);
+        $this->assertNotContainsString('you just said:', $output);
     }
 
     public function testPeriodicExampleWithSleepNoInputQuitsOnEnd()
     {
         $output = $this->execExample('sleep 0.1 | php 01-periodic.php');
 
-        $this->assertNotContains('you just said:', $output);
+        $this->assertNotContainsString('you just said:', $output);
     }
 
     public function testPeriodicExampleWithClosedInputQuitsImmediately()
@@ -40,7 +40,7 @@ public function testPeriodicExampleWithClosedInputQuitsImmediately()
             $this->markTestIncomplete('Your platform exhibits a closed STDIN bug, this may need some further debugging');
         }
 
-        $this->assertNotContains('you just said:', $output);
+        $this->assertNotContainsString('you just said:', $output);
     }
 
     public function testPeriodicExampleWithClosedInputAndOutputQuitsImmediatelyWithoutOutput()
@@ -58,28 +58,28 @@ public function testBindingsExampleWithPipedInputEndsBecauseInputEnds()
     {
         $output = $this->execExample('echo test | php 04-bindings.php');
 
-        $this->assertContains('you just said: test (4)' . PHP_EOL, $output);
+        $this->assertContainsString('you just said: test (4)' . PHP_EOL, $output);
     }
 
     public function testBindingsExampleWithPipedInputEndsWithSpecialBindingsReplacedBecauseInputEnds()
     {
         $output = $this->execExample('echo hello | php 04-bindings.php');
 
-        $this->assertContains('you just said: hellö (6)' . PHP_EOL, $output);
+        $this->assertContainsString('you just said: hellö (6)' . PHP_EOL, $output);
     }
 
     public function testStubShowStdinIsReadableByDefault()
     {
         $output = $this->execExample('php ../tests/stub/01-check-stdin.php');
 
-        $this->assertContains('YES', $output);
+        $this->assertContainsString('YES', $output);
     }
 
     public function testStubCanCloseStdinAndIsNotReadable()
     {
         $output = $this->execExample('php ../tests/stub/02-close-stdin.php');
 
-        $this->assertContains('NO', $output);
+        $this->assertContainsString('NO', $output);
     }
 
     public function testStubCanCloseStdoutAndIsNotWritable()
@@ -113,7 +113,7 @@ public function testPeriodicExampleViaInteractiveModeQuitsImmediately()
 
         // starts with either "Interactive mode enabled" or "Interactive shell"
         $this->assertStringStartsWith('Interactive ', $output);
-        $this->assertNotContains('you just said:', $output);
+        $this->assertNotContainsString('you just said:', $output);
     }
 
     private function execExample($command)
diff --git a/tests/ReadlineTest.php b/tests/ReadlineTest.php
@@ -12,7 +12,10 @@ class ReadlineTest extends TestCase
     private $output;
     private $readline;
 
-    public function setUp()
+    /**
+     * @before
+     */
+    public function setUpReadline()
     {
         $this->input = new ThroughStream();
         $this->output = $this->getMockBuilder('React\Stream\WritableStreamInterface')->getMock();
@@ -621,11 +624,9 @@ public function testAutocompleteReturnsSelf()
         $this->assertSame($this->readline, $this->readline->setAutocomplete(function () { }));
     }
 
-    /**
-     * @expectedException InvalidArgumentException
-     */
     public function testAutocompleteThrowsIfNotCallable()
     {
+        $this->setExpectedException('InvalidArgumentException');
         $this->assertSame($this->readline, $this->readline->setAutocomplete(123));
     }
 
@@ -931,7 +932,7 @@ public function testAutocompleteShowsAvailableOptionsWhenMultipleMatch()
 
         $this->readline->onKeyTab();
 
-        $this->assertContains("\na  b\n", $buffer);
+        $this->assertContainsString("\na  b\n", $buffer);
     }
 
     public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchWithEmptyWord()
@@ -945,7 +946,7 @@ public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchWithEmptyW
 
         $this->readline->onKeyTab();
 
-        $this->assertContains("\n  a\n", $buffer);
+        $this->assertContainsString("\n  a\n", $buffer);
     }
 
     public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchIncompleteWord()
@@ -961,7 +962,7 @@ public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchIncomplete
 
         $this->readline->onKeyTab();
 
-        $this->assertContains("\nhello  hellu\n", $buffer);
+        $this->assertContainsString("\nhello  hellu\n", $buffer);
     }
 
     public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchIncompleteWordWithUmlauts()
@@ -977,7 +978,7 @@ public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchIncomplete
 
         $this->readline->onKeyTab();
 
-        $this->assertContains("\nhällö  hällü\n", $buffer);
+        $this->assertContainsString("\nhällö  hällü\n", $buffer);
     }
 
     public function testAutocompleteShowsAvailableOptionsWithoutDuplicatesWhenMultipleMatch()
@@ -991,7 +992,7 @@ public function testAutocompleteShowsAvailableOptionsWithoutDuplicatesWhenMultip
 
         $this->readline->onKeyTab();
 
-        $this->assertContains("\na  b\n", $buffer);
+        $this->assertContainsString("\na  b\n", $buffer);
     }
 
     public function testAutocompleteShowsLimitedNumberOfAvailableOptionsWhenMultipleMatch()
@@ -1005,7 +1006,7 @@ public function testAutocompleteShowsLimitedNumberOfAvailableOptionsWhenMultiple
 
         $this->readline->onKeyTab();
 
-        $this->assertContains("\na  b  c  d  e  f  g  (+19 others)\n", $buffer);
+        $this->assertContainsString("\na  b  c  d  e  f  g  (+19 others)\n", $buffer);
     }
 
     public function testBindCustomFunctionFromBase()
diff --git a/tests/StdioTest.php b/tests/StdioTest.php
@@ -11,7 +11,10 @@ class StdioTest extends TestCase
 {
     private $loop;
 
-    public function setUp()
+    /**
+     * @before
+     */
+    public function setUpLoop()
     {
         $this->loop = Factory::create();
     }
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -46,7 +46,13 @@ protected function expectCallableOnceWith($value)
      */
     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();
+        }
     }
 
     protected function expectPromiseResolve($promise)
@@ -66,4 +72,43 @@ protected function expectPromiseReject($promise)
 
         return $promise;
     }
+
+    public function assertContainsString($needle, $haystack)
+    {
+        if (method_exists($this, 'assertStringContainsString')) {
+            // PHPUnit 7.5+
+            $this->assertStringContainsString($needle, $haystack);
+        } else {
+            // legacy PHPUnit 4 - PHPUnit 7.5
+            $this->assertContains($needle, $haystack);
+        }
+    }
+
+    public function assertNotContainsString($needle, $haystack)
+    {
+        if (method_exists($this, 'assertStringNotContainsString')) {
+            // PHPUnit 7.5+
+            $this->assertStringNotContainsString($needle, $haystack);
+        } else {
+            // legacy PHPUnit 4 - PHPUnit 7.5
+            $this->assertNotContains($needle, $haystack);
+        }
+    }
+
+    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);
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,28 +8,28 @@ public function testPeriodicExampleWithPipedInputEndsBecauseInputEnds()`
`8`	`8`	`{`
`9`	`9`	`$output = $this->execExample('echo hello \| php 01-periodic.php');`
`10`	`10`
`11`		`- $this->assertContains('you just said: hello\n', $output);`
	`11`	`+ $this->assertContainsString('you just said: hello\n', $output);`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`public function testPeriodicExampleWithNullInputQuitsImmediately()`
`15`	`15`	`{`
`16`	`16`	`$output = $this->execExample('php 01-periodic.php < /dev/null');`
`17`	`17`
`18`		`- $this->assertNotContains('you just said:', $output);`
	`18`	`+ $this->assertNotContainsString('you just said:', $output);`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`public function testPeriodicExampleWithNoInputQuitsImmediately()`
`22`	`22`	`{`
`23`	`23`	`$output = $this->execExample('true \| php 01-periodic.php');`
`24`	`24`
`25`		`- $this->assertNotContains('you just said:', $output);`
	`25`	`+ $this->assertNotContainsString('you just said:', $output);`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`public function testPeriodicExampleWithSleepNoInputQuitsOnEnd()`
`29`	`29`	`{`
`30`	`30`	`$output = $this->execExample('sleep 0.1 \| php 01-periodic.php');`
`31`	`31`
`32`		`- $this->assertNotContains('you just said:', $output);`
	`32`	`+ $this->assertNotContainsString('you just said:', $output);`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`public function testPeriodicExampleWithClosedInputQuitsImmediately()`
`@@ -40,7 +40,7 @@ public function testPeriodicExampleWithClosedInputQuitsImmediately()`
`40`	`40`	`$this->markTestIncomplete('Your platform exhibits a closed STDIN bug, this may need some further debugging');`
`41`	`41`	`}`
`42`	`42`
`43`		`- $this->assertNotContains('you just said:', $output);`
	`43`	`+ $this->assertNotContainsString('you just said:', $output);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`public function testPeriodicExampleWithClosedInputAndOutputQuitsImmediatelyWithoutOutput()`
`@@ -58,28 +58,28 @@ public function testBindingsExampleWithPipedInputEndsBecauseInputEnds()`
`58`	`58`	`{`
`59`	`59`	`$output = $this->execExample('echo test \| php 04-bindings.php');`
`60`	`60`
`61`		`- $this->assertContains('you just said: test (4)' . PHP_EOL, $output);`
	`61`	`+ $this->assertContainsString('you just said: test (4)' . PHP_EOL, $output);`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`public function testBindingsExampleWithPipedInputEndsWithSpecialBindingsReplacedBecauseInputEnds()`
`65`	`65`	`{`
`66`	`66`	`$output = $this->execExample('echo hello \| php 04-bindings.php');`
`67`	`67`
`68`		`- $this->assertContains('you just said: hellö (6)' . PHP_EOL, $output);`
	`68`	`+ $this->assertContainsString('you just said: hellö (6)' . PHP_EOL, $output);`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`public function testStubShowStdinIsReadableByDefault()`
`72`	`72`	`{`
`73`	`73`	`$output = $this->execExample('php ../tests/stub/01-check-stdin.php');`
`74`	`74`
`75`		`- $this->assertContains('YES', $output);`
	`75`	`+ $this->assertContainsString('YES', $output);`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`public function testStubCanCloseStdinAndIsNotReadable()`
`79`	`79`	`{`
`80`	`80`	`$output = $this->execExample('php ../tests/stub/02-close-stdin.php');`
`81`	`81`
`82`		`- $this->assertContains('NO', $output);`
	`82`	`+ $this->assertContainsString('NO', $output);`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`public function testStubCanCloseStdoutAndIsNotWritable()`
`@@ -113,7 +113,7 @@ public function testPeriodicExampleViaInteractiveModeQuitsImmediately()`
`113`	`113`
`114`	`114`	`// starts with either "Interactive mode enabled" or "Interactive shell"`
`115`	`115`	`$this->assertStringStartsWith('Interactive ', $output);`
`116`		`- $this->assertNotContains('you just said:', $output);`
	`116`	`+ $this->assertNotContainsString('you just said:', $output);`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`private function execExample($command)`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,10 @@ class ReadlineTest extends TestCase`
`12`	`12`	`private $output;`
`13`	`13`	`private $readline;`
`14`	`14`
`15`		`- public function setUp()`
	`15`	`+ /**`
	`16`	`+ * @before`
	`17`	`+ */`
	`18`	`+ public function setUpReadline()`
`16`	`19`	`{`
`17`	`20`	`$this->input = new ThroughStream();`
`18`	`21`	`$this->output = $this->getMockBuilder('React\Stream\WritableStreamInterface')->getMock();`
`@@ -621,11 +624,9 @@ public function testAutocompleteReturnsSelf()`
`621`	`624`	`$this->assertSame($this->readline, $this->readline->setAutocomplete(function () { }));`
`622`	`625`	`}`
`623`	`626`
`624`		`- /**`
`625`		`- * @expectedException InvalidArgumentException`
`626`		`- */`
`627`	`627`	`public function testAutocompleteThrowsIfNotCallable()`
`628`	`628`	`{`
	`629`	`+ $this->setExpectedException('InvalidArgumentException');`
`629`	`630`	`$this->assertSame($this->readline, $this->readline->setAutocomplete(123));`
`630`	`631`	`}`
`631`	`632`
`@@ -931,7 +932,7 @@ public function testAutocompleteShowsAvailableOptionsWhenMultipleMatch()`
`931`	`932`
`932`	`933`	`$this->readline->onKeyTab();`
`933`	`934`
`934`		`- $this->assertContains("\na b\n", $buffer);`
	`935`	`+ $this->assertContainsString("\na b\n", $buffer);`
`935`	`936`	`}`
`936`	`937`
`937`	`938`	`public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchWithEmptyWord()`
`@@ -945,7 +946,7 @@ public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchWithEmptyW`
`945`	`946`
`946`	`947`	`$this->readline->onKeyTab();`
`947`	`948`
`948`		`- $this->assertContains("\n a\n", $buffer);`
	`949`	`+ $this->assertContainsString("\n a\n", $buffer);`
`949`	`950`	`}`
`950`	`951`
`951`	`952`	`public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchIncompleteWord()`
`@@ -961,7 +962,7 @@ public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchIncomplete`
`961`	`962`
`962`	`963`	`$this->readline->onKeyTab();`
`963`	`964`
`964`		`- $this->assertContains("\nhello hellu\n", $buffer);`
	`965`	`+ $this->assertContainsString("\nhello hellu\n", $buffer);`
`965`	`966`	`}`
`966`	`967`
`967`	`968`	`public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchIncompleteWordWithUmlauts()`
`@@ -977,7 +978,7 @@ public function testAutocompleteShowsAvailableOptionsWhenMultipleMatchIncomplete`
`977`	`978`
`978`	`979`	`$this->readline->onKeyTab();`
`979`	`980`
`980`		`- $this->assertContains("\nhällö hällü\n", $buffer);`
	`981`	`+ $this->assertContainsString("\nhällö hällü\n", $buffer);`
`981`	`982`	`}`
`982`	`983`
`983`	`984`	`public function testAutocompleteShowsAvailableOptionsWithoutDuplicatesWhenMultipleMatch()`
`@@ -991,7 +992,7 @@ public function testAutocompleteShowsAvailableOptionsWithoutDuplicatesWhenMultip`
`991`	`992`
`992`	`993`	`$this->readline->onKeyTab();`
`993`	`994`
`994`		`- $this->assertContains("\na b\n", $buffer);`
	`995`	`+ $this->assertContainsString("\na b\n", $buffer);`
`995`	`996`	`}`
`996`	`997`
`997`	`998`	`public function testAutocompleteShowsLimitedNumberOfAvailableOptionsWhenMultipleMatch()`
`@@ -1005,7 +1006,7 @@ public function testAutocompleteShowsLimitedNumberOfAvailableOptionsWhenMultiple`
`1005`	`1006`
`1006`	`1007`	`$this->readline->onKeyTab();`
`1007`	`1008`
`1008`		`- $this->assertContains("\na b c d e f g (+19 others)\n", $buffer);`
	`1009`	`+ $this->assertContainsString("\na b c d e f g (+19 others)\n", $buffer);`
`1009`	`1010`	`}`
`1010`	`1011`
`1011`	`1012`	`public function testBindCustomFunctionFromBase()`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,10 @@ class StdioTest extends TestCase`
`11`	`11`	`{`
`12`	`12`	`private $loop;`
`13`	`13`
`14`		`- public function setUp()`
	`14`	`+ /**`
	`15`	`+ * @before`
	`16`	`+ */`
	`17`	`+ public function setUpLoop()`
`15`	`18`	`{`
`16`	`19`	`$this->loop = Factory::create();`
`17`	`20`	`}`