aggregate classes (#1)

---------

Co-authored-by: Michael Strelan <mstrelan@gmail.com>
Co-authored-by: Michael Strelan <michael.strelan@previousnext.com.au>

Author: kimpepper

.github/workflows/build.yml

@@ -0,0 +1,39 @@
+name: 🏗 Build
+
+on:
+  pull_request:
+    types: [ synchronize, opened, reopened, ready_for_review ]
+  push:
+    branches: [ main ]
+
+permissions:
+  checks: write
+  pull-requests: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        prefer_lowest: ["", "--prefer-lowest"]
+    container:
+      image: skpr/php-cli:${{ inputs.php_cli_tag }}
+      options:
+        --pull always
+        --user 1001:1001
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          show-progress: false
+      - name: 📦 Composer Install
+        run: composer install --prefer-dist --no-progress --no-interaction ${{ matrix.prefer_lowest }}
+      - name: 🧹 PHPStan
+        run: ./bin/phpstan --error-format=github analyse
+      - name: ⚡ Run Tests
+        run: ./bin/phpunit --log-junit phpunit-results.xml
+      - name: 📝 Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: phpunit-results.xml

.gitignore

@@ -1,3 +1,4 @@
+/bin/
 /vendor/
 /.phpunit.result.cache
 /composer.lock

.phpunit.cache/test-results

@@ -0,0 +1 @@
+{"version":1,"defects":{"PhpUnitSplitter\\Tests\\PhpUnitSplitterTest::testSplitter":5},"times":{"PhpUnitSplitter\\Tests\\PhpUnitSplitterTest::testSplitter":0.001}}

README.md

@@ -0,0 +1,44 @@
+# PHPUnit Test Splitter
+
+Allows you to split your PHPUnit tests by timings.
+
+## Usage
+
+Generate a timing file:
+
+```bash
+phpunit --cache-result --cache-result-file=.phpunit.result.cache
+```
+
+List your tests:
+
+```bash
+phpunit --list-tests-xml=tests.xml 
+```
+
+This generates an XML file with a list of tests. You can add `--testsuite` to limit the tests to a specific suite.
+
+Split the tests in 2 groups and get the first group (0):
+
+```bash
+phpunit-splitter 2 0 --tests-file=tests.xml --results-file=.phpunit.result.cache
+```
+
+Split the tests in 4 groups and get the third group (2):
+
+```bash
+phpunit-splitter 4 2 --tests-file=tests.xml --results-file=.phpunit.result.cache
+```
+
+Pass the results to PHPUnit:
+
+```bash
+./phpunit-splitter 2 0 --tests-file=tests/fixtures/tests.xml --results-file=tests/fixtures/.phpunit.result.cache | xargs ./vendor/bin/phpunit 
+done
+```
+
+Output the test list as JSON:
+
+```bash
+./phpunit-splitter 2 0 --json --tests-file=tests/fixtures/tests.xml --results-file=tests/fixtures/.phpunit.result.cache
+```

composer.json

@@ -11,16 +11,24 @@
   "type": "project",
   "require": {
     "php": "^8.1",
-    "phpunit/phpunit": "^9.6",
-    "previousnext/phpunit-finder": "^2.0"
+    "ext-simplexml": "*",
+    "symfony/console": "^6.3"
+  },
+  "require-dev": {
+    "phpstan/phpstan": "^1.10",
+    "phpunit/phpunit": "^9.6"
   },
   "autoload": {
     "psr-4": {"PhpUnitSplitter\\": "src/"}
   },
   "autoload-dev": {
-    "psr-4": {"PhpUnitSplitter\\Tests\\": "tests/"}
+    "psr-4": {
+      "PhpUnitSplitter\\Tests\\": "tests/src",
+      "PhpUnitSplitter\\Tests\\Fixtures\\": "tests/fixtures/src"
+    }
   },
   "config": {
-    "sort-packages": true
+    "sort-packages": true,
+    "bin-dir": "bin"
   }
 }

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+	level: 6
+	paths:
+		- src
+		- tests/src

phpunit-splitter

