Add pre-filters configuration option

resources/schema.json

@@ -495,6 +495,12 @@
         "testFrameworkOptions": {
             "type": "string",
             "description": "Specify an additional options to pass to the test framework (e.g. enabling Verbose Mode). --test-framework-options will override this option."
+        },
+        "plugins": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
         }
     },
     "definitions": {

scoper.inc.php

@@ -37,6 +37,10 @@
     'whitelist' => [
         \Composer\Autoload\ClassLoader::class,
         'Safe\*',
+        \Infection\Plugins\Plugin::class,
+        \Infection\Plugins\MutantFilterPlugin::class,
+        \Infection\Plugins\Mutant::class,
+        \Infection\Plugins\Configuration::class,
     ],
     'whitelist-global-constants' => false,
     'whitelist-global-classes' => false,

src/Configuration/Configuration.php

@@ -38,6 +38,7 @@
 use Infection\Configuration\Entry\Logs;
 use Infection\Configuration\Entry\PhpUnit;
 use Infection\Mutator\Mutator;
+use Infection\Plugins\Plugin;
 use Infection\TestFramework\TestFrameworkTypes;
 use Symfony\Component\Finder\SplFileInfo;
 use Webmozart\Assert\Assert;
@@ -82,13 +83,15 @@ class Configuration
     private $threadCount;
     private $dryRun;
     private $ignoreSourceCodeMutatorsMap;
+    private $plugins;
 
     /**
      * @param string[] $sourceDirectories
      * @param string[] $sourceFilesExcludes
      * @param iterable<SplFileInfo> $sourceFiles
      * @param array<string, Mutator> $mutators
      * @param array<string, array<int, string>> $ignoreSourceCodeMutatorsMap
+     * @param array<class-string<Plugin>> $plugins
      */
     public function __construct(
         float $timeout,
@@ -118,7 +121,8 @@ public function __construct(
         int $msiPrecision,
         int $threadCount,
         bool $dryRun,
-        array $ignoreSourceCodeMutatorsMap
+        array $ignoreSourceCodeMutatorsMap,
+        array $plugins
     ) {
         Assert::nullOrGreaterThanEq($timeout, 0);
         Assert::allString($sourceDirectories);
@@ -156,6 +160,7 @@ public function __construct(
         $this->threadCount = $threadCount;
         $this->dryRun = $dryRun;
         $this->ignoreSourceCodeMutatorsMap = $ignoreSourceCodeMutatorsMap;
+        $this->plugins = $plugins;
     }
 
     public function getProcessTimeout(): float
@@ -255,6 +260,14 @@ public function shouldSkipInitialTests(): bool
         return $this->skipInitialTests;
     }
 
+    /**
+     * @return array<class-string<Plugin>>
+     */
+    public function getPlugins(): array
+    {
+        return $this->plugins;
+    }
+
     public function isDebugEnabled(): bool
     {
         return $this->debug;

src/Configuration/ConfigurationFactory.php

@@ -159,7 +159,8 @@ public function create(
             $msiPrecision,
             $threadCount,
             $dryRun,
-            $ignoreSourceCodeMutatorsMap
+            $ignoreSourceCodeMutatorsMap,
+            $schema->getPlugins()
         );
     }
 

src/Configuration/Schema/SchemaConfiguration.php

@@ -38,6 +38,7 @@
 use Infection\Configuration\Entry\Logs;
 use Infection\Configuration\Entry\PhpUnit;
 use Infection\Configuration\Entry\Source;
+use Infection\Plugins\Plugin;
 use Infection\TestFramework\TestFrameworkTypes;
 use Webmozart\Assert\Assert;
 
@@ -60,9 +61,11 @@ final class SchemaConfiguration
     private $bootstrap;
     private $initialTestsPhpOptions;
     private $testFrameworkExtraOptions;
+    private $plugins;
 
     /**
      * @param array<string, mixed> $mutators
+     * @param array<class-string<Plugin>> $plugins
      */
     public function __construct(
         string $file,
@@ -78,7 +81,8 @@ public function __construct(
         ?string $testFramework,
         ?string $bootstrap,
         ?string $initialTestsPhpOptions,
-        ?string $testFrameworkExtraOptions
+        ?string $testFrameworkExtraOptions,
+        array $plugins
     ) {
         Assert::nullOrGreaterThanEq($timeout, 0);
         Assert::nullOrOneOf($testFramework, TestFrameworkTypes::TYPES);
@@ -97,6 +101,7 @@ public function __construct(
         $this->bootstrap = $bootstrap;
         $this->initialTestsPhpOptions = $initialTestsPhpOptions;
         $this->testFrameworkExtraOptions = $testFrameworkExtraOptions;
+        $this->plugins = $plugins;
     }
 
     public function getFile(): string
@@ -171,4 +176,12 @@ public function getTestFrameworkExtraOptions(): ?string
     {
         return $this->testFrameworkExtraOptions;
     }
+
+    /**
+     * @return array<class-string<Plugin>>
+     */
+    public function getPlugins(): array
+    {
+        return $this->plugins;
+    }
 }

src/Configuration/Schema/SchemaConfigurationFactory.php

@@ -66,7 +66,8 @@ public function create(string $path, stdClass $rawConfig): SchemaConfiguration
             $rawConfig->testFramework ?? null,
             self::normalizeString($rawConfig->bootstrap ?? null),
             self::normalizeString($rawConfig->initialTestsPhpOptions ?? null),
-            self::normalizeString($rawConfig->testFrameworkOptions ?? null)
+            self::normalizeString($rawConfig->testFrameworkOptions ?? null),
+            (array) ($rawConfig->plugins ?? [])
         );
     }
 

src/Container.php

@@ -81,6 +81,7 @@
 use Infection\Mutant\MutantCodeFactory;
 use Infection\Mutant\MutantExecutionResultFactory;
 use Infection\Mutant\MutantFactory;
+use Infection\Mutant\MutantFiltersHandler;
 use Infection\Mutation\FileMutationGenerator;
 use Infection\Mutation\MutationAttributeKeys;
 use Infection\Mutation\MutationGenerator;
@@ -89,6 +90,7 @@
 use Infection\Mutator\MutatorResolver;
 use Infection\PhpParser\FileParser;
 use Infection\PhpParser\NodeTraverserFactory;
+use Infection\Plugins\Wrapper\ContainerWrapper;
 use Infection\Process\Factory\InitialTestsRunProcessFactory;
 use Infection\Process\Factory\MutantProcessFactory;
 use Infection\Process\Runner\DryProcessRunner;
@@ -563,6 +565,7 @@ public static function create(): self
                 return new MutationTestingRunner(
                     $container->getMutantProcessFactory(),
                     $container->getMutantFactory(),
+                    $container->getMutantFiltersHandler(),
                     $container->getProcessRunner(),
                     $container->getEventDispatcher(),
                     $configuration->isDryRun()
@@ -574,6 +577,17 @@ public static function create(): self
                     $configuration->getIgnoreSourceCodeMutatorsMap()
                 );
             },
