Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fail Infection execution when at least 1 ignore source code regex wasn't matched #1631

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Fail Infection execution when at least 1 ignore source code regex wasn't matched #1631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/Command/RunCommand.php
View file
Open in desktop
Expand Up @@ -56,6 +56,7 @@
use Infection\Logger\GitHub\NoFilesInDiffToMutate;
use Infection\Metrics\MinMsiCheckFailed;
use Infection\Process\Runner\InitialTestsFailed;
use Infection\Process\Runner\NotMatchedIgnoreSourceCodeRegexFound;
use Infection\TestFramework\TestFrameworkTypes;
use InvalidArgumentException;
use const PHP_SAPI;
Expand Down Expand Up @@ -355,7 +356,7 @@ protected function executeCommand(IO $io): bool
$io->success($e->getMessage());

return true;
} catch (InitialTestsFailed | MinMsiCheckFailed $exception) {
} catch (InitialTestsFailed | MinMsiCheckFailed | NotMatchedIgnoreSourceCodeRegexFound $exception) {
// TODO: we can move that in a dedicated logger later and handle those cases in the
// Engine instead
$io->error($exception->getMessage());
Expand Down
18 changes: 17 additions & 1 deletion src/Process/Runner/MutationTestingRunner.php
View file
Open in desktop
Expand Up @@ -35,6 +35,10 @@

namespace Infection\Process\Runner;

use function array_keys;
use function array_merge;
use function array_unique;
use function array_values;
use Infection\Differ\DiffSourceCodeMatcher;
use Infection\Event\EventDispatcher\EventDispatcher;
use Infection\Event\MutantProcessWasFinished;
Expand All @@ -47,6 +51,7 @@
use Infection\Mutation\Mutation;
use Infection\Process\Factory\MutantProcessFactory;
use function Pipeline\take;
use function Safe\array_flip;
use Symfony\Component\Filesystem\Filesystem;

/**
Expand Down Expand Up @@ -99,15 +104,19 @@ public function run(iterable $mutations, string $testFrameworkExtraOptions): voi
$numberOfMutants = IterableCounter::bufferAndCountIfNeeded($mutations, $this->runConcurrently);
$this->eventDispatcher->dispatch(new MutationTestingWasStarted($numberOfMutants));

$notMatchedSourceCodeRegexes = array_flip(array_unique(array_merge(...array_values($this->ignoreSourceCodeMutatorsMap))));

$processes = take($mutations)
->cast(function (Mutation $mutation): Mutant {
return $this->mutantFactory->create($mutation);
})
->filter(function (Mutant $mutant): bool {
->filter(function (Mutant $mutant) use (&$notMatchedSourceCodeRegexes): bool {
$mutatorName = $mutant->getMutation()->getMutatorName();

foreach ($this->ignoreSourceCodeMutatorsMap[$mutatorName] ?? [] as $sourceCodeRegex) {
if ($this->diffSourceCodeMatcher->matches($mutant->getDiff()->get(), $sourceCodeRegex)) {
unset($notMatchedSourceCodeRegexes[$sourceCodeRegex]);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be:

$matchedSourceCodeRegexes[$sourceCodeRegex] += 1;


$this->eventDispatcher->dispatch(new MutantProcessWasFinished(
MutantExecutionResult::createFromIgnoredMutant($mutant)
));
Expand All @@ -118,6 +127,13 @@ public function run(iterable $mutations, string $testFrameworkExtraOptions): voi

return true;
})
->filter(static function (Mutant $mutant) use ($notMatchedSourceCodeRegexes): bool {
if ($notMatchedSourceCodeRegexes !== []) {
throw NotMatchedIgnoreSourceCodeRegexFound::forRegexes(array_keys($notMatchedSourceCodeRegexes));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not going to work because this gets called for every mutant, even for the very first one.

}

return true;
})
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sanmai I need your help here.

I feel like sanmain/pipeline needs one more method - tap (similar to this one https://lodash.com/docs/#tap)

What I want to do is after Mutants are filtered and we completed building $notMatchedSourceCodeRegexes - I would like to check it, but there is no possibility to do it since we have only filter() method on the Standard class, which iterates over all the items again.

So, desired logic:

take($mutations)
    ->filter(fn (Mutant $mutant): bool {
        // filter ignored mutants out and build $notMatchedSourceCodeRegexes
    })
    // (!) new
    ->tap(fn (array $mutants): array { 
        // check $notMatchedSourceCodeRegexes and throw an exception if needed
        return $mutants;
    })
    ->filter() // continue existing logic - filter not covered by tests mutants

do you have any recommendations here? is it the right way to go?

So, the following diff will reduce the number of iterations from N to 1:

- ->filter(static function (Mutant $mutant) use ($notMatchedSourceCodeRegexes): bool {
+ ->tap(static function (array $mutants) use ($notMatchedSourceCodeRegexes): array {
    if ($notMatchedSourceCodeRegexes !== []) {
        hrow NotMatchedIgnoreSourceCodeRegexFound::forRegexes(array_keys($notMatchedSourceCodeRegexes));
    }

-    return true;
+    return $mutants; 
 })

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem here is that there's no array $mutants; there are code paths when we produce them only as required. In other words, worst case there's interable $mutants with who knows how many values in it.

If you want to drop arbitrary parts of a sequence (say, first five, or two after ten), there's a handy slice() method, but I don't think that's what you're looking for here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm looking for a place (method) where I can do some job after the first filter() but before the second filter()

what are your recommendations?

I can leave it as is, in the filter() method. But from I don't like that we need to iterate over all the values again just to do 1 check and throw an exception if needed

Copy link
Member

@sanmai sanmai Dec 29, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you can't know if you're looking at the very last mutant, you can't throw an exception from any pipeline method here. Neither you should require to iterate over mutants all over again (all memory savings we get will go out of window). Therefore I'd like to suggest to track regex usages (in a dedicated filter() stage always returning true), and only throw at some later stage when we know this regex had no uses. With that said I would much more prefer to see a notice: breaking non-PR builds can be a real pain. (And what about mutants that only appear in PHP 8, will PHP 7 builds fail because of this?)

There's another option: you can inject a fake mutant at the end of the stream, and then catch it somewhere else. I can elaborate further, but this will be incredibly scuffed and very opaque. Simple counting should work better.

->filter(function (Mutant $mutant): bool {
// It's a proxy call to Mutation, can be done one stage up
if ($mutant->isCoveredByTest()) {
Expand Down
53 changes: 53 additions & 0 deletions src/Process/Runner/NotMatchedIgnoreSourceCodeRegexFound.php
View file
Open in desktop
@@ -0,0 +1,53 @@
<?php
/**
* This code is licensed under the BSD 3-Clause License.
*
* Copyright (c) 2017, Maks Rafalko
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

declare(strict_types=1);

namespace Infection\Process\Runner;

use Exception;
use function implode;

/**
* @internal
*/
final class NotMatchedIgnoreSourceCodeRegexFound extends Exception
{
/**
* @param array<int, string> $notMatchedSourceCodeRegexes
*/
public static function forRegexes(array $notMatchedSourceCodeRegexes): self
{
return new self('The following ignore source code regexes were not matched, consider removing them from `infection.json`: ' . implode(', ', $notMatchedSourceCodeRegexes));
}
}
11 changes: 10 additions & 1 deletion tests/e2e/Example_Test/infection.json
View file
Open in desktop
Expand Up @@ -9,5 +9,14 @@
"logs": {
"summary": "infection.log"
},
"tmpDir": "."
"tmpDir": ".",
"mutators": {
"@default": false,
"ProtectedVisibility": true,
"Plus": true,
"global-ignoreSourceCodeByRegex": [
"public(.*)"
],
"PublicVisibility": true
}
}
70 changes: 70 additions & 0 deletions tests/phpunit/Process/Runner/MutationTestingRunnerTest.php
View file
Open in desktop
Expand Up @@ -53,6 +53,7 @@
use Infection\Process\Factory\MutantProcessFactory;
use Infection\Process\MutantProcess;
use Infection\Process\Runner\MutationTestingRunner;
use Infection\Process\Runner\NotMatchedIgnoreSourceCodeRegexFound;
use Infection\Process\Runner\ProcessRunner;
use Infection\Tests\Fixtures\Event\EventDispatcherCollector;
use Infection\Tests\Mutant\MutantBuilder;
Expand Down Expand Up @@ -371,6 +372,75 @@ public function test_it_does_not_create_processes_when_code_is_ignored_by_regex(
);
}

