v0.4.17 Add backend coverage baseline tooling

.github/workflows/server.yml

@@ -40,5 +40,15 @@ jobs:
     - name: Run Lint
       run: composer lint
 
-    # - name: Run Tests -- Will add tests back after phppest issue https://github.com/pestphp/pest/issues/920 is fixed
-    #   run: composer test:unit
+    - name: Run Tests
+      run: composer test:unit
+
+    - name: Generate Coverage Baseline
+      run: XDEBUG_MODE=coverage composer coverage:baseline
+
+    - name: Upload Coverage Baseline
+      uses: actions/upload-artifact@v4
+      with:
+        name: storefront-coverage-clover
+        path: coverage/clover.xml
+        if-no-files-found: error

app/templates/promotions.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/storefront-engine/templates/promotions';

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "fleetbase/storefront-api",
-    "version": "0.4.16",
+    "version": "0.4.17",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "keywords": [
         "fleetbase-extension",
@@ -77,10 +77,17 @@
         }
     },
     "scripts": {
+        "coverage:baseline": [
+            "@test:coverage:clover",
+            "@coverage:summary"
+        ],
+        "coverage:summary": "php scripts/coverage-summary.php coverage/clover.xml",
         "lint": "php-cs-fixer fix -v",
         "test:lint": "php-cs-fixer fix -v --dry-run",
+        "test:coverage": "php scripts/coverage-runner.php --coverage --coverage-text --colors=always",
+        "test:coverage:clover": "mkdir -p coverage && php scripts/coverage-runner.php --coverage-clover=coverage/clover.xml --colors=always",
         "test:types": "phpstan analyse --ansi --memory-limit=0",
-        "test:unit": "pest --colors=always",
+        "test:unit": "php scripts/pest-runner.php --colors=always server/tests",
         "test": [
             "@test:lint",
             "@test:types",

extension.json

@@ -1,6 +1,6 @@
 {
     "name": "Storefront",
-    "version": "0.4.16",
+    "version": "0.4.17",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "repository": "https://github.com/fleetbase/storefront",
     "license": "AGPL-3.0-or-later",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fleetbase/storefront-engine",
-    "version": "0.4.16",
+    "version": "0.4.17",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "fleetbase": {
         "route": "storefront",
@@ -44,8 +44,8 @@
     },
     "dependencies": {
         "@babel/core": "^7.23.2",
-        "@fleetbase/ember-core": "^0.3.22",
-        "@fleetbase/ember-ui": "^0.3.34",
+        "@fleetbase/ember-core": "^0.3.24",
+        "@fleetbase/ember-ui": "^0.3.41",
         "@fleetbase/fleetops-data": "^0.1.37",
         "@fortawesome/ember-fontawesome": "^2.0.0",
         "@fortawesome/fontawesome-svg-core": "6.4.0",

phpunit.xml.dist

@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="./server_vendor/phpunit/phpunit/phpunit.xsd"
          colors="true"
 >
     <testsuites>
         <testsuite name="default">
-            <directory suffix=".php">./tests</directory>
+            <directory suffix=".php">./server/tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
+    <source>
+        <include>
+            <directory suffix=".php">./server/src</directory>
+        </include>
+    </source>
 </phpunit>

pnpm-workspace.yaml

@@ -5,4 +5,5 @@ allowBuilds:
   '@fortawesome/free-solid-svg-icons': false
   core-js: false
   fsevents: false
-minimumReleaseAge: 0
+minimumReleaseAge: 0
+packages: []

scripts/coverage-runner.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+$args = array_slice($argv, 1);
+
+if ($args === []) {
+    fwrite(STDERR, "Usage: php scripts/coverage-runner.php <pest coverage arguments>\n");
+    exit(1);
+}
+
+$pestRunner = getcwd() . '/scripts/pest-runner.php';
+if (!is_file($pestRunner)) {
+    fwrite(STDERR, "Unable to find Pest runner at scripts/pest-runner.php.\n");
+    exit(1);
+}
+
+$hasCoverageExtension = extension_loaded('xdebug') || extension_loaded('pcov');
+
+if (!$hasCoverageExtension) {
+    fwrite(STDERR, "No PHP coverage driver is available.\n\n");
+    fwrite(STDERR, "Install or enable one of:\n");
+    fwrite(STDERR, "  - Xdebug with XDEBUG_MODE=coverage\n");
+    fwrite(STDERR, "  - PCOV\n");
+    fwrite(STDERR, "\n");
+    fwrite(STDERR, 'Current PHP binary: ' . PHP_BINARY . "\n");
+    exit(1);
+}
+
+putenv('XDEBUG_MODE=coverage');
+$_ENV['XDEBUG_MODE']    = 'coverage';
+$_SERVER['XDEBUG_MODE'] = 'coverage';
+
+$hasTestTarget = false;
+foreach ($args as $arg) {
+    if ($arg !== '' && $arg[0] !== '-') {
+        $hasTestTarget = true;
+        break;
+    }
+}
+
+if (!$hasTestTarget && is_dir(getcwd() . '/server/tests')) {
+    $args[] = 'server/tests';
+}
+
+$command        = array_merge([PHP_BINARY, $pestRunner], $args);
+$escapedCommand = implode(' ', array_map('escapeshellarg', $command));
+
+passthru($escapedCommand, $exitCode);
+
+exit($exitCode);

scripts/coverage-summary.php

@@ -0,0 +1,110 @@
+<?php
+
+declare(strict_types=1);
+
+$cloverPath = $argv[1] ?? 'coverage/clover.xml';
+
+if (!is_file($cloverPath)) {
+    fwrite(STDERR, "Coverage file not found: {$cloverPath}\n");
+    fwrite(STDERR, "Run `composer test:coverage:clover` first.\n");
+    exit(1);
+}
+
+$xml = simplexml_load_file($cloverPath);
+if (!$xml) {
+    fwrite(STDERR, "Unable to parse Clover coverage file: {$cloverPath}\n");
+    exit(1);
+}
+
+function coveragePercent(int $covered, int $total): float
+{
+    return $total === 0 ? 0.0 : round(($covered / $total) * 100, 2);
+}
+
+function intMetric(SimpleXMLElement $node, string $name): int
+{
+    return (int) ($node->metrics[$name] ?? 0);
+}
+
+$project = $xml->project;
+$metrics = $project->metrics;
+
+$statements        = (int) ($metrics['statements'] ?? 0);
+$coveredStatements = (int) ($metrics['coveredstatements'] ?? 0);
+$methods           = (int) ($metrics['methods'] ?? 0);
+$coveredMethods    = (int) ($metrics['coveredmethods'] ?? 0);
+$classes           = (int) ($metrics['classes'] ?? 0);
+$coveredClasses    = (int) ($metrics['coveredclasses'] ?? 0);
+
+$files       = [];
+$directories = [];
+
+foreach ($project->xpath('.//file') ?: [] as $file) {
+    $path              = (string) $file['name'];
+    $fileStatements    = intMetric($file, 'statements');
+    $coveredFileLines  = intMetric($file, 'coveredstatements');
+    $fileMethods       = intMetric($file, 'methods');
+    $coveredFileMethod = intMetric($file, 'coveredmethods');
+
+    if ($fileStatements === 0) {
+        continue;
+    }
+
+    $files[] = [
+        'path'            => $path,
+        'covered'         => $coveredFileLines,
+        'statements'      => $fileStatements,
+        'methods'         => $fileMethods,
+        'covered_methods' => $coveredFileMethod,
+        'percent'         => coveragePercent($coveredFileLines, $fileStatements),
+    ];
+
+    $relativePath = preg_replace('#^' . preg_quote(getcwd(), '#') . '/?#', '', $path);
+    $parts        = explode('/', $relativePath ?: $path);
+    $directory    = count($parts) > 2 ? $parts[0] . '/' . $parts[1] : dirname($relativePath ?: $path);
+
+    if (!isset($directories[$directory])) {
+        $directories[$directory] = [
+            'covered'    => 0,
+            'statements' => 0,
+        ];
+    }
+
+    $directories[$directory]['covered'] += $coveredFileLines;
+    $directories[$directory]['statements'] += $fileStatements;
+}
+
+usort($files, function (array $a, array $b): int {
+    return $a['percent'] <=> $b['percent']
+        ?: $b['statements'] <=> $a['statements'];
+});
+
+$directoryRows = [];
+foreach ($directories as $directory => $directoryMetrics) {
+    $directoryRows[] = [
+        'directory'  => $directory,
+        'covered'    => $directoryMetrics['covered'],
+        'statements' => $directoryMetrics['statements'],
+        'percent'    => coveragePercent($directoryMetrics['covered'], $directoryMetrics['statements']),
+    ];
+}
+
+usort($directoryRows, function (array $a, array $b): int {
+    return $a['percent'] <=> $b['percent']
+        ?: $b['statements'] <=> $a['statements'];
+});
+
+printf("Line coverage: %.2f%% (%d/%d statements)\n", coveragePercent($coveredStatements, $statements), $coveredStatements, $statements);
+printf("Method coverage: %.2f%% (%d/%d methods)\n", coveragePercent($coveredMethods, $methods), $coveredMethods, $methods);
+printf("Class coverage: %.2f%% (%d/%d classes)\n", coveragePercent($coveredClasses, $classes), $coveredClasses, $classes);
+
+echo "\nLowest covered directories:\n";
+foreach (array_slice($directoryRows, 0, 10) as $row) {
+    printf("  %6.2f%%  %5d/%-5d  %s\n", $row['percent'], $row['covered'], $row['statements'], $row['directory']);
+}
+
+echo "\nLowest covered files:\n";
+foreach (array_slice($files, 0, 20) as $file) {
+    $relativePath = preg_replace('#^' . preg_quote(getcwd(), '#') . '/?#', '', $file['path']);
+    printf("  %6.2f%%  %5d/%-5d  %s\n", $file['percent'], $file['covered'], $file['statements'], $relativePath ?: $file['path']);
+}