[TASK] Bump PHPUnit version to ^8.1 (#456)

Bump PHPUnit to most recent version, adapt tests and adjust the Travis testing matrix to no longer test on PHP below 7.2, in preparation for the up-coming minimum PHP requirement. * Fix getMockForAbstractClass usages * Fix locale-based casting of expected float Prevent comparing a float cast to localized comma- or thousand-separators, causing assertion to fail.
TYPO3 · Jun 20, 2019 · 4312e8c · 4312e8c
1 parent 7f37c8a
commit 4312e8c
Show file tree

Hide file tree

Showing 43 changed files with 231 additions and 110 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ composer.lock
 vendor
 examples/cache/*.php
 .numerolog-token-90d266e4c7e3463a4266086282f608c1121c3d95
+/.phpunit.result.cache
diff --git a/.travis.yml b/.travis.yml
@@ -15,11 +15,8 @@ cache:
     - $HOME/.composer/cache
 
 php:
-  - 5.5
-  - 5.6
-  - 7
-  - 7.1
   - 7.2
+  - 7.3
 
 before_install:
   - composer self-update

diff --git a/composer.json b/composer.json
@@ -6,7 +6,7 @@
 		"php": ">=5.5.0"
 	},
 	"require-dev": {
-		"phpunit/phpunit": "^4.8",
+		"phpunit/phpunit": "^8.1",
 		"mikey179/vfsstream": "^1.6",
 		"squizlabs/php_codesniffer": "^2.7",
 		"php-coveralls/php-coveralls": "^2.1"

diff --git a/src/Core/Cache/FluidCacheWarmupResult.php b/src/Core/Cache/FluidCacheWarmupResult.php
@@ -58,7 +58,7 @@ public function add(ParsedTemplateInterface $state, $templatePathAndFilename)
         $currentlyCompiled = $state->isCompiled();
         $this->results[$templatePathAndFilename] = [
             static::RESULT_COMPILABLE => $currentlyCompiled || $state->isCompilable(),
-            static::RESULT_COMPILED => $state->isCompiled(),
+            static::RESULT_COMPILED => $currentlyCompiled,
             static::RESULT_HASLAYOUT => $state->hasLayout(),
             static::RESULT_COMPILEDCLASS => $state->getIdentifier()
         ];

diff --git a/tests/BaseTestCase.php b/tests/BaseTestCase.php
@@ -6,6 +6,9 @@
  * See LICENSE.txt that was shipped with this package.
  */
 
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
 /**
  * The mother of all test cases.
  *
@@ -14,7 +17,7 @@
  *
  * @api
  */
-abstract class BaseTestCase extends \PHPUnit_Framework_TestCase
+abstract class BaseTestCase extends TestCase
 {
 
     /**
@@ -34,12 +37,87 @@ abstract class BaseTestCase extends \PHPUnit_Framework_TestCase
      * @param boolean $callOriginalConstructor
      * @param boolean $callOriginalClone
      * @param boolean $callAutoload
-     * @return \PHPUnit_Framework_MockObject_MockObject
+     * @return MockObject
      * @api
      */
     protected function getAccessibleMock($originalClassName, $methods = [], array $arguments = [], $mockClassName = '', $callOriginalConstructor = true, $callOriginalClone = true, $callAutoload = true)
     {
-        return $this->getMock($this->buildAccessibleProxy($originalClassName), $methods, $arguments, $mockClassName, $callOriginalConstructor, $callOriginalClone, $callAutoload);
+        $builder = $this->getMockBuilder($this->buildAccessibleProxy($originalClassName))->setMethods($methods)->setConstructorArgs($arguments)->setMockClassName($mockClassName);
+        if (!$callAutoload) {
+            $builder->disableAutoload();
+        }
+        if (!$callOriginalClone) {
+            $builder->disableOriginalClone();
+        }
+        if (!$callOriginalConstructor) {
+            $builder->disableOriginalConstructor();
+        }
+
+        return $builder->getMock();
+    }
+
+    public static function assertAttributeEquals($expected, string $actualAttributeName, $actualClassOrObject, string $message = '', float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false): void
+    {
+        static::assertEquals($expected, static::extractNonPublicAttribute($actualClassOrObject, $actualAttributeName));
+    }
+
+    public static function assertAttributeSame($expected, string $actualAttributeName, $actualClassOrObject, string $message = '', float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false): void
+    {
+        static::assertSame($expected, static::extractNonPublicAttribute($actualClassOrObject, $actualAttributeName));
+    }
+
+    public static function assertAttributeContains($needle, string $haystackAttributeName, $haystackClassOrObject, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true, bool $checkForNonObjectIdentity = false): void
+    {
+        static::assertContains($needle, static::extractNonPublicAttribute($haystackClassOrObject, $haystackAttributeName));
+    }
+
+    public static function assertAttributeNotEmpty(string $haystackAttributeName, $haystackClassOrObject, string $message = ''): void
+    {
+        static::assertNotEmpty(static::extractNonPublicAttribute($haystackClassOrObject, $haystackAttributeName));
+    }
+
+    public static function assertAttributeInstanceOf(string $expected, string $attributeName, $classOrObject, string $message = ''): void
+    {
+        static::assertInstanceOf($expected, static::extractNonPublicAttribute($classOrObject, $attributeName));
+    }
+
+    protected static function extractNonPublicAttribute($actualClassOrObject, string $actualAttributeName)
+    {
+        $reflection = new \ReflectionClass($actualClassOrObject);
+        $attribute = $reflection->getProperty($actualAttributeName);
+        $attribute->setAccessible(true);
+        return $attribute->getValue($actualClassOrObject);
+    }
+
+    /**
+     * Returns a mock object which allows for calling protected methods and access
+     * of protected properties.
+     *
+     * @param string $originalClassName Full qualified name of the original class
+     * @param array $methods
+     * @param array $arguments
+     * @param boolean $callOriginalConstructor
+     * @param boolean $callOriginalClone
+     * @param boolean $callAutoload
+     * @return MockObject
+     * @api
+     */
+    protected function getMock($originalClassName, $methods = [], array $arguments = [], $callOriginalConstructor = true, $callOriginalClone = true, $callAutoload = true)
+    {
+        $builder = $this->getMockBuilder($originalClassName)->setMethods($methods)->setConstructorArgs($arguments);
+        if (!$callAutoload) {
+            $builder->disableAutoload();
+        }
+
+        if (!$callOriginalClone) {
+            $builder->disableOriginalClone();
+        }
+
+        if (!$callOriginalConstructor) {
+            $builder->disableOriginalConstructor();
+        }
+
+        return $builder->getMock();
     }
 
     /**
@@ -106,6 +184,19 @@ public function _get($propertyName) {
         return $accessibleClassName;
     }
 
+    protected function setExpectedException(string $class = \Exception::class, string $message = '', int $code = 0)
+    {
+        if ($class) {
+            $this->expectException($class);
+        }
+        if ($message) {
+            $this->expectExceptionMessage($message);
+        }
+        if ($code) {
+            $this->expectExceptionCode($code);
+        }
+    }
+
     /**
      * Injects $dependency into property $name of $target
      *

diff --git a/tests/Functional/BaseConditionalFunctionalTestCase.php b/tests/Functional/BaseConditionalFunctionalTestCase.php
@@ -125,6 +125,8 @@ public function testTemplateCodeFixtureWithCache($sourceOrStream, $expectation,
     {
         if ($this->getCache()) {
             $this->testTemplateCodeFixture($sourceOrStream, $variables, $expected, $notExpected, true);
+        } else {
+            $this->markTestSkipped('Cache-specific test skipped');
         }
     }
 }
diff --git a/tests/Functional/BaseFunctionalTestCase.php b/tests/Functional/BaseFunctionalTestCase.php
@@ -109,14 +109,14 @@ public function testTemplateCodeFixture($source, array $variables, array $expect
         }
         foreach ($expected as $expectedValue) {
             if (is_string($expectedValue) === true) {
-                $this->assertContains($expectedValue, $output);
+                $this->assertStringContainsString($expectedValue, $output);
             } else {
                 $this->assertEquals($expectedValue, $output);
             }
         }
         foreach ($notExpected as $notExpectedValue) {
             if (is_string($notExpectedValue) === true) {
-                $this->assertNotContains($notExpectedValue, $output);
+                $this->assertStringNotContainsString($notExpectedValue, $output);
             } else {
                 $this->assertNotEquals($notExpectedValue, $output);
             }
@@ -146,6 +146,8 @@ public function testTemplateCodeFixtureWithCache($sourceOrStream, array $variabl
         if ($this->getCache()) {
             $this->testTemplateCodeFixture($sourceOrStream, $variables, $expected, $notExpected, $expectedException, true);
             $this->testTemplateCodeFixture($sourceOrStream, $variables, $expected, $notExpected, $expectedException, true);
+        } else {
+            $this->markTestSkipped('Cache-specific test skipped');
         }
     }
 }
diff --git a/tests/Functional/Cases/Rendering/NestedFluidTemplatesWithLayoutTest.php b/tests/Functional/Cases/Rendering/NestedFluidTemplatesWithLayoutTest.php
@@ -79,14 +79,14 @@ public function testTemplateCodeFixture($source, array $variables, array $expect
 
         foreach ($expected as $expectedValue) {
             if (is_string($expectedValue) === true) {
-                $this->assertContains($expectedValue, $output);
+                $this->assertStringContainsString($expectedValue, $output);
             } else {
                 $this->assertEquals($expectedValue, $output);
             }
         }
         foreach ($notExpected as $notExpectedValue) {
             if (is_string($notExpectedValue) === true) {
-                $this->assertNotContains($notExpectedValue, $output);
+                $this->assertStringNotContainsString($notExpectedValue, $output);
             } else {
                 $this->assertNotEquals($notExpectedValue, $output);
             }

diff --git a/tests/Functional/CommandTest.php b/tests/Functional/CommandTest.php
@@ -18,7 +18,7 @@ class CommandTest extends BaseTestCase
     /**
      * @return void
      */
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         vfsStream::setup('fakecache/');
     }
@@ -35,10 +35,10 @@ public function testCommand($argumentString, array $mustContain, array $mustNotC
         $command = sprintf($argumentString, $bin);
         $output = shell_exec($command);
         foreach ($mustContain as $mustContainString) {
-            $this->assertContains($mustContainString, $output);
+            $this->assertStringContainsString($mustContainString, $output);
         }
         foreach ($mustNotContain as $mustNotContainString) {
-            $this->assertNotContains($mustNotContainString, $output);
+            $this->assertStringNotContainsString($mustNotContainString, $output);
         }
     }
 

diff --git a/tests/Functional/ExamplesTest.php b/tests/Functional/ExamplesTest.php
@@ -18,7 +18,7 @@ class ExamplesTest extends BaseTestCase
     /**
      * @return void
      */
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         vfsStream::setup('fakecache/');
     }