public function test_fails_with_error_when_not_all_ignore_source_code_regexes_are_used(): void
{
$mutations = [
$mutation0 = $this->createMutation(0),
];

$testFrameworkExtraOptions = '--filter=acme/FooTest.php';

$mutant = MutantBuilder::build(
'/path/to/mutant0',
$mutation0,
'mutated code 0',
'- Non matching source code line',
'<?php $a = 1;'
);

$this->mutantFactoryMock
->method('create')
->withConsecutive(
[$mutation0],
)
->willReturnOnConsecutiveCalls($mutant)
;

$this->fileSystemMock
->expects($this->never())
->method($this->anything())
;

$this->processFactoryMock
->expects($this->never())
->method($this->anything())
;

$this->processRunnerMock
->expects($this->never())
->method('run')
->with($this->emptyIterable())
;

$this->runner = new MutationTestingRunner(
$this->processFactoryMock,
$this->mutantFactoryMock,
$this->processRunnerMock,
$this->eventDispatcher,
$this->fileSystemMock,
new DiffSourceCodeMatcher(),
true,
100.0,
[
'For_' => ['Assert::.*'],
]
);

$this->expectException(NotMatchedIgnoreSourceCodeRegexFound::class);
$this->expectExceptionMessage('The following ignore source code regexes were not matched, consider removing them from `infection.json`: Assert::.*');

$this->runner->run($mutations, $testFrameworkExtraOptions);

$this->assertAreSameEvents(
[
new MutationTestingWasStarted(0),
new MutantProcessWasFinished(MutantExecutionResult::createFromNonCoveredMutant($mutant)),
new MutationTestingWasFinished(),
],
$this->eventDispatcher->getEvents()
);
}

public function test_it_passes_through_iterables_when_concurrent_execution_requested(): void
{
$mutations = new ArrayIterator();
Expand Down
53 changes: 53 additions & 0 deletions tests/phpunit/Process/Runner/NotMatchedIgnoreSourceCodeRegexFoundTest.php
View file
Open in desktop
@@ -0,0 +1,53 @@
<?php
/**
* This code is licensed under the BSD 3-Clause License.
*
* Copyright (c) 2017, Maks Rafalko
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

declare(strict_types=1);

namespace Infection\Tests\Process\Runner;

use Infection\Process\Runner\NotMatchedIgnoreSourceCodeRegexFound;
use PHPUnit\Framework\TestCase;

final class NotMatchedIgnoreSourceCodeRegexFoundTest extends TestCase
{
public function test_it_is_being_created_with_a_message(): void
{
$exception = NotMatchedIgnoreSourceCodeRegexFound::forRegexes(['a', 'b']);

$this->assertInstanceOf(NotMatchedIgnoreSourceCodeRegexFound::class, $exception);
$this->assertSame(
'The following ignore source code regexes were not matched, consider removing them from `infection.json`: a, b',
$exception->getMessage()
);
}
}