build: cleans up coverage analysis

Author: aidan-casey

bin/test

@@ -0,0 +1,77 @@
+#!/usr/bin/env php
+<?php
+
+/**
+ * The following is heavily borrowed from Ecotone.
+ *
+ * This script allows us to dynamically retrieve the package namespace
+ * and directory from our composer file. This is then used by our GitHub
+ * action to publish the packages to their appropriate repositories.
+ *
+ * @link https://github.com/ecotoneframework/ecotone-dev/blob/main/bin/get-packages
+ */
+
+const PACKAGES_DIRECTORY = __DIR__ . '/../src/Tempest/';
+
+function getPackageNameFromComposerFile(string $composerFile)
+{
+    $composer = json_decode(file_get_contents($composerFile), true);
+
+    $name = $composer['name'] ?? throw new UnexpectedValueException(
+        'The referenced package is invalid because it is missing a name: ' . $composerFile
+    );
+
+    return str_replace('tempest/', '', $name);
+}
+
+/**
+ * @return array<array-key, array{
+ *     basename: string,
+ *     directory: string,
+ *     name: string,
+ *     package: string,
+ *     organization: string,
+ *     repository: string
+ * }>
+ */
+function getPackages(): array {
+    $packages = [];
+    $directoryIterator = new DirectoryIterator(realpath(PACKAGES_DIRECTORY));
+
+    /**
+     * @var DirectoryIterator $directory
+     */
+    foreach ($directoryIterator as $directory) {
+        if ($directory->isDot()) {
+            continue;
+        }
+
+        $file = $directory->getRealPath() . DIRECTORY_SEPARATOR . 'composer.json';
+
+        if (! file_exists($file)) {
+            continue;
+        }
+
+        $name = getPackageNameFromComposerFile($file);
+        $packages[] = [
+            'basename' => $directory->getBasename(),
+            'directory'  => $directory->getRealPath(),
+            'name' => $name,
+            'package' => 'tempest/' . $name,
+            'organization' => 'tempestphp',
+            'repository' => sprintf('tempest-%s', $name),
+        ];
+    }
+
+    return $packages;
+}
+
+foreach (getPackages() as $package) {
+    $config = $package['directory'] . '/phpunit.xml';
+
+    passthru(__DIR__ . "/../vendor/bin/phpunit -c $config --bootstrap " . __DIR__ . "/../vendor/autoload.php --stop-on-failure --stop-on-risky", $result);
+
+    if ($result !== 0) {
+        exit;
+    }
+}

composer.json

@@ -34,7 +34,7 @@
         "symfony/uid": "^7.1",
         "symfony/var-dumper": "^7.1",
         "symfony/var-exporter": "^7.1",
-        "tempest/highlight": "^2.11.2",
+        "tempest/highlight": "^2.11.4",
         "vlucas/phpdotenv": "^5.6",
         "voku/portable-ascii": "^2.0.3"
     },

phpunit.xml.dist

@@ -3,6 +3,8 @@
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd"
         colors="true"
+        requireCoverageMetadata="true"
+        beStrictAboutCoverageMetadata="true"
         displayDetailsOnTestsThatTriggerDeprecations="true"
         displayDetailsOnTestsThatTriggerErrors="true"
         displayDetailsOnTestsThatTriggerNotices="true"

src/Tempest/Auth/phpunit.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" requireCoverageMetadata="true" beStrictAboutCoverageMetadata="true" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true">
     <testsuites>
         <testsuite name="Tempest Auth">
             <directory>tests</directory>

src/Tempest/Cache/phpunit.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" requireCoverageMetadata="true" beStrictAboutCoverageMetadata="true" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true">
     <testsuites>
         <testsuite name="Tempest Clock">
             <directory>tests</directory>

src/Tempest/Clock/.phpunit.result.cache

@@ -0,0 +1 @@
+{"version":1,"defects":[],"times":{"Tempest\\Clock\\Tests\\GenericClockTest::test_that_generic_clock_returns_the_current_date_time":0.001,"Tempest\\Clock\\Tests\\GenericClockTest::test_that_generic_clock_returns_the_current_time":0,"Tempest\\Clock\\Tests\\GenericClockTest::test_that_generic_clock_sleeps":1.006,"Tempest\\Clock\\Tests\\MockClockTest::test_mock_clock_returns_the_date_time_we_want":0,"Tempest\\Clock\\Tests\\MockClockTest::test_mock_clock_defaults_to_now":0.001,"Tempest\\Clock\\Tests\\MockClockTest::test_mock_clock_returns_the_time_we_want":0,"Tempest\\Clock\\Tests\\MockClockTest::test_mock_clock_sleeps_time":0,"Tempest\\Clock\\Tests\\MockClockTest::test_mock_clock_can_change_time":0}}

src/Tempest/Clock/phpunit.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" requireCoverageMetadata="true" beStrictAboutCoverageMetadata="true" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true">
     <testsuites>
         <testsuite name="Tempest Clock">
             <directory>tests</directory>

src/Tempest/Clock/tests/GenericClockTest.php

@@ -5,12 +5,14 @@
 namespace Tempest\Clock\Tests;
 
 use DateTimeImmutable;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 use Tempest\Clock\GenericClock;
 
 /**
  * @internal
  */
+#[CoversClass(GenericClock::class)]
 final class GenericClockTest extends TestCase
 {
     public function test_that_generic_clock_returns_the_current_date_time(): void

src/Tempest/Clock/tests/MockClockTest.php

@@ -5,12 +5,14 @@
 namespace Tempest\Clock\Tests;
 
 use DateTimeImmutable;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 use Tempest\Clock\MockClock;
 
 /**
  * @internal
  */
+#[CoversClass(MockClock::class)]
 final class MockClockTest extends TestCase
 {
     public function test_mock_clock_returns_the_date_time_we_want(): void

src/Tempest/CommandBus/.phpunit.result.cache

@@ -0,0 +1 @@
+{"version":1,"defects":{"Tempest\\CommandBus\\Tests\\GenericCommandBusTest::test_getting_command_handler_that_exists":5,"Tempest\\CommandBus\\Tests\\GenericCommandBusTest::test_exception_is_thrown_when_command_handler_doesnt_exist":5,"Tempest\\CommandBus\\Tests\\GenericCommandBusTest::test_exception_is_thrown_when_command_handler_already_exist":5},"times":{"Tempest\\CommandBus\\Tests\\GenericCommandBusTest::test_getting_command_handler_that_exists":0.001,"Tempest\\CommandBus\\Tests\\GenericCommandBusTest::test_exception_is_thrown_when_command_handler_doesnt_exist":0,"Tempest\\CommandBus\\Tests\\GenericCommandBusTest::test_exception_is_thrown_when_command_handler_already_exist":0}}