Validate usages of assert*-methods in TypeInferenceTestCase #2326

staabm · 2023-04-05T08:48:17Z

as discussed in https://github.com/phpstan/phpstan-src/pull/2107/files#r1048450984

tested using

diff --git a/tests/PHPStan/Analyser/data/implode.php b/tests/PHPStan/Analyser/data/implode.php
index b2e2b9aa7..86a03a838 100644
--- a/tests/PHPStan/Analyser/data/implode.php
+++ b/tests/PHPStan/Analyser/data/implode.php
@@ -2,7 +2,8 @@

 namespace ImplodeFunctionReturn;

-use function PHPStan\Testing\assertType;
+use function PHPStan\Testing\assertNativeType;
+use function PHPStan\wrong\assertType;

 class Foo
 {
@@ -10,6 +11,8 @@ class Foo
        const ONE = 1;

        public function constants() {
+               assertNativeType('string', implode(',', [self::X, '345']));
+
                assertType("'12345'", implode(['12', '345']));

                assertType("'12345'", implode('', ['12', '345']));

➜  phpstan-src git:(pr/2118) ✗ vendor/bin/phpunit tests/PHPStan/Analyser/NodeScopeResolverTest.php
Xdebug: [Step Debug] Could not connect to debugging client. Tried: 127.0.0.1:9003 (through xdebug.client_host/xdebug.client_port) :-(
PHPUnit 9.5.23 #StandWithUkraine

Warning:       XDEBUG_MODE=coverage or xdebug.mode=coverage has to be set

E                                                                   1 / 1 (100%)

Time: 00:00.017, Memory: 54.00 MB

There was 1 error:

1) Error
The data provider specified for PHPStan\Analyser\NodeScopeResolverTest::testFileAsserts is invalid.
PHPUnit\Framework\AssertionFailedError: ERROR: Assert-Method PHPStan\wrong\assertType imported with wrong namespace called from line 16.
/Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:182
/Users/staabm/workspace/phpstan-src/src/Node/ClassStatementsGatherer.php:115
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:553
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:3037
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:1751
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:618
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:294
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:569
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:294
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:668
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:294
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:638
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:249
/Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:71
/Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:197
/Users/staabm/workspace/phpstan-src/tests/PHPStan/Analyser/NodeScopeResolverTest.php:19

ERRORS!
Tests: 1, Assertions: 0, Errors: 1.

diff --git a/tests/PHPStan/Analyser/data/implode.php b/tests/PHPStan/Analyser/data/implode.php
index b2e2b9aa7..8e80ecead 100644
--- a/tests/PHPStan/Analyser/data/implode.php
+++ b/tests/PHPStan/Analyser/data/implode.php
@@ -2,7 +2,7 @@

 namespace ImplodeFunctionReturn;

-use function PHPStan\Testing\assertType;
+use function PHPStan\Testing\assertNativeType;

 class Foo
 {
@@ -10,6 +10,8 @@ class Foo
        const ONE = 1;

        public function constants() {
+               assertNativeType('string', implode(',', [self::X, '345']));
+
                assertType("'12345'", implode(['12', '345']));

                assertType("'12345'", implode('', ['12', '345']));

➜  phpstan-src git:(asserts) ✗ vendor/bin/phpunit tests/PHPStan/Analyser/NodeScopeResolverTest.php
PHPUnit 9.5.23 #StandWithUkraine

Warning:       No code coverage driver available

E                                                                   1 / 1 (100%)

Time: 00:00.011, Memory: 52.00 MB

There was 1 error:

1) Error
The data provider specified for PHPStan\Analyser\NodeScopeResolverTest::testFileAsserts is invalid.
PHPUnit\Framework\AssertionFailedError: ERROR: Missing import for assertType() on line 15.
/Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:131
/Users/staabm/workspace/phpstan-src/src/Node/ClassStatementsGatherer.php:115
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:553
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:3037
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:1751
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:618
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:294
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:569
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:294
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:668
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:294
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:638
/Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:249
/Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:71
/Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:197
/Users/staabm/workspace/phpstan-src/tests/PHPStan/Analyser/NodeScopeResolverTest.php:19

ERRORS!
Tests: 1, Assertions: 0, Errors: 1.

phpstan-bot · 2023-04-05T09:05:42Z

This pull request has been marked as ready for review.

ondrejmirtes

This needs a test. Please add a new class that extend TypeInferenceTestCase and do something with $this->expectException('PHPUnit\Framework\ExpectationFailedException'); there (https://stackoverflow.com/questions/3917909/how-to-indicate-that-a-phpunit-test-is-expected-to-fail). Thanks.

staabm · 2023-04-05T14:44:57Z

@herndlm looks like the new patching solution has problems on windows with php 7.2

ondrejmirtes · 2023-04-05T15:30:18Z

tests/PHPStan/Tests/TypeInferenceTestCaseTest.php

@@ -0,0 +1,59 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Tests;


This namespace could be Testing.

already existing test-classes in the same folder use PHPStan\Tests.

Testing is used in the src/ folder

But here you're testing PHPStan\Testing\TypeInferenceTestCase class.

ondrejmirtes · 2023-04-05T15:32:27Z

tests/PHPStan/Tests/TypeInferenceTestCaseTest.php

+	public function testWrongAssertTypeNamespace(): void
+	{
+		$this->expectException(AssertionFailedError::class);
+		$this->expectExceptionMessage('ERROR: Assert-Method SomeWrong\Namespace\assertType imported with wrong namespace called from line 8.');


The error messages could be cleaned up a bit.

ERROR: at the beginning isn't needed, it's obvious when the test fails that it's an error.

"on line" 8, not "from line"

The message should read: "Function PHPStan\Testing\assertType imported with wrong namespace SomeWrong\Namespace..."

nearly all other error messages in TypeInferenceTestCase use the ERROR: prefix - stripped it

done

done

ondrejmirtes · 2023-04-05T15:32:50Z

src/Testing/TypeInferenceTestCase.php

@@ -125,7 +127,13 @@ public static function gatherAssertTypes(string $file): array
 			}

 			$functionName = $nameNode->toString();
-			if ($functionName === 'PHPStan\\Testing\\assertType') {
+			if (in_array($functionName, ['assertType', 'assertNativeType', 'assertVariableCertainty'], true)) {


This should be case-insensitive + please also test it

ondrejmirtes · 2023-04-05T15:33:14Z

src/Testing/TypeInferenceTestCase.php

-			if ($functionName === 'PHPStan\\Testing\\assertType') {
+			if (in_array($functionName, ['assertType', 'assertNativeType', 'assertVariableCertainty'], true)) {
+				self::fail(sprintf(
+					'ERROR: Missing import for %s() on line %d.',


It's not import but "use statement".

ondrejmirtes · 2023-04-05T15:40:52Z

Fixed the Windows problem 2df5f87

staabm · 2023-04-06T06:44:09Z

Looking at it again, I think a dataProvider could be useful

ondrejmirtes · 2023-04-06T06:47:28Z

Yes :)

ondrejmirtes · 2023-04-11T12:09:59Z

Thank you.

staabm mentioned this pull request Apr 5, 2023

Validate usages of assert*-methods in TypeInferenceTestCase #2121

Closed

staabm marked this pull request as draft April 5, 2023 08:51

clxmstaab force-pushed the asserts10 branch from f150ef8 to cac6871 Compare April 5, 2023 08:57

staabm marked this pull request as ready for review April 5, 2023 09:02

clxmstaab force-pushed the asserts10 branch from c07828b to 1e18996 Compare April 5, 2023 09:04

ondrejmirtes requested changes Apr 5, 2023

View reviewed changes

clxmstaab force-pushed the asserts10 branch 2 times, most recently from 90142ce to 4c6d0ed Compare April 5, 2023 13:11

ondrejmirtes requested changes Apr 5, 2023

View reviewed changes

clxmstaab force-pushed the asserts10 branch from 6a6307e to 68bbbd1 Compare April 5, 2023 16:03

clxmstaab force-pushed the asserts10 branch 2 times, most recently from c4094cb to 9b6217d Compare April 6, 2023 07:43

staabm force-pushed the asserts10 branch 2 times, most recently from 008660d to 92185a3 Compare April 8, 2023 06:06

staabm and others added 5 commits April 11, 2023 11:46

Validate usages of assert*-methods in TypeInferenceTestCase

edb9197

added TypeInferenceTestCaseTest

a5bd5da

check case-insensitive. fix error messages.

ef16eb3

move test

1b5423e

use dataProvider

7c6cfc0

staabm force-pushed the asserts10 branch from 92185a3 to 7c6cfc0 Compare April 11, 2023 09:46

ondrejmirtes merged commit a7f1fa3 into phpstan:1.10.x Apr 11, 2023
370 of 377 checks passed

staabm deleted the asserts10 branch April 11, 2023 12:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate usages of assert*-methods in TypeInferenceTestCase #2326

Validate usages of assert*-methods in TypeInferenceTestCase #2326

staabm commented Apr 5, 2023 •

edited

phpstan-bot commented Apr 5, 2023

ondrejmirtes left a comment

staabm commented Apr 5, 2023

ondrejmirtes Apr 5, 2023

staabm Apr 5, 2023 •

edited

ondrejmirtes Apr 5, 2023

ondrejmirtes Apr 5, 2023

staabm Apr 5, 2023

ondrejmirtes Apr 5, 2023

staabm Apr 5, 2023

ondrejmirtes Apr 5, 2023

ondrejmirtes commented Apr 5, 2023

staabm commented Apr 6, 2023

ondrejmirtes commented Apr 6, 2023

ondrejmirtes commented Apr 11, 2023

		@@ -0,0 +1,59 @@
		<?php declare(strict_types = 1);

		namespace PHPStan\Tests;

Validate usages of assert*-methods in TypeInferenceTestCase #2326

Validate usages of assert*-methods in TypeInferenceTestCase #2326

Conversation

staabm commented Apr 5, 2023 • edited

phpstan-bot commented Apr 5, 2023

ondrejmirtes left a comment

Choose a reason for hiding this comment

staabm commented Apr 5, 2023

ondrejmirtes Apr 5, 2023

Choose a reason for hiding this comment

staabm Apr 5, 2023 • edited

Choose a reason for hiding this comment

ondrejmirtes Apr 5, 2023

Choose a reason for hiding this comment

ondrejmirtes Apr 5, 2023

Choose a reason for hiding this comment

staabm Apr 5, 2023

Choose a reason for hiding this comment

ondrejmirtes Apr 5, 2023

Choose a reason for hiding this comment

staabm Apr 5, 2023

Choose a reason for hiding this comment

ondrejmirtes Apr 5, 2023

Choose a reason for hiding this comment

ondrejmirtes commented Apr 5, 2023

staabm commented Apr 6, 2023

ondrejmirtes commented Apr 6, 2023

ondrejmirtes commented Apr 11, 2023

staabm commented Apr 5, 2023 •

edited

staabm Apr 5, 2023 •

edited