Somehow passing array<'0.6.0'|'1.0.0'|'1.0.x-dev'|'1.1.x-dev'|'9999999-dev'|'dev-feature-b'|'dev-feature/a-1.0-B'|'dev-master', true> into self::assertEmpty() is not allowed

183    Call to method PHPUnit\Framework\Assert::assertEmpty() with
         array<'0.6.0'|'1.0.0'|'1.0.x-dev'|'1.1.x-dev'|'9999999-dev'|'dev-feature-b'|'dev-feature/a-1.0-B'|'dev-master', true> and
         literal-string&non-falsy-string will always evaluate to false.

It's not a non-empty-array, so I don't see why it isn't allowed.

The code looks something like this, but obviously there is no error there as I cannot use the phpunit code

https://phpstan.org/r/7c7be20e-ed51-4311-a0e0-74c061f99561

Using phpstan/phpstan-phpunit 1.0.0 and phpstan/phpstan 1.4.8, the following code creates a false positive:

namespace OliverKlee\Oelib\Tests\Unit\Templating;

use Nimut\TestingFramework\TestCase\UnitTestCase;
use OliverKlee\Oelib\Templating\Template;
use OliverKlee\Oelib\Templating\TemplateRegistry;

class TemplateRegistryTest extends UnitTestCase
{
    /**
     * @test
     */
    public function getForExistingTemplateFileNameCalledTwoTimesReturnsNewInstance(): void
    {
        self::assertNotSame(
            TemplateRegistry::get('EXT:oelib/Tests/Functional/Fixtures/Template.html'),
            TemplateRegistry::get('EXT:oelib/Tests/Functional/Fixtures/Template.html')
        );
    }
}

This is the error (with different line numbers):

 ------ --------------------------------------------------------------------------------------------------------------------------------------------------------- 
  Line   Tests/Unit/Templating/TemplateRegistryTest.php                                                                                                           
 ------ --------------------------------------------------------------------------------------------------------------------------------------------------------- 
  69     Call to static method PHPUnit\Framework\Assert::assertNotSame() with OliverKlee\Oelib\Templating\Template and OliverKlee\Oelib\Templating\Template will  
         always evaluate to false.                                                                                                                                
  91     Call to static method PHPUnit\Framework\Assert::assertNotSame() with OliverKlee\Oelib\Templating\Template and OliverKlee\Oelib\Templating\Template will  
         always evaluate to false.                                                                                                                                
 ------ --------------------------------------------------------------------------------------------------------------------------------------------------------- 

This problem is new with PHPStan 1.4.8 (as it did no occur with PHPStan 1.4.7).

You can find the complete build with the problem at https://github.com/oliverklee/ext-oelib/pull/904.

