Add grouping of output in GitHub Actions

phpro · Mar 21, 2023 · 5a2bed6 · 5a2bed6
1 parent 15d7599
commit 5a2bed6
Show file tree

Hide file tree

Showing 10 changed files with 98 additions and 21 deletions.
diff --git a/resources/config/services.yml b/resources/config/services.yml
@@ -37,15 +37,15 @@ services:
                 logger: '@grumphp.logger'
                 inherit_environment_variables: true
 
-    grumphp.io:
-        alias: grumphp.io.console
+    GrumPHP\IO\IOFactory:
+        arguments:
+            - '@OndraM\CiDetector\CiDetector'
 
-    grumphp.io.console:
-        class: GrumPHP\IO\ConsoleIO
+    grumphp.io:
+        factory: ['@GrumPHP\IO\IOFactory', 'create']
         arguments:
-          - '@console.input'
-          - '@console.output'
-        public: true
+            - '@console.input'
+            - '@console.output'
 
     grumphp.logger:
         class: Monolog\Logger

diff --git a/src/Console/Command/Git/CommitMsgCommand.php b/src/Console/Command/Git/CommitMsgCommand.php
@@ -6,7 +6,8 @@
 
 use GrumPHP\Collection\FilesCollection;
 use GrumPHP\Collection\TestSuiteCollection;
-use GrumPHP\IO\ConsoleIO;
+use GrumPHP\IO\IOFactory;
+use GrumPHP\IO\IOInterface;
 use GrumPHP\Locator\ChangedFiles;
 use GrumPHP\Locator\StdInFiles;
 use GrumPHP\Runner\TaskRunner;
@@ -60,13 +61,16 @@ class CommitMsgCommand extends Command
      */
     private $paths;
 
+    private IOFactory $IOFactory;
+
     public function __construct(
         TestSuiteCollection $testSuites,
         StdInFiles $stdInFilesLocator,
         ChangedFiles $changedFilesLocator,
         TaskRunner $taskRunner,
         Filesystem $filesystem,
-        Paths $paths
+        Paths $paths,
+        IOFactory $IOFactory
     ) {
         parent::__construct();
 
@@ -76,6 +80,7 @@ public function __construct(
         $this->filesystem = $filesystem;
         $this->paths = $paths;
         $this->stdInFilesLocator = $stdInFilesLocator;
+        $this->IOFactory = $IOFactory;
     }
 
     public static function getDefaultName(): string
@@ -93,7 +98,7 @@ protected function configure(): void
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
-        $io = new ConsoleIO($input, $output);
+        $io = $this->IOFactory->create($input, $output);
         $files = $this->getCommittedFiles($io);
 
         /** @var string $gitUser */
@@ -124,7 +129,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
         return $results->isFailed() ? self::EXIT_CODE_NOK : self::EXIT_CODE_OK;
     }
 
