From bf27a84be7acc67db44089c432c59dc3e51382b2 Mon Sep 17 00:00:00 2001
From: Alexey Kopytko <alexey@kopytko.com>
Date: Wed, 5 May 2021 00:39:47 +0900
Subject: [PATCH] Remove CodeCoverageAnnotationIgnorer (#1517)

Since we have a very explicit annotation `@infection-ignore-all` (added in #1468) that, again, very explicit on the purpose, and works not only for methods, but for most kinds of statements, let's remove `@codeCoverageIgnore` ignorer, that not only implicit (you may only want to ignore a piece of code temporarily, and only ignore) but also messes up the metrics (hides otherwise-uncovered mutations).
---
 .../PhpUnitCodeCoverageAnnotationIgnorer.php  |  59 -------
 .../PhpUnit/Adapter/PhpUnitAdapter.php        |   9 +-
 .../src/DoNotMutateClass.php                  |  12 ++
 .../tests/DoNotMutateClassTest.php            |  16 ++
 ...pUnitCodeCoverageAnnotationIgnorerTest.php | 161 ------------------
 .../PhpUnit/Adapter/PhpUnitAdapterTest.php    |  12 --
 6 files changed, 29 insertions(+), 240 deletions(-)
 delete mode 100644 src/PhpParser/Visitor/IgnoreNode/PhpUnitCodeCoverageAnnotationIgnorer.php
 create mode 100644 tests/e2e/Ignore_All_Mutations/src/DoNotMutateClass.php
 create mode 100644 tests/e2e/Ignore_All_Mutations/tests/DoNotMutateClassTest.php
 delete mode 100644 tests/phpunit/PhpParser/Visitor/IgnoreNode/PhpUnitCodeCoverageAnnotationIgnorerTest.php

diff --git a/src/PhpParser/Visitor/IgnoreNode/PhpUnitCodeCoverageAnnotationIgnorer.php b/src/PhpParser/Visitor/IgnoreNode/PhpUnitCodeCoverageAnnotationIgnorer.php
deleted file mode 100644
index 85d0978cc..000000000
--- a/src/PhpParser/Visitor/IgnoreNode/PhpUnitCodeCoverageAnnotationIgnorer.php
+++ /dev/null
@@ -1,59 +0,0 @@
-<?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\PhpParser\Visitor\IgnoreNode;
-
-use PhpParser\Node;
-use PhpParser\Node\Stmt;
-use function strpos;
-
-/**
- * @internal
- */
-final class PhpUnitCodeCoverageAnnotationIgnorer implements NodeIgnorer
-{
-    public function ignores(Node $node): bool
-    {
-        if (!$node instanceof Stmt\ClassLike && !$node instanceof Stmt\ClassMethod) {
-            return false;
-        }
-
-        $docComment = $node->getDocComment();
-
-        return $docComment !== null
-            && strpos($docComment->getText(), '@codeCoverageIgnore') !== false
-        ;
-    }
-}
diff --git a/src/TestFramework/PhpUnit/Adapter/PhpUnitAdapter.php b/src/TestFramework/PhpUnit/Adapter/PhpUnitAdapter.php
index 13b6cc69f..03326c597 100644
--- a/src/TestFramework/PhpUnit/Adapter/PhpUnitAdapter.php
+++ b/src/TestFramework/PhpUnit/Adapter/PhpUnitAdapter.php
@@ -38,13 +38,11 @@
 use function escapeshellarg;
 use Infection\AbstractTestFramework\MemoryUsageAware;
 use Infection\Config\ValueProvider\PCOVDirectoryProvider;
-use Infection\PhpParser\Visitor\IgnoreNode\PhpUnitCodeCoverageAnnotationIgnorer;
 use Infection\TestFramework\AbstractTestFrameworkAdapter;
 use Infection\TestFramework\CommandLineArgumentsAndOptionsBuilder;
 use Infection\TestFramework\CommandLineBuilder;
 use Infection\TestFramework\Config\InitialConfigBuilder;
 use Infection\TestFramework\Config\MutationConfigBuilder;
-use Infection\TestFramework\IgnoresAdditionalNodes;
 use Infection\TestFramework\ProvidesInitialRunOnlyOptions;
 use Infection\TestFramework\VersionParser;
 use function Safe\preg_match;
@@ -56,7 +54,7 @@
  * @internal
  * @final
  */
-class PhpUnitAdapter extends AbstractTestFrameworkAdapter implements IgnoresAdditionalNodes, MemoryUsageAware, ProvidesInitialRunOnlyOptions
+class PhpUnitAdapter extends AbstractTestFrameworkAdapter implements MemoryUsageAware, ProvidesInitialRunOnlyOptions
 {
     public const COVERAGE_DIR = 'coverage-xml';
 
@@ -172,11 +170,6 @@ public function getInitialTestsFailRecommendations(string $commandLine): string
         return $recommendations;
     }
 
-    public function getNodeIgnorers(): array
-    {
-        return [new PhpUnitCodeCoverageAnnotationIgnorer()];
-    }
-
     /**
      * @return string[]
      */
diff --git a/tests/e2e/Ignore_All_Mutations/src/DoNotMutateClass.php b/tests/e2e/Ignore_All_Mutations/src/DoNotMutateClass.php
new file mode 100644
index 000000000..917716edb
--- /dev/null
+++ b/tests/e2e/Ignore_All_Mutations/src/DoNotMutateClass.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Ignore_All_Mutations;
+
+/** @infection-ignore-all */
+class DoNotMutateClass
+{
+    public function divide(int $a, int $b): float
+    {
+        return $a / $b;
+    }
+}
diff --git a/tests/e2e/Ignore_All_Mutations/tests/DoNotMutateClassTest.php b/tests/e2e/Ignore_All_Mutations/tests/DoNotMutateClassTest.php
new file mode 100644
index 000000000..d1169567d
--- /dev/null
+++ b/tests/e2e/Ignore_All_Mutations/tests/DoNotMutateClassTest.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Ignore_All_Mutations\Test;
+
+use Ignore_All_Mutations\DoNotMutateClass;
+use PHPUnit\Framework\TestCase;
+
+class DoNotMutateClassTest extends TestCase
+{
+    public function test_divide()
+    {
+        $sourceClass = new DoNotMutateClass();
+        $this->assertGreaterThan(0.0, $sourceClass->divide(2, 2));
+    }
+
+}
diff --git a/tests/phpunit/PhpParser/Visitor/IgnoreNode/PhpUnitCodeCoverageAnnotationIgnorerTest.php b/tests/phpunit/PhpParser/Visitor/IgnoreNode/PhpUnitCodeCoverageAnnotationIgnorerTest.php
deleted file mode 100644
index cb7c66c2d..000000000
--- a/tests/phpunit/PhpParser/Visitor/IgnoreNode/PhpUnitCodeCoverageAnnotationIgnorerTest.php
+++ /dev/null
@@ -1,161 +0,0 @@
-<?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\PhpParser\Visitor\IgnoreNode;
-
-use Infection\PhpParser\Visitor\IgnoreNode\NodeIgnorer;
-use Infection\PhpParser\Visitor\IgnoreNode\PhpUnitCodeCoverageAnnotationIgnorer;
-
-final class PhpUnitCodeCoverageAnnotationIgnorerTest extends BaseNodeIgnorerTestCase
-{
-    /**
-     * @dataProvider provideIgnoreCases
-     */
-    public function test_it_ignores_the_right_nodes(string $code, int $count): void
-    {
-        $spy = $this->createSpy();
-
-        $this->parseAndTraverse($code, $spy);
-
-        $this->assertSame($count, $spy->nodeCounter);
-    }
-
-    public function provideIgnoreCases(): iterable
-    {
-        yield 'classes with annotation are ignored' => [
-            <<<'PHP'
-<?php
-
-/**
- * @codeCoverageIgnore
- */
-class IgnoredClass
-{
-    public function foo()
-    {
-        $ignored = true;
-    }
-}
-PHP
-            ,
-            0,
-        ];
-
-        yield 'method with annotations are ignored' => [
-            <<<'PHP'
-<?php
-
-class IgnoredClass
-{
-    /**
-     * @codeCoverageIgnore
-     */
-    public function foo()
-    {
-        $ignored = true;
-    }
-
-    public function bar(): void
-    {
-        $counted = 1;
-    }
-
-}
-PHP
-            ,
-            1,
-        ];
-
-        yield 'methods without comments are not ignored' => [
-            <<<'PHP'
-<?php
-
-class IgnoredClass
-{
-    public function foo($counted)
-    {
-        $counted = true;
-    }
-}
-PHP
-            ,
-            2,
-        ];
-
-        yield 'classes without ignore annotation are not ignored' => [
-            <<<'PHP'
-<?php
-
-/**
- * A comment, but not one that ignores
- */
-class Foo
-{
-    public function bar($counted)
-    {
-        $counted = 2;
-    }
-}
-PHP
-            ,
-            2,
-        ];
-
-        yield 'methods without ignore annotation are not ignored' => [
-            <<<'PHP'
-<?php
-
-
-class Foo
-{
-    /**
-     * A comment, but not one that ignores
-     */
-    public function bar($counted)
-    {
-        $counted = 2;
-    }
-}
-PHP
-            ,
-            2,
-        ];
-    }
-
-    protected function getIgnore(): NodeIgnorer
-    {
-        return new PhpUnitCodeCoverageAnnotationIgnorer();
-    }
-}
diff --git a/tests/phpunit/TestFramework/PhpUnit/Adapter/PhpUnitAdapterTest.php b/tests/phpunit/TestFramework/PhpUnit/Adapter/PhpUnitAdapterTest.php
index ed119f051..212fdc7ba 100644
--- a/tests/phpunit/TestFramework/PhpUnit/Adapter/PhpUnitAdapterTest.php
+++ b/tests/phpunit/TestFramework/PhpUnit/Adapter/PhpUnitAdapterTest.php
@@ -35,10 +35,8 @@
 
 namespace Infection\Tests\TestFramework\PhpUnit\Adapter;
 
-use function array_map;
 use const DIRECTORY_SEPARATOR;
 use Infection\Config\ValueProvider\PCOVDirectoryProvider;
-use Infection\PhpParser\Visitor\IgnoreNode\PhpUnitCodeCoverageAnnotationIgnorer;
 use Infection\TestFramework\CommandLineArgumentsAndOptionsBuilder;
 use Infection\TestFramework\CommandLineBuilder;
 use Infection\TestFramework\PhpUnit\Adapter\PhpUnitAdapter;
@@ -124,16 +122,6 @@ public function test_it_provides_initial_run_only_options(): void
         );
     }
 
-    public function test_it_provides_node_ignorers(): void
-    {
-        $nodeIgnorers = array_map('get_class', $this->adapter->getNodeIgnorers());
-
-        $this->assertSame(
-            [PhpUnitCodeCoverageAnnotationIgnorer::class],
-            $nodeIgnorers
-        );
-    }
-
     /**
      * @group integration
      */