Merge pull request #675: support xdebug in tests

Author: roxblnfk

tests/Acceptance/App/Input/Command.php testing/src/Command.phptests/Acceptance/App/Input/Command.php renamed to testing/src/Command.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Temporal\Tests\Acceptance\App\Input;
+namespace Temporal\Testing;
 
 final class Command
 {
@@ -18,12 +18,19 @@ final class Command
     /** @var non-empty-string|null */
     public ?string $tlsCert = null;
 
+    private array $xdebug;
+
     public static function fromEnv(): self
     {
         $self = new self();
 
         $self->namespace = \getenv('TEMPORAL_NAMESPACE') ?: 'default';
         $self->address = \getenv('TEMPORAL_ADDRESS') ?: 'localhost:7233';
+        $self->xdebug = [
+            'xdebug.mode' => \ini_get('xdebug.mode'),
+            'xdebug.start_with_request' => \ini_get('xdebug.start_with_request'),
+            'xdebug.start_upon_error' => \ini_get('xdebug.start_upon_error'),
+        ];
         // $self->tlsCert =
         // $self->tlsKey =
 
@@ -66,7 +73,7 @@ public static function fromCommandLine(array $argv): self
     /**
      * @return list<non-empty-string> CLI arguments that can be parsed by `fromCommandLine`
      */
-    public function toCommandLineArguments(): array
+    public function getCommandLineArguments(): array
     {
         $result = [];
         $this->namespace === null or $result[] = "namespace=$this->namespace";
@@ -76,4 +83,13 @@ public function toCommandLineArguments(): array
 
         return $result;
     }
+
+    public function getPhpBinaryArguments(): array
+    {
+        $result = [];
+        foreach ($this->xdebug as $key => $value) {
+            $result[] = "-d$key=$value";
+        }
+        return $result;
+    }
 }

testing/src/Environment.php

@@ -102,9 +102,9 @@ public function startTemporalServer(
         $this->temporalServerProcess->setTimeout($commandTimeout);
         $this->temporalServerProcess->start();
 
-        $limit = 1_000_000;
-        while (!$this->temporalServerProcess->isRunning() && $limit > 0) {
-            \usleep($limit -= 1000);
+        $deadline = \microtime(true) + 1.2;
+        while (!$this->temporalServerProcess->isRunning() && \microtime(true) < $deadline) {
+            \usleep(10_000);
         }
 
         if (!$this->temporalServerProcess->isRunning()) {
@@ -132,10 +132,7 @@ public function startTemporalTestServer(int $commandTimeout = 10): void
         $this->temporalTestServerProcess->setTimeout($commandTimeout);
         $this->temporalTestServerProcess->start();
 
-        $limit = 1_000_000;
-        while (!$this->temporalTestServerProcess->isRunning() && $limit > 0) {
-            \usleep($limit -= 1000);
-        }
+        \sleep(1);
 
         if (!$this->temporalTestServerProcess->isRunning()) {
             $this->output->writeln('<error>error</error>');

tests/Acceptance/App/Runtime/RRStarter.php

@@ -39,9 +39,10 @@ public function start(): void
             "temporal.address={$this->runtime->address}",
             '-o',
             'server.command=' . \implode(',', [
-                'php',
+                PHP_BINARY,
+                ...$run->getPhpBinaryArguments(),
                 $this->runtime->rrConfigDir . DIRECTORY_SEPARATOR . 'worker.php',
-                ...$run->toCommandLineArguments(),
+                ...$run->getCommandLineArguments(),
             ]),
         ];
         $run->tlsKey === null or $rrCommand = [...$rrCommand, '-o', "tls.key={$run->tlsKey}"];

tests/Acceptance/App/Runtime/State.php

@@ -4,8 +4,8 @@
 
 namespace Temporal\Tests\Acceptance\App\Runtime;
 
-use Temporal\Tests\Acceptance\App\Input\Command;
 use Temporal\DataConverter\PayloadConverterInterface;
+use Temporal\Testing\Command;
 
 final class State
 {

tests/Acceptance/App/RuntimeBuilder.php

@@ -7,7 +7,7 @@
 use PHPUnit\Framework\Attributes\Test;
 use Temporal\Activity\ActivityInterface;
 use Temporal\DataConverter\PayloadConverterInterface;
-use Temporal\Tests\Acceptance\App\Input\Command;
+use Temporal\Testing\Command;
 use Temporal\Tests\Acceptance\App\Input\Feature;
 use Temporal\Tests\Acceptance\App\Runtime\State;
 use Temporal\Worker\FeatureFlags;

tests/Acceptance/bootstrap.php

@@ -18,16 +18,16 @@
 use Temporal\Client\WorkflowStubInterface;
 use Temporal\DataConverter\DataConverter;
 use Temporal\DataConverter\DataConverterInterface;
+use Temporal\Testing\Command;
 use Temporal\Tests\Acceptance\App\Feature\WorkflowStubInjector;
-use Temporal\Tests\Acceptance\App\Input\Command;
 use Temporal\Tests\Acceptance\App\Runtime\ContainerFacade;
 use Temporal\Tests\Acceptance\App\Runtime\RRStarter;
 use Temporal\Tests\Acceptance\App\Runtime\State;
 use Temporal\Tests\Acceptance\App\Runtime\TemporalStarter;
 use Temporal\Tests\Acceptance\App\RuntimeBuilder;
 use Temporal\Tests\Acceptance\App\Support;
 
-chdir(__DIR__ . '/../..');
+\chdir(__DIR__ . '/../..');
 require './vendor/autoload.php';
 
 RuntimeBuilder::init();
@@ -91,8 +91,8 @@
 $container->bindSingleton(ScheduleClientInterface::class, $scheduleClient);
 $container->bindInjector(WorkflowStubInterface::class, WorkflowStubInjector::class);
 $container->bindSingleton(DataConverterInterface::class, $converter);
-$container->bind(RPCInterface::class, static fn() => RPC::create(getenv('RR_RPC_ADDRESS') ?: 'tcp://127.0.0.1:6001'));
+$container->bind(RPCInterface::class, static fn() => RPC::create(\getenv('RR_RPC_ADDRESS') ?: 'tcp://127.0.0.1:6001'));
 $container->bind(
     StorageInterface::class,
-    fn(#[Proxy] ContainerInterface $c): StorageInterface => $c->get(Factory::class)->select('harness'),
+    static fn(#[Proxy] ContainerInterface $c): StorageInterface => $c->get(Factory::class)->select('harness'),
 );

tests/Acceptance/worker.php

@@ -2,11 +2,6 @@
 
 declare(strict_types=1);
 
-use Temporal\Internal\Support\StackRenderer;
-use Temporal\Tests\Acceptance\App\Input\Command;
-use Temporal\Tests\Acceptance\App\Runtime\Feature;
-use Temporal\Tests\Acceptance\App\Runtime\State;
-use Temporal\Tests\Acceptance\App\RuntimeBuilder;
 use Psr\Container\ContainerInterface;
 use Spiral\Core\Attribute\Proxy;
 use Spiral\Goridge\RPC\RPC;
@@ -26,6 +21,11 @@
 use Temporal\DataConverter\NullConverter;
 use Temporal\DataConverter\ProtoConverter;
 use Temporal\DataConverter\ProtoJsonConverter;
+use Temporal\Internal\Support\StackRenderer;
+use Temporal\Testing\Command;
+use Temporal\Tests\Acceptance\App\Runtime\Feature;
+use Temporal\Tests\Acceptance\App\Runtime\State;
+use Temporal\Tests\Acceptance\App\RuntimeBuilder;
 use Temporal\Worker\WorkerFactoryInterface;
 use Temporal\Worker\WorkerInterface;
 use Temporal\WorkerFactory;

tests/Functional/.rr.silent.yaml

@@ -5,8 +5,6 @@ rpc:
 
 server:
     command: "php worker.php"
-    env:
-        XDEBUG_SESSION: 1
 
 # Workflow and activity mesh service
 temporal:

tests/Functional/bootstrap.php

@@ -2,22 +2,35 @@
 
 declare(strict_types=1);
 
+use Temporal\Testing\Command;
 use Temporal\Testing\Environment;
 use Temporal\Tests\SearchAttributeTestInvoker;
 use Temporal\Worker\FeatureFlags;
 
-chdir(__DIR__ . '/../..');
+\chdir(__DIR__ . '/../..');
 require_once __DIR__ . '/../../vendor/autoload.php';
 
 $sysInfo = \Temporal\Testing\SystemInfo::detect();
 
+$command = Command::fromEnv();
 $environment = Environment::create();
 $environment->startTemporalTestServer();
-(new SearchAttributeTestInvoker)();
-$environment->startRoadRunner(
-    rrCommand: sprintf('%s serve -c .rr.silent.yaml -w tests/Functional', $sysInfo->rrExecutable),
-);
-register_shutdown_function(fn() => $environment->stop());
+(new SearchAttributeTestInvoker())();
+$environment->startRoadRunner(\implode(' ', [
+    $sysInfo->rrExecutable,
+    'serve',
+    '-c', '.rr.silent.yaml',
+    '-w', 'tests/Functional',
+    '-o',
+    'server.command=' . \implode(',', [
+        PHP_BINARY,
+        ...$command->getPhpBinaryArguments(),
+        'worker.php',
+        ...$command->getCommandLineArguments(),
+    ]),
+]));
+
+\register_shutdown_function(static fn() => $environment->stop());
 
 // Default feature flags
 FeatureFlags::$warnOnWorkflowUnfinishedHandlers = false;