@@ -132,8 +132,8 @@ public function getExampleScriptTestValues()
                 [
                     'Expression: $numberten % 4 = 2',
                     'Expression: 4 * $numberten = 40',
-                    'Expression: 4 / $numberten = 0.4',
-                    'Expression: $numberone / $numberten = 0.1',
+                    'Expression: 4 / $numberten = ' . (0.4), // NOTE: concat'ing a float + string LC-casts the float to localized comma/t-sep. Hence, let PHP also cast the expected value.
+                    'Expression: $numberone / $numberten = ' . (0.1), // NOTE: concat'ing a float + string LC-casts the float to localized comma/t-sep. Hence, let PHP also cast the expected value.
                     'Expression: 10 ^ $numberten = 10000000000'
                 ]
             ],

diff --git a/tests/Unit/Core/Cache/FluidCacheWarmupResultTest.php b/tests/Unit/Core/Cache/FluidCacheWarmupResultTest.php
@@ -30,7 +30,7 @@ public function testMerge(array $results, array $expected)
         $result2 = $this->getAccessibleMock(FluidCacheWarmupResult::class, ['dummy']);
         $result2->_set('results', array_pop($results));
         $result1->merge($result2);
-        $this->assertAttributeSame($expected, 'results', $result1);
+        $this->assertEquals($expected, $result1->getResults());
     }
 
     /**
@@ -51,7 +51,7 @@ public function testGetResults()
     {
         $subject = $this->getAccessibleMock(FluidCacheWarmupResult::class, ['dummy']);
         $subject->_set('results', ['foo' => 'bar']);
-        $this->assertAttributeEquals(['foo' => 'bar'], 'results', $subject);
+        $this->assertEquals(['foo' => 'bar'], $subject->getResults());
     }
 
     /**
@@ -64,7 +64,7 @@ public function testAdd(ParsedTemplateInterface $subject, array $expected)
     {
         $result = new FluidCacheWarmupResult();
         $result->add($subject, 'foobar');
-        $this->assertAttributeEquals(['foobar' => $expected], 'results', $result);
+        $this->assertEquals(['foobar' => $expected], $result->getResults());
     }
 
     /**
@@ -77,7 +77,7 @@ public function getAddTestValues()
         )->setMethods(
             ['isCompiled', 'isCompilable', 'hasLayout', 'getIdentifier']
         )->getMockForAbstractClass();
-        $subject1->expects($this->exactly(2))->method('isCompiled')->willReturn(false);
+        $subject1->expects($this->once())->method('isCompiled')->willReturn(false);
         $subject1->expects($this->once())->method('isCompilable')->willReturn(true);
         $subject1->expects($this->once())->method('hasLayout')->willReturn(false);
         $subject1->expects($this->once())->method('getIdentifier')->willReturn('subject1-identifier');
@@ -86,8 +86,8 @@ public function getAddTestValues()
         )->setMethods(
             ['isCompiled', 'isCompilable', 'hasLayout', 'getIdentifier', 'getFailureReason', 'getMitigations']
         )->getMockForAbstractClass();
-        $subject2->expects($this->exactly(2))->method('isCompiled')->willReturn(true);
-        $subject2->expects($this->once())->method('isCompilable')->willReturn(true);
+        $subject2->expects($this->once())->method('isCompiled')->willReturn(true);
+        $subject2->expects($this->never())->method('isCompilable');
         $subject2->expects($this->once())->method('hasLayout')->willReturn(true);
         $subject2->expects($this->once())->method('getIdentifier')->willReturn('subject2-identifier');
         $subject2->expects($this->once())->method('getFailureReason')->willReturn('failure-reason');

diff --git a/tests/Unit/Core/Cache/SimpleFileCacheTest.php b/tests/Unit/Core/Cache/SimpleFileCacheTest.php
@@ -26,7 +26,7 @@ class SimpleFileCacheTest extends UnitTestCase
     /**
      * @return void
      */
