[Bug]: [mutate] Enum case values are never mutation-tested

Abierto
#1,978 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 5 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
25/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
php
Área
testing

Línea de trabajo

The report identifies four issues in pestphp/pest-plugin-mutate and links a branch with fixtures and tests for each. Read the plugin's mutation generation and coverage handling, then review the linked fixtures and tests to see how each case is reproduced. Done means the maintainers agree on an approach and the reported enum mutations and shared-root coverage paths behave as intended.

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

Descripción

bug
What Happened

The value of a string-backed enum case is never effectively mutation-tested, even when tests check it. Changing 'paid' in the example below would break the test, but --mutate never reports it. There are four independent reasons, all in pestphp/pest-plugin-mutate:

  1. The mutator is dropped. The mutator for non-empty strings, NotEmptyStringToEmpty, is not in a default set. When it is requested explicitly, MutationGenerator::filterMutators() drops it, because it only keeps mutators found in MutatorMap, which is built from the default sets. So no mutation is created at all.
  2. mutates() and --class ignore enums. MutationGenerator::doesNotContainClassToMutate() matches only class and trait, so mutates(Status::class) creates no mutation for an enum.
  3. The case declarations have no line coverage. The mutation is then reported as uncovered, without running any test. With --covered-only, the enum file is skipped entirely.
  4. Separately, on Linux and macOS, when the covered files share only /, every mutation is reported as uncovered (basePath of --coverage-php is empty and the paths stay relative).
How to Reproduce
enum Status: string
{
    case Paid = 'paid';
}
it('stores the paid status', function () {
    expect(Status::Paid->value)->toBe('paid');
});

Run pest --mutate --mutator=StringNotEmptyStringToEmpty: no mutation is created for 'paid'. With mutates(Status::class) in the test file, no mutation is created either.

Sample Repository

https://github.com/mechgw/pest-plugin-mutate/compare/5.x...fix/enum-case-mutations (fixtures and tests for every case)

Pest Version

5.3.2 (pest-plugin-mutate 5.0.2)

PHP Version

8.4.21

Operation System

Linux, Windows

Notes

I would like to fix this in a series of small pull requests to pestphp/pest-plugin-mutate, each one useful on its own:

  • pestphp/pest-plugin-mutate#48: keep the mutators requested outside the default sets (point 1). This is a general fix: it applies to any such mutator, not only to enums.
  • pestphp/pest-plugin-mutate#49: restore the coverage paths when the covered files share only / (point 4). Not related to enums; I found it while running the tests on Linux.
  • pestphp/pest-plugin-mutate#50: let mutates() and --class select enums (point 2). It changes the same regular expression as pestphp/pest-plugin-mutate#22; the two changes do not contradict each other, and I will rebase #50 on top of #22 if #22 is merged first.
  • last: verify the mutations of enum case values (point 3).

The last part is the largest, so I would rather hear your opinion before opening it. The approach is:

  • for a mutated case value, the plugin runs the tests whose code references the case (Status::Paid, self::Paid, static::Paid, and from(), tryFrom(), cases() as a reference to every case), including the hooks and the helper functions of the same test file. If those tests do not detect the mutation, it falls back to all the tests originally selected;
  • the result comes from the JUnit report of that run: a failing test means tested, a passing run means untested, and a missing report or an unknown exit code is reported as uncovered with the reason printed, never as tested;
  • with --covered-only, a case value is mutated only when the selected tests reference it. Cases referenced only from helpers in other files or from closures stored in variables are skipped, and this limitation is covered by a test;
  • in parallel runs, the workers record the tests they execute, so the plugin knows which tests were actually selected.

The complete change, with tests on Linux and Windows, is on the branch linked above. It is a large diff, so please read it only as a preview. I will split it and adapt it to whatever direction you prefer.

Would you accept this approach, or would you rather solve point 3 differently?

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.