Flutter测试框架插件angel3_test的使用

angel3_test 是一个用于 Angel3 框架的测试工具库。通过该库，你可以方便地编写和运行测试用例，确保你的应用在不同情况下都能正常工作。

TestClient

TestClient 类是一个自定义的 angel3_client，它可以向你的服务器发送模拟请求。这意味着你无需将服务器绑定到 HTTP 即可运行测试。此外，它支持服务和其他功能。TestClient 还支持 WebSocket。WebSocket 在此库中无法模拟（目前），因此调用 websocket() 函数会将你的服务器绑定到 HTTP（如果尚未监听）。返回值是一个 WebSockets 客户端实例（来自 package:angel3_websocket）。

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

// 接收 WebSocket 上发送的所有数据块：
ws.onData.listen(...);

Matchers

该包包含多个 Matcher，它们可以应用于任何 package:http 的 Response，而不仅仅是那些由 Angel 返回的响应。

void test('foo', () async {
    var res = await client.get('/foo');
    expect(res, allOf([
        isJson({'foo': 'bar'}),  // 响应体是 JSON 并且内容为 {"foo": "bar"}
        hasStatus(200),          // 状态码为 200
        hasContentType(ContentType.JSON),  // 内容类型为 JSON
        hasContentType('application/json'),  // 内容类型为 application/json
        hasHeader('server'),     // 存在 server 头
        hasHeader('server', 'angel'),  // server 头的值为 angel
        hasHeader('foo', ['bar', 'baz']),  // foo 头的值为 bar 或 baz
        hasBody(),               // 响应体不为空
        hasBody('{"foo":"bar"}') // 响应体为 {"foo":"bar"}
    ]));
});

void test('error', () async {
    var res = await client.get('/error');
    expect(res, isAngelHttpException());  // 响应是 AngelHttpException
    expect(res, isAngelHttpException(statusCode: 404, message: ..., errors: [...]))  // 可选参数
});

hasValidBody 是此库中最强大的 Matcher 之一，因为它允许你根据验证模式验证 JSON 响应体。Angel3 提供了一个综合的验证库，与你已经使用的 matcher 包紧密集成。

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

完整示例

以下是一个完整的示例，展示了如何使用 angel3_test 来测试一个简单的 Angel3 应用程序。

import 'dart:io';
import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel3_test/angel3_test.dart';
import 'package:angel3_validate/angel3_validate.dart';
import 'package:angel3_websocket/server.dart';
import 'package:test/test.dart';

void main() {
  Angel app;
  late TestClient client;

  setUp(() async {
    app = Angel()
      ..get('/hello', (req, res) => 'Hello')
      ..get(
          '/error',
          (req, res) =>
              throw AngelHttpException.forbidden(message: 'Test')
                ..errors.addAll(['foo', 'bar']))
      ..get('/body', (req, res) {
        res
          ..write('OK')
          ..close();
      })
      ..get(
          '/valid',
          (req, res) =>
              {
                'michael': 'jackson',
                'billie': {'jean': 'hee-hee', 'is_my_lover': false}
              })
      ..post('/hello', (req, res) async {
        var body = await req.parseBody().then((_) => req.bodyAsMap);
        return {'bar': body['foo']};
      })
      ..get('/gzip', (req, res) async {
        res
          ..headers['content-encoding'] = 'gzip'
          ..add(gzip.encode('Poop'.codeUnits));
        await res.close();
      })
      ..use(
          '/foo',
          AnonymousService(
              index: ([params]) async => [
                    {'michael': 'jackson'}
                  ],
              create: (dynamic data, [params]) async => {'foo': 'bar'}));

    var ws = AngelWebSocket(app);
    await app.configure(ws.configureServer);
    app.all('/ws', ws.handleRequest);

    app.errorHandler = (e, req, res) => e.toJson();

    client = await connectTo(app);
  });

  tearDown(() async {
    await client.close();
  });

  group('matchers', () {
    group('isJson+hasStatus', () {
      test('get', () async {
        final response = await client.get(Uri.parse('/hello'));
        expect(response, isJson('Hello'));
      });

      test('post', () async {
        final response =
            await client.post(Uri.parse('/hello'), body: {'foo': 'baz'});
        expect(response, allOf(hasStatus(200), isJson({'bar': 'baz'})));
      });
    });

    test('isAngelHttpException', () async {
      var res = await client.get(Uri.parse('/error'));
      print(res.body);
      expect(res, isAngelHttpException());
      expect(
          res,
          isAngelHttpException(
              statusCode: 403, message: 'Test', errors: ['foo', 'bar']));
    });

    test('hasBody', () async {
      var res = await client.get(Uri.parse('/body'));
      expect(res, hasBody());
      expect(res, hasBody('OK'));
    });

    test('hasHeader', () async {
      var res = await client.get(Uri.parse('/hello'));
      expect(res, hasHeader('server'));
      expect(res, hasHeader('server', 'angel'));
      expect(res, hasHeader('server', ['angel']));
    });

    test('hasValidBody+hasContentType', () async {
      var res = await client.get(Uri.parse('/valid'));
      expect(res, hasContentType('application/json'));
      expect(
          res,
          hasValidBody(Validator({
            'michael*': [isString, isNotEmpty, equals('jackson')],
            'billie': Validator({
              'jean': [isString, isNotEmpty],
              'is_my_lover': [isBool, isFalse]
            })
          })));
    });

    test('gzip decode', () async {
      var res = await client.get(Uri.parse('/gzip'));
      expect(res, hasHeader('content-encoding', 'gzip'));
      expect(res, hasBody('Poop'));
    });

    group('service', () {
      test('index', () async {
        var foo = client.service('foo');
        var result = await foo.index();
        expect(result, [
          {'michael': 'jackson'}
        ]);
      });

      test('create', () async {
        var foo = client.service('foo');
        var result = await foo.create({});
        expect(result, {'foo': 'bar'});
      });
    });

    test('websocket', () async {
      var ws = await client.websocket();
      var foo = ws.service('foo');
      await foo.create({});
      var result = await foo.onCreated.first;
      expect(result.data, equals({'foo': 'bar'}));
    });
  });
}