Disabling mutating "true" -> "false" in TrueValue mutator for in_array/array_search

resources/schema.json

@@ -90,7 +90,33 @@
         },
         "mutators": {
             "type": "object",
-            "description": "Contains the settings for different mutations and profiles"
+            "description": "Contains the settings for different mutations and profiles",
+            "properties": {
+                "TrueValue": {
+                    "type": {
+                        "anyOf": [
+                            {
+                                "type": "boolean"
+                            },
+                            {
+                                "type": "object",
+                                "additionalProperties": false,
+                                "properties": {
+                                    "ignore": {"type": "array", "items": {"type": "string"}},
+                                    "settings": {
+                                        "type": "object",
+                                        "additionalProperties": false,
+                                        "properties": {
+                                            "in_array": {"type": "boolean"},
+                                            "array_search": {"type": "boolean"}
+                                        }
+                                    }
+                                }
+                            }
+                        ]
+                    }
+                }
+            }
         },
         "testFramework": {
             "type": "string",

src/Mutator/Boolean/TrueValue.php

@@ -36,13 +36,19 @@
 namespace Infection\Mutator\Boolean;
 
 use Infection\Mutator\Util\Mutator;
+use Infection\Visitor\ParentConnectorVisitor;
 use PhpParser\Node;
 
 /**
  * @internal
  */
 final class TrueValue extends Mutator
 {
+    private const DEFAULT_SETTINGS = [
+        'array_search' => false,
+        'in_array' => false,
+    ];
+
     /**
      * Replaces "true" with "false"
      *
@@ -60,6 +66,21 @@ protected function mutatesNode(Node $node): bool
             return false;
         }
 
-        return $node->name->toLowerString() === 'true';
+        if ($node->name->toLowerString() !== 'true') {
+            return false;
+        }
+
+        $parentNode = $node->getAttribute(ParentConnectorVisitor::PARENT_KEY);
+        $grandParentNode = $parentNode !== null ? $parentNode->getAttribute(ParentConnectorVisitor::PARENT_KEY) : null;
+
+        if (!$grandParentNode instanceof Node\Expr\FuncCall || !$grandParentNode->name instanceof Node\Name) {
+            return true;
+        }
+
+        $resultSettings = array_merge(self::DEFAULT_SETTINGS, $this->getSettings());
+
+        $functionName = $grandParentNode->name->toLowerString();
+
+        return array_key_exists($functionName, $resultSettings) && $resultSettings[$functionName] !== false;
     }
 }

src/Mutator/Util/Mutator.php

@@ -77,5 +77,10 @@ final public static function getName(): string
         return end($parts);
     }
 
+    final protected function getSettings(): array
+    {
+        return $this->config->getMutatorSettings();
+    }
+
     abstract protected function mutatesNode(Node $node): bool;
 }

src/Mutator/Util/MutatorConfig.php

@@ -45,9 +45,15 @@ final class MutatorConfig
      */
     private $ignoreConfig;
 
+    /**
+     * @var array
+     */
+    private $mutatorSettings;
+
     public function __construct(array $config)
     {
         $this->ignoreConfig = $config['ignore'] ?? [];
+        $this->mutatorSettings = $config['settings'] ?? [];
     }
 
     public function isIgnored(string $class, string $method): bool
@@ -68,4 +74,9 @@ public function isIgnored(string $class, string $method): bool
 
         return false;
     }
+
+    public function getMutatorSettings(): array
+    {
+        return $this->mutatorSettings;
+    }
 }

tests/Json/JsonFileTest.php

@@ -113,4 +113,155 @@ public function test_it_throws_schema_validation_exception(): void
 
         (new JsonFile($jsonPath))->decode();
     }
