danog/amp
1
0
Fork 0
mirror of https://github.com/danog/amp.git synced 2024-12-03 18:07:57 +01:00
Code Issues Projects Releases Wiki Activity

Remove unused BaseTest

Browse Source
This commit is contained in:
Aaron Piotrowski 2020-10-04 10:12:22 -05:00
parent b226030a11
commit 3dbebd2a77
No known key found for this signature in database
GPG Key ID: ADD1EF783EDE9EEB
1 changed files with 0 additions and 197 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

197
test/BaseTest.php
View File

@ -1,197 +0,0 @@
<?php
namespace Amp\Test;
use Amp\Deferred;
use Amp\Loop;
use Amp\PHPUnit\CallbackStub;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase as PHPUnitTestCase;
use function Amp\await;
use function Amp\async;
use function Amp\call;
use function Amp\sleep;
abstract class BaseTest extends PHPUnitTestCase
{
const RUNTIME_PRECISION = 2;
private Deferred $timeoutDeferred;
private string $timeoutId;
/** @var int Minimum runtime in milliseconds. */
private int $minimumRuntime = 0;
/** @var string Temporary storage for actual test name. */
private string $realTestName;
private bool $setUpInvoked = false;
public function __construct(?string $name = null, array $data = [], $dataName = '')
{
parent::__construct($name, $data, $dataName);
$this->timeoutDeferred = new Deferred;
}
protected function setUp(): void
{
$this->setUpInvoked = true;
Loop::set((new Loop\DriverFactory)->create());
\gc_collect_cycles(); // extensions using an event loop may otherwise leak the file descriptors to the loop
}
/**
* @codeCoverageIgnore Invoked before code coverage data is being collected.
*/
final public function setName(string $name): void
{
parent::setName($name);
$this->realTestName = $name;
}
/** @internal */
final protected function runAsyncTest(mixed ...$args): mixed
{
if (!$this->setUpInvoked) {
$this->fail(\sprintf(
'%s::setUp() overrides %s::setUp() without calling the parent method',
\str_replace("\0", '@', \get_class($this)), // replace NUL-byte in anonymous class name
self::class
));
}
parent::setName($this->realTestName);
$start = \microtime(true);
try {
[$returnValue] = await([
async(function () use ($args): mixed {
try {
return await(call([$this, $this->realTestName], ...$args));
} finally {
if (!$this->timeoutDeferred->isResolved()) {
$this->timeoutDeferred->resolve();
}
}
}),
$this->timeoutDeferred->promise()
]);
} finally {
if (isset($this->timeoutId)) {
Loop::cancel($this->timeoutId);
}
$this->clearLoopRethrows();
}
if ($this->minimumRuntime > 0) {
$actualRuntime = (int) (\round(\microtime(true) - $start, self::RUNTIME_PRECISION) * 1000);
$msg = 'Expected test to take at least %dms but instead took %dms';
$this->assertGreaterThanOrEqual(
$this->minimumRuntime,
$actualRuntime,
\sprintf($msg, $this->minimumRuntime, $actualRuntime)
);
}
return $returnValue;
}
final protected function runTest(): mixed
{
parent::setName('runAsyncTest');
return parent::runTest();
}
/**
* Fails the test if the loop does not run for at least the given amount of time.
*
* @param int $runtime Required run time in milliseconds.
*/
final protected function setMinimumRuntime(int $runtime): void
{
if ($runtime < 1) {
throw new \Error('Minimum runtime must be at least 1ms');
}
$this->minimumRuntime = $runtime;
}
/**
* Fails the test (and stops the loop) after the given timeout.
*
* @param int $timeout Timeout in milliseconds.
*/
final protected function setTimeout(int $timeout): void
{
$this->timeoutId = Loop::delay($timeout, function () use ($timeout): void {
Loop::setErrorHandler(null);
$additionalInfo = '';
$loop = Loop::get();
if ($loop instanceof Loop\TracingDriver) {
$additionalInfo .= "\r\n\r\n" . $loop->dump();
} elseif (\class_exists(Loop\TracingDriver::class)) {
$additionalInfo .= "\r\n\r\nSet AMP_DEBUG_TRACE_WATCHERS=true as environment variable to trace watchers keeping the loop running.";
} else {
$additionalInfo .= "\r\n\r\nInstall amphp/amp@^2.3 and set AMP_DEBUG_TRACE_WATCHERS=true as environment variable to trace watchers keeping the loop running. ";
}
try {
$this->fail('Expected test to complete before ' . $timeout . 'ms time limit' . $additionalInfo);
} catch (AssertionFailedError $e) {
$this->timeoutDeferred->fail($e);
}
});
Loop::unreference($this->timeoutId);
}
/**
* @param int $invocationCount Number of times the callback must be invoked or the test will fail.
* @param callable|null $returnCallback Callable providing a return value for the callback.
*
* @return callable|MockObject Mock object having only an __invoke method.
*/
final protected function createCallback(int $invocationCount, callable $returnCallback = null): callable
{
$mock = $this->createMock(CallbackStub::class);
$invocationMocker = $mock->expects($this->exactly($invocationCount))
->method('__invoke');
if ($returnCallback) {
$invocationMocker->willReturnCallback($returnCallback);
}
return $mock;
}
private function clearLoopRethrows(): void
{
$info = Loop::getInfo();
$errors = [];
while (true) {
try {
sleep(0);
break;
} catch (\Throwable $e) {
$errors[] = (string) $e;
}
}
if ($errors) {
$this->markTestIncomplete(\implode("\n", $errors));
}
if ($info['enabled_watchers']['referenced'] + $info['enabled_watchers']['unreferenced'] > 0) {
$this->markTestIncomplete(
"Found enabled watchers at end of test '{$this->getName()}': " . \json_encode($info, \JSON_PRETTY_PRINT),
);
}
}
}