platform/packages/test/README.md

Protevus Test

Testing utility library for Protevus framework.

TestClient

The TestClient class is a custom protevus_client that sends mock requests to your server. This means that you will not have to bind your server to HTTP to run. Plus, it is an protevus_client, and thus supports services and other goodies. The TestClient also supports WebSockets. WebSockets cannot be mocked (yet!) within this library, so calling the websocket() function will also bind your server to HTTP, if it is not already listening. The return value is a WebSockets client instance (from package:protevus_websocket);

var ws = await client.websocket('/ws');
ws.service('api/users').onCreated.listen(...);

// To receive all blobs of data sent on the WebSocket:
ws.onData.listen(...);

Matchers

Several Matchers are bundled with this package, and run on any package:http Response, not just those returned by Protevus.

void test('foo', () async {
    var res = await client.get('/foo');
    expect(res, allOf([
        isJson({'foo': 'bar'}),
        hasStatus(200),
        hasContentType(ContentType.JSON),
        hasContentType('application/json'),
        hasHeader('server'), // Assert header present
        hasHeader('server', 'protevus'), // Assert header present with value
        hasHeader('foo', ['bar', 'baz']), // ... Or multiple values
        hasBody(), // Assert non-empty body
        hasBody('{"foo":"bar"}') // Assert specific body
    ]));
});

void test('error', () async {
    var res = await client.get('/error');
    expect(res, isAngelHttpException());
    expect(res, isAngelHttpException(statusCode: 404, message: ..., errors: [...])) // Optional
});

hasValidBody is one of the most powerful Matchers in this library, because it allows you to validate a JSON body against a validation schema. Protevus provides a comprehensive validation library that integrates tightly with the matcher package that you already use for testing.

test('validate response', () async {
    var res = await client.get('/bar');
    expect(res, hasValidBody(Validator({
        'foo': isBoolean,
        'bar': [isString, equals('baz')],
        'age*': [],
        'nested': someNestedValidator
    })));
});