Skip to content
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

Fix erroneous exit code not propagating for BatchJob #36

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
13 changes: 12 additions & 1 deletion src/Spork/Batch/BatchJob.php
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,18 @@ public function __invoke()

$results = array();
foreach ($forks as $fork) {
$results = array_merge($results, $fork->getResult());

$exitStatus = $fork->getExitStatus();
if (0 !== $exitStatus) {
if ($error = $fork->getError()) {
// Unfortunately the original exception is lost and Error is not throwable
throw new \RuntimeException($error->getMessage());
}

return $exitStatus;
}

$results = array_merge($results, (array) $fork->getResult());
}

return $results;
Expand Down
112 changes: 112 additions & 0 deletions tests/Spork/Test/Batch/BatchJobTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<?php

namespace Spork\Test\Batch;

class BatchJobTest extends \PHPUnit_Framework_TestCase
{
public function testErrorPropagation()
{
$manager = new \Spork\ProcessManager();
$batch = $manager->createBatchJob(range(1, 5));

$expectedExitStatus = 20;

$failingClosure = function ($data) use ($expectedExitStatus) {
// Simple condition to simulate only one point of failure
if (3 === $data) {
exit($expectedExitStatus);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't we rather have a case throwing an exception in the closure ? This seems a more sensible use case.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exceptions are indeed more sensible use cases. But this way we cannot test the correctness of the exit status.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stof I just added a new test case when the closure throws an exception.

}

exit(0);
};

$promise = $batch->execute($failingClosure);

$promise->wait();

$success = null;

$promise->done(function () use (& $success) {
$success = true;
});

$promise->fail(function () use (& $success) {
$success = false;
});

$this->assertFalse($success, 'Promise should fail');

$this->assertNull($promise->getError(), 'Child process did not throw and exception so error should be null');

$actualExitStatus = $promise->getExitStatus();

$this->assertEquals($expectedExitStatus, $actualExitStatus, 'Parent process exit status should match the child one');
}

public function testErrorMessagePropagation()
{
$manager = new \Spork\ProcessManager();
$batch = $manager->createBatchJob(range(1, 5));

$expectedErrorMessage = 'This is a test message';

$failingClosure = function ($data) use ($expectedErrorMessage) {
// Simple condition to simulate only one point of failure
if (3 === $data) {
throw new \InvalidArgumentException($expectedErrorMessage);
}

exit(0);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we absolutely need to exit here ? It would be great if this example could match what people will probably do, i.e. not using exit at all

};

$promise = $batch->execute($failingClosure);

$promise->wait();

$success = null;

$promise->done(function () use (& $success) {
$success = true;
});

$promise->fail(function () use (& $success) {
$success = false;
});

$this->assertFalse($success, 'Promise should fail');

$this->assertNotNull($promise->getError(), 'Since child process thrown an exception, parent process should have an error');

$this->assertEquals($expectedErrorMessage, $promise->getError()->getMessage(), 'Parent process error message should match the child one');
}

public function testExitStatusIsZeroOnSuccess()
{
$manager = new \Spork\ProcessManager();
$batch = $manager->createBatchJob(range(1, 5));

$simpleClosure = function () {
exit(0);
};

$promise = $batch->execute($simpleClosure);

$promise->wait();

$success = null;

$promise->done(function () use (& $success) {
$success = true;
});

$promise->fail(function () use (& $success) {
$success = false;
});

$this->assertTrue($success, 'Promise should be successful');

$actualExitStatus = $promise->getExitStatus();

$this->assertEquals(0, $actualExitStatus, 'When the promise is successful the exit status should be zero');
}
}