Merge pull request #31 from Codeception/fix_tests

Update to PHP 8.2, Codeception 5 and static analysis

Author: TavoNiievez

.github/workflows/main.yml

@@ -8,23 +8,30 @@ jobs:
 
     strategy:
       matrix:
-        php: [8.1, 8.2, 8.3, 8.4]
+        php: [8.2, 8.3, 8.4]
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: ${{ matrix.php }}
-        coverage: none
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+          tools: phpstan, phpcs
 
-    - name: Validate composer.json and composer.lock
-      run: composer validate
+      - name: Validate composer.json and composer.lock
+        run: composer validate
 
-    - name: Install dependencies
-      run: composer install --prefer-dist --no-progress --no-interaction --no-suggest
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-interaction --no-suggest
 
-    - name: Run test suite
-      run: php vendor/bin/codecept run
+      - name: Run PHPStan
+        run: phpstan analyse src
+
+      - name: Run PHPCS
+        run: phpcs --standard=PSR12 src
+
+      - name: Run test suite
+        run: php vendor/bin/codecept run

codeception.yml

@@ -1,7 +1,12 @@
+namespace: Tests
+support_namespace: Support
+
+settings:
+    shuffle: true
+    lint: true
 paths:
     tests: tests
     output: tests/_output
-    data: tests/_data
-    support: tests/_support
-    envs: tests/_envs
-actor_suffix: Tester
+    support: tests/Support
+    data: tests/Support/Data
+     

composer.json

@@ -22,7 +22,7 @@
     ],
     "homepage": "https://codeception.com/",
     "require": {
-        "php": "^8.1",
+        "php": "^8.2",
         "codeception/codeception": "*@dev",
         "codeception/lib-asserts": "^2.2"
     },

readme.md

@@ -9,7 +9,7 @@ A Codeception module containing various assertions.
 
 ## Requirements
 
-* `PHP 8.1` or higher.
+* `PHP 8.2` or higher.
 
 ## Installation
 

src/Codeception/Module/AbstractAsserts.php

@@ -147,4 +147,4 @@ abstract class AbstractAsserts extends Module
         markTestIncomplete as public;
         markTestSkipped as public;
     }
-}
+}

src/Codeception/Module/Asserts.php

@@ -4,6 +4,10 @@
 
 namespace Codeception\Module;
 
+use Throwable;
+
+use function get_debug_type;
+
 /**
  * Special module for using asserts in your tests.
  */
@@ -23,6 +27,7 @@ class Asserts extends AbstractAsserts
      *     $this->doSomethingBad();
      * });
      * ```
+     *
      * If you want to check message or throwable code, you can pass them with throwable instance:
      * ```php
      * <?php
