Skip to content

child process - sanity tests and tweaks #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions src/ChildProcess.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,35 @@ class ChildProcess

public function __construct(protected Client $client) {}

public function start(string $alias, array $cmd, ?string $cwd = null, ?array $env = null): object
public function start(string $alias, string|array $cmd, ?string $cwd = null, ?array $env = null): self
{
$this->alias = $alias;

$cwd = $cwd ?? base_path();

$cmd = is_iterable($cmd)
// when an array is passed, escape spaces for each item
? array_map(fn ($a) => str_replace(' ', '\ ', $a), $cmd)
// when a string is passed, explode it on the space
: array_values(array_filter(explode(' ', $cmd)));

$this->process = $this->client->post('child-process/start', [
'alias' => $alias,
'cmd' => $cmd,
'cwd' => base_path(),
'cwd' => $cwd,
'env' => $env,
])->json();

return $this;
}

public function artisan(string $alias, string|array $cmd, ?array $env = null): self
{
$cmd = [PHP_BINARY, 'artisan', ...(array) $cmd];

return $this->start($alias, $cmd, env: $env);
}

public function stop(string $alias): void
{
$this->client->post('child-process/stop', [
Expand Down
88 changes: 88 additions & 0 deletions tests/ChildProcess/ChildProcessTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<?php

use Illuminate\Http\Client\Request;
use Illuminate\Support\Facades\Http;
use Native\Laravel\Facades\ChildProcess;

beforeEach(function () {
Http::fake();
});

it('can start a child process', function () {
ChildProcess::start('some-alias', 'foo bar', 'path/to/dir', ['baz' => 'zah']);

Http::assertSent(function (Request $request) {
return $request->url() === 'http://localhost:4000/api/child-process/start' &&
$request['alias'] === 'some-alias' &&
$request['cmd'] === ['foo', 'bar'] &&
$request['cwd'] === 'path/to/dir' &&
$request['env'] === ['baz' => 'zah'];
});
});

it('can start a artisan command', function () {
ChildProcess::artisan('some-alias', 'foo:bar', ['baz' => 'zah']);

Http::assertSent(function (Request $request) {
return $request->url() === 'http://localhost:4000/api/child-process/start' &&
$request['alias'] === 'some-alias' &&
$request['cmd'] === [str_replace(' ', '\ ', PHP_BINARY), 'artisan', 'foo:bar'] &&
$request['cwd'] === base_path() &&
$request['env'] === ['baz' => 'zah'];
});
});

it('can mark the process as persistent')->todo();

it('accepts either a string or a array as start command argument', function () {
ChildProcess::start('some-alias', 'foo bar');
Http::assertSent(fn (Request $request) => $request['cmd'] === ['foo', 'bar']);

ChildProcess::start('some-alias', ['foo', 'baz']);
Http::assertSent(fn (Request $request) => $request['cmd'] === ['foo', 'baz']);
});

it('accepts either a string or a array as artisan command argument', function () {
ChildProcess::artisan('some-alias', 'foo:bar');
Http::assertSent(fn (Request $request) => $request['cmd'] === [str_replace(' ', '\ ', PHP_BINARY), 'artisan', 'foo:bar']);

ChildProcess::artisan('some-alias', ['foo:baz']);
Http::assertSent(fn (Request $request) => $request['cmd'] === [str_replace(' ', '\ ', PHP_BINARY), 'artisan', 'foo:baz']);
});

it('sets the cwd to the base path if none was given', function () {
ChildProcess::start('some-alias', ['foo', 'bar'], cwd: 'path/to/dir');
Http::assertSent(fn (Request $request) => $request['cwd'] === 'path/to/dir');

ChildProcess::start('some-alias', ['foo', 'bar']);
Http::assertSent(fn (Request $request) => $request['cwd'] === base_path());
});

it('filters double spaces when exploding a command string', function () {
ChildProcess::start('some-alias', 'foo bar baz bak');
Http::assertSent(fn (Request $request) => $request['cmd'] === ['foo', 'bar', 'baz', 'bak']);
});

it('escapes spaces when passing a command array', function () {
ChildProcess::start('some-alias', ['path/to/some executable with spaces.sh', '--foo', '--bar']);
Http::assertSent(fn (Request $request) => $request['cmd'] === ['path/to/some\ executable\ with\ spaces.sh', '--foo', '--bar']);
});

it('can stop a child process', function () {
ChildProcess::stop('some-alias');

Http::assertSent(function (Request $request) {
return $request->url() === 'http://localhost:4000/api/child-process/stop' &&
$request['alias'] === 'some-alias';
});
});

it('can send messages to a child process', function () {
ChildProcess::message('some-alias', 'some-message');

Http::assertSent(function (Request $request) {
return $request->url() === 'http://localhost:4000/api/child-process/message' &&
$request['alias'] === 'some-alias' &&
$request['message'] === '"some-message"';
});
});