1
0
mirror of https://github.com/danog/amp.git synced 2024-12-03 09:57:51 +01:00
amp/test/FunctionsTest.php
2015-07-23 15:23:45 -04:00

848 lines
27 KiB
PHP

<?php
namespace Amp\Test;
use Amp\NativeReactor;
use Amp\Success;
use Amp\Failure;
use Amp\Deferred;
use Amp\PromiseStream;
use Amp\Pause;
use Amp\CoroutineResult;
class FunctionsTest extends \PHPUnit_Framework_TestCase {
public function testStream() {
$endReached = false;
(new NativeReactor)->run(function($reactor) use (&$endReached) {
$def = new Deferred;
$stream = \Amp\stream($def->promise());
$i = 0;
$reactor->repeat(function($reactor, $watcherId) use ($def, &$i) {
$i++;
$def->update("test{$i}");
if ($i === 3) {
$def->succeed();
$reactor->cancel($watcherId);
}
}, 100);
$results = [];
foreach ($stream as $msgElement) {
$results[] = (yield $msgElement);
}
$this->assertSame(["test1", "test2", "test3", null], $results);
$endReached = true;
});
$this->assertTrue($endReached);
}
public function testStreamRetainsUpdatesUntilInitialized() {
$endReached = false;
(new NativeReactor)->run(function($reactor) use (&$endReached) {
$def = new Deferred;
$stream = \Amp\stream($def->promise());
$def->update("foo");
$def->update("bar");
$def->update("baz");
$def->succeed();
$results = [];
foreach ($stream as $msgElement) {
$results[] = (yield $msgElement);
}
$this->assertSame(["foo", "bar", "baz", null], $results);
$endReached = true;
});
$this->assertTrue($endReached);
}
/**
* @expectedException \Exception
* @expectedExceptionMessage test
*/
public function testStreamThrowsIfPromiseFails() {
(new NativeReactor)->run(function($reactor) {
$promisor = new PromisorPrivateImpl;
$reactor->repeat(function($reactor, $watcherId) use (&$i, $promisor) {
$i++;
$promisor->update($i);
if ($i === 3) {
$reactor->cancel($watcherId);
$promisor->fail(new \Exception(
"test"
));
}
}, 10);
$stream = \Amp\stream($promisor->promise());
$results = [];
foreach ($stream as $msgElement) {
$results[] = (yield $msgElement);
}
});
}
public function testMap() {
$promises = ["test1", new Success("test2"), new Success("test3")];
$functor = "strtoupper";
$promise = \Amp\map($promises, $functor);
$error = null;
$result = null;
$promise->when(function ($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($error);
$this->assertSame(["TEST1", "TEST2", "TEST3"], $result);
}
public function testMapReturnsEmptySuccessOnEmptyInput() {
$promise = \Amp\map([], function () {});
$this->assertInstanceOf("Amp\Success", $promise);
$error = null;
$result = null;
$promise->when(function ($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($error);
$this->assertSame([], $result);
}
/**
* @expectedException Exception
* @expectedExceptionMessage hulk smash
*/
public function testMapFailsIfFunctorThrowsOnUnwrappedValue() {
(new NativeReactor)->run(function ($reactor) {
yield \Amp\map(["test"], function () { throw new \Exception("hulk smash"); });
});
}
/**
* @expectedException Exception
* @expectedExceptionMessage hulk smash
*/
public function testMapFailsIfFunctorThrowsOnResolvedValue() {
(new NativeReactor)->run(function ($reactor) {
$promises = [new Success("test")];
yield \Amp\map($promises, function () { throw new \Exception("hulk smash"); });
});
}
public function testMapFailsIfAnyPromiseFails() {
$e = new \RuntimeException(
"true progress is to know more, and be more, and to do more"
);
$promise = \Amp\map([new Failure($e)], function () {});
$error = null;
$result = null;
$promise->when(function ($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertSame($e, $error);
$this->assertNull($result);
}
public function testMapIgnoresFurtherResultsOnceFailed() {
$completed = false;
(new NativeReactor)->run(function ($reactor) use (&$completed) {
$p1 = new Deferred;
$reactor->once(function () use ($p1) {
$p1->succeed("woot");
}, 50);
$e = new \RuntimeException(
"true progress is to know more, and be more, and to do more"
);
$p2 = new Deferred;
$reactor->once(function () use ($p2, $e) {
$p2->fail($e);
}, 10);
$toMap = \Amp\promises([$p1, $p2]);
try {
yield \Amp\map($toMap, "strtoupper");
$this->fail("this line should not be reached");
} catch (\RuntimeException $error) {
$this->assertSame($e, $error);
}
yield $p1->promise();
$completed = true;
});
$this->assertTrue($completed);
}
public function testFilter() {
$promises = ["test1", new Success("test2"), new Success("test2"), "test2"];
$functor = function($el) { return $el === "test2"; };
$promise = \Amp\filter($promises, $functor);
$error = null;
$result = null;
$promise->when(function ($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($error);
$this->assertSame([1=>"test2", 2=>"test2", 3=>"test2"], $result);
}
public function testFilter2() {
$promises = ["test1", "test2", new Success("test2"), new Success("test2")];
$functor = function($el) { return $el === "test2"; };
$promise = \Amp\filter($promises, $functor);
$error = null;
$result = null;
$promise->when(function ($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($error);
$this->assertSame([1=>"test2", 2=>"test2", 3=>"test2"], $result);
}
public function testFilterReturnsEmptySuccessOnEmptyInput() {
$promise = \Amp\filter([], function () {});
$this->assertInstanceOf("Amp\Success", $promise);
$error = null;
$result = null;
$promise->when(function ($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($error);
$this->assertSame([], $result);
}
/**
* @expectedException Exception
* @expectedExceptionMessage hulk smash
*/
public function testFilterFailsIfFunctorThrowsOnUnwrappedValue() {
(new NativeReactor)->run(function ($reactor) {
yield \Amp\filter(["test"], function () { throw new \Exception("hulk smash"); });
});
}
/**
* @expectedException Exception
* @expectedExceptionMessage hulk smash
*/
public function testFilterFailsIfFunctorThrowsOnResolvedValue() {
(new NativeReactor)->run(function ($reactor) {
$promises = [new Success("test")];
yield \Amp\filter($promises, function () { throw new \Exception("hulk smash"); });
});
}
public function testFilterFailsIfAnyPromiseFails() {
$e = new \RuntimeException(
"true progress is to know more, and be more, and to do more"
);
$promise = \Amp\filter([new Failure($e)], function () {});
$error = null;
$result = null;
$promise->when(function ($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertSame($e, $error);
$this->assertNull($result);
}
public function testFilterIgnoresFurtherResultsOnceFailed() {
$completed = false;
(new NativeReactor)->run(function ($reactor) use (&$completed) {
$p1 = new Deferred;
$p2 = new Deferred;
$e = new \RuntimeException(
"true progress is to know more, and be more, and to do more"
);
$reactor->once(function ($reactor) use ($p1, $p2, $e) {
$p2->fail($e);
$reactor->immediately(function() use ($p1) {
$p1->succeed("woot");
});
}, 10);
$toMap = \Amp\promises([$p1, $p2]);
$functor = function () { return true; };
try {
yield \Amp\filter($toMap, $functor);
$this->fail("this line should not be reached");
} catch (\RuntimeException $error) {
$this->assertSame($e, $error);
}
yield $p1->promise();
$completed = true;
});
$this->assertTrue($completed);
}
public function testPipeWrapsRawValue() {
$invoked = 0;
$promise = \Amp\pipe(21, function($r) { return $r * 2; });
$promise->when(function($e, $r) use (&$invoked) {
$invoked++;
$this->assertSame(42, $r);
});
$this->assertSame(1, $invoked);
}
public function testPipeTransformsEventualPromiseResult() {
$result = 0;
(new NativeReactor)->run(function ($reactor) use (&$result) {
$promisor = new Deferred;
$reactor->once(function () use ($promisor) {
$promisor->succeed("woot");
}, 10);
$promise = $promisor->promise();
$result = (yield \Amp\pipe($promise, "strtoupper"));
});
$this->assertSame("WOOT", $result);
}
public function testPipeAbortsIfOriginalPromiseFails() {
$invoked = 0;
$failure = new Failure(new \RuntimeException);
$promise = \Amp\pipe($failure, function(){});
$promise->when(function($e, $r) use (&$invoked) {
$invoked++;
$this->assertInstanceOf("RuntimeException", $e);
});
$this->assertSame(1, $invoked);
}
public function testPipeAbortsIfFunctorThrowsOnRawValue() {
$invoked = 0;
$promise = \Amp\pipe(42, function(){ throw new \RuntimeException; });
$promise->when(function($e, $r) use (&$invoked) {
$invoked++;
$this->assertInstanceOf("RuntimeException", $e);
});
$this->assertSame(1, $invoked);
}
public function testPipeAbortsIfFunctorThrows() {
$invoked = 0;
$promise = \Amp\pipe(new Success(42), function(){ throw new \RuntimeException; });
$promise->when(function($e, $r) use (&$invoked) {
$invoked++;
$this->assertInstanceOf("RuntimeException", $e);
});
$this->assertSame(1, $invoked);
}
public function testAllResolutionWhenNoPromiseInstancesCombined() {
$promises = [null, 1, 2, true];
\Amp\all($promises)->when(function($e, $r) {
list($a, $b, $c, $d) = $r;
$this->assertNull($a);
$this->assertSame(1, $b);
$this->assertSame(2, $c);
$this->assertSame(true, $d);
});
}
public function testSomeResolutionWhenNoPromiseInstancesCombined() {
$promises = [null, 1, 2, true];
\Amp\some($promises)->when(function($e, $r) {
list($errors, $results) = $r;
list($a, $b, $c, $d) = $results;
$this->assertNull($a);
$this->assertSame(1, $b);
$this->assertSame(2, $c);
$this->assertSame(true, $d);
});
}
public function testAnyResolutionWhenNoPromiseInstancesCombined() {
$promises = [null, 1, 2, true];
\Amp\any($promises)->when(function($e, $r) {
list($errors, $results) = $r;
list($a, $b, $c, $d) = $results;
$this->assertNull($a);
$this->assertSame(1, $b);
$this->assertSame(2, $c);
$this->assertSame(true, $d);
});
}
public function testAnyReturnsImmediatelyOnEmptyPromiseArray() {
$promise = \Amp\any([]);
$this->assertInstanceOf("Amp\Success", $promise);
$error = null;
$result = null;
$promise->when(function($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($error);
$this->assertSame([[], []], $result);
}
public function testAllResolvesWithArrayOfResults() {
\Amp\all(['r1' => 42, 'r2' => new Success(41)])->when(function($error, $result) {
$expected = ['r1' => 42, 'r2' => 41];
$this->assertSame($expected, $result);
});
}
public function testAllReturnsImmediatelyOnEmptyPromiseArray() {
$promise = \Amp\all([]);
$this->assertInstanceOf("Amp\Success", $promise);
$error = null;
$result = null;
$promise->when(function($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($error);
$this->assertSame([], $result);
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage zanzibar
*/
public function testAllThrowsIfAnyIndividualPromiseFails() {
$exception = new \RuntimeException('zanzibar');
\Amp\all([
'r1' => new Success(42),
'r2' => new Failure($exception),
'r3' => new Success(40),
])->when(function(\Exception $error) {
throw $error;
});
}
public function testSomeReturnsArrayOfErrorsAndResults() {
$exception = new \RuntimeException('zanzibar');
\Amp\some([
'r1' => new Success(42),
'r2' => new Failure($exception),
'r3' => new Success(40),
])->when(function($error, $result) use ($exception) {
list($errors, $results) = (yield \Amp\some($promises));
$this->assertSame(['r2' => $exception], $errors);
$this->assertSame(['r1' => 42, 'r3' => 40], $results);
});
}
public function testSomeFailsImmediatelyOnEmptyPromiseArrayInput() {
$promise = \Amp\some([]);
$this->assertInstanceOf("Amp\Failure", $promise);
$error = null;
$result = null;
$promise->when(function($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($result);
$this->assertInstanceOf("\LogicException", $error);
$this->assertSame("No promises or values provided for resolution", $error->getMessage());
}
/**
* @expectedException \RuntimeException
*/
public function testSomeThrowsIfNoPromisesResolveSuccessfully() {
\Amp\some([
'r1' => new Failure(new \RuntimeException),
'r2' => new Failure(new \RuntimeException),
])->when(function($error) {
throw $error;
});
}
public function testFirstFailsImmediatelyOnEmptyPromiseArrayInput() {
$promise = \Amp\first([]);
$this->assertInstanceOf("Amp\Failure", $promise);
$error = null;
$result = null;
$promise->when(function($e, $r) use (&$error, &$result) {
$error = $e;
$result = $r;
});
$this->assertNull($result);
$this->assertInstanceOf("\LogicException", $error);
$this->assertSame("No promises or values provided", $error->getMessage());
}
public function testFirst() {
$resolutionCount = 0;
$result = 0;
(new NativeReactor)->run(function ($reactor) use (&$resolutionCount, &$result) {
$p1 = new Deferred;
$reactor->once(function () use ($p1, &$resolutionCount) {
$p1->succeed(1);
$resolutionCount++;
}, 10);
$p2 = new Deferred;
$reactor->once(function () use ($p2, &$resolutionCount) {
$p2->succeed(2);
$resolutionCount++;
}, 20);
$p3 = new Deferred;
$reactor->once(function () use ($p3, &$resolutionCount) {
$p3->succeed(3);
$resolutionCount++;
}, 30);
$promises = [$p1->promise(), $p2->promise(), $p3->promise()];
$allPromise = \Amp\all($promises, $reactor);
$allPromise->when([$reactor, "stop"]);
$result = (yield \Amp\first($promises, $reactor));
});
$this->assertSame(3, $resolutionCount);
$this->assertSame(1, $result);
}
public function testNonPromiseValueImmediatelyResolvesFirstCombinator() {
$result = 0;
(new NativeReactor)->run(function ($reactor) use (&$result) {
$p1 = 42;
$p2 = (new Deferred)->promise();
$result = (yield \Amp\first([$p1, $p2], $reactor));
});
$this->assertSame(42, $result);
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage All promises failed
*/
public function testFirstFailsIfAllPromisesFail() {
(new NativeReactor)->run(function ($reactor) use (&$result) {
$e1 = new \Exception("foo");
$e2 = new \Exception("bar");
$promises = [new Failure($e1), new Failure($e2)];
yield \Amp\first($promises, $reactor);
});
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage Promise resolution timed out
*/
public function testTimeout() {
(new NativeReactor)->run(function($reactor) {
$pause = new \Amp\Pause(1000, $reactor);
yield \Amp\timeout($pause, 10, $reactor);
});
}
public function testTimeoutOnSuccess() {
$invoked = false;
(new NativeReactor)->run(function ($reactor) use (&$invoked) {
$promisor = new Deferred;
$reactor->once(function () use ($promisor) {
$promisor->succeed(42);
}, 10);
$result = (yield \Amp\timeout($promisor->promise(), 10000, $reactor));
$this->assertSame(42, $result);
$invoked = true;
});
$this->assertTrue($invoked);
}
/**
* @expectedException RuntimeException
* @expectedExceptionMessage nothing that is worth knowing can be taught
*/
public function testTimeoutOnFailure() {
(new NativeReactor)->run(function ($reactor) {
$promisor = new Deferred;
$reactor->once(function () use ($promisor) {
$promisor->fail(new \RuntimeException(
"nothing that is worth knowing can be taught"
));
}, 10);
$result = (yield \Amp\timeout($promisor->promise(), 10000, $reactor));
});
}
public function testTimeoutIgnoresResultIfAlreadyComplete() {
$invoked = false;
(new NativeReactor)->run(function ($reactor) use (&$invoked) {
$promisor = new Deferred;
$reactor->once(function () use ($promisor) {
$promisor->succeed(42);
}, 100);
try {
$result = (yield \Amp\timeout($promisor->promise(), 10, $reactor));
} catch (\RuntimeException $e) {
// ignore this
}
yield $promisor->promise();
$invoked = true;
});
$this->assertTrue($invoked);
}
public function testAllCombinatorResolution() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
list($a, $b) = (yield \Amp\all([
new Success(21),
new Success(2),
]));
$result = ($a * $b);
$this->assertSame(42, $result);
$invoked++;
});
$this->assertSame(1, $invoked);
}
public function testAllCombinatorResolutionWithNonPromises() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
list($a, $b, $c) = (yield \Amp\all([new Success(21), new Success(2), 10]));
$result = ($a * $b * $c);
$this->assertSame(420, $result);
$invoked++;
});
$this->assertSame(1, $invoked);
}
/**
* @expectedException \Exception
* @expectedExceptionMessage When in the chronicle of wasted time
*/
public function testAllCombinatorResolutionThrowsIfAnyOnePromiseFails() {
(new NativeReactor)->run(function($reactor) {
list($a, $b) = (yield \Amp\all([
new Success(21),
new Failure(new \Exception('When in the chronicle of wasted time')),
]));
});
}
public function testExplicitAllCombinatorResolution() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
list($a, $b, $c) = (yield \Amp\all([
new Success(21),
new Success(2),
10
]));
$this->assertSame(420, ($a * $b * $c));
$invoked++;
});
$this->assertSame(1, $invoked);
}
public function testExplicitAnyCombinatorResolution() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
list($errors, $results) = (yield \Amp\any([
'a' => new Success(21),
'b' => new Failure(new \Exception('test')),
]));
$this->assertSame('test', $errors['b']->getMessage());
$this->assertSame(21, $results['a']);
$invoked++;
});
$this->assertSame(1, $invoked);
}
/**
* @expectedException \RuntimeException
*/
public function testExplicitSomeCombinatorResolutionFailsOnError() {
(new NativeReactor)->run(function($reactor) {
yield \Amp\some([
'r1' => new Failure(new \RuntimeException),
'r2' => new Failure(new \RuntimeException),
]);
});
}
public function testPromisesNormalization() {
$completed = false;
(new NativeReactor)->run(function($reactor) use (&$completed) {
$promisor = new Deferred;
$promisor->succeed(41);
$values = [
$promisor,
42,
new Success(43),
];
list($a, $b, $c) = (yield \Amp\all(\Amp\promises($values)));
$this->assertSame(41, $a);
$this->assertSame(42, $b);
$this->assertSame(43, $c);
$completed = true;
});
$this->assertTrue($completed);
}
public function testCoroutine() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
$co = function($reactor) use (&$invoked) {
yield new Success;
yield;
yield new Pause(25, $reactor);
$invoked++;
};
$wrapped = \Amp\coroutine($co, $reactor);
$wrapped($reactor);
});
$this->assertSame(1, $invoked);
}
public function testNestedCoroutineResolutionContinuation() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
$co = function() use (&$invoked) {
yield new Success;
yield new Success;
yield new Success;
yield new Success;
yield new Success;
yield new CoroutineResult(42);
$invoked++;
};
$result = (yield \Amp\resolve($co(), $reactor));
$this->assertSame(42, $result);
});
$this->assertSame(1, $invoked);
}
public function testCoroutineFauxReturnValue() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
$co = function() use (&$invoked) {
yield;
yield new CoroutineResult(42);
yield;
$invoked++;
};
$result = (yield \Amp\resolve($co(), $reactor));
$this->assertSame(42, $result);
});
$this->assertSame(1, $invoked);
}
public function testResolutionFailuresAreThrownIntoGeneratorCoroutine() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
$foo = function() {
$a = (yield new Success(21));
$b = 1;
try {
yield new Failure(new \Exception("test"));
$this->fail("Code path should not be reached");
} catch (\Exception $e) {
$this->assertSame("test", $e->getMessage());
$b = 2;
}
};
$result = (yield \Amp\resolve($foo(), $reactor));
$invoked++;
});
$this->assertSame(1, $invoked);
}
/**
* @expectedException \Exception
* @expectedExceptionMessage a moveable feast
*/
public function testExceptionOnInitialAdvanceFailsCoroutineResolution() {
(new NativeReactor)->run(function($reactor) use (&$invoked) {
$co = function() {
throw new \Exception("a moveable feast");
yield;
};
$result = (yield \Amp\resolve($co(), $reactor));
});
}
/**
* @dataProvider provideInvalidYields
*/
public function testInvalidYieldFailsCoroutineResolution($badYield) {
try {
(new NativeReactor)->run(function($reactor) use (&$invoked, $badYield) {
$gen = function() use ($badYield) {
yield;
yield $badYield;
yield;
};
yield \Amp\resolve($gen(), $reactor);
});
$this->fail("execution should not reach this point");
} catch (\DomainException $e) {
$pos = strpos($e->getMessage(), "Unexpected yield (Promise|CoroutineResult|null expected);");
$this->assertSame(0, $pos);
return;
}
$this->fail("execution should not reach this point");
}
public function provideInvalidYields() {
return [
[42],
[3.14],
["string"],
[true],
[new \StdClass],
];
}
/**
* @expectedException \Exception
* @expectedExceptionMessage When in the chronicle of wasted time
*/
public function testUncaughtGeneratorExceptionFailsCoroutineResolution() {
$invoked = 0;
(new NativeReactor)->run(function($reactor) use (&$invoked) {
$gen = function() {
yield;
throw new \Exception("When in the chronicle of wasted time");
yield;
};
yield \Amp\resolve($gen(), $reactor);
$invoked++;
});
$this->assertSame(1, $invoked);
}
}