@@ -31,15 +36,13 @@ class Asserts extends AbstractAsserts
      *     $this->doSomethingBad();
      * });
      * ```
-     *
-     * @param \Throwable|string $throwable
      */
-    public function expectThrowable($throwable, callable $callback): void
+    public function expectThrowable(string|Throwable $throwable, callable $callback): void
     {
         if (is_object($throwable)) {
             $class = get_class($throwable);
             $msg = $throwable->getMessage();
-            $code = $throwable->getCode();
+            $code = (int) $throwable->getCode();
         } else {
             $class = $throwable;
             $msg = null;
@@ -48,7 +51,7 @@ public function expectThrowable($throwable, callable $callback): void
 
         try {
             $callback();
-        } catch (\Throwable $t) {
+        } catch (Throwable $t) {
             $this->checkThrowable($t, $class, $msg, $code);
             return;
         }
@@ -60,13 +63,17 @@ public function expectThrowable($throwable, callable $callback): void
      * Check if the given throwable matches the expected data,
      * fail (throws an exception) if it does not.
      */
-    protected function checkThrowable(\Throwable $throwable, string $expectedClass, ?string $expectedMsg, $expectedCode = null): void
-    {
+    protected function checkThrowable(
+        Throwable $throwable,
+        string $expectedClass,
+        ?string $expectedMsg,
+        int|null $expectedCode = null
+    ): void {
         if (!($throwable instanceof $expectedClass)) {
             $this->fail(sprintf(
                 "Exception of class '%s' expected to be thrown, but class '%s' was caught",
                 $expectedClass,
-                get_class($throwable)
+                get_debug_type($throwable)
             ));
         }
 

tests/_data/DummyClass.php renamed to tests/Support/Data/DummyClass.php

@@ -2,9 +2,11 @@
 
 declare(strict_types=1);
 
+namespace Support\Data;
+
 class DummyClass
 {
     private int $foo;
-    
+
     private static int $staticFoo;
 }

tests/_data/data1.json renamed to tests/Support/Data/data1.json

@@ -1,26 +1,29 @@
 <?php
 
+declare(strict_types=1);
+
+namespace Tests\Support;
 
 /**
  * Inherited Methods
- * @method void wantToTest($text)
  * @method void wantTo($text)
+ * @method void wantToTest($text)
  * @method void execute($callable)
  * @method void expectTo($prediction)
  * @method void expect($prediction)
  * @method void amGoingTo($argumentation)
  * @method void am($role)
  * @method void lookForwardTo($achieveValue)
  * @method void comment($description)
- * @method void pause()
+ * @method void pause($vars = [])
  *
  * @SuppressWarnings(PHPMD)
 */
 class UnitTester extends \Codeception\Actor
 {
     use _generated\UnitTesterActions;
 
-   /**
-    * Define custom actions here
-    */
+    /**
+     * Define custom actions here
+     */
 }

tests/_data/data1.txt renamed to tests/Support/Data/data1.txt

@@ -0,0 +1,2 @@
+*
+!.gitignore

tests/_data/data1.xml renamed to tests/Support/Data/data1.xml

@@ -1,5 +1,4 @@
-# Codeception Test Suite Configuration
-
-# suite for unit (internal) tests.
-error_level: "E_ALL"
-class_name: UnitTester
+actor: UnitTester
+suite_namespace: Tests\Unit
+modules:
+    enabled: []

tests/_data/data2.json renamed to tests/Support/Data/data2.json

@@ -12,7 +12,9 @@
 use PHPUnit\Framework\AssertionFailedError;
 use PHPUnit\Framework\Constraint\IsEqual;
 use PHPUnit\Framework\IncompleteTestError;
+use PHPUnit\Framework\SkippedTestError;
 use PHPUnit\Framework\SkippedWithMessageException;
+use PHPUnit\Runner\Version as PHPUnitVersion;
 use RuntimeException;
 use stdClass;
 
@@ -46,14 +48,14 @@ public function testPHPUnitAsserts()
     {
         $this->module->assertArrayHasKey('one', ['one' => 1, 'two' => 2]);
         $this->module->assertArrayNotHasKey('three', ['one' => 1, 'two' => 2]);
-        $this->module->assertClassHasAttribute('foo', \DummyClass::class);
-        $this->module->assertClassHasStaticAttribute('staticFoo', \DummyClass::class);
-        $this->module->assertClassNotHasAttribute('bar', \DummyClass::class);
-        $this->module->assertClassNotHasStaticAttribute('staticBar', \DummyClass::class);
+        $this->module->assertClassHasAttribute('foo', \Support\Data\DummyClass::class);
+        $this->module->assertClassHasStaticAttribute('staticFoo', \Support\Data\DummyClass::class);
+        $this->module->assertClassNotHasAttribute('bar', \Support\Data\DummyClass::class);
+        $this->module->assertClassNotHasStaticAttribute('staticBar', \Support\Data\DummyClass::class);
         $this->module->assertContains(1, [1, 2]);
         $this->module->assertContainsEquals(2, [1, 2]);
-        $this->module->assertContainsOnly(\DummyClass::class, [new \DummyClass(), new \DummyClass()]);
-        $this->module->assertContainsOnlyInstancesOf(\DummyClass::class, [new \DummyClass(), new \DummyClass()]);
+        $this->module->assertContainsOnly(\Support\Data\DummyClass::class, [new \Support\Data\DummyClass(), new \Support\Data\DummyClass()]);
+        $this->module->assertContainsOnlyInstancesOf(\Support\Data\DummyClass::class, [new \Support\Data\DummyClass(), new \Support\Data\DummyClass()]);
         $this->module->assertCount(3, [1, 2, 3]);
         $this->module->assertDirectoryDoesNotExist(__DIR__.'notExist');
         $this->module->assertDirectoryExists(__DIR__);
@@ -130,7 +132,7 @@ public function testPHPUnitAsserts()
         $this->module->assertNan(sqrt(-1));
         $this->module->assertNotContains('three', ['one', 'two']);
         $this->module->assertNotContainsEquals(3, [1, 2]);
-        $this->module->assertNotContainsOnly(\DummyClass::class, [new \DummyClass(), new Exception()]);
+        $this->module->assertNotContainsOnly(\Support\Data\DummyClass::class, [new \Support\Data\DummyClass(), new Exception()]);
         $this->module->assertNotCount(1, ['one', 'two']);
         $this->module->assertNotEmpty([1]);
         $this->module->assertNotEquals(true, false);
@@ -150,8 +152,8 @@ public function testPHPUnitAsserts()
         $this->module->assertNotTrue(null);
         $this->module->assertNotTrue('foo');
         $this->module->assertNull(null);
-        $this->module->assertObjectHasAttribute('foo', new \DummyClass());
-        $this->module->assertObjectNotHasAttribute('bar', new \DummyClass());
+        $this->module->assertObjectHasAttribute('foo', new \Support\Data\DummyClass());
+        $this->module->assertObjectNotHasAttribute('bar', new \Support\Data\DummyClass());
         $this->module->assertSame(1, 1);
         $this->module->assertSameSize([1, 2, 3], [1, 2, 3]);
         $this->module->assertStringContainsString('bar', 'foobar');
@@ -280,8 +282,12 @@ public function testMarkTestIncomplete()
 
     public function testMarkTestSkipped()
     {
-        $this->expectException(SkippedWithMessageException::class);
         $this->expectExceptionMessage('foobar');
+        if (PHPUnitVersion::series() < 10) {
+            $this->expectException(SkippedTestError::class);
+        } else {
+            $this->expectException(SkippedWithMessageException::class);
+        }
 
         $this->module->markTestSkipped('foobar');
     }