Add settings to TrueValue mutator and disabling mutating "true" -> "f…

…alse" in in_array and array_search functions. Add json schema validation for TrueValue mutator in infection.json
infection · Jan 5, 2019 · 2382469 · 2382469
1 parent 7894cf5
commit 2382469
Show file tree

Hide file tree

Showing 86 changed files with 438 additions and 101 deletions.
diff --git a/resources/schema.json b/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",

diff --git a/src/Mutator/Arithmetic/Assignment.php b/src/Mutator/Arithmetic/Assignment.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\Assign($node->var, $node->expr, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\AssignOp;
     }

diff --git a/src/Mutator/Arithmetic/AssignmentEqual.php b/src/Mutator/Arithmetic/AssignmentEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\Assign($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\Equal && $node->left instanceof Node\Expr\Variable;
     }

diff --git a/src/Mutator/Arithmetic/BitwiseAnd.php b/src/Mutator/Arithmetic/BitwiseAnd.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\BitwiseOr($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\BitwiseAnd;
     }

diff --git a/src/Mutator/Arithmetic/BitwiseNot.php b/src/Mutator/Arithmetic/BitwiseNot.php
@@ -51,7 +51,7 @@ public function mutate(Node $node)
         return $node->expr;
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BitwiseNot;
     }

diff --git a/src/Mutator/Arithmetic/BitwiseOr.php b/src/Mutator/Arithmetic/BitwiseOr.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\BitwiseAnd($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\BitwiseOr;
     }

diff --git a/src/Mutator/Arithmetic/BitwiseXor.php b/src/Mutator/Arithmetic/BitwiseXor.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\BitwiseAnd($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\BitwiseXor;
     }

diff --git a/src/Mutator/Arithmetic/Decrement.php b/src/Mutator/Arithmetic/Decrement.php
@@ -64,7 +64,7 @@ public function mutate(Node $node)
         }
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof PreDec || $node instanceof PostDec;
     }

diff --git a/src/Mutator/Arithmetic/DivEqual.php b/src/Mutator/Arithmetic/DivEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\AssignOp\Mul($node->var, $node->expr, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\AssignOp\Div;
     }

diff --git a/src/Mutator/Arithmetic/Division.php b/src/Mutator/Arithmetic/Division.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Mul($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\Div;
     }

diff --git a/src/Mutator/Arithmetic/Exponentiation.php b/src/Mutator/Arithmetic/Exponentiation.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Div($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\Pow;
     }

diff --git a/src/Mutator/Arithmetic/Increment.php b/src/Mutator/Arithmetic/Increment.php
@@ -64,7 +64,7 @@ public function mutate(Node $node)
         }
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof PreInc || $node instanceof PostInc;
     }

diff --git a/src/Mutator/Arithmetic/Minus.php b/src/Mutator/Arithmetic/Minus.php
@@ -53,7 +53,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Plus($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\Minus;
     }

diff --git a/src/Mutator/Arithmetic/MinusEqual.php b/src/Mutator/Arithmetic/MinusEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\AssignOp\Plus($node->var, $node->expr, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\AssignOp\Minus;
     }

diff --git a/src/Mutator/Arithmetic/ModEqual.php b/src/Mutator/Arithmetic/ModEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\AssignOp\Mul($node->var, $node->expr, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\AssignOp\Mod;
     }

diff --git a/src/Mutator/Arithmetic/Modulus.php b/src/Mutator/Arithmetic/Modulus.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Mul($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\Mod;
     }

diff --git a/src/Mutator/Arithmetic/MulEqual.php b/src/Mutator/Arithmetic/MulEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\AssignOp\Div($node->var, $node->expr, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\AssignOp\Mul;
     }

diff --git a/src/Mutator/Arithmetic/Multiplication.php b/src/Mutator/Arithmetic/Multiplication.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Div($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\Mul;
     }

