Indicate file on TypeInferenceTestCase validation errors

[staabm]

was just hunting down a bug in one of my PRs, but wasn't able to find the offending file, because the error message did not indicate which file the error related to

before this PR:

There was 1 error: 1) Error The data provider specified for PHPStan\Analyser\NodeScopeResolverTest::testFileAsserts is invalid. PHPUnit\Framework\AssertionFailedError: Expected type must be a literal string, string given on line 78. /Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:166 /Users/staabm/workspace/phpstan-src/src/Node/ClassStatementsGatherer.php:128 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:650 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:759 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:3938 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:2124 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:758 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:339 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:649 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:339 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:835 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:339 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:803 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:296 /Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:92 /Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:145 /Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:271 /Users/staabm/workspace/phpstan-src/tests/PHPStan/Analyser/NodeScopeResolverTest.php:17 

after this PR:

1) Error The data provider specified for PHPStan\Analyser\NodeScopeResolverTest::testFileAsserts is invalid. PHPUnit\Framework\AssertionFailedError: Expected type must be a literal string, string given in tests/PHPStan/Analyser/nsrt/param-closure-this.php on line 78. /Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:166 /Users/staabm/workspace/phpstan-src/src/Node/ClassStatementsGatherer.php:128 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:650 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:759 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:3938 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:2124 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:758 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:339 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:649 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:339 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:835 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:339 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:803 /Users/staabm/workspace/phpstan-src/src/Analyser/NodeScopeResolver.php:296 /Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:92 /Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:145 /Users/staabm/workspace/phpstan-src/src/Testing/TypeInferenceTestCase.php:273 /Users/staabm/workspace/phpstan-src/tests/PHPStan/Analyser/NodeScopeResolverTest.php:17 

note the added filename in the error message

[phpstan-bot]

This pull request has been marked as ready for review.

[staabm]

I will finalize this PR when back at my windows laptop next week

[phpstan-bot]

This pull request has been marked as ready for review.

[ondrejmirtes]

We don't need to change the backslashes here I think. And if you wanted to, we have FileHelper::normalizePath() for that. You can run this function on both sides here (implementation & tests).

[staabm]

the currentWorkingDirectory in

phpstan-src/src/File/SimpleRelativePathHelper.php

Line 19 in 519982c

if ($this->currentWorkingDirectory !== '' && str_starts_with($filename, $this->currentWorkingDirectory)) {

is normalized to forward slashes.

when not doing strtr($file, '\\', '/') we pass on windows a path with backslashes and this makes the path not getting returned relative.

[staabm]

just tried FileHelper::normalize instead of strtr($file, '\\', '/'): it will not turn the slashes in the correct form to make $pathHelper->getRelativePath return a proper relative path

[ondrejmirtes]

Why wouldn't it? It works everywhere else in PHPStan's codebase.

[staabm]

I don't think so.

in other places we also do the \\ -> / dance to make it work:

phpstan-src/tests/e2e/ResultCacheEndToEndTest.php

Lines 194 to 199 in 494b7b0

	private function relativizePath(string $path): string
	{
	$path = str_replace('\\', '/', $path);
	$helper = new SimpleRelativePathHelper(str_replace('\\', '/', __DIR__ . '/PHP-Parser'));
	return $helper->getRelativePath($path);
	}

but I found a way to make it work.

[ondrejmirtes]

This doesn't make sense as it will be somewhere deep in the PHAR, for users that use TypeInferenceTestCase outside of phpstan-src.

[staabm]

last try in the latest git push. if this doesn't work for you I will close this PR.

[ondrejmirtes]

I committed my vision how it should have been done: 0e53118

[ondrejmirtes]

Thank you.

As a next step we could stop using SimpleRelativePathHelper in more places in tests and start using SystemAgnosticSimpleRelativePathHelper instead. It could find more issues like it did here in PathConstantsTest.