+
+    /**
+     * @dataProvider validTrueValueProvider
+     */
+    public function test_it_validates_true_value_mutator(string $jsonString): void
+    {
+        $jsonPath = $this->tmpDir . '/file.json';
+
+        $this->filesystem->dumpFile($jsonPath, $jsonString);
+
+        $content = (new JsonFile($jsonPath))->decode();
+
+        self::assertObjectHasAttribute('mutators', $content);
+    }
+
+    public function validTrueValueProvider(): \Generator
+    {
+        yield 'Boolean value' => [
+            <<<JSON
+{
+    "timeout": 25,
+    "source": {"directories": ["src"]},
+    "mutators": {
+        "TrueValue": true
+    }
+}
+JSON
+        ];
+
+        yield 'Object value' => [
+            <<<JSON
+{
+    "timeout": 25,
+    "source": {
+        "directories": ["src"]
+    },
+    "mutators": {
+        "TrueValue": {
+            "ignore": [
+                "IgnoreClass"
+            ],
+            "settings": {
+                "in_array": false,
+                "array_search": true
+            }
+        }
+    }
+}
+JSON
+        ];
+    }
+
+    /**
+     * @dataProvider invalidTrueValueProvider
+     */
+    public function test_it_throws_exception_for_invalid_true_value_mutator(string $jsonString, string $expectedMessageRegex): void
+    {
+        $jsonPath = $this->tmpDir . '/file.json';
+
+        $this->filesystem->dumpFile($jsonPath, $jsonString);
+
+        self::expectException(ValidationException::class);
+        self::expectExceptionMessageRegExp($expectedMessageRegex);
+
+        (new JsonFile($jsonPath))->decode();
+    }
+
+    public function invalidTrueValueProvider(): \Generator
+    {
+        yield 'Extra property for TrueValue mutator' => [
+            <<<'JSON'
+{
+    "timeout": 25,
+    "source": {"directories": ["src"]},
+    "mutators": {
+        "TrueValue": {
+            "EXTRA_KEY": true,
+            "ignore": [
+                "IgnoreClass"
+            ],
+            "settings": {
+                "in_array": false,
+                "array_search": true
+            }
+        }
+    }
+}
+JSON
+            ,
+            '/mutators\.TrueValue : The property EXTRA_KEY is not defined and the definition does not allow additional properties/',
+        ];
+
+        yield 'Extra property for TrueValue mutator, settings object' => [
+            <<<'JSON'
+{
+    "timeout": 25,
+    "source": {"directories": ["src"]},
+    "mutators": {
+        "TrueValue": {
+            "ignore": [
+                "IgnoreClass"
+            ],
+            "settings": {
+                "EXTRA_KEY": true,
+                "in_array": false,
+                "array_search": true
+            }
+        }
+    }
+}
+JSON
+            ,
+            '/mutators\.TrueValue\.settings : The property EXTRA_KEY is not defined and the definition does not allow additional properties/',
+        ];
+
+        yield 'Invalid type for "in_array" setting' => [
+            <<<'JSON'
+{
+    "timeout": 25,
+    "source": {"directories": ["src"]},
+    "mutators": {
+        "TrueValue": {
+            "ignore": [
+                "IgnoreClass"
+            ],
+            "settings": {
+                "in_array": 123,
+                "array_search": true
+            }
+        }
+    }
+}
+JSON
+            ,
+            '/mutators\.TrueValue\.settings\.in_array : Integer value found, but a boolean is required/',
+        ];
+
+        yield 'Invalid type TrueValue' => [
+            <<<'JSON'
+{
+    "timeout": 25,
+    "source": {"directories": ["src"]},
+    "mutators": {
+        "TrueValue": 123
+    }
+}
+JSON
+            ,
+            '/mutators\.TrueValue : Failed to match at least one schema/',
+        ];
+    }
 }

tests/Mutator/AbstractMutatorTestCase.php

@@ -66,7 +66,7 @@ protected function setUp(): void
         $this->mutator = $this->getMutator();
     }
 
-    public function doTest(string $inputCode, $expectedCode = null): void
+    public function doTest(string $inputCode, $expectedCode = null, array $settings = []): void
     {
         $expectedCodeSamples = (array) $expectedCode;
 
@@ -76,7 +76,7 @@ public function doTest(string $inputCode, $expectedCode = null): void
             throw new \LogicException('Input code cant be the same as mutated code');
         }
 
-        $mutants = $this->mutate($inputCode);
+        $mutants = $this->mutate($inputCode, $settings);
 
         $this->assertSame(\count($mutants), \count($expectedCodeSamples), sprintf(
             'Failed asserting that the number of code samples (%d) equals the number of mutants (%d) created by the mutator.',
@@ -98,12 +98,12 @@ public function doTest(string $inputCode, $expectedCode = null): void
         }
     }
 
-    protected function getMutator(): Mutator
+    protected function getMutator(array $settings = []): Mutator
     {
         $class = \get_class($this);
         $mutator = substr(str_replace('\Tests', '', $class), 0, -4);
 
-        return new $mutator(new MutatorConfig([]));
+        return new $mutator(new MutatorConfig($settings));
     }
 
     protected function getNodes(string $code): array
@@ -114,12 +114,12 @@ protected function getNodes(string $code): array
         return $parser->parse($code);
     }
 
-    protected function mutate(string $code): array
+    protected function mutate(string $code, array $settings = []): array
     {
         $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7, new Lexer\Emulative());
         $prettyPrinter = new Standard();
 
-        $mutations = $this->getMutationsFromCode($code, $parser);
+        $mutations = $this->getMutationsFromCode($code, $parser, $settings);
 
         $traverser = new NodeTraverser();
         $traverser->addVisitor(new CloneVisitor());
@@ -144,13 +144,13 @@ protected function mutate(string $code): array
     /**
      * @return SimpleMutation[]
      */
-    private function getMutationsFromCode(string $code, Parser $parser): array
+    private function getMutationsFromCode(string $code, Parser $parser, array $settings): array
     {
         $initialStatements = $parser->parse($code);
 
         $traverser = new NodeTraverser();
 
-        $mutationsCollectorVisitor = new SimpleMutationsCollectorVisitor($this->getMutator(), $initialStatements);
+        $mutationsCollectorVisitor = new SimpleMutationsCollectorVisitor($this->getMutator($settings), $initialStatements);
 
         $traverser->addVisitor($mutationsCollectorVisitor);
         $traverser->addVisitor(new ParentConnectorVisitor());