-    protected function getCommittedFiles(ConsoleIO $io): FilesCollection
+    protected function getCommittedFiles(IOInterface $io): FilesCollection
     {
         if ($stdin = $io->readCommandInput(STDIN)) {
             return $this->stdInFilesLocator->locate($stdin);

diff --git a/src/Console/Command/Git/PreCommitCommand.php b/src/Console/Command/Git/PreCommitCommand.php
@@ -6,7 +6,8 @@
 
 use GrumPHP\Collection\FilesCollection;
 use GrumPHP\Collection\TestSuiteCollection;
-use GrumPHP\IO\ConsoleIO;
+use GrumPHP\IO\IOFactory;
+use GrumPHP\IO\IOInterface;
 use GrumPHP\Locator\ChangedFiles;
 use GrumPHP\Locator\StdInFiles;
 use GrumPHP\Runner\TaskRunner;
@@ -46,18 +47,22 @@ class PreCommitCommand extends Command
      */
     private $taskRunner;
 
+    private IOFactory $IOFactory;
+
     public function __construct(
         TestSuiteCollection $testSuites,
         StdInFiles $stdInFilesLocator,
         ChangedFiles $changedFilesLocator,
-        TaskRunner $taskRunner
+        TaskRunner $taskRunner,
+        IOFactory $IOFactory
     ) {
         parent::__construct();
 
         $this->testSuites = $testSuites;
         $this->stdInFilesLocator = $stdInFilesLocator;
         $this->changedFilesLocator = $changedFilesLocator;
         $this->taskRunner = $taskRunner;
+        $this->IOFactory = $IOFactory;
     }
 
     public static function getDefaultName(): string
@@ -78,7 +83,7 @@ protected function configure(): void
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
-        $io = new ConsoleIO($input, $output);
+        $io = $this->IOFactory->create($input, $output);
         $files = $this->getCommittedFiles($io);
 
         $context = (
@@ -95,7 +100,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
         return $results->isFailed() ? self::EXIT_CODE_NOK : self::EXIT_CODE_OK;
     }
 
-    protected function getCommittedFiles(ConsoleIO $io): FilesCollection
+    protected function getCommittedFiles(IOInterface $io): FilesCollection
     {
         if ($stdin = $io->readCommandInput(STDIN)) {
             return $this->stdInFilesLocator->locate($stdin);

diff --git a/src/Console/Command/RunCommand.php b/src/Console/Command/RunCommand.php
@@ -6,7 +6,8 @@
 
 use GrumPHP\Collection\FilesCollection;
 use GrumPHP\Collection\TestSuiteCollection;
-use GrumPHP\IO\ConsoleIO;
+use GrumPHP\IO\IOFactory;
+use GrumPHP\IO\IOInterface;
 use GrumPHP\Locator\RegisteredFiles;
 use GrumPHP\Locator\StdInFiles;
 use GrumPHP\Runner\TaskRunner;
@@ -44,18 +45,22 @@ class RunCommand extends Command
      */
     private $taskRunner;
 
+    private IOFactory $IOFactory;
+
     public function __construct(
         TestSuiteCollection $testSuites,
         StdInFiles $stdInFileLocator,
         RegisteredFiles $registeredFilesLocator,
-        TaskRunner $taskRunner
+        TaskRunner $taskRunner,
+        IOFactory $IOFactory
     ) {
         parent::__construct();
 
         $this->testSuites = $testSuites;
         $this->stdInFileLocator = $stdInFileLocator;
         $this->registeredFilesLocator = $registeredFilesLocator;
         $this->taskRunner = $taskRunner;
+        $this->IOFactory = $IOFactory;
     }
 
     public static function getDefaultName(): string
@@ -83,7 +88,7 @@ protected function configure(): void
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
-        $io = new ConsoleIO($input, $output);
+        $io = $this->IOFactory->create($input, $output);
 
         /** @var string $taskNames */
         $taskNames = $input->getOption('tasks') ?? '';
@@ -107,7 +112,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
         return $results->isFailed() ? self::EXIT_CODE_NOK : self::EXIT_CODE_OK;
     }
 
-    private function detectFiles(ConsoleIO $io): FilesCollection
+    private function detectFiles(IOInterface $io): FilesCollection
     {
         if ($stdin = $io->readCommandInput(STDIN)) {
             return $this->stdInFileLocator->locate($stdin);

diff --git a/src/IO/ConsoleIO.php b/src/IO/ConsoleIO.php
@@ -139,6 +139,15 @@ static function (string $message) use ($color) : string {
         );
     }
 
+    public function startGroup(string $title): void
+    {
+        $this->style()->title($title);
+    }
+
+    public function endGroup(): void
+    {
+    }
+
     /**
      * Serializing this IO will result in an unwritable resource stream.
      * Therefor we serialize the data end build up a new stream instead.

diff --git a/src/IO/GitHubActionsIO.php b/src/IO/GitHubActionsIO.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace GrumPHP\IO;
+
+use Symfony\Component\Console\Output\ConsoleSectionOutput;
+
+class GitHubActionsIO extends ConsoleIO
+{
+    public function startGroup(string $title): void
+    {
+        $this->write('::group::' . $title);
+        parent::startGroup($title);
+    }
+
+    public function endGroup(): void
+    {
+        parent::endGroup();
+        $this->write('::endgroup::');
+    }
+}
diff --git a/src/IO/IOFactory.php b/src/IO/IOFactory.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace GrumPHP\IO;
+use OndraM\CiDetector\Ci\GitHubActions;
+use OndraM\CiDetector\CiDetector;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class IOFactory
+{
+    public function __construct(private CiDetector $ciDetector)
+    {
+    }
+
+    public function create(InputInterface $input, OutputInterface $output): IOInterface
+    {
+        if ($this->ciDetector->isCiDetected()) {
+            $platform = $this->ciDetector->detect();
+
+            if ($platform instanceof GitHubActions) {
+                return new GitHubActionsIO($input, $output);
+            }
+        }
+
+        return new ConsoleIO($input, $output);
+    }
+}
diff --git a/src/IO/IOInterface.php b/src/IO/IOInterface.php
@@ -34,4 +34,8 @@ public function style(): StyleInterface;
     public function section(): ConsoleSectionOutput;
 
     public function colorize(array $messages, string $color): array;
+
+    public function startGroup(string $title): void;
+
+    public function endGroup(): void;
 }
diff --git a/src/Runner/Middleware/GroupByPriorityMiddleware.php b/src/Runner/Middleware/GroupByPriorityMiddleware.php
@@ -35,11 +35,12 @@ public function handle(TaskRunnerContext $context, callable $next): TaskResultCo
            ->groupByPriority();
 
         foreach ($grouped as $priority => $tasks) {
-            $this->IO->style()->title('Running tasks with priority '.$priority.'!');
+            $this->IO->startGroup('Running tasks with priority '.$priority.'!');
             $results = new TaskResultCollection(array_merge(
                 $results->toArray(),
                 $next($context->withTasks($tasks))->toArray()
             ));
+            $this->IO->endGroup();
 
             // Stop on failure:
             if ($this->config->stopOnFailure() && $results->isFailed()) {

diff --git a/src/Runner/Reporting/RunnerReporter.php b/src/Runner/Reporting/RunnerReporter.php
@@ -124,8 +124,9 @@ private function reportWarningMessages(array $warningMessages): void
     private function reportFailedMessages(array $messages, string $color): void
     {
         foreach ($messages as $label => $message) {
-            $this->IO->style()->title($label);
+            $this->IO->startGroup($label);
             $this->IO->writeError($this->IO->colorize([$message], $color));
+            $this->IO->endGroup();
         }
     }