[Bug]: [mutate] Windows: the 5 s minimum per-mutant timeout is shorter than a child boot under Xdebug, so untested mutants are scored as killed

Abierto
#1,968 0 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 5 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
30/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
php
Área
testing

Línea de trabajo

Start in MutationTest::calculateTimeout() and MutationTest::start(), where the per-mutant timeout is computed and the child's arguments and XDEBUG_MODE are set, then in hasFinished(), which maps ProcessTimedOutException to Timeout. The mutation code lives in pestphp/pest-plugin-mutate, which the issue says is where to work. Done means a mutant that no test covers is reported as untested rather than killed, with the fix chosen by the maintainers from the options listed.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug
What Happened

On Windows, pest --mutate scores some mutants as killed when no test can kill them, because their child process times out before the covering test has even run.

MutationTest::calculateTimeout() gives each mutant run the initial suite duration plus max(5, 20%):

return (int) ($initialTestSuiteDuration + max(5, $initialTestSuiteDuration * 0.2));

When the targeted test set is small (a single test file, as when mutating one class), the initial suite takes ~2 s, so each child gets ~7 s. On Windows, booting a child Pest process (Laravel app) takes 4 to 7 s on its own, partly because children inherit XDEBUG_MODE=coverage and the --coverage-php=... argument (see the TODO: filter arguments to remove unnecessary stuff (Teamcity, Coverage, etc.) in MutationTest::start()). Some legitimate runs exceed the budget, hasFinished() maps the ProcessTimedOutException to Timeout, and the score counts Timeout as killed.

Expected: a mutant that no test kills is reported as untested, regardless of process start-up time.

How to Reproduce
  1. On Windows, with Xdebug, write a test that executes a class but asserts nothing about it:

    it('runs the code without checking anything', function () {
        (new SomeValueObject(120.5, 80.0))->format();
    
        expect(true)->toBeTrue();
    });
    
  2. XDEBUG_MODE=coverage php vendor/bin/pest tests/Unit/SanityTest.php --mutate --class='App\Domain\SomeValueObject' --covered-only --no-cache

Result: Mutations: 15 untested, 6 timeout, 0 tested, score 28.57 %. No test can kill any of these 21 mutants, so the expected score is 0 %.

With the minimum raised from 5 to 30 s on Windows (max(PHP_OS_FAMILY === 'Windows' ? 30 : 5, ...)), the same run reports 21 untested, 0 tested, score 0.00 %.

This was measured with the child-launch fix from #1916 applied (otherwise every mutant is scored as killed and this bug is invisible).

Sample Repository

None (private project). The reproduction above only needs any Laravel app with Pest and one class.

Pest Version

3.8.6 (pestphp/pest-plugin-mutate v3.0.5, symfony/process v7.4.8)

PHP Version

8.4.15 ZTS (x64), Xdebug 3.5.3

Operation System

Windows

Notes

Filed here because issues are disabled on pestphp/pest-plugin-mutate.

Related: #1843 (timed-out mutants scored as killed, different root cause: a deadlock) and #1916 (child process fails to launch on Windows, also scored as killed). pestphp/pest-plugin-mutate#45 would make all three visible instead of silent.

Possible fixes, from least to most invasive:

  • do not pass coverage arguments/env to the per-mutant children (the existing TODO), which removes most of the start-up cost;
  • a higher minimum timeout, or a --mutate-timeout option;
  • report Timeout separately from kills in the score.
Lenguaje dominante
PHP
Estrellas
11.8k
Forks
559
Merge medio
5 d 23 h
PR fusionados (30 d)
24

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de pestphp/pest

Todos los issues de pestphp/pest

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.