Merge pull request #84 from mirko-pagliai/develop

Develop

Author: mirko-pagliai

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ['7.2', '7.3', '7.4', '8.0']
+        php-version: ['7.2', '7.3', '7.4', '8.0', '8.1']
         db-type: [sqlite, mysql, pgsql]
         prefer-lowest: ['']
         exclude:
@@ -39,6 +39,9 @@ jobs:
           - php-version: '8.0'
             db-type: 'mysql'
             prefer-lowest: 'prefer-lowest'
+          - php-version: '8.1'
+            db-type: 'mysql'
+            prefer-lowest: 'prefer-lowest'
 
     steps:
         - name: Setup Database
@@ -49,7 +52,7 @@ jobs:
                 docker run --rm --name=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=test -p 5432:5432 -d postgres:9.6
             fi
 
-        - uses: actions/checkout@v2
+        - uses: actions/checkout@v3
 
         - name: Validate composer.json and composer.lock
           run: composer validate --strict
@@ -95,21 +98,21 @@ jobs:
             if [[ ${{ matrix.db-type }} == 'pgsql' ]]; then export db_dsn='postgres://postgres:postgres@127.0.0.1/test'; fi
 
             if [[ ${{ matrix.php-version }} == '8.0' ]]; then
-              export CODECOVERAGE=1 && vendor/bin/phpunit --verbose --coverage-clover=coverage.xml
+             export XDEBUG_MODE=coverage && vendor/bin/phpunit --verbose --coverage-clover=coverage.xml
             else
               vendor/bin/phpunit
             fi
 
         - name: Submit code coverage
           if: matrix.php-version == '8.0'
-          uses: codecov/codecov-action@v1
+          uses: codecov/codecov-action@v2
 
   cs-stan:
     name: Coding Standard & Static Analysis
     runs-on: ubuntu-latest
 
     steps:
-        - uses: actions/checkout@v2
+        - uses: actions/checkout@v3
 
         - name: Setup PHP
           uses: shivammathur/setup-php@v2
@@ -118,17 +121,11 @@ jobs:
             coverage: none
             tools: cs2pr
 
-        - name: Cache Composer packages
-          id: composer-cache
-          uses: actions/cache@v2
-          with:
-            path: vendor
-            key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
-            restore-keys: |
-              ${{ runner.os }}-php-
-
         - name: Composer install
-          run: composer stan-setup
+          run: composer update
+
+        - name: Composer show
+          run: composer show
 
         - name: Run PHP CodeSniffer
           continue-on-error: true
@@ -139,7 +136,7 @@ jobs:
 
         - name: Run psalm
           if: success() || failure()
-          run: vendor/bin/psalm.phar --output-format=github
+          run: vendor/bin/psalm.phar --output-format=github --php-version=8.0
 
         - name: Run phpstan
           if: success() || failure()
@@ -155,7 +152,7 @@ jobs:
       PHP_VERSION: '7.4'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2

CHANGELOG.md

@@ -1,5 +1,9 @@
 # 2.x branch
 ## 2.10 branch
+### 2.10.2
+* added tests for PHP 8.1;
+* little fixes for phpstan, psalm and for the composer.json file.
+
 ### 2.10.1
 * stable version;
 * updated for `php-tools` 1.5.8.

composer.json

@@ -18,7 +18,9 @@
     "require-dev": {
         "cakephp/cakephp-codesniffer": "^4.4",
         "mirko-pagliai/me-tools": "^2.19.8",
-        "phpunit/phpunit": "^8.5.14|^9.0"
+        "phpunit/phpunit": "^8.5.23|^9.1|^9.5",
+        "phpstan/phpstan": "^1.7",
+        "psalm/phar": "^4.24"
     },
     "autoload": {
         "psr-4": {
@@ -46,13 +48,16 @@
         "test": "rm -f -r /tmp/cake* && phpunit && driver_test=sqlite phpunit && driver_test=postgres phpunit",
         "coverage": "XDEBUG_MODE=coverage phpunit --coverage-html=coverage",
         "phpstan": "phpstan.phar analyse",
-        "psalm": "psalm.phar",
+        "psalm": "psalm.phar --php-version=8.0",
         "stan": [
-            "@stan-setup",
             "@phpstan",
             "@psalm"
         ],
-        "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan:^0.12 psalm/phar:\"^3.18|^4\" && mv composer.backup composer.json",
         "update-lowest": "@composer update --prefer-lowest"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     }
 }