-    public function setUp()
+    public function setUp(): void
     {
         $this->directory = vfsStream::setup('cache');
     }

diff --git a/tests/Unit/Core/Compiler/FailedCompilingStateTest.php b/tests/Unit/Core/Compiler/FailedCompilingStateTest.php
@@ -40,8 +40,9 @@ public function testSetter($property, $value)
         $subject = $this->getAccessibleMock(FailedCompilingState::class, ['dummy']);
         $subject->_set($property, $value);
         $method = 'set' . ucfirst($property);
+        $getter = 'get' . ucfirst($property);
         $subject->$method($value);
-        $this->assertAttributeEquals($value, $property, $subject);
+        $this->assertEquals($value, $subject->$getter());
     }
 
     /**
@@ -52,7 +53,7 @@ public function testAddMitigation()
         $subject = $this->getAccessibleMock(FailedCompilingState::class, ['dummy']);
         $subject->_set('mitigations', ['m1']);
         $subject->addMitigation('m2');
-        $this->assertAttributeEquals(['m1', 'm2'], 'mitigations', $subject);
+        $this->assertEquals(['m1', 'm2'], $subject->getMitigations());
     }
 
     /**

diff --git a/tests/Unit/Core/Parser/BooleanParserTest.php b/tests/Unit/Core/Parser/BooleanParserTest.php
@@ -24,7 +24,7 @@ class BooleanParserTest extends UnitTestCase
     /**
      * Setup fixture
      */
