Merge pull request #621 from Chris53897/feature/phpunit-10

Feat: allow phpunit 10
rollbar · Apr 29, 2023 · 3ef7481 · 3ef7481
2 parents 141936e + 6725840
commit 3ef7481
Show file tree

Hide file tree

Showing 18 changed files with 139 additions and 131 deletions.
diff --git a/composer.json b/composer.json
@@ -38,11 +38,11 @@
   },
 
   "require-dev": {
-    "phpunit/phpunit": "^9.6",
+    "phpunit/phpunit": "^9.6 || ^10.1",
     "mockery/mockery": "^1.5.1",
-    "squizlabs/php_codesniffer": "^3.6 || 3.x-dev",
-    "phpmd/phpmd" : "^2",
-    "vimeo/psalm": "^5"
+    "squizlabs/php_codesniffer": "^3.7",
+    "phpmd/phpmd" : "^2.13",
+    "vimeo/psalm": "^5.9"
   },
 
   "suggest": {
@@ -55,7 +55,7 @@
     "test": [
       "phpcs --standard=PSR2 src tests",
       "psalm --long-progress",
-      "phpunit --coverage-clover build/logs/clover.xml --testsuite 'Rollbar Test Suite'"
+      "phpunit --coverage-clover build/logs/clover.xml"
     ],
     "fix": "phpcbf --standard=PSR2 src tests",
     "get-js-snippet": "ROLLBAR_JS_TAG=$(curl -s https://api.github.com/repos/rollbar/rollbar.js/releases/latest | sed -n 's/\"tag_name\":.*\"\\(.*\\)\",/\\1/p' | sed 's/ *//'); curl -X GET https://raw.githubusercontent.com/rollbar/rollbar.js/$ROLLBAR_JS_TAG/dist/rollbar.snippet.js > data/rollbar.snippet.js",

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,30 +1,36 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
-    backupGlobals="false"
-    backupStaticAttributes="false"
-    bootstrap="./tests/bootstrap.php"
-    colors="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
-    stopOnFailure="false">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="./tests/bootstrap.php"
+         colors="true"
+         cacheDirectory=".phpunit.cache"
+         defaultTestSuite="Rollbar Test Suite"
+>
   <testsuites>
     <testsuite name="Rollbar Test Suite">
       <directory suffix=".php">./tests/</directory>
       <exclude>./tests/Performance/</exclude>
+      <exclude>./tests/TestHelpers/</exclude>
+      <exclude>./tests/FakeDataBuilder.php</exclude>
+      <exclude>./tests/bootstrap.php</exclude>
+      <exclude>./tests/BaseRollbarTest.php</exclude>
     </testsuite>
+
     <testsuite name="Rollbar Performance Test Suite">
       <directory suffix=".php">./tests/Performance/</directory>
     </testsuite>
   </testsuites>
-  <coverage processUncoveredFiles="true">
+
+  <coverage/>
+
+  <php>
+    <env name="ROLLBAR_TEST_TOKEN" value="ad865e76e7fb496fab096ac07b1dbabb"/>
+  </php>
+
+  <source>
     <include>
       <directory suffix=".php">./src</directory>
     </include>
-  </coverage>
-  <php>
-    <env name="ROLLBAR_TEST_TOKEN" value="ad865e76e7fb496fab096ac07b1dbabb" />
-  </php>
+  </source>
+
 </phpunit>
diff --git a/tests/BaseRollbarTest.php b/tests/BaseRollbarTest.php
@@ -4,7 +4,6 @@
 
 abstract class BaseRollbarTest extends TestCase
 {
-
     const DEFAULT_ACCESS_TOKEN = 'ad865e76e7fb496fab096ac07b1dbabb';
 
     public function tearDown(): void

diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -202,7 +202,7 @@ public function testVerboseInfo(): void
         ));
 
         $handlerMock = $this->getMockBuilder(ErrorLogHandler::class)
-            ->setMethods(array('handle'))
+            ->onlyMethods(array('handle'))
             ->getMock();
 
         $handlerMock->expects($this->once())->method('handle');
@@ -721,7 +721,7 @@ public function testUseErrorReporting($use_error_reporting, $error_reporting, $e
         }
     }
 
