CoverageGuard: enforce 70% coverage for all methods; add missing tests

Author: janedbal

composer.json

@@ -22,6 +22,7 @@
         "phpunit/phpunit": "^9.6.22",
         "shipmonk/coding-standard": "^0.2.0",
         "shipmonk/composer-dependency-analyser": "^1.8.1",
+        "shipmonk/coverage-guard": "dev-master",
         "shipmonk/dead-code-detector": "^0.9.0",
         "shipmonk/name-collision-detector": "^2.1.1",
         "shipmonk/phpstan-dev": "^0.1.2"
@@ -59,7 +60,7 @@
             "@check:ec",
             "@check:cs",
             "@check:types",
-            "@check:tests",
+            "@check:coverage",
             "@check:dependencies",
             "@check:collisions",
             "@check:ignores"
@@ -69,11 +70,15 @@
             "composer normalize --dry-run --no-check-lock --no-update-lock",
             "composer validate --strict"
         ],
+        "check:coverage": [
+            "XDEBUG_MODE=coverage phpunit tests --coverage-clover cache/clover.xml",
+            "coverage-guard check cache/clover.xml"
+        ],
         "check:cs": "phpcs",
         "check:dependencies": "composer-dependency-analyser",
         "check:ec": "ec src tests",
         "check:ignores": "php bin/verify-inline-ignore.php",
-        "check:tests": "phpunit -vvv tests",
+        "check:tests": "phpunit tests",
         "check:types": "phpstan analyse -vv --ansi",
         "fix:cs": "phpcbf"
     }

composer.lock

@@ -0,0 +1,12 @@
+<?php
+
+use ShipMonk\CoverageGuard\Config;
+use ShipMonk\CoverageGuard\Rule\EnforceCoverageForMethodsRule;
+
+$config = new Config();
+$config->addRule(new EnforceCoverageForMethodsRule(
+    requiredCoveragePercentage: 70,
+    minExecutableLines: 5,
+));
+
+return $config;

coverage-guard.php

@@ -14,4 +14,10 @@
     <php>
         <ini name="error_reporting" value="-1"/>
     </php>
+
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
 </phpunit>

phpunit.xml.dist

@@ -49,7 +49,8 @@ protected function getRule(): Rule
                 'ForbidCheckedExceptionInCallableRule\FirstClassCallableTest::allowThrow' => [1],
                 'ForbidCheckedExceptionInCallableRule\ArrowFunctionTest::allowThrow' => [0],
                 'ForbidCheckedExceptionInCallableRule\ArrowFunctionTest::__construct' => [0],
-                'allowed_function' => [0],
+                'ForbidCheckedExceptionInCallableRule\allowed_function' => [0], // not really needed as functions are always considered immediately invoked (https://phpstan.org/writing-php-code/phpdocs-basics#callables)
+                'ForbidCheckedExceptionInCallableRule\allowed_function_not_immediate' => [0],
             ],
         );
     }

tests/Rule/ForbidCheckedExceptionInCallableRuleTest.php

@@ -11,6 +11,11 @@ function throwing_function() {}
 
 function allowed_function(callable $callable) {}
 
+/**
+ * @param-later-invoked-callable $callable
+ */
+function allowed_function_not_immediate(callable $callable) {}
+
 interface CallableTest {
 
     public function allowThrowInInterface(callable $callable): void;
@@ -96,6 +101,12 @@ public function testPassedCallbacksA5(): void
         $this->allowThrow(42, throwing_function(...));
     }
 
+    public function testPassedCallbacksA6(): void
+    {
+        allowed_function(throwing_function(...));
+        allowed_function_not_immediate(throwing_function(...));
+    }
+
     public function testPassedCallbacksA6(): void
     {
         $this->immediateThrow(
@@ -510,3 +521,5 @@ private function throws(): void
         throw new CheckedException();
     }
 }
+
+