Merge pull request #121 from clue-labs/phpunit

Update test suite to support PHPUnit 9
clue · Dec 28, 2021 · 45d09b2 · 45d09b2
2 parents e04f13a + 1e25ffd
commit 45d09b2
Show file tree

Hide file tree

Showing 12 changed files with 167 additions and 211 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -27,6 +27,9 @@ jobs:
           php-version: ${{ matrix.php }}
       - run: composer install
       - run: vendor/bin/phpunit --coverage-text
+        if: ${{ matrix.php >= 7.3 }}
+      - run: vendor/bin/phpunit --coverage-text -c phpunit.xml.legacy
+        if: ${{ matrix.php < 7.3 }}
       - run: composer build
 
   PHPUnit-hhvm:

diff --git a/composer.json b/composer.json
@@ -18,7 +18,7 @@
         "symfony/process": "^5.0 || ^4.0 || ^3.0 || ^2.5"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8"
+        "phpunit/phpunit": "^9.5 || ^5.7 || ^4.8.36"
     },
     "autoload": {
         "psr-0": {"Clue": "src/"}

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,14 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<phpunit bootstrap="./tests/bootstrap.php" colors="true">
+<!-- PHPUnit configuration file with new format for PHPUnit 9.5+ -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         bootstrap="tests/bootstrap.php"
+         cacheResult="false"
+         colors="true">
     <testsuites>
         <testsuite name="PharComposer Test Suite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory>./src</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+    <coverage>
+        <include>
+            <directory>./src/</directory>
+        </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 before PHPUnit 9 -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/4.8/phpunit.xsd"
+         bootstrap="tests/bootstrap.php"
+         colors="true">
+    <testsuites>
+        <testsuite name="PharComposer Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>./src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>
diff --git a/tests/Command/BuildTest.php b/tests/Command/BuildTest.php
@@ -17,18 +17,18 @@ public function testCtorCreatesPackager()
 
     public function testExecuteBuildWillBuildPharer()
     {
-        $input = $this->getMock('Symfony\Component\Console\Input\InputInterface');
+        $input = $this->getMockBuilder('Symfony\Component\Console\Input\InputInterface')->getMock();
         $input->expects($this->exactly(2))->method('getArgument')->withConsecutive(
             array('project'),
             array('target')
         )->willReturnOnConsecutiveCalls('dir', null);
-        $output = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+        $output = $this->getMockBuilder('Symfony\Component\Console\Output\OutputInterface')->getMock();
 
         $pharer = $this->getMockBuilder('Clue\PharComposer\Phar\PharComposer')->disableOriginalConstructor()->getMock();
         $pharer->expects($this->never())->method('setTarget');
         $pharer->expects($this->once())->method('build');
 
-        $packager = $this->getMock('Clue\PharComposer\Phar\Packager');
+        $packager = $this->getMockBuilder('Clue\PharComposer\Phar\Packager')->getMock();
         $packager->expects($this->once())->method('setOutput')->with($output);
         $packager->expects($this->once())->method('getPharer')->with('dir')->willReturn($pharer);
 
@@ -38,18 +38,18 @@ public function testExecuteBuildWillBuildPharer()
 
     public function testExecuteBuildWillBuildPharerWithExplicitTarget()
     {
-        $input = $this->getMock('Symfony\Component\Console\Input\InputInterface');
+        $input = $this->getMockBuilder('Symfony\Component\Console\Input\InputInterface')->getMock();
         $input->expects($this->exactly(2))->method('getArgument')->withConsecutive(
             array('project'),
             array('target')
         )->willReturnOnConsecutiveCalls('dir', 'targetDir');
-        $output = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+        $output = $this->getMockBuilder('Symfony\Component\Console\Output\OutputInterface')->getMock();
 
         $pharer = $this->getMockBuilder('Clue\PharComposer\Phar\PharComposer')->disableOriginalConstructor()->getMock();
         $pharer->expects($this->once())->method('setTarget')->with('targetDir');
         $pharer->expects($this->once())->method('build');
 
-        $packager = $this->getMock('Clue\PharComposer\Phar\Packager');
+        $packager = $this->getMockBuilder('Clue\PharComposer\Phar\Packager')->getMock();
         $packager->expects($this->once())->method('setOutput')->with($output);
         $packager->expects($this->once())->method('getPharer')->with('dir')->willReturn($pharer);
 

diff --git a/tests/Command/InstallTest.php b/tests/Command/InstallTest.php
@@ -18,18 +18,18 @@ public function testCtorCreatesPackager()
 
     public function testExecuteInstallWillInstallPackager()
     {
-        $input = $this->getMock('Symfony\Component\Console\Input\InputInterface');
+        $input = $this->getMockBuilder('Symfony\Component\Console\Input\InputInterface')->getMock();
         $input->expects($this->exactly(2))->method('getArgument')->withConsecutive(
             array('project'),
             array('target')
         )->willReturnOnConsecutiveCalls('dir', null);
-        $output = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+        $output = $this->getMockBuilder('Symfony\Component\Console\Output\OutputInterface')->getMock();
 
         $package = $this->getMockBuilder('Clue\PharComposer\Package\Package')->disableOriginalConstructor()->getMock();
         $pharer = $this->getMockBuilder('Clue\PharComposer\Phar\PharComposer')->disableOriginalConstructor()->getMock();
         $pharer->expects($this->once())->method('getPackageRoot')->willReturn($package);
 
-        $packager = $this->getMock('Clue\PharComposer\Phar\Packager');
+        $packager = $this->getMockBuilder('Clue\PharComposer\Phar\Packager')->getMock();
         $packager->expects($this->once())->method('setOutput')->with($output);
         $packager->expects($this->once())->method('getPharer')->with('dir')->willReturn($pharer);
         $packager->expects($this->once())->method('getSystemBin')->with($package, null)->willReturn('targetPath');
@@ -41,18 +41,18 @@ public function testExecuteInstallWillInstallPackager()
 
     public function testExecuteInstallWillInstallPackagerWithExplicitTarget()
     {
-        $input = $this->getMock('Symfony\Component\Console\Input\InputInterface');
+        $input = $this->getMockBuilder('Symfony\Component\Console\Input\InputInterface')->getMock();
         $input->expects($this->exactly(2))->method('getArgument')->withConsecutive(
             array('project'),
             array('target')
         )->willReturnOnConsecutiveCalls('dir', 'targetDir');
-        $output = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+        $output = $this->getMockBuilder('Symfony\Component\Console\Output\OutputInterface')->getMock();
 
         $package = $this->getMockBuilder('Clue\PharComposer\Package\Package')->disableOriginalConstructor()->getMock();
         $pharer = $this->getMockBuilder('Clue\PharComposer\Phar\PharComposer')->disableOriginalConstructor()->getMock();
         $pharer->expects($this->once())->method('getPackageRoot')->willReturn($package);
 
-        $packager = $this->getMock('Clue\PharComposer\Phar\Packager');
+        $packager = $this->getMockBuilder('Clue\PharComposer\Phar\Packager')->getMock();
         $packager->expects($this->once())->method('setOutput')->with($output);
         $packager->expects($this->once())->method('getPharer')->with('dir')->willReturn($pharer);
         $packager->expects($this->once())->method('getSystemBin')->with($package, 'targetDir')->willReturn('targetPath');
@@ -62,32 +62,16 @@ public function testExecuteInstallWillInstallPackagerWithExplicitTarget()
         $command->run($input, $output);
     }
 
-    /**
-     * @doesNotPerformAssertions
-     */
-    public function testNotBlockedByLegacyInstallation()
-    {
-        // Symfony 5+ added parameter type declarations, so we can use this to check which version is installed
-        $ref = new ReflectionMethod('Symfony\Component\Console\Command\Command', 'setName');
-        $params = $ref->getParameters();
-        if (PHP_VERSION_ID >= 70000 && isset($params[0]) && $params[0]->hasType()) {
-            $this->markTestSkipped('Unable to run this test (mocked QuestionHelper) with legacy PHPUnit against Symfony v5+');
-        }
-    }
-
-    /**
-     * @depends testNotBlockedByLegacyInstallation
-     */
     public function testExecuteInstallWillInstallPackagerWhenTargetPathAlreadyExistsAndDialogQuestionYieldsYes()
     {
-        $input = $this->getMock('Symfony\Component\Console\Input\InputInterface');
+        $input = $this->getMockBuilder('Symfony\Component\Console\Input\InputInterface')->getMock();
         $input->expects($this->exactly(2))->method('getArgument')->withConsecutive(
             array('project'),
             array('target')
         )->willReturnOnConsecutiveCalls('dir', null);
-        $output = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+        $output = $this->getMockBuilder('Symfony\Component\Console\Output\OutputInterface')->getMock();
 
-        $questionHelper = $this->getMock('Symfony\Component\Console\Helper\QuestionHelper');
+        $questionHelper = $this->getMockBuilder('Symfony\Component\Console\Helper\QuestionHelper')->getMock();
         $questionHelper->expects($this->once())->method('ask')->willReturn(true);
 
         $helpers = new HelperSet(array(
@@ -98,7 +82,7 @@ public function testExecuteInstallWillInstallPackagerWhenTargetPathAlreadyExists
         $pharer = $this->getMockBuilder('Clue\PharComposer\Phar\PharComposer')->disableOriginalConstructor()->getMock();
         $pharer->expects($this->once())->method('getPackageRoot')->willReturn($package);
 
-        $packager = $this->getMock('Clue\PharComposer\Phar\Packager');
+        $packager = $this->getMockBuilder('Clue\PharComposer\Phar\Packager')->getMock();
         $packager->expects($this->once())->method('setOutput')->with($output);
         $packager->expects($this->once())->method('getPharer')->with('dir')->willReturn($pharer);
         $packager->expects($this->once())->method('getSystemBin')->with($package, null)->willReturn(__FILE__);
@@ -109,20 +93,17 @@ public function testExecuteInstallWillInstallPackagerWhenTargetPathAlreadyExists
         $command->run($input, $output);
     }
 
-    /**
-     * @depends testNotBlockedByLegacyInstallation
-     */
     public function testExecuteInstallWillNotInstallPackagerWhenTargetPathAlreadyExistsAndDialogQuestionShouldNotOverwrite()
     {
-        $input = $this->getMock('Symfony\Component\Console\Input\InputInterface');
+        $input = $this->getMockBuilder('Symfony\Component\Console\Input\InputInterface')->getMock();
         $input->expects($this->exactly(2))->method('getArgument')->withConsecutive(
             array('project'),
             array('target')
         )->willReturnOnConsecutiveCalls('dir', null);
-        $output = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+        $output = $this->getMockBuilder('Symfony\Component\Console\Output\OutputInterface')->getMock();
         $output->expects($this->once())->method('writeln')->with('Aborting');
 
-        $questionHelper = $this->getMock('Symfony\Component\Console\Helper\QuestionHelper');
+        $questionHelper = $this->getMockBuilder('Symfony\Component\Console\Helper\QuestionHelper')->getMock();
         $questionHelper->expects($this->once())->method('ask')->willReturn(false);
 
         $helpers = new HelperSet(array(
@@ -133,7 +114,7 @@ public function testExecuteInstallWillNotInstallPackagerWhenTargetPathAlreadyExi
         $pharer = $this->getMockBuilder('Clue\PharComposer\Phar\PharComposer')->disableOriginalConstructor()->getMock();
         $pharer->expects($this->once())->method('getPackageRoot')->willReturn($package);
 
-        $packager = $this->getMock('Clue\PharComposer\Phar\Packager');
+        $packager = $this->getMockBuilder('Clue\PharComposer\Phar\Packager')->getMock();
         $packager->expects($this->once())->method('setOutput')->with($output);
         $packager->expects($this->once())->method('getPharer')->with('dir')->willReturn($pharer);
         $packager->expects($this->once())->method('getSystemBin')->with($package, null)->willReturn(__FILE__);
@@ -146,8 +127,8 @@ public function testExecuteInstallWillNotInstallPackagerWhenTargetPathAlreadyExi
 
     public function testExecuteInstallWillReportErrorOnWindows()
     {
-        $input = $this->getMock('Symfony\Component\Console\Input\InputInterface');
-        $output = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+        $input = $this->getMockBuilder('Symfony\Component\Console\Input\InputInterface')->getMock();
+        $output = $this->getMockBuilder('Symfony\Component\Console\Output\OutputInterface')->getMock();
         $output->expects($this->once())->method('writeln')->with($this->stringContains('platform'));
 
         $command = new Install(null, true);