Enable PHPStan in tests #3260

Majkl578 · 2018-08-18T01:53:38Z

Q	A
Type	improvement
BC Break	no

Summary

Enabling PHPStan in tests/ at level 3, just like for lib/. 🎉
Rewritten some Prophecy-based unit tests into PHPUnit mock system to avoid having another (unofficial) extension for Prophecy.

Replaces incomplete #3203 with no changes like (Class -> mixed).

Currently depends on my fork of phpstan-phpunit due to phpstan/phpstan-phpunit#28.

Majkl578 · 2018-08-18T01:54:11Z

tests/Doctrine/Tests/DBAL/Functional/DataAccessTest.php

        );

        self::assertCount(1, $results);
-        self::assertInstanceOf(__NAMESPACE__.'\\MyFetchClass', $results[0]);
+        self::assertInstanceOf(MyFetchClass::class, $results[0]);


Not strictly needed, but affected by phpstan/phpstan-phpunit#27.

morozov · 2018-08-18T04:02:51Z

composer.json

@@ -21,6 +21,7 @@
        "doctrine/coding-standard": "^4.0",
        "jetbrains/phpstorm-stubs": "^2018.1.2",
        "phpstan/phpstan": "^0.10.1",
+        "phpstan/phpstan-phpunit": "dev-GetMockBuilderDynamicReturnTypeExtension-with-undefined-class as 0.10.0.999",


Note to self: make sure this patch is released first.

morozov · 2018-08-18T04:03:38Z

tests/Doctrine/Tests/DBAL/Driver/PDOExceptionTest.php

@@ -24,7 +24,7 @@ class PDOExceptionTest extends DbalTestCase
    /**
     * The wrapped PDO exception mock.
     *
-     * @var \PDOException|\PHPUnit_Framework_MockObject_MockObject
+     * @var \PDOException


tests/Doctrine/Tests/DBAL/Functional/Driver/IBMDB2/DB2StatementTest.php

morozov · 2018-08-18T04:08:04Z

tests/Doctrine/Tests/DBAL/Schema/MySqlSchemaManagerTest.php

@@ -15,7 +16,7 @@ class MySqlSchemaManagerTest extends \PHPUnit\Framework\TestCase
     */
    private $manager;

-    /** @var Connection */
+    /** @var Connection|MockObject */


It looks like the opposite of https://github.com/doctrine/dbal/pull/3260/files#diff-90748caec80a98aa0fcfef640916661bL27.

No, the referenced code isn't acutally a mock at all, see https://github.com/doctrine/dbal/pull/3260/files#diff-90748caec80a98aa0fcfef640916661bR39. :)

I see. Makes sense.

I thought, using phpstan-phpunit would eliminate the necessity to explicitly annotate mocks as such. Looks like it's only the case for the return values of methods like createMock() which automatically get the traits of the object under test and the mock. But for properties, you still have to specify the type explictly. Does it sound about right?

Yes, it changes return types of these factory methods to return intersections of the mock type and the mocked type.
Also, because intersection support sucks in IDEs, it should convert unions like Type|MockObject to an intersection Type&MockObject (not sure how this is implemented).
Additional constraints are there for assertion methods (i.e. assertInstanceOf), see readme: https://github.com/phpstan/phpstan-phpunit#phpstan-phpunit-extensions-and-rules

Yes, it converts them in this case, currently hardcoded in PHPStan, but will be cleaner and part of the phpunit extension in 0.11.

tests/Doctrine/Tests/DBAL/Schema/SchemaTest.php

morozov · 2018-08-18T04:10:03Z

tests/Doctrine/Tests/DBAL/Types/DateImmutableTypeTest.php

@@ -24,7 +25,7 @@ class DateImmutableTypeTest extends \PHPUnit\Framework\TestCase
    protected function setUp()
    {
        $this->type = Type::getType('date_immutable');
-        $this->platform = $this->prophesize(AbstractPlatform::class);
+        $this->platform = $this->getMockBuilder(AbstractPlatform::class)->getMock();


Probably could use $this->createMock() instead.

Yes, forgot to change this file. 😃

morozov · 2018-08-18T04:12:54Z

tests/Doctrine/Tests/Mocks/TaskMock.php

- * TaskMock used for testing the CLI interface.
- * @author Nils Adermann <naderman@naderman.de>
- */
-class TaskMock extends \Doctrine\Common\Cli\Tasks\AbstractTask


I guess this one was REALLY old. ;)
https://github.com/doctrine/dbal/commits/319e20f847efecc8a2727c8dac5ceb592498b81b/tests/Doctrine/Tests/Mocks/TaskMock.php