(I was not able to use the PHPStan playground for this as I currently do not know of any way of including PHPUnit in it: https://phpstan.org/r/c7fa7bda-1024-45c3-957d-7b91de41b844)

Don't work comments Foo&PHPUnit_Framework_MockObject_MockObject and Foo&MockObject

/**
* @return Foo&MockObject
*/
private function createSomeMock()
{
    $mock = $this
        ->getMockBuilder(Foo::class)
        ->setMethodsExcept(['foo', 'bar'])
        ->setConstructorArgs([])
        ->getMock();

    return $mock;
}

phpstan error: PHPDoc tag @return contains unresolvable type.

phpstan version: 0.12.37 phpstan-phpunit version: 0.12.16

I'm testing my codebase miklcct/thin_php_app and in two of the test files phpstan throws an error:

 ------ ------------------------------------------------------------------------------------ 
  Line   test/View/StreamToStringTest.php                                                    
 ------ ------------------------------------------------------------------------------------ 
  16     Call to an undefined method PHPUnit\Framework\MockObject\MockObject::__toString().  
 ------ ------------------------------------------------------------------------------------ 

 ------ -------------------------------------------------------------------------------- 
  Line   test/View/StringToStreamTest.php                                                
 ------ -------------------------------------------------------------------------------- 
  16     Call to an undefined method PHPUnit\Framework\MockObject\MockObject::render().  
 ------ -------------------------------------------------------------------------------- 

The mock objects are created by $iut = $this->getMockForTrait(StreamToString::class); and $iut = $this->getMockForTrait(StringToStream::class);, and the traits have the mentioned methods defined. PhpStorm type hints work on these 2 files.

I'm not sure if this is the correct repo to open this issue, but it seems to be the best place...

What I'd like to implement (with some help, sure) is the ability to do the same thing done when assert() is called but when using PHPUnit's assertions:

https://github.com/phpstan/phpstan/blob/a50b95cb29fe720a3f8b35297fe3b559d6616d5a/src/Analyser/NodeScopeResolver.php#L197-L204

Some context:

We create contexts for Behat using PHPUnit's assertions and sometimes we have this kind of code:

public function thenSomethingMustHaveHappened(): void
{
    $something = $this->lovelyService->doSomething(); // which has `?Something` as return type hint

    Assert::assertNotNull($something);
    Assert::assertSame('Something', $something->getSomething());    
}

Then PHPstan complains:

------ -------------------------------------------------------------------------------------------------- 
  Line   SomethingContext.php                                                                     
 ------ -------------------------------------------------------------------------------------------------- 
  XX     Calling method getSomething() on possibly null value of type Something|null.  
 ------ -------------------------------------------------------------------------------------------------- 

However if assert($something !== null) is used, things just work...

Of course we could simply use assert() everywhere but we rather use a more friendly tool. So this leads us to two questions:

1. is this interesting for phpstan?
2. how can we implement this?

Summary of a problem or a feature request

When asserting a method result to be null, then changing the internal state of the object, and then asserting the method result to be the same as some object, PHPStan currently fails thinking it will still be null, letting assertSame() always fail.

Code snippet that reproduces the problem

<?php

declare(strict_types=1);

class Foo {
    /**
     * @var Bar|null
     */
    protected $bar;

    /**
     * @return Bar|null
     */
    public function getBar(): ?Bar
    {
        return $this->bar;
    }

    /**
     * @param Bar|null $bar
     */
    public function setBar(?Bar $bar): void
    {
        $this->bar = $bar;
    }
}

class Bar
{
}

class FooTest extends TestCase
{
    public function testBar(): void
    {
        $foo = new Foo();
        $bar = new Bar();

        $this->assertNull($foo->getBar());
        $foo->setBar($bar);
        $this->assertSame($bar, $foo->getBar()); // <-- This line triggers the error
    }
}

Used configuration

parameters:
  level: max

includes:
  - vendor/phpstan/phpstan-phpunit/extension.neon
  - vendor/phpstan/phpstan-phpunit/rules.neon

• phpstan/phpstan @ 0.10.2
• phpstan/phpstan-phpunit @ 0.10

Actual output

 ------ --------------------------------------------------------------------------------------------------------------------------------------- 
  Line   FooTest.php                                                                                                                            
 ------ --------------------------------------------------------------------------------------------------------------------------------------- 
  18     Call to method PHPUnit\Framework\Assert::assertSame() with FactorioItemBrowser\ExportData\Bar and null will always evaluate to false.  
 ------ --------------------------------------------------------------------------------------------------------------------------------------- 
                                                                                                                       
 [ERROR] Found 1 error      

Expected output

 [OK] No errors   

PHPUnit test does run successfully, and so should PHPStan, as all asserts are valid.

Since the phpstan update to 1.7.0, assertSame throws an error when used with symfonysResponse::HTTP_*constants. As the error only appears forassertSamecalls and not others e.g.assertEquals` I think the error may lay in this extension instead of in phpstan itself.

Error message

Parameter #1 $expected of method PHPUnit\Framework\Assert::assertSame() contains unresolvable type.

How to reproduce

use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Response;

class Test extends TestCase
{
    public function testThrowsAnError(): void
    {
         $this->assertSame(Response::HTTP_OK, 200);   
    }

    public function testThrowsNoError(): void
    {
         $this->assertEquals(Response::HTTP_OK, 200);   
         $this->assertSame(\PDO::PARAM_BOOL, 5);   
    }
}

Environment

PHP: 8.1.5 phpstan: 1.7.0 phpstan-phpunit: 1.1.1 phpunit: 9.5.20

Other extensions: phpstan-symfony: 1.1.8 phpstan-doctrine: 1.3.5

I'm using

"phpstan/phpstan": "0.12.*",
"phpstan/phpstan-phpunit": "0.12.*",
"phpunit/phpunit": "8.2.5",

I have warning from Phpstorm 'void' method 'getMockBuilder' result used with the following code :

$pdfGenerator = $this->getMockBuilder(PdfGenerator::class)->getMock();

When I Cmd + Click, I see Phpstorm are locating the getMockBuilder in phpstan/phpstan-phpunit/stubs (instead of inside Phpunit package, maybe he take the first one in lexical order) with the following annotation:

	/**
	 * @template T
	 * @phpstan-param class-string<T> $originalClassName
	 * @phpstan-return MockObject&T
	 */
	public function createConfiguredMock($originalClassName) {}

And theses annotations are not understood by Phpstorm.

Changing to

	/**
	 * @template T
	 * @phpstan-param class-string<T> $originalClassName
	 * @phpstan-return MockObject&T
         * @return MockBuilder
	 */
	public function createConfiguredMock($originalClassName) {}

Fix the issue.

By the way, in Phpunit code, the annotations are

/**
     * Returns a builder object to create mock objects using a fluent interface.
     *
     * @param string|string[] $className
     *
     * @psalm-template RealInstanceType of object
     * @psalm-param class-string<RealInstanceType>|string[] $className
     * @psalm-return MockBuilder<RealInstanceType>
     */
    public function getMockBuilder($className): MockBuilder
    {
        $this->recordDoubledType($className);

        return new MockBuilder($this, $className);
    }

So the returnType/paramsType are added both with the psalm syntax and the regular syntax.

Shouldn't the regular syntax be used too in the stubs provided by phpstan ?

I just tried dev-master version of PHPStan with dev-master (actually ^0.10) of phpstan-phpunit and I stumbled across this issue: assertSame somehow fixes the value to the first occurrence.

Although the test pass, an error is reported for the second assert:

Call to static method PHPUnit\Framework\Assert::assertSame() with int(200) and int(100) will always evaluate to false.

<?php declare(strict_types = 1);

namespace App;

class FooTest extends \PHPUnit\Framework\TestCase
{

	public function testAssertSameBehaviour(): void
	{
		$foo = new Foo();
		$foo->setValue(100);

		self::assertSame(100, $foo->getValue());

		$foo->setValue(200);
		self::assertSame(200, $foo->getValue());
	}

}


class Foo {

	/** @var int */
	private $value;

	public function getValue(): int
	{
		return $this->value;
	}

	public function setValue(int $value): void
	{
		$this->value = $value;
	}

}

Hello

Inside a unit test I had a code like this

        $collector = $client->getProfile()->getCollector('request');

because $client->getProfile() can return false|Profile phpstan was reporting the following issue:

 20     Cannot call method getCollector() on                                                                
         false|Symfony\Component\HttpKernel\Profiler\Profile.
 ------ ---------------------------------------------------------------------------------------------------- 

I changed my code to something like this:

        $profiler = $client->getProfile();
        $this->assertInstanceOf(Profile::class, $profiler);

        $collector = $profiler->getCollector('request');

And the error was still reported. So finally I had to add this /** @var Profile $profiler */ inline docblock in order for the error not to be reported and trick PHPstan.

I believe that since you do an assertInstanceOf there is no need to display an error and having to trick PHPstan by adding inline docblock. Is this possible to be fixed?

PHPUnit should not be a mandatory requirement.

Some users would like to use PHPUnit phar global installation and don't want to have to get the whole dependencies of PHPUnit and itself on the project vendor dir.

What is the goal of this requirement? I don't see any direct class usage so far.

UPDATE: BTW, it also mandatory to require also phpstan from plugins? What is the usage if we use the docker image or the shim repository?

Regards

Hello,

I am building a test returning an array of entities to be used in some others tests marked with @depends. Despite I check that my returned array is not empty an contains only instances of a specific class, phpstan keeps alerting that my returned value does not match. Here is my code:

     /**
     * @return Post[]
     *
     * @throws \Exception
     */
    public function testFindForHomePageReturnsCollectionOfPosts(): array
    {
        $testSubject = self::getContainer()->get(PostRepository::class);
        if (!$testSubject instanceof PostRepository) {
            throw new ServiceNotFoundException(PostRepository::class);
        }

        $result = $testSubject->findForHomePage()->toArray();
        self::assertNotEmpty($result);
        self::assertContainsOnlyInstancesOf(Post::class, $result);

        return $result;
    }

And the alert thrown by phpstan (line 34 is the return $result statement):

Context:

Symfony 6.2 KernelTestCase phpunit/phpunit 9.5.25 symfony/phpunit-bridge 6.2.0

PhpStan 1.9.3 extensions:

• phpstan-phpunit 1.3.2
• phpstan-doctrine 1.3.18
• phpstan-symfony 1.2.15
• phpstan/phpstan-webmozart-assert 1.2.1

Thanks a lot for your help :)

This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | dealerdirect/phpcodesniffer-composer-installer (source) | require-dev | major | ^0.7.0 -> ^1.0.0 | | slevomat/coding-standard | require-dev | major | ^7.0 -> ^8.0 |

Release Notes

Configuration

📅 Schedule: Branch creation - "before 3am on Monday" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

• [ ] If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

I have not been able to create a working example for this on the PHPStan playground as this bug involves PHPUnit and the phpstan-phpunit package.

We have a class with a generator function that looks like this:

    /**
     * Creates an instance of a class taking into account the class-extensions
     * API of TYPO3. USE THIS method instead of the PHP "new" keyword.
     * Eg. "$obj = new myclass;" should be "$obj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance("myclass")" instead!
     *
     * You can also pass arguments for a constructor:
     * \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\myClass::class, $arg1, $arg2, ..., $argN)
     *
     * @template T of object
     * @param class-string<T> $className name of the class to instantiate, must not be empty and not start with a backslash
     * @param array<int, mixed> $constructorArguments Arguments for the constructor
     * @return T the created instance
     */
    public static function makeInstance($className, ...$constructorArguments)
    {…}

One of the tests for this method looks like this:

    /**
     * @test
     */
    public function makeInstanceReturnsClassInstance(): void
    {
        $className = get_class($this->getMockBuilder('foo')->getMock());
        self::assertInstanceOf($className, GeneralUtility::makeInstance($className));
    }

PHPStan (or phpstan-phpunit) now seems to mix up two different representations of a class string for a intersection types (which both look plausible to me, but they're not the same to PHPStan):

  3123   Parameter #1 $className of static method TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance() expects                                                       
         class-string<foo&PHPUnit\Framework\MockObject\MockObject>,
         class-string<foo>&class-string<PHPUnit\Framework\MockObject\MockObject> given.   

The following TestCase will cause PHPStan to report a false positive.

<?php declare(strict_types=1);

use PHPUnit\Framework\TestCase;

/**
 * @phpstan-return non-empty-string
 */
function someFunction(): string {
	return '10';
}

final class MyTest extends TestCase {
	public function testGeneration(): void {
		self::assertIsNotNumeric(
			someFunction(),
			'This expectation message is misinterpreted as the "actual" param.'
		);
	}
}

The false positive:

Call to static method PHPUnit\Framework\Assert::assertIsNotNumeric() with non-empty-string and 'This expectation…' will always evaluate to true.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• [ ] Update dependency consistence-community/coding-standard to v3.11.2

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• [ ] Update build-cs (major) (dealerdirect/phpcodesniffer-composer-installer, slevomat/coding-standard)

Detected dependencies

• [ ] Check this box to trigger a request for Renovate to run again on this repository