phpstan-baseline.neon

@@ -11,9 +11,9 @@ parameters:
 			path: src/TestSuite/TestCase.php
 
 		-
-			message: "#^Parameter \\#1 \\$callback of function array_map expects \\(callable\\(\\)\\: mixed\\)\\|null, 'self\\:\\:delete' given\\.$#"
-			count: 2
-			path: src/Utility/BackupManager.php
+			message: "#^Property DatabaseBackup\\\\Test\\\\TestCase\\\\BackupTraitTest\\:\\:\\$Trait has no type specified\\.$#"
+			count: 1
+			path: tests/TestCase/BackupTraitTest.php
 
 		-
 			message: "#^Ternary operator condition is always true\\.$#"
@@ -25,3 +25,8 @@ parameters:
 			count: 2
 			path: tests/TestCase/Utility/BackupImportTest.php
 
+		-
+			message: "#^Ternary operator condition is always true\\.$#"
+			count: 2
+			path: tests/TestCase/Utility/BackupManagerTest.php
+

phpstan.neon

@@ -16,5 +16,5 @@ parameters:
     checkMissingIterableValueType: false
     treatPhpDocTypesAsCertain: false
 
-    excludes_analyse:
+    excludePaths:
         -  tests/test_app/

src/BackupTrait.php