…m (DBAL)

…ram()

…having to replicate the \PDOStatement interface in ResultStatement

Changed the type of $char in AbstractPlatform::getTrimExpression()`from string|false to ?string

…pression() signatures

Modified AbstractPlatform::getLocateExpression() and ::getSubstringExpression() signatures

Reworked AbstractPlatform::get*Expression() methods

Enable strict types

…n-key-rule-def Removed DB2SchemaManager::_getPortableForeignKeyRuleDef()

Reworked driver exceptions

…ment APIs

…moved `::removeDoctrineTypeFromComment()`

Removed errorCode() and errorInfo() methods from Connection and Statement APIs

Reworked AbstractSchemaManager::extractDoctrineTypeFromComment(), removed ::removeDoctrineTypeFromComment()

Majkl578 · 2019-04-16T19:43:43Z

Rebased on top of develop, green on level 3, 65 more errors on level 7.

morozov · 2019-04-16T19:49:47Z

Rebased on top of develop, green on level 3, 65 more errors on level 7.

We can wrap it up at level 3 and continue to improve later in order to avoid future conflicts and new issues on Level 3 and lower. BTW, why develop? Is it possible to move it to master, same as lib/, especially given that we should have more freedom in making changes in tests?

Majkl578 · 2019-04-16T19:53:46Z

BTW, why develop?

Picked wrong target when rebasing and didn't want to start again on top of master. :|

morozov · 2019-04-16T20:42:13Z

Picked wrong target when rebasing and didn't want to start again on top of master. :|

Could you at least roll it back? I would like to have it done in master, and backporting to master and rebasing develop on top of it would be unnecessary extra work.

morozov · 2019-06-02T21:06:26Z

Closing in favor of #3582. Thanks, @Majkl578.

Majkl578 added Improvement Static Analysis labels Aug 18, 2018

Majkl578 requested a review from morozov August 18, 2018 01:53

Majkl578 commented Aug 18, 2018

View reviewed changes

Majkl578 force-pushed the phpstan-tests branch from 6fd682b to 0fc324b Compare August 18, 2018 02:21

morozov reviewed Aug 18, 2018

View reviewed changes

tests/Doctrine/Tests/DBAL/Functional/Driver/IBMDB2/DB2StatementTest.php Show resolved Hide resolved

morozov reviewed Aug 18, 2018

View reviewed changes

tests/Doctrine/Tests/DBAL/Schema/SchemaTest.php Outdated Show resolved Hide resolved

morozov reviewed Aug 18, 2018

View reviewed changes

Majkl578 force-pushed the phpstan-tests branch 3 times, most recently from 385b730 to 6a2b788 Compare August 18, 2018 19:35

Majkl578 added this to the 2.9.0 milestone Aug 18, 2018

morozov self-assigned this Aug 28, 2018

morozov mentioned this pull request Nov 18, 2018

Enforce parameter and return value types in the codebase #3348

Merged

morozov removed this from the 2.9.0 milestone Dec 2, 2018

guilhermeblanco and others added 11 commits April 15, 2019 20:47

Decouple unique index from unique constraint

2f4809a

Added flag support to unique constraint

75ca0b9

Fixed tests

64a1f95

Removed identifier generator type from schema table definition

dc9696e

Fixing rebase with master

b4da554

Fixed undefined result of rebase

ca0e17d

Moved getSequencePrefix() from ClassMetadata (ORM) to AbstractPlatfor…

2513424

…m (DBAL)

Bump version to 3.0.x-dev

e656cd5

[BC] Removed support for PDO::PARAM_INPUT_OUTPUT in Statement::bindPa…

d2f585a

…ram()

[BC] Replaced extension of \PDOStatement with a composition to avoid …

b542a51

…having to replicate the \PDOStatement interface in ResultStatement

[BC] Replaced PDO constants with values

c4f5d50

Ocramius and others added 16 commits April 15, 2019 20:56

Merge pull request doctrine#3491 from morozov/get-trim-expr

195a2ad

Changed the type of $char in AbstractPlatform::getTrimExpression()`from string|false to ?string