-    public function setUp()
+    public function setUp(): void
     {
         $this->renderingContext = new RenderingContextFixture();
     }

diff --git a/tests/Unit/Core/Parser/Interceptor/EscapeTest.php b/tests/Unit/Core/Parser/Interceptor/EscapeTest.php
@@ -22,26 +22,26 @@ class EscapeTest extends UnitTestCase
 {
 
     /**
-     * @var Escape|\PHPUnit_Framework_MockObject_MockObject
+     * @var Escape|\PHPUnit\Framework\MockObject\MockObject
      */
     protected $escapeInterceptor;
 
     /**
-     * @var AbstractViewHelper|\PHPUnit_Framework_MockObject_MockObject
+     * @var AbstractViewHelper|\PHPUnit\Framework\MockObject\MockObject
      */
     protected $mockViewHelper;
 
     /**
-     * @var ViewHelperNode|\PHPUnit_Framework_MockObject_MockObject
+     * @var ViewHelperNode|\PHPUnit\Framework\MockObject\MockObject
      */
     protected $mockNode;
 
     /**
-     * @var ParsingState|\PHPUnit_Framework_MockObject_MockObject
+     * @var ParsingState|\PHPUnit\Framework\MockObject\MockObject
      */
     protected $mockParsingState;
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->escapeInterceptor = $this->getAccessibleMock(Escape::class, ['dummy']);
         $this->mockViewHelper = $this->getMockBuilder(AbstractViewHelper::class)->disableOriginalConstructor()->getMock();