[Bug] Test in Pest format have wrong $this type

[Lea-Reift]

I've been using devsense for a short period, and so far, so good (I love it), unfortunately, when using PestPHP as testing framework, using $this in the callbacks does not give access to the protected methods of the base test case. I tried with PHPstan like docs and I have not made them work. I tend to disable it with phpcs:ignorefile but it seems to be an overkill for something that should be included in the extension.

This is the output without annotations, with param-closure-this TestCase docblock and with var TestCase $this docblock ( usingTests\TestCase in the imports):

it('can run prune command', function () {
    $this->artisan('model:prune')
        ->assertOk();
});

it('can prune activity model', function () {
    /** @param-closure-this TestCase */
    $class = Activity::class;
    $model = new Activity;
    $pruneInPeriod = 10;
    $instanceFile = new InstanceFileService;

    $demo = $instanceFile->get('demo');
    $demo['demo']['pruneInDays'] = $pruneInPeriod;
    $instanceFile->update($demo);

    Activity::factory(state: ['created_at' => now()->subDays($pruneInPeriod)])->createMany(5);

    $this->assertDatabaseCount('activity_log', 5);

    $this->artisan('model:prune', ['--model' => [$class]])
        ->assertOk();

    unset($demo['demo']['pruneInDays']);
    $instanceFile->update($demo);

    $this->assertDatabaseEmpty('activity_log');
});

it('does not prune when prune period does not exist or is 0', function () {
    /** @var TestCase $this */
    $instanceFile = new InstanceFileService;
    $demo = $instanceFile->get('demo');
    if (isset($demo['demo']['pruneInDays'])) {
        $demo['demo']['pruneInDays'] = 0;
        $instanceFile->update($demo);
    }

    Activity::factory(state: ['created_at' => now()->subDays(10)])->createMany(5);

    $this->assertDatabaseCount('activity_log', 5);

    $this->artisan('model:prune', ['--model' => [Activity::class]])
        ->assertOk();

    $this->assertDatabaseCount('activity_log', 5);
});

[jakubmisek]

Thank you for reporting the issue, and for your nice words!

We'll fix that; the functionality relies on PHPStan tag @param-closure-this (used by the it() function), which forces type of $this inside an anonymous function. I didn't realise, that it also changes the current scope - so it lets you to call private and protected members.

[jakubmisek]

There are two issues:

• We don't respect the new function scope (will be fixed).
• It seems the definition in pest is incorrect; It defines$this as @param-closure-this PHPUnit\Framework\TestCase $closure while there should be Illuminate\Foundation\Testing\TestCase.

We'll add the related fixes (that will be in the upcoming pre-release), and I would recommend possible workarounds for the second issue:

• as you already did, add annotation at the beginning of your anonymous function:

  /** @var TestCase $this */

• or add a dummy "ide helper" class anywhere in your workspace:

  namespace PHPUnit\Framework {
    /** @mixin \Illuminate\Foundation\Testing\TestCase */
    class TestCase { }
  }

[Lea-Reift]

@jakubmisek thanks for replying so quick. I used the dummy helper and it partially worked. Now it considers the $this variable as an instance of Test\TestCase, the issue now is that it still shows visibility errors, as it should, because technically, I'm using a protected function "out" of the scope

[jakubmisek]

Yesterday, we have released a pre-release version, which partially fixes the scope (as provided by @param-closure-this PHPUnit\Framework\TestCase tag in Pest source code)

I think, in the next update, we can safely ignore most of the visibility errors on $this->

[Lea-Reift]

BTW, the test explorer does not show the pest tests. Should I open a new issue?

[jakubmisek]

@Lea-Reift we don't index pest tests yet, tracked at #572

[jakubmisek]

@Lea-Reift do you use Pest tests with phpunit.xml or the new Pest.php ?

[Lea-Reift]

phpunit file, as the project was started before that was implemented

[Lea-Reift]

BTW, it should be able to extend the project's base test case, as it may have methods that the Illuminate one doesn't

[jakubmisek]

The upcoming update will "guess" the correct of type of $this;

if there is class Tests\TestCase or Illuminate\Foundation\Testing\TestCase, it will use this type instead.