test: added unit tests for testable code

Author: vardumper

.githooks/pre-commit

@@ -139,6 +139,25 @@ else
     printf "${RED}Composer audit failed${NC}\n"
 fi
 
+# add pest unit tests. stopping the commit if they fail
+HAS_PEST=false
+PEST="./vendor/bin/pest"
+if [ -x $PEST ]; then
+    HAS_PEST=true
+fi
+printf "${YELLOW}Pest Unit Tests${NC}\n"
+if $HAS_PEST; then
+    if time exec $PEST --testdox --colors=always; then
+      # All good, also re-generate clover.xml
+        $PEST --coverage-clover clover.xml
+        printf "${GREEN}Pest tests passed${NC}\n"
+    else
+      PASS=false
+    fi
+else
+  printf "\npest is required. Install it with:\n\n  ddev composer require --dev pestphp/pest\n\n"
+fi
+
 END_TIME=$(date +%s) # Record the end time
 DURATION=$((END_TIME - START_TIME)) # Calculate the duration
 

.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Maintain dependencies for Composer
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/code-coverage.yml

@@ -0,0 +1,38 @@
+name: Code Coverage
+on:
+    push:
+    # only trigger if theres a change in src/ directory
+        paths:
+            - '.github/workflows/code-coverage.yml'
+            - 'clover.xml'
+    pull_request:
+        paths:
+            - '.github/workflows/code-coverage.yml'
+            - 'clover.xml'
+    workflow_dispatch:
+
+permissions:
+  contents: write
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+
+      - name: Generate code coverage badge
+        run: php bin/generate-coverage-badge.php clover.xml coverage.svg
+
+      - name: Commit badge
+        run: |
+            git config --global user.name 'github-actions[bot]'
+            git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+            git add coverage.svg
+            git commit -am "coverage.svg badge updated" --no-verify
+            git push --no-verify
+        continue-on-error: true # do not fail if nothing changed

.gitignore

@@ -1,2 +1,3 @@
 /vendor/
-/tests/examples/
+/tests/examples/
+/coverage-report/

README.md

@@ -86,10 +86,11 @@ Then run the tests:
 ./vendor/bin/pest
 ```
 
-### Test Structure
-
-- `tests/Feature/DeleteMigrationTest.php` - Tests the delete migration generation functionality
-- `tests/Feature/ContentTypeListenerTest.php` - Unit tests for the ContentTypeListener class
+### Coverage Report
+You can also generate a coverage report by running the following command.
+```
+XDEBUG_MODE=coverage vendor/bin/pest --coverage-html=coverage-report
+```
 
 ## Roadmap
 * Allow admins to execute pending migrations in the admin panel

bin/generate-coverage-badge.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+$cloverPath = $argv[1] ?? 'clover.xml';
+$outputPath = $argv[2] ?? 'coverage.svg';
+
+if (!is_file($cloverPath)) {
+    fwrite(\STDERR, "Clover report not found: {$cloverPath}\n");
+    exit(1);
+}
+
+libxml_use_internal_errors(true);
+$xml = simplexml_load_file($cloverPath);
+if ($xml === false) {
+    fwrite(\STDERR, "Failed to parse clover XML: {$cloverPath}\n");
+    foreach (libxml_get_errors() as $error) {
+        fwrite(\STDERR, trim($error->message) . "\n");
+    }
+    exit(1);
+}
+
+$metrics = $xml->project->metrics;
+if ($metrics === null) {
+    fwrite(\STDERR, "Clover XML is missing /coverage/project/metrics\n");
+    exit(1);
+}
+
+$statements = (int) ($metrics['statements'] ?? 0);
+$coveredStatements = (int) ($metrics['coveredstatements'] ?? 0);
+
+$percent = 0;
+if ($statements > 0) {
+    $percent = (int) round(($coveredStatements / $statements) * 100);
+}
+
+$percent = max(0, min(100, $percent));
+
+// Match the typical shields.io color thresholds.
+$color = '#e05d44'; // red
+if ($percent >= 90) {
+    $color = '#4c1'; // green
+} elseif ($percent >= 50) {
+    $color = '#dfb317'; // yellow
+}
+
+$percentText = $percent . ' %';
+
+$svg = <<<SVG
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="108" height="20" role="img">
+    <linearGradient id="s" x2="0" y2="100%">
+        <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+        <stop offset="1" stop-opacity=".1"/>
+    </linearGradient>
+    <clipPath id="r">
+        <rect width="108" height="20" rx="3" fill="#fff"/>
+    </clipPath>
+    <g clip-path="url(#r)">
+        <rect width="63" height="20" fill="#555"/>
+        <rect x="63" width="45" height="20" fill="{$color}"/>
+        <rect width="108" height="20" fill="url(#s)"/>
+    </g>
+    <g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110">
+        <text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">coverage</text>
+        <text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="530">coverage</text>
+        <text aria-hidden="true" x="850" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="350">{$percentText}</text>
+        <text x="850" y="140" transform="scale(.1)" fill="#fff" textLength="350">{$percentText}</text>
+    </g>
+</svg>
+SVG;
+
+if (file_put_contents($outputPath, $svg) === false) {
+    fwrite(\STDERR, "Failed to write badge: {$outputPath}\n");
+    exit(1);
+}