-    public function useErrorReportingProvider(): array
+    public static function useErrorReportingProvider(): array
     {
         return array(
             "use_error_reporting off" => array(
@@ -760,7 +760,7 @@ public function testExceptionSampleRate($exception, $expected): void
         $this->assertEquals($expected, $sampleRate);
     }
 
-    public function providerExceptionSampleRate(): array
+    public static function providerExceptionSampleRate(): array
     {
         return array(
             array(

diff --git a/tests/DataBuilderTest.php b/tests/DataBuilderTest.php
@@ -78,11 +78,11 @@ public function testGetUrl($protoData, $hostData, $portData): void
         $this->assertEquals($expected, $result);
     }
 
-    public function getUrlProvider(): array
+    public static function getUrlProvider(): array
     {
-        $protoData = $this->getUrlProtoProvider();
-        $hostData = $this->getUrlHostProvider();
-        $portData = $this->getUrlPortProvider();
+        $protoData = self::getUrlProtoProvider();
+        $hostData = self::getUrlHostProvider();
+        $portData = self::getUrlPortProvider();
 
         $testData = array();
 
@@ -118,7 +118,7 @@ public function testParseForwardedString($forwaded, $expected): void
         $this->assertEquals($expected, $output);
     }
 
-    public function parseForwardedStringProvider(): array
+    public static function parseForwardedStringProvider(): array
     {
         return array(
             array( // test 1
@@ -182,7 +182,7 @@ public function testGetUrlProto($data, $expected): void
         $_SERVER = $pre_SERVER;
     }
 
-    public function getUrlProtoProvider(): array
+    public static function getUrlProtoProvider(): array
     {
         return array(
             array( // test 1: HTTP_FORWARDED
@@ -237,7 +237,7 @@ public function testGetUrlHost($data, $expected): void
         $this->assertEquals($expected, $output);
     }
 
-    public function getUrlHostProvider(): array
+    public static function getUrlHostProvider(): array
     {
         return array(
             array( // test 1: HTTP_FORWARDED
@@ -311,7 +311,7 @@ public function testGetUrlPort($data, $expected): void
         $this->assertEquals($expected, $output);
     }
 
-    public function getUrlPortProvider(): array
+    public static function getUrlPortProvider(): array
     {
         return array(
             array( // test 1: HTTP_X_FORWARDED
@@ -952,7 +952,7 @@ public function testCaptureErrorStacktracesError(
         $this->assertEquals($expected, count($frames) == 0);
     }
 
-    public function captureErrorStacktracesProvider(): array
+    public static function captureErrorStacktracesProvider(): array
     {
         return array(
             array(false,true),
@@ -1002,7 +1002,7 @@ public function testGetUserIp($ipAddress, $expected, $captureIP): void
         unset($_SERVER['HTTP_X_REAL_IP']);
     }
 
-    public function getUserIpProvider(): array
+    public static function getUserIpProvider(): array
     {
         return array(
             array('127.0.0.1', '127.0.0.1', null),

diff --git a/tests/FakeLog.php b/tests/FakeLog.php
diff --git a/tests/Handlers/ErrorHandlerTest.php b/tests/Handlers/ErrorHandlerTest.php
@@ -42,7 +42,7 @@ public function testRegister(): void
     {
         $handler = $this->getMockBuilder(ErrorHandler::class)
                         ->setConstructorArgs(array(new RollbarLogger(self::$simpleConfig)))
-                        ->setMethods(array('handle'))
+                        ->onlyMethods(array('handle'))
                         ->getMock();
 
         $handler->expects($this->once())
@@ -57,7 +57,7 @@ public function testHandle(): void
     {
         $logger = $this->getMockBuilder(RollbarLogger::class)
                         ->setConstructorArgs(array(self::$simpleConfig))
-                        ->setMethods(array('report'))
+                        ->onlyMethods(array('report'))
                         ->getMock();
 
         $logger->expects($this->once())

diff --git a/tests/Handlers/ExceptionHandlerTest.php b/tests/Handlers/ExceptionHandlerTest.php
@@ -49,7 +49,7 @@ public function testSetup(): void
     {
         $handler = $this->getMockBuilder(ExceptionHandler::class)
                         ->setConstructorArgs(array(new RollbarLogger(self::$simpleConfig)))
-                        ->setMethods(array('handle'))
+                        ->onlyMethods(array('handle'))
                         ->getMock();
 
         $handler->expects($this->once())
@@ -73,7 +73,7 @@ public function testHandle(): void
 
         $logger = $this->getMockBuilder(RollbarLogger::class)
                         ->setConstructorArgs(array(self::$simpleConfig))
-                        ->setMethods(array('report'))
+                        ->onlyMethods(array('report'))
                         ->getMock();
 
         $logger->expects($this->once())

diff --git a/tests/JsHelperTest.php b/tests/JsHelperTest.php
@@ -2,20 +2,27 @@
 
 class JsHelperTest extends BaseRollbarTest
 {
-    protected RollbarJsHelper $jsHelper;
-    protected string|false $testSnippetPath;
+    protected static RollbarJsHelper $jsHelper;
+    protected static string|false $testSnippetPath = "";
 
     public function setUp(): void
     {
-        $this->jsHelper = new RollbarJsHelper(array());
-        $this->testSnippetPath = realpath(__DIR__ . "/../data/rollbar.snippet.js");
+        self::$jsHelper = new RollbarJsHelper(array());
+        self::$testSnippetPath = realpath(__DIR__ . "/../data/rollbar.snippet.js");
     }
-
+
+    # TODO this is needed for phpUnit 10 as all Generators needs to be static
+    public static function init(): void
+    {
+        self::$jsHelper = new RollbarJsHelper(array());
+        self::$testSnippetPath = realpath(__DIR__ . "/../data/rollbar.snippet.js");
+    }
+
     public function testSnippetPath(): void
     {
         $this->assertEquals(
-            $this->testSnippetPath,
-            $this->jsHelper->snippetPath()
+            self::$testSnippetPath,
+            self::$jsHelper->snippetPath()
         );
     }
 
@@ -40,7 +47,7 @@ public function testShouldAddJs($setup, $expected): void
         $this->assertEquals($expected, $mock->shouldAddJs($status, array()));
     }
 
-    public function shouldAddJsProvider(): array
+    public static function shouldAddJsProvider(): array
     {
         return array(
             array(
@@ -85,11 +92,11 @@ public function testIsHtml($headers, $expected): void
     {
         $this->assertEquals(
             $expected,
-            $this->jsHelper->isHtml($headers)
+            self::$jsHelper->isHtml($headers)
         );
     }
 
-    public function isHtmlProvider(): array
+    public static function isHtmlProvider(): array
     {
         return array(
             array(
@@ -114,11 +121,11 @@ public function testHasAttachment($headers, $expected): void
     {
         $this->assertEquals(
             $expected,
-            $this->jsHelper->hasAttachment($headers)
+            self::$jsHelper->hasAttachment($headers)
         );
     }
 
-    public function hasAttachmentProvider(): array
+    public static function hasAttachmentProvider(): array
     {
         return array(
             array(
@@ -137,9 +144,9 @@ public function hasAttachmentProvider(): array
 
     public function testJsSnippet(): void
     {
-        $expected = file_get_contents($this->testSnippetPath);
+        $expected = file_get_contents(self::$testSnippetPath);
 
-        $this->assertEquals($expected, $this->jsHelper->jsSnippet());
+        $this->assertEquals($expected, self::$jsHelper->jsSnippet());
     }
 
     /**
@@ -149,11 +156,11 @@ public function testShouldAppendNonce($headers, $expected): void
     {
         $this->assertEquals(
             $expected,
-            $this->jsHelper->shouldAppendNonce($headers)
+            self::$jsHelper->shouldAppendNonce($headers)
         );
     }
 
-    public function shouldAppendNonceProvider(): array
+    public static function shouldAppendNonceProvider(): array
     {
         return array(
             array(
@@ -184,21 +191,21 @@ public function testScriptTag($content, $headers, $nonce, $expected): void
     {
         if ($expected === 'Exception') {
             try {
-                $result = $this->jsHelper->scriptTag($content, $headers, $nonce);
+                $result = self::$jsHelper->scriptTag($content, $headers, $nonce);
 
                 $this->fail();
             } catch (\Exception $e) {
                 $this->assertTrue(true);
                 return;
             }
         } else {
-            $result = $this->jsHelper->scriptTag($content, $headers, $nonce);
+            $result = self::$jsHelper->scriptTag($content, $headers, $nonce);
 
             $this->assertEquals($expected, $result);
         }
     }
 
-    public function scriptTagProvider(): array
+    public static function scriptTagProvider(): array
     {
         return array(
             'nonce script' => array(
@@ -239,7 +246,7 @@ public function testConfigJsTag($config, $expectedJson): void
         $this->assertEquals($expected, $result);
     }
 
-    public function configJsTagProvider()
+    public static function configJsTagProvider(): array
     {
         return array(
             array(array(), '{}'),
@@ -254,7 +261,7 @@ public function configJsTagProvider()
     /**
      * @dataProvider addJsProvider
      */
-    public function testBuildJs($config, $headers, $nonce, $expected): void
+    public static function testBuildJs($config, $headers, $nonce, $expected): void
     {
         $result = RollbarJsHelper::buildJs(
             $config,
@@ -263,7 +270,7 @@ public function testBuildJs($config, $headers, $nonce, $expected): void
             "var customJs = true;"
         );
 
-        $this->assertEquals($expected, $result);
+        self::assertEquals($expected, $result);
     }
 
     /**
@@ -281,11 +288,13 @@ public function testAddJs($config, $headers, $nonce, $expected): void
 
         $this->assertEquals($expected, $result);
     }
-
-    public function addJsProvider(): array
+
+    # TODO this is needed for phpUnit 10 as all Generators needs to be static
+    public static function addJsProvider(): array
     {
-        $this->setUp();
-        $expectedJs = file_get_contents($this->testSnippetPath);
+        self::init();
+        $expectedJs = file_get_contents(self::$testSnippetPath);
+
         return array(
             array(
                 array(), // 'config'
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,6 @@ @@
     abstract class BaseRollbarTest extends TestCase
     {
         const DEFAULT_ACCESS_TOKEN = 'ad865e76e7fb496fab096ac07b1dbabb';
         public function tearDown(): void
@@ Expand Down @@