GH-119: Add module-scoped phpunit GrumPHP task

config/grumphp.yml

@@ -13,6 +13,7 @@ grumphp:
     yaml_lint: ~
     json_lint: ~
     psalm: ~
+    phpunit_drupal_modules: ~
   extensions:
     - Wunderio\GrumPHP\Task\PhpCompatibility\PhpCompatibilityExtensionLoader
     - Wunderio\GrumPHP\Task\PhpCheckSyntax\PhpCheckSyntaxExtensionLoader
@@ -23,3 +24,4 @@ grumphp:
     - Wunderio\GrumPHP\Task\YamlLint\YamlLintExtensionLoader
     - Wunderio\GrumPHP\Task\JsonLint\JsonLintExtensionLoader
     - Wunderio\GrumPHP\Task\Psalm\PsalmExtensionLoader
+    - Wunderio\GrumPHP\Task\PhpUnitDrupalModules\PhpUnitDrupalModulesExtensionLoader

src/Task/PhpUnitDrupalModules/PhpUnitDrupalModulesExtensionLoader.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wunderio\GrumPHP\Task\PhpUnitDrupalModules;
+
+use Wunderio\GrumPHP\Task\AbstractExternalExtensionLoader;
+
+/**
+ * Registers the PhpUnitDrupalModules task in GrumPHP.
+ */
+class PhpUnitDrupalModulesExtensionLoader extends AbstractExternalExtensionLoader {}

src/Task/PhpUnitDrupalModules/PhpUnitDrupalModulesTask.php