+            MutantFiltersHandler::class => static function (self $container): MutantFiltersHandler {
+                return new MutantFiltersHandler(
+                    $container->getPluginProvider()->getMutantFilters()
+                );
+            },
+            PluginProvider::class => static function (self $container): PluginProvider {
+                return new PluginProvider(
+                    $container->getConfiguration()->getPlugins(),
+                    new ContainerWrapper($container)
+                );
+            },
             LineRangeCalculator::class => static function (): LineRangeCalculator {
                 return new LineRangeCalculator();
             },
@@ -852,6 +866,16 @@ public function getMutantFactory(): MutantFactory
         return $this->get(MutantFactory::class);
     }
 
+    public function getMutantFiltersHandler(): MutantFiltersHandler
+    {
+        return $this->get(MutantFiltersHandler::class);
+    }
+
+    public function getPluginProvider(): PluginProvider
+    {
+        return $this->get(PluginProvider::class);
+    }
+
     public function getDiffer(): Differ
     {
         return $this->get(Differ::class);

src/Mutant/Mutant.php

@@ -37,6 +37,8 @@
 
 use Infection\AbstractTestFramework\Coverage\TestLocation;
 use Infection\Mutation\Mutation;
+use Infection\Plugins\Mutant as PublicMutant;
+use Infection\Plugins\Wrapper\MutantWrapper;
 
 /**
  * @internal
@@ -50,6 +52,11 @@ class Mutant
     private $diff;
     private $prettyPrintedOriginalCode;
 
+    /**
+     * @var PublicMutant|null
+     */
+    private $wrapper;
+
     public function __construct(
         string $mutantFilePath,
         Mutation $mutation,
@@ -101,4 +108,9 @@ public function getTests(): array
     {
         return $this->mutation->getAllTests();
     }
+
+    public function getMutantWrapper(): PublicMutant
+    {
+        return $this->wrapper ?? $this->wrapper = new MutantWrapper($this);
+    }
 }

src/Mutant/MutantFiltersHandler.php

@@ -0,0 +1,81 @@
+<?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\Mutant;
+
+use Infection\Plugins\Mutant as PublicMutant;
+use Infection\Plugins\MutantFilterPlugin;
+use Pipeline\Interfaces\StandardPipeline as MutantPipeline;
+
+/**
+ * @internal
+ * @final
+ */
+class MutantFiltersHandler
+{
+    /**
+     * @var array<callable>
+     * @psalm-var array<callable(PublicMutant): bool>
+     */
+    private $filters;
+
+    /**
+     * @param array<MutantFilterPlugin> $filters
+     */
+    public function __construct(array $filters)
+    {
+        $this->filters = [];
+
+        foreach ($filters as $filter) {
+            $filterCallable = $filter->getMutantFilter();
+
+            if ($filterCallable !== null) {
+                $this->filters[] = $filterCallable;
+            }
+        }
+    }
+
+    /**
+     * @param MutantPipeline<Mutant> $mutants
+     */
+    public function applyFilters(MutantPipeline $mutants): void
+    {
+        foreach ($this->filters as $filterCallback) {
+            $mutants->filter(static function (Mutant $mutant) use ($filterCallback): bool {
+                return $filterCallback($mutant->getMutantWrapper());
+            });
+        }
+    }
+}