@@ -0,0 +1,33 @@
+#!/usr/bin/env php
+<?php
+/**
+ * @file
+ * Console application for PHPUnit Splitter.
+ */
+
+$autoload = [
+  __DIR__ . '/vendor/autoload.php',
+  dirname(__DIR__, 1) . '/vendor/autoload.php',
+  dirname(__DIR__, 2) . '/vendor/autoload.php',
+  dirname(__DIR__, 1) . '/autoload.php',
+  dirname(__DIR__, 2) . '/autoload.php',
+];
+foreach ($autoload as $file) {
+  if (file_exists($file)) {
+    require $file;
+    break;
+  }
+}
+
+const APP_NAME = 'PHPUnit Splitter';
+const VERSION = '1.x-dev';
+
+use PhpUnitSplitter\SplitterCommand;
+use Symfony\Component\Console\Application;
+
+
+$application = new Application(APP_NAME, VERSION);
+$command = new SplitterCommand('phpunit-splitter');
+$application->add($command);
+$application->setDefaultCommand($command->getName(), TRUE);
+$application->run();

phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheResultFile=".phpunit.cache/test-results"
+         executionOrder="depends,defects"
+         forceCoversAnnotation="true"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests/src</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>

scripts/generate-fixtures.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+./vendor/bin/phpunit --list-tests-xml=tests/fixtures/tests.xml tests/fixtures/src
+./vendor/bin/phpunit tests/fixtures/src --cache-result --cache-result-file=tests/fixtures/.phpunit.result.cache

