👋 Hi there,

At ChesslaBlab we're writing functional tests for the PHP Chess Server.

See:

• chesslablab/chess-server#193

At this moment I'm trying to run the docs example as it is shown in the two images below.

Figure 1. php cli/testing.php

Figure 2. vendor/bin/phpunit tests/functional/

However, the test is left waiting indefinitely.

<?php

namespace ChessServer\Tests\Functional;

use Amp\ByteStream;
use Amp\PHPUnit\AsyncTestCase;
use Amp\Socket;

class StartCommandTest extends AsyncTestCase
{
    public function test(): void
    {
        $socket = Socket\connect('tcp://127.0.0.1:8080');
        
        $socket->write('/start classical fen');

        $expected = '{"\/start":{"variant":"classical","mode":"fen","fen":"rnbqkbnr\/pppppppp\/8\/8\/8\/8\/PPPPPPPP\/RNBQKBNR w KQkq -"}}';

        $this->assertSame($expected, ByteStream\buffer($socket));
    }
}

Also this is the cli/testing.php script running the TCP socket server on port 8080 shown in Figure 1.

<?php

namespace ChessServer\Cli;

use ChessServer\Socket\TcpSocket;
use Dotenv\Dotenv;

require __DIR__ . '/../vendor/autoload.php';

$dotenv = Dotenv::createImmutable(__DIR__.'/../');
$dotenv->load();

$server = new TcpSocket($_ENV['TCP_PORT']);

Any help would be greatly appreciated.

Thank you,

Thank you for the excellent work that you've done to improve asynchronous programming in PHP. I am starting to develop a series of applications on top of amphp and I plan on developing a series of test utilities that I wanted to see if you'd like to see added to this library.

The first piece is an AsynchronousTestCase that would allow userland code to ensure all asynchronous operations in their test completes appropriately and that tests aren't allowed to run forever. This is accomplished by allowing tests to return a Promise to control when the test ends and setting a delay timer to ensure the test does not run past a set period of time.

The second is a TestContext class (or something more aptly named) that would ensure a series of asynchronous tasks occur and to also act as a Deferred able to provide a Promise returned for each test in the AsyncTestCase.

Here is a gist of an example implementation of the AsyncTestCase along with an example test using the TestContext object. https://gist.github.com/cspray/88ce3d550a0e5ac74c5cafbc5b85df95

Please let me know if you have any questions or any other feedback. If this is something that you would be interested in I can provide tests for it (nothing like testing the tests) and submit a PR. Before I go down that route I wanted to ensure this is something you'd like to see.

Thanks

It is common for PHPUnit extensions to implement functionality with base classes, but we can only extend one. Therefore, it is often impossible to use two or more extensions at once. For example, one may wish to use Symfony's WebTestCase but also AsyncTestCase, which is impossible since both must be extended directly.

Since traits offer unlimited extension, an alternative implementation should be offered in addition to/instead of the current base class approach.

I'm working on a simple abstraction built on top of http-server for making async APIs and I ran into the following issue - when I try to write a test to assert that an exception is thrown, TestCase::expectException() seems to be unaware of it actually happening. Take a look at this snippet:

<?php
class AwesomeTest extends AsyncTestCase
{
    public function testOhNoes()
    {
        $this->expectException(Error::class);
    
        yield call(function () {
            throw new Error;
        });
    }

    public function testYay()
    {
        $this->expectException(Error::class);

        throw new Error;
    }
}

And the output from PHPUnit:

1) AwesomeTest::testOhNoes
Error: 
/home/jakobmats/workspace/empress/test/AwesomeTest.php:13
/home/jakobmats/workspace/empress/vendor/amphp/amp/lib/functions.php:60
/home/jakobmats/workspace/empress/test/AwesomeTest.php:14
/home/jakobmats/workspace/empress/vendor/amphp/amp/lib/Coroutine.php:60
/home/jakobmats/workspace/empress/vendor/amphp/amp/lib/functions.php:66
/home/jakobmats/workspace/empress/vendor/amphp/phpunit-util/src/AsyncTestCase.php:23
/home/jakobmats/.config/composer/vendor/phpunit/phpunit/src/TextUI/Command.php:201
/home/jakobmats/.config/composer/vendor/phpunit/phpunit/src/TextUI/Command.php:160

The other test case passes without problems. Any ideas why it happens? As far as I understand it the error should bubble up until it hits the top level so that PHPUnit is supposed to see it, no?

Shoulnd't it abort the loop instead?

Same happens if we just remove the line throw new Exception("TEST");, but I'm not sure whether it's so by design.

class MyAsyncTestCase extends AsyncTestCase
{
    function test()
    {
        Loop::repeat(1000, static function() { echo "alive\n"; });
        throw new Exception("TEST"); // Doesn't abort the loop. This method runs forever.
    }
}

I have a TCP connection running in the event loop. This TCP connection has always something to do, like handling heart beats. I need to explicitly close the connection, otherwise the loop will run forever and never stop.

I used wait(call(...)) before and there wasn't this problem. Using phpunit-util, I need to close the connection manually and add that line of code more than 400 test cases. Is there a way around this that can be incorporated into this lib?

PHPUnit 10 has recently been released and it includes improvements to the testing framework along with a new Event system. Unfortunately, it also brings along a breaking change that causes this library to no longer work. Specifically, the PHPUnit\Framework\TestCase::setName method has been marked as final and can no longer be overridden. Fortunately, I believe the event system could simplify what we'd have to do.

A tl;dr is that we create an Extension that invokes EventLoop::getSuspension()->suspend() in an appropriate event. The first thought is the PHPUnit\Event\Events\Test\Finished event.

If this sounds like a good place to start I can work on a new branch for PHPUnit 10 support in the next week or two.

For example:

<?php

use Amp\PHPUnit\AsyncTestCase;
use Amp\Success;
use Generator;

class MockedClass {
    public function doSomething(): Promise {
        return new Success('Some Value');
    }
}

class TestedClass {

    private MockedClass $mockedClass;

    public function __construct(MockedClass $mockedClass) {
        $this->mockedClass = $mockedClass;
    }

    public function performAction(): Promise
    {
        // Not the greatest example..
        return new Success( yield $this->mockedClass->doSomething() );
    }
}

class TestedClassTest extends AsyncTestCase {
    public function testPerformAction() {
        $mockedClass = $this->createMock(MockedClass::CLASS);
        $testedClass = new TestedClass($mockedClass);

        yield $testedClass->performAction();

        $this->assertEquals(1, 1);  // Is never reached.
    }
}

Causes: Loop stopped without resolving promise or coroutine returned from test method

If you define the method mock which is yielded inside TestedClass to return a promise, it works.

Caused a fair bit of confusion writing tests, wouldn't mind an easier to understand error message if possible!

Hi,
PHPUnit 7 is not supported currently, any blockers? I would provide PR, but there are no tests unfortunately (can you add some please?).