transpile 4.3.9, 4.3.10 from v4

lucatume · lucatume · commit 7d9a5079fe8b · 2024-11-29T15:01:28.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unreleased] Unreleased
 
+## Fixed
+
+- Check the PID file for the PHP built-in server, MySQL and Chromedriver controllers to make sure the PID maps to an actually running process.
+
+## Changed
+
+- Inherit environment variables while parsing configuration files in the `WPConfigFile` class.
+
 ## [3.7.9] 2024-11-27;
 
 ## Added
diff --git a/src/Extension/BuiltInServerController.php b/src/Extension/BuiltInServerController.php
@@ -19,7 +19,7 @@ public function start(OutputInterface $output): void
     {
         $pidFile = $this->getPidFile();
 
-        if (is_file($pidFile)) {
+        if ($this->isProcessRunning($pidFile)) {
             $output->writeln('PHP built-in server already running.');
             return;
         }
diff --git a/src/Extension/ChromeDriverController.php b/src/Extension/ChromeDriverController.php
@@ -20,7 +20,7 @@ public function start(OutputInterface $output): void
     {
         $pidFile = $this->getPidFile();
 
-        if (is_file($pidFile)) {
+        if ($this->isProcessRunning($pidFile)) {
             $output->writeln('ChromeDriver already running.');
 
             return;
diff --git a/src/Extension/MysqlServerController.php b/src/Extension/MysqlServerController.php
@@ -23,7 +23,7 @@ public function start(OutputInterface $output): void
     {
         $pidFile = $this->getPidFile();
 
-        if (is_file($pidFile)) {
+        if ($this->isProcessRunning($pidFile)) {
             $output->writeln('MySQL server already running.');
 
             return;
diff --git a/src/Extension/PidBasedController.php b/src/Extension/PidBasedController.php
@@ -3,6 +3,7 @@
 namespace lucatume\WPBrowser\Extension;
 
 use Codeception\Exception\ExtensionException;
+use lucatume\WPBrowser\Exceptions\RuntimeException;
 
 trait PidBasedController
 {
@@ -49,4 +50,53 @@ protected function removePidFile(string $pidFile): void
             );
         }
     }
+
+    /**
+     * @throws RuntimeException
+     */
+    protected function isProcessRunning(string $pidFile):bool
+    {
+        if (!is_file($pidFile)) {
+            return false;
+        }
+
+        try {
+            $pidFileContents = file_get_contents($pidFile);
+            if ($pidFileContents === false) {
+                throw new \Exception();
+            }
+        } catch (\Exception $e) {
+            if (!unlink($pidFile)) {
+                throw new RuntimeException("Failed to delete PID file: $pidFile");
+            }
+
+            return false;
+        }
+
+        $pid = trim($pidFileContents);
+
+        if (!is_numeric($pid) || (int)$pid === 0) {
+            return false;
+        }
+
+        if (PHP_OS_FAMILY === 'Windows') {
+            $output = [];
+            exec("tasklist /FI \"PID eq $pid\" 2>NUL", $output);
+
+            return strpos(implode("\n", $output), $pid) !== false;
+        } else {
+            // Check if the process is running on POSIX (Mac or Linux)
+            exec("ps -p $pid", $output, $resultCode);
+            if ($resultCode === 0 && count($output) > 1) {
+                // Process is running
+                return true;
+            }
+        }
+
+        if (!unlink($pidFile)) {
+            throw new RuntimeException("Failed to delete PID file: $pidFile");
+        }
+
+        return false;
+    }
 }
diff --git a/src/Process/Loop.php b/src/Process/Loop.php
@@ -62,6 +62,10 @@ class Loop
      * @var bool
      */
     private $useFilePayloads = false;
+    /**
+     * @var bool
+     */
+    private $inheritEnv = false;
 
     /**
      * @param array<int|string,Worker|callable> $workers
@@ -91,7 +95,8 @@ public function __construct(
      *     rethrow?: bool,
      *     requireFiles?: array<string>,
      *     cwd?: string,
-     *     use_file_payloads?: bool,
+     *     useFilePayloads?: bool,
+     *     inheritEnv?: bool
      * } $options
      *
      * @throws ProcessException
@@ -102,10 +107,14 @@ public static function executeClosure(Closure $closure, int $timeout = 30, array
     {
         $loop = new self([$closure], 1, true, $timeout, $options);
 
-        if (!empty($options['use_file_payloads'])) {
+        if (!empty($options['useFilePayloads'])) {
             $loop->setUseFilePayloads(true);
         }
 
+        if (!empty($options['inheritEnv'])) {
+            $loop->setInheritEnv(true);
+        }
+
         $loop->run();
         $results = $loop->getResults();
         $result = $results[0];
@@ -215,7 +224,7 @@ private function startWorker(): void
         }
 
         try {
-            $w = Running::fromWorker($runnableWorker, $this->useFilePayloads);
+            $w = Running::fromWorker($runnableWorker, $this->useFilePayloads, $this->inheritEnv);
             $this->started[$w->getId()] = $w;
             $this->running[$w->getId()] = $w;
             $this->peakParallelism = max((int)$this->peakParallelism, count($this->running));
@@ -407,4 +416,9 @@ private function buildWorker(string $id, callable $worker): Worker
     {
         return new Worker($id, $worker, [], []);
     }
+
+    public function setInheritEnv(bool $inheritEnv):void
+    {
+        $this->inheritEnv = $inheritEnv;
+    }
 }
diff --git a/src/Process/Worker/Running.php b/src/Process/Worker/Running.php
@@ -57,7 +57,7 @@ public function __construct(string $id, WorkerProcess $proc, array $requiredReso
     /**
      * @throws ConfigurationException|ProcessException
      */
-    public static function fromWorker(Worker $worker, bool $useFilePayloads = false): Running
+    public static function fromWorker(Worker $worker, bool $useFilePayloads = false, bool $inheritEnv = false): Running
     {
         $workerCallable = $worker->getCallable();
         $workerClosure = $workerCallable instanceof Closure ?
@@ -69,11 +69,17 @@ public static function fromWorker(Worker $worker, bool $useFilePayloads = false)
 
         $workerScriptPathname = __DIR__ . '/worker-script.php';
         $control = $worker->getControl();
+
+        if ($inheritEnv) {
+            $control['env'] = array_merge($control['env'] ?? [], getenv());
+        }
+
         $workerSerializableClosure = new SerializableClosure($workerClosure);
 
         $request = new Request($control, $workerSerializableClosure);
         $request->setUseFilePayloads($useFilePayloads);
 
+
         try {
             $workerProcess = new WorkerProcess([PHP_BINARY, $workerScriptPathname, $request->getPayload()]);
             $workerProcess->start();
diff --git a/src/WordPress/WPConfigFile.php b/src/WordPress/WPConfigFile.php
@@ -129,7 +129,7 @@ private function includeFile(): void
         try {
             $result = Loop::executeClosure(function () use ($wpSettingsFile, $wpConfigFile): array {
                 return $this->toIncludeFile($wpConfigFile, $wpSettingsFile);
-            });
+            }, 30, ['inheritEnv' => true]);
 
             $returnValue = $result->getReturnValue();
 
diff --git a/tests/_data/wp-config-files/ddev/wp-config-ddev.php b/tests/_data/wp-config-files/ddev/wp-config-ddev.php
@@ -0,0 +1,41 @@
+<?php
+/**
+ * #ddev-generated: Automatically generated WordPress settings file.
+ * ddev manages this file and may delete or overwrite the file unless this comment is removed.
+ *
+ * @package ddevapp
+ */
+
+if ( getenv( 'IS_DDEV_PROJECT' ) == 'true' ) {
+    /** The name of the database for WordPress */
+    defined( 'DB_NAME' ) || define( 'DB_NAME', 'db' );
+
+    /** MySQL database username */
+    defined( 'DB_USER' ) || define( 'DB_USER', 'db' );
+
+    /** MySQL database password */
+    defined( 'DB_PASSWORD' ) || define( 'DB_PASSWORD', 'db' );
+
+    /** MySQL hostname */
+    defined( 'DB_HOST' ) || define( 'DB_HOST', 'ddev-ddev-project-db' );
+
+    /** WP_HOME URL */
+    defined( 'WP_HOME' ) || define( 'WP_HOME', 'https://ddev-project.ddev.site:33001' );
+
+    /** WP_SITEURL location */
+    defined( 'WP_SITEURL' ) || define( 'WP_SITEURL', WP_HOME . '/' );
+
+    /** Enable debug */
+    defined( 'WP_DEBUG' ) || define( 'WP_DEBUG', true );
+
+    /**
+     * Set WordPress Database Table prefix if not already set.
+     *
+     * @global string $table_prefix
+     */
+    if ( ! isset( $table_prefix ) || empty( $table_prefix ) ) {
+        // phpcs:disable WordPress.WP.GlobalVariablesOverride.Prohibited
+        $table_prefix = 'wp_';
+        // phpcs:enable
+    }
+}
diff --git a/tests/_data/wp-config-files/ddev/wp-config.php b/tests/_data/wp-config-files/ddev/wp-config.php
@@ -0,0 +1,44 @@
+<?php
+/**
+ * #ddev-generated: Automatically generated WordPress settings file.
+ * ddev manages this file and may delete or overwrite the file unless this comment is removed.
+ * It is recommended that you leave this file alone.
+ *
+ * @package ddevapp
+ */
+
+/** Database charset to use in creating database tables. */
+define( 'DB_CHARSET', 'utf8' );
+
+/** The database collate type. Don't change this if in doubt. */
+define( 'DB_COLLATE', '' );
+
+/** Authentication Unique Keys and Salts. */
+define( 'AUTH_KEY', 'tCGZUeKbIdopaFexrGoPqNNlLNsfaJPrHlXPBoPwhGZFvguTIpelFEFsNwCgyQWP' );
+define( 'SECURE_AUTH_KEY', 'EdTQtDpfrFpzuwMOIFljwQcyusSTVPtqMfpGhBfKEAJwFxDmFaBdOKiNGPwJsDWA' );
+define( 'LOGGED_IN_KEY', 'oWUgUNaIPqTZAeTAAyPALbLWwnRHFVSPYSJooRBpuRlphdjogVDIYLYRRqhwZXIm' );
+define( 'NONCE_KEY', 'kHzVnpmLOgkzfNyESZslNHZNzxsatEAJVVnmxJqbKjnooSmdSoVJHzxcWxAxNUwA' );
+define( 'AUTH_SALT', 'kGENEUGicWfvwDvjjMtncIOmLQAJztohoqSMRumqjlmhexnRLocvZCjfXGnftfTL' );
+define( 'SECURE_AUTH_SALT', 'WLPqqvorXIIPCnPOBPLopTADMtDVGYpvJDSMHOvpgaIpTADVZYNNWakSKtiXhJKg' );
+define( 'LOGGED_IN_SALT', 'KZTqsQCEnJMPaYMGHOkpSEBsjnMznCPdzKVxFCHWldfnlNSYpdRaWzXFsBxiTcsk' );
+define( 'NONCE_SALT', 'jeBUcIcVAFQjsWbOpomcvjIBARyiEQWwHWSGDzUyLIBixJnHJPtZTdjNUkIgDFow' );
+
+/* Add any custom values between this line and the "stop editing" line. */
+
+
+
+/* That's all, stop editing! Happy publishing. */
+
+/** Absolute path to the WordPress directory. */
+defined( 'ABSPATH' ) || define( 'ABSPATH', dirname( __FILE__ ) . '/' );
+
+// Include for settings managed by ddev.
+$ddev_settings = __DIR__ . '/wp-config-ddev.php';
+if ( ! defined( 'DB_USER' ) && getenv( 'IS_DDEV_PROJECT' ) == 'true' && is_readable( $ddev_settings ) ) {
+    require_once( $ddev_settings );
+}
+
+/** Include wp-settings.php */
+if ( file_exists( ABSPATH . '/wp-settings.php' ) ) {
+    require_once ABSPATH . '/wp-settings.php';
+}
diff --git a/tests/_data/wp-config-files/ddev/wp-settings.php b/tests/_data/wp-config-files/ddev/wp-settings.php
@@ -0,0 +1,2 @@
+<?php
+// Nothing to see here.
diff --git a/tests/_support/Traits/LoopIsolation.php b/tests/_support/Traits/LoopIsolation.php
@@ -28,7 +28,7 @@ protected function assertInIsolation(Closure $runAssertions, string $cwd = null,
             $options['requireFiles'][] = $callerFile;
         }
         $options['cwd'] = !empty($options['cwd']) ? $options['cwd'] : getcwd();
-        $options['use_file_payloads'] = true;
+        $options['useFilePayloads'] = true;
         $timeout = Debug::isEnabled() ? PHP_INT_MAX : 30;
         $result = Loop::executeClosure($runAssertions, $timeout, $options);
         $returnValue = $result->getReturnValue();
diff --git a/tests/unit/lucatume/WPBrowser/Extension/PidBasedControllerTest.php b/tests/unit/lucatume/WPBrowser/Extension/PidBasedControllerTest.php
@@ -0,0 +1,86 @@
+<?php
+
+
+namespace Unit\lucatume\WPBrowser\Extension;
+
+use lucatume\WPBrowser\Extension\PidBasedController;
+use lucatume\WPBrowser\Exceptions\RuntimeException;
+use Symfony\Component\Process\Process;
+
+class PidBasedControllerTest extends \Codeception\Test\Unit
+{
+    public function test_isProcessRunning_on_posix():void{
+        $testClass = new class {
+            use PidBasedController;
+
+            public function openIsProcessRunning(string $pidFile):bool{
+                return $this->isProcessRunning($pidFile);
+            }
+        };
+        $hash = md5(microtime());
+        $pidFile = sys_get_temp_dir()."/test-{$hash}.pid";
+        $pid = posix_getpid();
+        if(!file_put_contents($pidFile,$pid)){
+            $this->fail('Could not write pid to file '.$pidFile);
+        }
+
+        $this->assertTrue($testClass->openIsProcessRunning($pidFile));
+        $this->assertFileExists($pidFile);
+    }
+
+    public function test_isProcessRunning_returns_false_if_pid_file_not_exists():void{
+        $testClass = new class {
+            use PidBasedController;
+
+            public function openIsProcessRunning(string $pidFile):bool{
+                return $this->isProcessRunning($pidFile);
+            }
+        };
+        $pid = posix_getpid();
+
+        $this->assertFalse($testClass->openIsProcessRunning(__DIR__ .'/test.pid'));
+    }
+
+    public function test_isProcessRunning_throws_if_pid_file_cannot_be_read():void{
+        $testClass = new class {
+            use PidBasedController;
+
+            public function openIsProcessRunning(string $pidFile):bool{
+                return $this->isProcessRunning($pidFile);
+            }
+        };
+        $pid = posix_getpid();
+        $hash = md5(microtime());
+        $pidFile = sys_get_temp_dir()."/test-{$hash}.pid";
+        $pid = posix_getpid();
+        if(!file_put_contents($pidFile,$pid)){
+            $this->fail('Could not write pid to file '.$pidFile);
+        }
+        // Change the file mode to not be readable by the current user.
+        chmod($pidFile,0000);
+
+        $this->assertFalse($testClass->openIsProcessRunning($pidFile));
+    }
+
+    public function test_isProcessRunning_returns_false_if_process_is_not_running():void{
+        $testClass = new class {
+            use PidBasedController;
+
+            public function openIsProcessRunning(string $pidFile):bool{
+                return $this->isProcessRunning($pidFile);
+            }
+        };
+        $hash = md5(microtime());
+        $pidFile = sys_get_temp_dir()."/test-{$hash}.pid";
+        $process = new Process(['echo', '23']);
+        $process->start();
+        $pid = $process->getPid();
+        $process->wait();
+        if(!file_put_contents($pidFile,$pid)){
+            $this->fail('Could not write pid to file '.$pidFile);
+        }
+
+        $this->assertFalse($testClass->openIsProcessRunning($pidFile));
+        $this->assertFileNotExists($pidFile);
+    }
+}
diff --git a/tests/unit/lucatume/WPBrowser/Module/WPLoaderArbitraryPluginLocationTest.php b/tests/unit/lucatume/WPBrowser/Module/WPLoaderArbitraryPluginLocationTest.php
diff --git a/tests/unit/lucatume/WPBrowser/WordPress/WPConfigFileTest.php b/tests/unit/lucatume/WPBrowser/WordPress/WPConfigFileTest.php

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public function start(OutputInterface $output): void`
`19`	`19`	`{`
`20`	`20`	`$pidFile = $this->getPidFile();`
`21`	`21`
`22`		`- if (is_file($pidFile)) {`
	`22`	`+ if ($this->isProcessRunning($pidFile)) {`
`23`	`23`	`$output->writeln('PHP built-in server already running.');`
`24`	`24`	`return;`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public function start(OutputInterface $output): void`
`20`	`20`	`{`
`21`	`21`	`$pidFile = $this->getPidFile();`
`22`	`22`
`23`		`- if (is_file($pidFile)) {`
	`23`	`+ if ($this->isProcessRunning($pidFile)) {`
`24`	`24`	`$output->writeln('ChromeDriver already running.');`
`25`	`25`
`26`	`26`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public function start(OutputInterface $output): void`
`23`	`23`	`{`
`24`	`24`	`$pidFile = $this->getPidFile();`
`25`	`25`
`26`		`- if (is_file($pidFile)) {`
	`26`	`+ if ($this->isProcessRunning($pidFile)) {`
`27`	`27`	`$output->writeln('MySQL server already running.');`
`28`	`28`
`29`	`29`	`return;`