src/SplitterCommand.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpUnitSplitter;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * A symfony command for splitting PHPUnit tests.
+ */
+class SplitterCommand extends Command {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function configure(): void {
+    $this->addArgument('splits', InputArgument::OPTIONAL, "The number of splits", 1);
+    $this->addArgument('index', InputArgument::OPTIONAL, "The index of the current split", 0);
+    $this->addOption('tests-file', 't', InputOption::VALUE_REQUIRED, "The xml file listing all tests.", getcwd() . '/tests.xml');
+    $this->addOption('results-file', 'f', InputOption::VALUE_REQUIRED, "The results cache file.", getcwd() . '/.phpunit.result.cache', );
+    $this->addOption('bootstrap-file', 'b', InputOption::VALUE_OPTIONAL, "The tests bootstrap file.", getcwd() . '/tests/bootstrap.php');
+    $this->addOption('prefix', 'p', InputOption::VALUE_OPTIONAL, "The prefix to remove from the file names.", getcwd() . '/');
+    $this->addOption('json', 'j', InputOption::VALUE_NONE, "Output the result as json.");
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function execute(InputInterface $input, OutputInterface $output): int {
+    $bootstrap = $input->getOption('bootstrap-file');
+    if (\file_exists($bootstrap)) {
+      include_once $bootstrap;
+    }
+    // @todo validation
+    $splits = (int) $input->getArgument('splits');
+    $index = (int) $input->getArgument('index');
+    $testsFile = $input->getOption('tests-file');
+    $resultsFile = $input->getOption('results-file');
+    $prefix = $input->getOption('prefix');
+    $json = $input->getOption('json');
+
+    $mapper = new TestMapper($testsFile, $resultsFile, $prefix);
+    $map = $mapper->sortMap($mapper->getMap());
+
+    $split = $this->split($map, $splits, $index);
+    if ($json) {
+      $output->writeln(\json_encode($split));
+      return Command::SUCCESS;
+    }
+    foreach ($split as $testPath => $test) {
+      $output->writeln($testPath);
+    }
+
+    return Command::SUCCESS;
+  }
+
+  /**
+   * Splits the map into the given number of splits.
+   *
+   * @param array<string,array<string,float>> $map
+   *
+   * @return array<string,array<string,float>>
+   */
+  private function split(array $map, int $splits, int $index): array {
+    $result = [];
+    $keys = array_keys($map);
+    $values = array_values($map);
+
+    for ($i = $index; $i < count($map); $i++) {
+      if (($i - $index) % $splits === 0) {
+        $result[$keys[$i]] = $values[$i];
+      }
+    }
+
+    return $result;
+  }
+
+}

src/TestMapper.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpUnitSplitter;
+
+use PHPUnit\Runner\DefaultTestResultCache;
+use PHPUnit\Runner\TestResultCache;
+
+/**
+ * Generates a map of test methods with their file name and execution time.
+ */
+final class TestMapper {
+
+  private \SimpleXMLElement|false $testsXml;
+
+  private TestResultCache $resultCache;
+
+  private string $prefix;
+
+  /**
+   * Constructs a new TestMapper.
+   */
+  public function __construct(string $testListFilePath, string $testResultFilePath, string $prefix) {
+    $this->testsXml = \simplexml_load_file($testListFilePath);
+    $this->resultCache = new DefaultTestResultCache($testResultFilePath);
+    $this->prefix = $prefix;
+  }
+
+  /**
+   * Returns a map of test methods with their file name and execution time.
+   *
+   * @return array<string,array<string,float>>
+   *   The map of test files and execution times.
+   */
+  public function getMap(): array {
+    $this->resultCache->load();
+    $map = [];
+    $classesXpath = $this->testsXml->xpath('//testCaseClass');
+    foreach ($classesXpath as $class) {
+      $className = (string) $class->attributes()['name'];
+      try {
+        $reflection = new \ReflectionClass($className);
+      } catch (\ReflectionException $e) {
+        // Couldn't find the class.
+        continue;
+      }
+      $filename = $reflection->getFileName();
+      if (\str_starts_with($filename, $this->prefix)) {
+        $filename = \substr($filename, \strlen($this->prefix));
+      }
+      $map[$filename] = [
+        'className' => $className,
+        'time' => 0.0,
+      ];
+      $testCases = $class->xpath('testCaseMethod');
+      foreach ($testCases as $testCase) {
+        $shortName = (string) $testCase->attributes()['name'];
+        $fullName = $reflection->getName() . '::' . $shortName;
+        $dataSet = $testCase->attributes()['dataSet'] ?? NULL;
+        $cacheKey = $fullName;
+        if ($dataSet !== NULL) {
+          $cacheKey .= " with data set $dataSet";
+          $shortName .= "@$dataSet";
+        }
+        $time = $this->resultCache->getTime($cacheKey);
+        $map[$filename]['testCases'][] = [
+          'testCase' => $shortName,
+          'time' => $time,
+        ];
+        $map[$filename]['time'] += $time;
+      }
+    }
+    return $map;
+  }
+
+  /**
+   * Sorts the map by execution time.
+   *
+   * @param array<string,array<string,float>> $map
+   *   The map to sort.
+   *
+   * @return array<string,array<string,float>>
+   *   The sorted map.
+   */
+  public function sortMap(array $map): array {
+    uasort($map, function ($a, $b) {
+      return $a['time'] <=> $b['time'];
+    });
+    return $map;
+  }
+
+}

tests/fixtures/.phpunit.result.cache

@@ -0,0 +1 @@
+{"version":1,"defects":[],"times":{"PhpUnitSplitter\\Tests\\Fixtures\\FastTestsTest::testOne":0.011,"PhpUnitSplitter\\Tests\\Fixtures\\FastTestsTest::testTwo":0.02,"PhpUnitSplitter\\Tests\\Fixtures\\FastTestsTest::testThree":0.03,"PhpUnitSplitter\\Tests\\Fixtures\\FastTestsTest::testFour":0.04,"PhpUnitSplitter\\Tests\\Fixtures\\FastTestsTest::testFive":0.05,"PhpUnitSplitter\\Tests\\Fixtures\\ProviderTest::testProvider with data set \"one\"":0.111,"PhpUnitSplitter\\Tests\\Fixtures\\ProviderTest::testProvider with data set \"two\"":0.445,"PhpUnitSplitter\\Tests\\Fixtures\\ProviderTest::testProvider with data set \"three\"":0.222,"PhpUnitSplitter\\Tests\\Fixtures\\ProviderTest::testProvider with data set \"four\"":0.334,"PhpUnitSplitter\\Tests\\Fixtures\\ProviderTest::testProvider with data set \"five\"":0.667,"PhpUnitSplitter\\Tests\\Fixtures\\SlowTestsTest::testOne":0.1,"PhpUnitSplitter\\Tests\\Fixtures\\SlowTestsTest::testTwo":0.2,"PhpUnitSplitter\\Tests\\Fixtures\\SlowTestsTest::testThree":0.3,"PhpUnitSplitter\\Tests\\Fixtures\\SlowTestsTest::testFour":0.4,"PhpUnitSplitter\\Tests\\Fixtures\\SlowTestsTest::testFive":0.5}}