Modified AbstractPlatform::getLocateExpression() and ::getSubstringEx…

fab415a

…pression() signatures

Reworked AbstractPlatform::get*Expression() methods

f771d67

Merge pull request doctrine#3494 from morozov/get-locate-expr

6c5f79b

Modified AbstractPlatform::getLocateExpression() and ::getSubstringExpression() signatures

Merge pull request doctrine#3498 from morozov/get-other-expr

1b86ed3

Reworked AbstractPlatform::get*Expression() methods

Enable strict types

82f5fe3

Removed DB2SchemaManager::_getPortableForeignKeyRuleDef()

c59ee29

Merge pull request doctrine#2854 from Majkl578/strict-types

07b9819

Enable strict types

Reworking driver exceptions

b0a8ab0

Merge pull request doctrine#3502 from morozov/db2-get-portable-foreig…

90286b5

…n-key-rule-def Removed DB2SchemaManager::_getPortableForeignKeyRuleDef()

Merge pull request doctrine#3505 from morozov/driver-exceptions

9f3c882

Reworked driver exceptions

Removed errorCode() and errorInfo() methods from Connection and State…

0f662c5

…ment APIs

Reworked AbstractSchemaManager::extractDoctrineTypeFromComment() re…

6b5d226

…moved `::removeDoctrineTypeFromComment()`

Merge pull request doctrine#3507 from morozov/error-code-info

ba45fbd

Removed errorCode() and errorInfo() methods from Connection and Statement APIs

Merge pull request doctrine#3501 from morozov/extract-type-from-comment

6daf933

Reworked AbstractSchemaManager::extractDoctrineTypeFromComment(), removed ::removeDoctrineTypeFromComment()

Enable PHPStan in tests

9742200

Majkl578 force-pushed the phpstan-tests branch from 6a2b788 to 9742200 Compare April 16, 2019 19:43

Majkl578 changed the base branch from master to develop April 16, 2019 19:44

morozov force-pushed the develop branch from e46c09b to 5ee9443 Compare May 6, 2019 04:48

morozov force-pushed the develop branch from 0cfd360 to fb869d7 Compare May 23, 2019 00:59

morozov mentioned this pull request May 30, 2019

Enforced parameter and return value types in test classes #3575

Merged

morozov force-pushed the develop branch from c634b7c to e571fa1 Compare May 31, 2019 02:23

morozov mentioned this pull request Jun 2, 2019

Enable phpstan in DBAL tests #3582

Merged

morozov closed this Jun 2, 2019

github-actions bot locked as resolved and limited conversation to collaborators Aug 8, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable PHPStan in tests #3260

Enable PHPStan in tests #3260

Majkl578 commented Aug 18, 2018

Majkl578 Aug 18, 2018

morozov Aug 18, 2018

morozov Aug 18, 2018

morozov Aug 18, 2018

Majkl578 Aug 18, 2018

morozov Aug 18, 2018

Majkl578 Aug 18, 2018

ondrejmirtes Aug 18, 2018

morozov Aug 18, 2018

Majkl578 Aug 18, 2018

morozov Aug 18, 2018

Majkl578 Aug 18, 2018

Majkl578 commented Apr 16, 2019 •

edited

Loading

morozov commented Apr 16, 2019

Majkl578 commented Apr 16, 2019

morozov commented Apr 16, 2019

morozov commented Jun 2, 2019

Enable PHPStan in tests #3260

Enable PHPStan in tests #3260

Conversation

Majkl578 commented Aug 18, 2018

Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Majkl578 commented Apr 16, 2019 • edited Loading

morozov commented Apr 16, 2019

Majkl578 commented Apr 16, 2019

morozov commented Apr 16, 2019

morozov commented Jun 2, 2019

Majkl578 commented Apr 16, 2019 •

edited

Loading