diff --git a/src/Mutator/Arithmetic/Plus.php b/src/Mutator/Arithmetic/Plus.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Minus($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         if (!($node instanceof Node\Expr\BinaryOp\Plus)) {
             return false;

diff --git a/src/Mutator/Arithmetic/PlusEqual.php b/src/Mutator/Arithmetic/PlusEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\AssignOp\Minus($node->var, $node->expr, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\AssignOp\Plus;
     }

diff --git a/src/Mutator/Arithmetic/PowEqual.php b/src/Mutator/Arithmetic/PowEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\AssignOp\Div($node->var, $node->expr, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\AssignOp\Pow;
     }

diff --git a/src/Mutator/Arithmetic/RoundingFamily.php b/src/Mutator/Arithmetic/RoundingFamily.php
@@ -74,7 +74,7 @@ public function mutate(Node $node)
         }
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         if (!$node instanceof Node\Expr\FuncCall) {
             return false;

diff --git a/src/Mutator/Arithmetic/ShiftLeft.php b/src/Mutator/Arithmetic/ShiftLeft.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\ShiftRight($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\ShiftLeft;
     }

diff --git a/src/Mutator/Arithmetic/ShiftRight.php b/src/Mutator/Arithmetic/ShiftRight.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\ShiftLeft($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\ShiftRight;
     }

diff --git a/src/Mutator/Boolean/ArrayItem.php b/src/Mutator/Boolean/ArrayItem.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Greater($node->key, $node->value, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\ArrayItem && $node->key && ($this->isNodeWithSideEffects($node->value) || $this->isNodeWithSideEffects($node->key));
     }

diff --git a/src/Mutator/Boolean/EqualIdentical.php b/src/Mutator/Boolean/EqualIdentical.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Identical($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\Equal;
     }

diff --git a/src/Mutator/Boolean/FalseValue.php b/src/Mutator/Boolean/FalseValue.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\ConstFetch(new Node\Name('true'));
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         if (!($node instanceof Node\Expr\ConstFetch)) {
             return false;

diff --git a/src/Mutator/Boolean/IdenticalEqual.php b/src/Mutator/Boolean/IdenticalEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\Equal($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\Identical;
     }

diff --git a/src/Mutator/Boolean/LogicalAnd.php b/src/Mutator/Boolean/LogicalAnd.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\BooleanOr($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\BooleanAnd;
     }

diff --git a/src/Mutator/Boolean/LogicalLowerAnd.php b/src/Mutator/Boolean/LogicalLowerAnd.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\LogicalOr($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\LogicalAnd;
     }

diff --git a/src/Mutator/Boolean/LogicalLowerOr.php b/src/Mutator/Boolean/LogicalLowerOr.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\LogicalAnd($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\LogicalOr;
     }

diff --git a/src/Mutator/Boolean/LogicalNot.php b/src/Mutator/Boolean/LogicalNot.php
@@ -51,7 +51,7 @@ public function mutate(Node $node)
         return $node->expr;
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         if (!($node instanceof Node\Expr\BooleanNot)) {
             return false;

diff --git a/src/Mutator/Boolean/LogicalOr.php b/src/Mutator/Boolean/LogicalOr.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\BooleanAnd($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\BooleanOr;
     }

diff --git a/src/Mutator/Boolean/NotEqualNotIdentical.php b/src/Mutator/Boolean/NotEqualNotIdentical.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\NotIdentical($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\NotEqual;
     }

diff --git a/src/Mutator/Boolean/NotIdenticalNotEqual.php b/src/Mutator/Boolean/NotIdenticalNotEqual.php
@@ -54,7 +54,7 @@ public function mutate(Node $node)
         return new Node\Expr\BinaryOp\NotEqual($node->left, $node->right, $node->getAttributes());
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         return $node instanceof Node\Expr\BinaryOp\NotIdentical;
     }

diff --git a/src/Mutator/Boolean/TrueValue.php b/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 = [
+        'in_array' => false,
+        'array_search' => false,
+    ];
+
     /**
      * Replaces "true" with "false"
      *
@@ -54,12 +60,29 @@ public function mutate(Node $node)
         return new Node\Expr\ConstFetch(new Node\Name('false'));
     }
 
-    protected function mutatesNode(Node $node): bool
+    protected function mutatesNode(Node $node, array $mutatorSettings): bool
     {
         if (!($node instanceof Node\Expr\ConstFetch)) {
             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) {
+            $resultSettings = array_merge(self::DEFAULT_SETTINGS, $mutatorSettings);
+
+            $functionName = $grandParentNode->name->toLowerString();
+
+            if (array_key_exists($functionName, $resultSettings) && $resultSettings[$functionName] === false) {
+                return false;
+            }
+        }
+
+        return true;
     }
 }