@@ -0,0 +1,229 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wunderio\GrumPHP\Task\PhpUnitDrupalModules;
+
+use GrumPHP\Collection\ProcessArgumentsCollection;
+use GrumPHP\Runner\TaskResult;
+use GrumPHP\Runner\TaskResultInterface;
+use GrumPHP\Task\Context\ContextInterface;
+use Wunderio\GrumPHP\Task\AbstractMultiPathProcessingTask;
+
+/**
+ * Class PhpUnitDrupalModulesTask.
+ *
+ * Runs phpunit only for affected Drupal custom modules.
+ */
+class PhpUnitDrupalModulesTask extends AbstractMultiPathProcessingTask {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function run(ContextInterface $context): TaskResultInterface {
+    $config = $this->getConfig()->getOptions();
+    $paths = $this->getPathsOrResult($context, $config, $this);
+
+    if ($paths instanceof TaskResultInterface) {
+      return $paths;
+    }
+
+    $moduleRoots = $this->getModuleRoots($config);
+    $modules = $this->collectModulesFromPaths($paths, $moduleRoots);
+
+    [$modulesWithTests, $modulesWithoutTests] = $this->splitModulesByTests($modules);
+
+    $this->printModulesWithoutTests($modulesWithoutTests);
+
+    if (!$modulesWithTests) {
+      return TaskResult::createSkipped($this, $context);
+    }
+
+    // Run phpunit once per affected module so that each module's directory
+    // is honoured even when a testsuite is used in the configuration file.
+    $this->printModulesWithTests($modulesWithTests);
+
+    $moduleCount = count($modulesWithTests);
+    $timeout = $config['timeout'] ?? NULL;
+
+    foreach ($modulesWithTests as $index => $modulePath) {
+      $process = $this->processBuilder->buildProcess($this->buildArguments([$modulePath]));
+
+      if ($timeout !== NULL) {
+        $process->setTimeout($timeout);
+      }
+
+      $process->run();
+
+      $result = $this->getTaskResult($process, $context);
+
+      fwrite(
+        STDOUT,
+        sprintf(
+          "%s: finished module %d/%d: %s [%s]\n\n",
+          $this->getName(),
+          $index + 1,
+          $moduleCount,
+          $modulePath,
+          $result->isPassed() ? 'OK' : 'FAILED'
+        )
+      );
+
+      if (!$result->isPassed()) {
+        // Stop on first failure/error to keep feedback fast and clear.
+        return $result;
+      }
+    }
+
+    return TaskResult::createPassed($this, $context);
+  }
+
+  /**
+   * Determine which directory roots should be treated as Drupal module roots.
+   *
+   * Defaults to web/modules/custom for backward compatibility, but can be
+   * configured via the run_on option in tasks.yml.
+   *
+   * @param array $config
+   *   Task configuration options.
+   *
+   * @return string[]
+   *   Normalised module root paths.
+   */
+  private function getModuleRoots(array $config): array {
+    $moduleRoots = $config['run_on'] ?? ['web/modules/custom'];
+    $normalisedRoots = [];
+    foreach ($moduleRoots as $root) {
+      $normalisedRoots[] = rtrim((string) $root, '/');
+    }
+    return array_values($normalisedRoots);
+  }
+
+  /**
+   * Collect all affected modules from the changed file paths.
+   *
+   * @param iterable $paths
+   *   Changed paths.
+   * @param string[] $moduleRoots
+   *   Module root directories.
+   *
+   * @return string[]
+   *   Module paths keyed by path for uniqueness.
+   */
+  protected function collectModulesFromPaths(iterable $paths, array $moduleRoots): array {
+    $modules = [];
+    foreach ($paths as $file) {
+      $path = (string) $file;
+      foreach ($moduleRoots as $root) {
+        $rootWithSlash = $root . '/';
+
+        if (!str_starts_with($path, $rootWithSlash)) {
+          continue;
+        }
+
+        if (preg_match('#^(' . preg_quote($root, '#') . '/[^/]+)#', $path, $matches)) {
+          $modules[$matches[1]] = $matches[1];
+        }
+      }
+    }
+
+    return $modules;
+  }
+
+  /**
+   * Split modules into ones with and without tests directories.
+   *
+   * @param string[] $modules
+   *   All affected modules.
+   *
+   * @return array{0: string[], 1: string[]}
+   *   First array contains modules with tests, second without.
+   */
+  protected function splitModulesByTests(array $modules): array {
+    $modulesWithTests = [];
+    foreach ($modules as $modulePath) {
+      if (is_dir($modulePath . '/tests')) {
+        $modulesWithTests[] = $modulePath;
+      }
+    }
+
+    $modulesWithoutTests = array_values(array_diff($modules, $modulesWithTests));
+
+    return [$modulesWithTests, $modulesWithoutTests];
+  }
+
+  /**
+   * Print a note about affected modules that do not have tests.
+   *
+   * @param string[] $modulesWithoutTests
+   *   Affected modules without tests.
+   */
+  private function printModulesWithoutTests(array $modulesWithoutTests): void {
+    if (!$modulesWithoutTests) {
+      return;
+    }
+
+    $lines = [];
+    foreach ($modulesWithoutTests as $modulePath) {
+      $lines[] = '  - ' . $modulePath;
+    }
+
+    fwrite(
+      STDOUT,
+      sprintf(
+        "\n%s: NOTE: affected modules without tests:\n%s\n\n",
+        $this->getName(),
+        implode("\n", $lines)
+      )
+    );
+  }
+
+  /**
+   * Print a list of modules for which tests will be executed.
+   *
+   * @param string[] $modulesWithTests
+   *   Affected modules with tests.
+   */
+  private function printModulesWithTests(array $modulesWithTests): void {
+    $lines = [];
+    foreach ($modulesWithTests as $modulePath) {
+      $lines[] = '  - ' . $modulePath;
+    }
+
+    fwrite(
+      STDOUT,
+      sprintf(
+        "%s: running tests for modules:\n%s\n\n",
+        $this->getName(),
+        implode("\n", $lines)
+      )
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildArguments(iterable $modules): ProcessArgumentsCollection {
+    $config = $this->getConfig()->getOptions();
+
+    $arguments = $this->processBuilder->createArgumentsForCommand('phpunit');
+
+    if (!empty($config['config_file'])) {
+      // Mirror GrumPHP's core phpunit task: allow passing a custom config file.
+      $arguments->add('-c');
+      $arguments->add($config['config_file']);
+    }
+
+    if (!empty($config['testsuite'])) {
+      $arguments->add('--testsuite');
+      $arguments->add($config['testsuite']);
+    }
+
+    foreach ($modules as $modulePath) {
+      $arguments->add($modulePath);
+    }
+
+    return $arguments;
+  }
+
+}

src/Task/PhpUnitDrupalModules/services.yaml

@@ -0,0 +1,9 @@
+services:
+  Wunderio\GrumPHP\Task\PhpUnitDrupalModules\PhpUnitDrupalModulesTask:
+    class: Wunderio\GrumPHP\Task\PhpUnitDrupalModules\PhpUnitDrupalModulesTask
+    arguments:
+      - '@process_builder'
+      - '@formatter.raw_process'
+    tags:
+      - { name: grumphp.task, task: phpunit_drupal_modules }
+

src/Task/tasks.yml

@@ -281,3 +281,31 @@ Wunderio\GrumPHP\Task\Psalm\PsalmTask:
     show_info:
       defaults: false
       allowed_types: ['bool']
+
+Wunderio\GrumPHP\Task\PhpUnitDrupalModules\PhpUnitDrupalModulesTask:
+  name: phpunit_drupal_modules
+  is_file_specific: true
+  options:
+    ignore_patterns:
+      defaults:
+        - '/vendor/'
+        - '/node_modules/'
+        - '/core/'
+        - '/libraries/'
+        - '/contrib/'
+      allowed_types: ['array']
+    extensions:
+      defaults: ['php', 'inc', 'module', 'install', 'theme']
+      allowed_types: ['array']
+    run_on:
+      defaults: ['web/modules/custom']
+      allowed_types: ['array']
+    config_file:
+      defaults: ~
+      allowed_types: ['string', 'null']
+    testsuite:
+      defaults: ~
+      allowed_types: ['string', 'null']
+    timeout:
+      defaults: ~
+      allowed_types: ['int', 'null']