Fix screen version detection on macOS

Author: aarondfrancis

src/Console/Commands/Solo.php

@@ -38,16 +38,19 @@ protected function checkScreenVersion(): void
         $process = new Process(['screen', '-v']);
         $process->run();
 
-        if ($process->isSuccessful()) {
-            preg_match('/Screen version ([\d.]+)/', $process->getOutput(), $matches);
+        $screenOutput = trim($process->getOutput() . "\n" . $process->getErrorOutput());
 
-            if (!empty($matches[1]) && version_compare($matches[1], '5.0.0', '<')) {
+        preg_match('/Screen version ([\d.]+)/', $screenOutput, $matches);
+
+        if (!empty($matches[1])) {
+            if (version_compare($matches[1], '5.0.0', '<')) {
                 Log::error("The installed version of `screen` ({$matches[1]}) is outdated. Please upgrade to 5.0.0 or greater for best compatibility with Solo.");
             }
-        } else {
-            Log::error('Unable to determine `screen` version. Make sure `screen` is installed.');
+
+            return;
         }
 
+        Log::error('Unable to determine `screen` version. Make sure `screen` is installed.');
     }
 
     protected function usesScreenDriver(): bool

tests/Unit/SoloCommandTest.php

@@ -0,0 +1,148 @@
+<?php
+
+namespace SoloTerm\Solo\Tests\Unit;
+
+use Illuminate\Support\Facades\Log;
+use PHPUnit\Framework\Attributes\Test;
+use Psr\Log\AbstractLogger;
+use SoloTerm\Solo\Console\Commands\Solo as SoloCommand;
+
+class SoloCommandTest extends Base
+{
+    private string|false $originalPath;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->originalPath = getenv('PATH');
+    }
+
+    protected function tearDown(): void
+    {
+        if ($this->originalPath === false) {
+            putenv('PATH');
+        } else {
+            putenv("PATH={$this->originalPath}");
+        }
+
+        parent::tearDown();
+    }
+
+    #[Test]
+    public function screen_version_is_detected_from_error_output_even_when_screen_exits_non_zero(): void
+    {
+        $logger = $this->swapCapturingLogger();
+
+        $this->runWithFakeScreen(<<<'SH'
+#!/bin/sh
+echo "Screen version 4.9.0" >&2
+exit 1
+SH, function (): void {
+            config()->set('solo.process_driver', 'screen');
+
+            $command = new class extends SoloCommand
+            {
+                public function runScreenVersionCheckForTest(): void
+                {
+                    $this->checkScreenVersion();
+                }
+            };
+
+            $command->runScreenVersionCheckForTest();
+        });
+
+        $this->assertSame([
+            [
+                'level' => 'error',
+                'message' => 'The installed version of `screen` (4.9.0) is outdated. Please upgrade to 5.0.0 or greater for best compatibility with Solo.',
+            ],
+        ], $logger->records);
+    }
+
+    #[Test]
+    public function missing_screen_version_still_logs_detection_error(): void
+    {
+        $logger = $this->swapCapturingLogger();
+
+        $this->runWithFakeScreen(<<<'SH'
+#!/bin/sh
+exit 1
+SH, function (): void {
+            config()->set('solo.process_driver', 'screen');
+
+            $command = new class extends SoloCommand
+            {
+                public function runScreenVersionCheckForTest(): void
+                {
+                    $this->checkScreenVersion();
+                }
+            };
+
+            $command->runScreenVersionCheckForTest();
+        });
+
+        $this->assertSame([
+            [
+                'level' => 'error',
+                'message' => 'Unable to determine `screen` version. Make sure `screen` is installed.',
+            ],
+        ], $logger->records);
+    }
+
+    /**
+     * @param  callable(): void  $callback
+     */
+    private function runWithFakeScreen(string $script, callable $callback): void
+    {
+        $directory = sys_get_temp_dir() . '/solo-screen-' . bin2hex(random_bytes(5));
+        $screen = $directory . '/screen';
+
+        mkdir($directory);
+        file_put_contents($screen, $script);
+        chmod($screen, 0755);
+
+        $path = $this->originalPath === false ? $directory : $directory . PATH_SEPARATOR . $this->originalPath;
+
+        putenv("PATH={$path}");
+
+        try {
+            $callback();
+        } finally {
+            if ($this->originalPath === false) {
+                putenv('PATH');
+            } else {
+                putenv("PATH={$this->originalPath}");
+            }
+
+            @unlink($screen);
+            @rmdir($directory);
+        }
+    }
+
+    /**
+     * @return object{records: array<int, array{level: string, message: string}>}
+     */
+    private function swapCapturingLogger(): object
+    {
+        $logger = new class extends AbstractLogger
+        {
+            /**
+             * @var array<int, array{level: string, message: string}>
+             */
+            public array $records = [];
+
+            public function log($level, string|\Stringable $message, array $context = []): void
+            {
+                $this->records[] = [
+                    'level' => (string) $level,
+                    'message' => (string) $message,
+                ];
+            }
+        };
+
+        Log::swap($logger);
+
+        return $logger;
+    }
+}