PHPStan 1.5, Doctrine Coding Standard 9 (#1248)

derrabus · web-flow · commit f9b4c8032276 · 2022-04-01T08:38:22.000+02:00
diff --git a/composer.json b/composer.json
@@ -36,16 +36,16 @@
     },
     "require-dev": {
         "ext-pdo_sqlite": "*",
-        "doctrine/coding-standard": "^8.0",
+        "doctrine/coding-standard": "^9",
         "doctrine/orm": "^2.6",
         "doctrine/persistence": "^1.3 || ^2.0",
         "doctrine/sql-formatter": "^1.0",
         "ergebnis/composer-normalize": "^2.9",
-        "phpstan/phpstan": "^0.12",
-        "phpstan/phpstan-deprecation-rules": "^0.12",
-        "phpstan/phpstan-phpunit": "^0.12",
-        "phpstan/phpstan-strict-rules": "^0.12",
-        "phpstan/phpstan-symfony": "^0.12",
+        "phpstan/phpstan": "^1.5",
+        "phpstan/phpstan-deprecation-rules": "^1",
+        "phpstan/phpstan-phpunit": "^1.1",
+        "phpstan/phpstan-strict-rules": "^1.1",
+        "phpstan/phpstan-symfony": "^1.1",
         "phpunit/phpunit": "^8.5 || ^9.4",
         "symfony/cache": "^3.4.26 || ^4.2.12 || ^5.0 || ^6.0",
         "symfony/process": "^3.4 || ^4.0 || ^5.0 || ^6.0",
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/CurrentCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/CurrentCommand.php
@@ -15,7 +15,7 @@
  */
 final class CurrentCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:current';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/DiffCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/DiffCommand.php
@@ -31,7 +31,7 @@
  */
 final class DiffCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:diff';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/DumpSchemaCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/DumpSchemaCommand.php
@@ -27,7 +27,7 @@
  */
 final class DumpSchemaCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:dump-schema';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/ExecuteCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/ExecuteCommand.php
@@ -25,7 +25,7 @@
  */
 final class ExecuteCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:execute';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/GenerateCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/GenerateCommand.php
@@ -19,7 +19,7 @@
  */
 final class GenerateCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:generate';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/LatestCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/LatestCommand.php
@@ -15,7 +15,7 @@
  */
 final class LatestCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:latest';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/ListCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/ListCommand.php
@@ -22,7 +22,7 @@
  */
 final class ListCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:list';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/MigrateCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/MigrateCommand.php
@@ -30,7 +30,7 @@
  */
 final class MigrateCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:migrate';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/RollupCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/RollupCommand.php
@@ -15,7 +15,7 @@
  */
 final class RollupCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:rollup';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/StatusCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/StatusCommand.php
@@ -13,7 +13,7 @@
  */
 final class StatusCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:status';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/SyncMetadataCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/SyncMetadataCommand.php
@@ -9,7 +9,7 @@
 
 final class SyncMetadataCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:sync-metadata-storage';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/UpToDateCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/UpToDateCommand.php
@@ -26,7 +26,7 @@
  */
 final class UpToDateCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:up-to-date';
 
     protected function configure(): void
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/VersionCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/VersionCommand.php
@@ -25,7 +25,7 @@
  */
 final class VersionCommand extends DoctrineCommand
 {
-    /** @var string */
+    /** @var string|null */
     protected static $defaultName = 'migrations:version';
 
     /** @var bool */
diff --git a/phpstan-common.neon.dist b/phpstan-common.neon.dist
@@ -24,6 +24,8 @@ parameters:
             message: '~^Method Doctrine\\Migrations\\Tests\\Stub\\DoctrineRegistry::getService\(\) should return Doctrine\\Persistence\\ObjectManager but returns Doctrine\\DBAL\\Connection\|Doctrine\\ORM\\EntityManager~'
             path: tests/Doctrine/Migrations/Tests/Stub/DoctrineRegistry.php
 
+        - '~^Property Doctrine\\Migrations\\Tests\\Provider\\\w+::\$id is never written, only read\.$~'
+
         # https://github.com/phpstan/phpstan/issues/5982
         -
             message: '~^Cannot call method getWrappedConnection\(\) on class-string\|object\.~'
@@ -35,6 +37,11 @@ parameters:
             paths:
                 - tests/Doctrine/Migrations/Tests/Generator/ClassNameGeneratorTest.php
 
+        # TODO: Be more precise about class-strings
+        -
+            message: '~^Method Doctrine\\Migrations\\Version\\DbalMigrationFactory::createVersion\(\) should return Doctrine\\Migrations\\AbstractMigration but returns object\.$~'
+            paths:
+                - lib/Doctrine/Migrations/Version/DbalMigrationFactory.php
 
     symfony:
             console_application_loader: %currentWorkingDirectory%/tests/Doctrine/Migrations/Tests/doctrine-migrations-phpstan-app.php
diff --git a/phpstan-dbal-2.neon.dist b/phpstan-dbal-2.neon.dist
@@ -35,3 +35,8 @@ parameters:
                 - tests/Doctrine/Migrations/Tests/SchemaDumperTest.php
 
         - '~Trying to mock an undefined method getNativeConnection\(\) on class Doctrine\\DBAL\\Connection~'
+
+        -
+            message: '~^Expression on left side of \?\? is not nullable\.$~'
+            paths:
+                - lib/Doctrine/Migrations/Tools/Console/Command/RollupCommand.php
diff --git a/tests/Doctrine/Migrations/Tests/Event/Listeners/AutoCommitListenerTest.php b/tests/Doctrine/Migrations/Tests/Event/Listeners/AutoCommitListenerTest.php
@@ -52,7 +52,7 @@ public function testListenerDoesFinalCommitWhenAutoCommitIsOff(): void
 
     protected function setUp(): void
     {
-        $this->conn       = $this->createStub(Connection::class);
+        $this->conn       = $this->createMock(Connection::class);
         $driverConnection = $this->createStub(DriverConnection::class);
         $this->conn->method('getWrappedConnection')->willReturn($driverConnection);
 
diff --git a/tests/Doctrine/Migrations/Tests/Tools/Console/Command/DiffCommandTest.php b/tests/Doctrine/Migrations/Tests/Tools/Console/Command/DiffCommandTest.php
@@ -144,8 +144,8 @@ public function testExecutedUnavailableMigrationsCancel(): void
 
     protected function setUp(): void
     {
-        $this->migrationDiffGenerator    = $this->createStub(DiffGenerator::class);
-        $this->migrationStatusCalculator = $this->createStub(MigrationStatusCalculator::class);
+        $this->migrationDiffGenerator    = $this->createMock(DiffGenerator::class);
+        $this->migrationStatusCalculator = $this->createMock(MigrationStatusCalculator::class);
         $this->configuration             = new Configuration();
         $this->configuration->addMigrationsDirectory('FooNs', sys_get_temp_dir());
 
diff --git a/tests/Doctrine/Migrations/Tests/Tools/Console/Command/MigrateCommandTest.php b/tests/Doctrine/Migrations/Tests/Tools/Console/Command/MigrateCommandTest.php
@@ -374,8 +374,9 @@ public function testExecuteMigrateDown(): void
     }
 
     /**
-     * @dataProvider allOrNothing
      * @psalm-param array<string, bool> $input
+     *
+     * @dataProvider allOrNothing
      */
     public function testExecuteMigrateAllOrNothing(bool $default, array $input, bool $expected): void
     {

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`*/`
`16`	`16`	`final class CurrentCommand extends DoctrineCommand`
`17`	`17`	`{`
`18`		`- /** @var string */`
	`18`	`+ /** @var string\|null */`
`19`	`19`	`protected static $defaultName = 'migrations:current';`
`20`	`20`
`21`	`21`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`*/`
`32`	`32`	`final class DiffCommand extends DoctrineCommand`
`33`	`33`	`{`
`34`		`- /** @var string */`
	`34`	`+ /** @var string\|null */`
`35`	`35`	`protected static $defaultName = 'migrations:diff';`
`36`	`36`
`37`	`37`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`*/`
`28`	`28`	`final class DumpSchemaCommand extends DoctrineCommand`
`29`	`29`	`{`
`30`		`- /** @var string */`
	`30`	`+ /** @var string\|null */`
`31`	`31`	`protected static $defaultName = 'migrations:dump-schema';`
`32`	`32`
`33`	`33`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`*/`
`26`	`26`	`final class ExecuteCommand extends DoctrineCommand`
`27`	`27`	`{`
`28`		`- /** @var string */`
	`28`	`+ /** @var string\|null */`
`29`	`29`	`protected static $defaultName = 'migrations:execute';`
`30`	`30`
`31`	`31`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`*/`
`20`	`20`	`final class GenerateCommand extends DoctrineCommand`
`21`	`21`	`{`
`22`		`- /** @var string */`
	`22`	`+ /** @var string\|null */`
`23`	`23`	`protected static $defaultName = 'migrations:generate';`
`24`	`24`
`25`	`25`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`*/`
`23`	`23`	`final class ListCommand extends DoctrineCommand`
`24`	`24`	`{`
`25`		`- /** @var string */`
	`25`	`+ /** @var string\|null */`
`26`	`26`	`protected static $defaultName = 'migrations:list';`
`27`	`27`
`28`	`28`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`*/`
`31`	`31`	`final class MigrateCommand extends DoctrineCommand`
`32`	`32`	`{`
`33`		`- /** @var string */`
	`33`	`+ /** @var string\|null */`
`34`	`34`	`protected static $defaultName = 'migrations:migrate';`
`35`	`35`
`36`	`36`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`*/`
`14`	`14`	`final class StatusCommand extends DoctrineCommand`
`15`	`15`	`{`
`16`		`- /** @var string */`
	`16`	`+ /** @var string\|null */`
`17`	`17`	`protected static $defaultName = 'migrations:status';`
`18`	`18`
`19`	`19`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`final class SyncMetadataCommand extends DoctrineCommand`
`11`	`11`	`{`
`12`		`- /** @var string */`
	`12`	`+ /** @var string\|null */`
`13`	`13`	`protected static $defaultName = 'migrations:sync-metadata-storage';`
`14`	`14`
`15`	`15`	`protected function configure(): void`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`*/`
`27`	`27`	`final class UpToDateCommand extends DoctrineCommand`
`28`	`28`	`{`
`29`		`- /** @var string */`
	`29`	`+ /** @var string\|null */`
`30`	`30`	`protected static $defaultName = 'migrations:up-to-date';`
`31`	`31`
`32`	`32`	`protected function configure(): void`