Test Double Code Generator does not work when PHPUnit is used from PHAR on PHP 8.4

[jankal]

Q	A
PHPUnit version	11.5.1
PHP version	8.4.2
Installation Method	PHAR

Summary

Tests using the createMock() method run flawlessly with phpunit installed as a composer package.
They do not run when using the PHAR.

Current behavior

Each test using createMock() outputs assert(class_exists(PropertyHookType::class)) - which looks a lot like an AssertionError.

How to reproduce

Run a test-suite using createMock() with the PHAR version of phpunit.

Expected behavior

Tests should run as expected. No assertion fails.

[jankal]

This error currently happens even if property hooks are not used.
My best guess about why this happens: the PHAR building tool aliases the global classPropertyHookType to a internal PHAR class which does not exist.

I first thought #6044 might remedy this for mocks where no property hooks are involved... but nope. We would need to figure out if property hooks are used without touching PropertyHookType - which is not possible.

[jankal]

relates to humbug/php-scoper#1092

[sebastianbergmann]

Thank you for your report. Unfortunately, I am not able to reproduce it:

Issue6093Test.php

<?php declare(strict_types=1);
namespace PHPUnit\TestFixture\Issue6093;

use PHPUnit\Framework\TestCase;

interface I
{
    public function m(): bool;
}

final class Issue6093Test extends TestCase
{
    public function testOne(): void
    {
        $i = $this->createMock(I::class);
        
        $i->expects($this->once())
          ->method('m');

        $i->m();
    }
}

❯ php phpunit-11.5.2.phar Issue6093Test.php
PHPUnit 11.5.2 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.4.2

.                                                                   1 / 1 (100%)

Time: 00:00.002, Memory: 25.34 MB

OK (1 test, 1 assertion)

Please provide a minimal, self-contained, reproducing test case that shows the problem you are reporting.

Without such a minimal, self-contained, reproducing test case I will not be able to investigate this issue.

[sebastianbergmann]

relates to humbug/php-scoper#1092

Not really, as the issue you reference is about the php-scoper not being able to run on PHP 8.4 which means that PHPUnit's PHAR cannot currently be built on PHP 8.4.

The issue you are reporting here seems to be rooted in PHP-Scoper wrongly transforming PHP code when PHPUnit's PHAR is built.

[sebastianbergmann]

@theofidry What do you think?

[sebastianbergmann]

Because we transform PHPUnit's code using PHP-Scoper on PHP 8.3, PHP-Scoper does not know about the built-in PropertyHookType class and therefore wrongly prefixes it with PHPUnitPHAR\.

Please disregard what I wrote in #6093 (comment) and sorry for the noise.

[jankal]

@sebastianbergmann here is my reproduction:

<?php

namespace App\Tests;

use PHPUnit\Framework\TestCase;

class Abc {
    public int $a;
}

class MinimalTest extends TestCase
{
    public function testMinimal() {
        $mock = $this->createMock(Abc::class);
        $this->assertTrue($mock instanceof Abc);
    }
}

Using the binary:

vendor/bin/phpunit tests/MinimalTest.php
PHPUnit 11.5.1 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.4.2
Configuration: /Users/jankal/projects/internal/app/phpunit.xml.dist

.                                                                   1 / 1 (100%)

Time: 00:00.004, Memory: 10.00 MB

OK (1 test, 1 assertion)

Using the PHAR:

./phpunit-11.5.1.phar tests/MinimalTest.php
PHPUnit 11.5.1 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.4.2
Configuration: /Users/jankal/projects/internal/app/phpunit.xml.dist

F                                                                   1 / 1 (100%)

Time: 00:00.001, Memory: 27.34 MB

There was 1 failure:

1) App\Tests\MinimalTest::testMinimal
assert(class_exists(PropertyHookType::class))

/Users/jankal/projects/internal/app/tests/MinimalTest.php:14

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.
                 
  exit status 1  
                 

My phpunit.xml.dist:

<?xml version="1.0" encoding="UTF-8"?>

<!-- https://phpunit.readthedocs.io/en/latest/configuration.html -->
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
         backupGlobals="false"
         colors="true"
         bootstrap="tests/bootstrap.php"
>
    <php>
        <ini name="display_errors" value="1" />
        <ini name="error_reporting" value="-1" />
        <server name="APP_ENV" value="test" force="true" />
        <server name="SHELL_VERBOSITY" value="-1" />
    </php>

    <source>
        <include>
            <directory>src</directory>
        </include>
    </source>

    <testsuites>
        <testsuite name="Project Test Suite">
            <directory>tests</directory>
        </testsuite>
    </testsuites>

    <extensions>
    </extensions>
</phpunit>

[jankal]

@sebastianbergmann I had mentioned the relationship to php-scoper in #6093 (comment) because the issue title there reads "PHP-Scoper does not work in PHP 8.4" which is a fact discovered in this case as well - even though the causes are different ones.

We might need to track this in separate issues with php-scoper.

[sebastianbergmann]

We might need to track this in separate issues with php-scoper.

I do not think so, see #6093 (comment).

[sebastianbergmann]

Blocked by humbug/php-scoper#1099.

[sebastianbergmann]

@jankal Can you please check whether https://github.com/sebastianbergmann/phpunit/actions/runs/12580496240/artifacts/2378104831 (built in https://github.com/sebastianbergmann/phpunit/actions/runs/12580496240/job/35062614523) solves your problem? Thanks!

[jankal]

@sebastianbergmann the snapshot version works.

> ./phpunit-snapshot.phar tests/MinimalTest.php
PHPUnit 11.5.2 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.4.2
Configuration: /Users/jankal/projects/internal/app/phpunit.xml.dist

.                                                                   1 / 1 (100%)

Time: 00:00.001, Memory: 27.34 MB

OK (1 test, 1 assertion)

[jankal]

@sebastianbergmann humbug/php-scoper#1100 was merged thus we can move forwared here.
humbug/php-scoper:0.18.16 contains the fix. - https://github.com/humbug/php-scoper/commits/0.18.16

[jankal]

Ah, it seems you have already updated the dep in bbd266e - nice work!