Merge branch 'review-file'

Author: lkrms

.github/workflows/ci.yml

@@ -112,9 +112,8 @@ jobs:
           - macos-latest
         php-version:
           - "8.3"
+          - "8.2"
         include:
-          - os: ubuntu-latest
-            php-version: "8.2"
           - os: ubuntu-latest
             php-version: "8.1"
           - os: ubuntu-latest
@@ -123,6 +122,13 @@ jobs:
             php-version: "7.4"
           - os: windows-latest
             php-version: "7.4"
+        exclude:
+          # As of 2024-03-13, macos-latest + 8.3 is slooooow (5+ seconds per
+          # process spawned?), but macos-latest + 8.2 runs normally
+          - os: macos-latest
+            php-version: "8.3"
+          - os: windows-latest
+            php-version: "8.2"
 
     runs-on: ${{ matrix.os }}
 
@@ -167,19 +173,27 @@ jobs:
           done
 
       - name: Start Mockoon CLI
+        id: start-mockoon
         shell: bash
         run: scripts/start-mockoon.sh
 
       - name: Run PHPUnit tests and generate code coverage report
-        run: vendor/bin/phpunit --no-coverage --coverage-clover=coverage.xml
+        id: run-phpunit-tests
+        shell: bash
+        run: |
+          vendor/bin/phpunit --no-coverage --coverage-clover=coverage.xml && status=0 || status=$?
+          printf 'coverage_report_generated=%d\n' "$([[ -s coverage.xml ]] && echo 1 || echo 0)" >>"$GITHUB_OUTPUT"
+          (exit $status)
+
+      - name: Upload code coverage report to Codecov
+        if: ${{ !cancelled() && steps.run-phpunit-tests.outputs.coverage_report_generated == 1 }}
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Upload Mockoon CLI log files artifact
+        if: ${{ !cancelled() && steps.start-mockoon.conclusion == 'success' }}
         uses: actions/upload-artifact@v4
         with:
           name: mockoon-cli-logs-${{ matrix.os }}-${{ matrix.php-version }}
           path: ~/.mockoon-cli/logs/*.log
-
-      - name: Upload code coverage report to Codecov
-        uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}

phpstan-baseline-7.4.neon

@@ -175,8 +175,8 @@ public function reopen(?string $path = null): void
      * Creates a new StreamTarget object backed by an open PHP stream
      *
      * @param resource $stream
-     * @param bool $closeable If `true`, call {@see fclose()} to close `$stream`
-     * when the target is closed.
+     * @param bool $closeable If `true`, call {@see File::close()} to close
+     * `$stream` when the target is closed.
      * @param bool|null $addTimestamp If `null`, add timestamps if `$stream` is
      * not `STDOUT` or `STDERR`.
      * @param DateTimeZone|string|null $timezone If `null`, the timezone

phpstan-baseline-8.3.neon

@@ -321,7 +321,7 @@ public function __construct(
 
         $this->BasePath = $basePath;
 
-        $this->WorkingDirectory = File::cwd();
+        $this->WorkingDirectory = File::getCwd();
 
         $this->RunningFromSource =
             !extension_loaded('Phar') ||
@@ -393,7 +393,7 @@ final public function getWorkingDirectory(): string
      */
     final public function restoreWorkingDirectory()
     {
-        if (File::cwd() !== $this->WorkingDirectory) {
+        if (File::getCwd() !== $this->WorkingDirectory) {
             File::chdir($this->WorkingDirectory);
         }
 
@@ -405,7 +405,7 @@ final public function restoreWorkingDirectory()
      */
     final public function setWorkingDirectory(?string $directory = null)
     {
-        $this->WorkingDirectory = $directory ?? File::cwd();
+        $this->WorkingDirectory = $directory ?? File::getCwd();
 
         return $this;
     }

src/Toolkit/Console/Target/StreamTarget.php

@@ -33,15 +33,15 @@ final class Process
      */
     private const TIMEOUT_PRECISION = 200000;
 
-    private const OPTIONS = [
+    private const DEFAULT_OPTIONS = [
         'suppress_errors' => true,
         'bypass_shell' => true,
     ];
 
     /**
-     * @var string[]
+     * @var string[]|string
      */
-    private array $Command;
+    private $Command;
 
     /**
      * @var resource|string|null
@@ -59,6 +59,11 @@ final class Process
 
     private bool $UseOutputFiles;
 
+    /**
+     * @var array<string,bool>|null
+     */
+    private ?array $Options = null;
+
     private ?int $Sec = null;
 
     private int $Usec = 0;
@@ -105,15 +110,14 @@ final class Process
     ];
 
     /**
-     * Creates a new ProcessWrapper object
+     * Creates a new Process object
      *
-     * @param string[] $args
+     * @param string[] $command
      * @param resource|string|null $input
      * @param array<string,string>|null $env
      */
     public function __construct(
-        string $command,
-        array $args = [],
+        array $command,
         $input = '',
         ?string $cwd = null,
         ?array $env = null,
@@ -130,7 +134,7 @@ public function __construct(
             // @codeCoverageIgnoreEnd
         }
 
-        $this->Command = [$command, ...$args];
+        $this->Command = $command;
         $this->Input = $input;
         $this->Cwd = $cwd;
         $this->Env = $env;
@@ -143,6 +147,26 @@ public function __construct(
         }
     }
 
+    /**
+     * Creates a new Process object for a shell command
+     *
+     * @param resource|string|null $input
+     * @param array<string,string>|null $env
+     */
+    public static function withShellCommand(
+        string $command,
+        $input = '',
+        ?string $cwd = null,
+        ?array $env = null,
+        ?int $timeout = null,
+        bool $useOutputFiles = false
+    ): self {
+        $process = new self([], $input, $cwd, $env, $timeout, $useOutputFiles);
+        $process->Command = $command;
+        $process->Options = array_diff_key(self::DEFAULT_OPTIONS, ['bypass_shell' => null]);
+        return $process;
+    }
+
     public function __destruct()
     {
         if ($this->isRunning() && $this->stop()->isRunning()) {
@@ -204,7 +228,7 @@ public function run(): int
                 $pipes,
                 $this->Cwd,
                 $this->Env,
-                self::OPTIONS,
+                $this->Options ?? self::DEFAULT_OPTIONS,
             ),
             'Error running process: %s',
         );
@@ -266,11 +290,11 @@ public function isTerminated(): bool
     }
 
     /**
-     * Get the command parameters passed to proc_open() to spawn the process
+     * Get the command passed to proc_open() to spawn the process
      *
-     * @return string[]
+     * @return string[]|string
      */
-    public function getCommand(): array
+    public function getCommand()
     {
         return $this->Command;
     }