@@ -72,6 +72,7 @@ public static function getDriver(?ConnectionInterface $connection = null): Drive
     {
         $connection = $connection ?: self::getConnection();
         $name = self::getDriverName($connection);
+        /** @var class-string<\DatabaseBackup\Driver\Driver> $Driver */
         $Driver = App::classname('DatabaseBackup.' . $name, 'Driver');
         Exceptionist::isTrue($Driver, __d('database_backup', 'The `{0}` driver does not exist', $name), InvalidArgumentException::class);
 

src/TestSuite/DriverTestCase.php

@@ -55,7 +55,7 @@ abstract class DriverTestCase extends TestCase
     protected $connection;
 
     /**
-     * @var array
+     * @var array<string>
      */
     public $fixtures = [
         'core.Articles',

src/TestSuite/TestCase.php

@@ -19,14 +19,12 @@
 use DatabaseBackup\Utility\BackupExport;
 use DatabaseBackup\Utility\BackupManager;
 use MeTools\TestSuite\TestCase as BaseTestCase;
-use Tools\TestSuite\BackwardCompatibilityTrait;
 
 /**
  * TestCase class
  */
 abstract class TestCase extends BaseTestCase
 {
-    use BackwardCompatibilityTrait;
     use BackupTrait;
 
     /**

src/Utility/BackupManager.php

@@ -59,7 +59,7 @@ public static function delete(string $filename): string
      */
     public static function deleteAll(): array
     {
-        return array_map('self::delete', self::index()->extract('filename')->toList());
+        return array_map([__CLASS__, 'delete'], self::index()->extract('filename')->toList());
     }
 
     /**
@@ -97,7 +97,7 @@ public static function rotate(int $rotate): array
     {
         Exceptionist::isPositive($rotate, __d('database_backup', 'Invalid rotate value'), InvalidArgumentException::class);
         $backupsToBeDeleted = self::index()->skip($rotate);
-        array_map('self::delete', $backupsToBeDeleted->extract('filename')->toList());
+        array_map([__CLASS__, 'delete'], $backupsToBeDeleted->extract('filename')->toList());
 
         return $backupsToBeDeleted->toList();
     }

tests/TestCase/BackupTraitTest.php

@@ -29,26 +29,40 @@
  */
 class BackupTraitTest extends TestCase
 {
-    use BackupTrait;
+    /**
+     * @psalm-var trait-string<\DatabaseBackup\BackupTrait>
+     */
+    protected $Trait;
 
     /**
      * Fixtures
-     * @var array
+     * @var array<string>
      */
     public $fixtures = [
         'core.Articles',
         'core.Comments',
     ];
 
+    /**
+     * Called before every test method
+     * @return void
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->Trait = $this->Trait ?: $this->getMockForTrait(BackupTrait::class);
+    }
+
     /**
      * Test for `getAbsolutePath()` method
      * @test
      */
     public function testGetAbsolutePath(): void
     {
         $expected = Configure::read('DatabaseBackup.target') . DS . 'file.txt';
-        $this->assertEquals($expected, $this->getAbsolutePath('file.txt'));
-        $this->assertEquals($expected, $this->getAbsolutePath(Configure::read('DatabaseBackup.target') . DS . 'file.txt'));
+        $this->assertEquals($expected, $this->Trait->getAbsolutePath('file.txt'));
+        $this->assertEquals($expected, $this->Trait->getAbsolutePath(Configure::read('DatabaseBackup.target') . DS . 'file.txt'));
     }
 
     /**
@@ -65,7 +79,7 @@ public function testGetCompression(): void
             'backup.sql.gz' => 'gzip',
             'text.txt' => null,
         ] as $filename => $expectedCompression) {
-            $this->assertEquals($expectedCompression, $this->getCompression($filename));
+            $this->assertEquals($expectedCompression, $this->Trait->getCompression($filename));
         }
     }
 
@@ -76,13 +90,13 @@ public function testGetCompression(): void
     public function testGetConnection(): void
     {
         foreach ([null, Configure::read('DatabaseBackup.connection')] as $name) {
-            $connection = $this->getConnection($name);
+            $connection = $this->Trait->getConnection($name);
             $this->assertInstanceof(Connection::class, $connection);
             $this->assertEquals('test', $connection->config()['name']);
         }
 
         ConnectionManager::setConfig('fake', ['url' => 'mysql://root:password@localhost/my_database']);
-        $connection = $this->getConnection('fake');
+        $connection = $this->Trait->getConnection('fake');
         $this->assertInstanceof(Connection::class, $connection);
         $this->assertEquals('fake', $connection->config()['name']);
 
@@ -98,18 +112,18 @@ public function testGetConnection(): void
     public function testGetDriver(): void
     {
         foreach ([ConnectionManager::get('test'), null] as $driver) {
-            $this->assertInstanceof(Driver::class, $this->getDriver($driver));
+            $this->assertInstanceof(Driver::class, $this->Trait->getDriver($driver));
         }
 
         //With a no existing driver
         $connection = $this->getMockBuilder(Connection::class)
-            ->setMethods(['__debuginfo', 'getDriver'])
+            ->onlyMethods(['__debuginfo', 'getDriver'])
             ->disableOriginalConstructor()
             ->getMock();
         $connection->method('getDriver')->will($this->returnValue(new Sqlserver()));
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('The `Sqlserver` driver does not exist');
-        $this->getDriver($connection);
+        $this->Trait->getDriver($connection);
     }
 
     /**
@@ -131,7 +145,7 @@ public function testGetExtension(): void
             'text' => null,
             '.txt' => null,
         ] as $filename => $expectedExtension) {
-            $this->assertEquals($expectedExtension, $this->getExtension($filename));
+            $this->assertEquals($expectedExtension, $this->Trait->getExtension($filename));
         }
     }
 
@@ -141,6 +155,6 @@ public function testGetExtension(): void
      */
     public function testGetValidCompressions(): void
     {
-        $this->assertNotEmpty($this->getValidCompressions());
+        $this->assertNotEmpty($this->Trait->getValidCompressions());
     }
 }