async_test.dart 17 KB
Newer Older
1 2 3 4 5 6
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';

7 8 9
import 'package:flutter/widgets.dart';
import 'package:flutter_test/flutter_test.dart';

10
void main() {
11
  Widget snapshotText(BuildContext context, AsyncSnapshot<String> snapshot) {
Ian Hickson's avatar
Ian Hickson committed
12
    return new Text(snapshot.toString(), textDirection: TextDirection.ltr);
13
  }
14 15 16
  group('AsyncSnapshot', () {
    test('requiring data succeeds if data is present', () {
      expect(
17
        const AsyncSnapshot<String>.withData(ConnectionState.done, 'hello').requireData,
18 19 20 21 22
        'hello',
      );
    });
    test('requiring data fails if there is an error', () {
      expect(
23
        () => const AsyncSnapshot<String>.withError(ConnectionState.done, 'error').requireData,
24 25 26 27 28
        throwsA(equals('error')),
      );
    });
    test('requiring data fails if snapshot has neither data nor error', () {
      expect(
29
        () => const AsyncSnapshot<String>.nothing().requireData,
30 31 32 33
        throwsStateError,
      );
    });
  });
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
  group('Async smoke tests', () {
    testWidgets('FutureBuilder', (WidgetTester tester) async {
      await tester.pumpWidget(new FutureBuilder<String>(
        future: new Future<String>.value('hello'),
        builder: snapshotText
      ));
      await eventFiring(tester);
    });
    testWidgets('StreamBuilder', (WidgetTester tester) async {
      await tester.pumpWidget(new StreamBuilder<String>(
        stream: new Stream<String>.fromIterable(<String>['hello', 'world']),
        builder: snapshotText
      ));
      await eventFiring(tester);
    });
    testWidgets('StreamFold', (WidgetTester tester) async {
      await tester.pumpWidget(new StringCollector(
        stream: new Stream<String>.fromIterable(<String>['hello', 'world'])
      ));
      await eventFiring(tester);
    });
  });
  group('FutureBuilder', () {
    testWidgets('gracefully handles transition from null future', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key, future: null, builder: snapshotText
      ));
62
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, null, null)'), findsOneWidget);
63 64 65 66
      final Completer<String> completer = new Completer<String>();
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key, future: completer.future, builder: snapshotText
      ));
67
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
68 69 70 71 72 73 74
    });
    testWidgets('gracefully handles transition to null future', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      final Completer<String> completer = new Completer<String>();
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key, future: completer.future, builder: snapshotText
      ));
75
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
76 77 78
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key, future: null, builder: snapshotText
      ));
79
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, null, null)'), findsOneWidget);
80 81
      completer.complete('hello');
      await eventFiring(tester);
82
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, null, null)'), findsOneWidget);
83 84 85 86 87 88 89 90
    });
    testWidgets('gracefully handles transition to other future', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      final Completer<String> completerA = new Completer<String>();
      final Completer<String> completerB = new Completer<String>();
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key, future: completerA.future, builder: snapshotText
      ));
91
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
92 93 94
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key, future: completerB.future, builder: snapshotText
      ));
95
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
96 97 98
      completerB.complete('B');
      completerA.complete('A');
      await eventFiring(tester);
99
      expect(find.text('AsyncSnapshot<String>(ConnectionState.done, B, null)'), findsOneWidget);
100 101 102 103 104 105
    });
    testWidgets('tracks life-cycle of Future to success', (WidgetTester tester) async {
      final Completer<String> completer = new Completer<String>();
      await tester.pumpWidget(new FutureBuilder<String>(
        future: completer.future, builder: snapshotText
      ));
106
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
107 108
      completer.complete('hello');
      await eventFiring(tester);
109
      expect(find.text('AsyncSnapshot<String>(ConnectionState.done, hello, null)'), findsOneWidget);
110 111 112 113 114 115
    });
    testWidgets('tracks life-cycle of Future to error', (WidgetTester tester) async {
      final Completer<String> completer = new Completer<String>();
      await tester.pumpWidget(new FutureBuilder<String>(
        future: completer.future, builder: snapshotText
      ));
116
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
117 118
      completer.completeError('bad');
      await eventFiring(tester);
119
      expect(find.text('AsyncSnapshot<String>(ConnectionState.done, null, bad)'), findsOneWidget);
120
    });
121 122 123 124 125 126 127 128
    testWidgets('runs the builder using given initial data', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key,
        future: null,
        builder: snapshotText,
        initialData: 'I',
      ));
129
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, I, null)'), findsOneWidget);
130 131 132 133 134 135 136 137 138
    });
    testWidgets('ignores initialData when reconfiguring', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key,
        future: null,
        builder: snapshotText,
        initialData: 'I',
      ));
139
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, I, null)'), findsOneWidget);
140 141 142 143 144 145 146
      final Completer<String> completer = new Completer<String>();
      await tester.pumpWidget(new FutureBuilder<String>(
        key: key,
        future: completer.future,
        builder: snapshotText,
        initialData: 'Ignored',
      ));
147
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, I, null)'), findsOneWidget);
148
    });
149 150 151 152 153 154 155
  });
  group('StreamBuilder', () {
    testWidgets('gracefully handles transition from null stream', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key, stream: null, builder: snapshotText
      ));
156
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, null, null)'), findsOneWidget);
157 158 159 160
      final StreamController<String> controller = new StreamController<String>();
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key, stream: controller.stream, builder: snapshotText
      ));
161
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
162 163 164 165 166 167 168
    });
    testWidgets('gracefully handles transition to null stream', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      final StreamController<String> controller = new StreamController<String>();
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key, stream: controller.stream, builder: snapshotText
      ));
169
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
170 171 172
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key, stream: null, builder: snapshotText
      ));
173
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, null, null)'), findsOneWidget);
174 175 176 177 178 179 180 181
    });
    testWidgets('gracefully handles transition to other stream', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      final StreamController<String> controllerA = new StreamController<String>();
      final StreamController<String> controllerB = new StreamController<String>();
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key, stream: controllerA.stream, builder: snapshotText
      ));
182
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
183 184 185 186 187 188
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key, stream: controllerB.stream, builder: snapshotText
      ));
      controllerB.add('B');
      controllerA.add('A');
      await eventFiring(tester);
189
      expect(find.text('AsyncSnapshot<String>(ConnectionState.active, B, null)'), findsOneWidget);
190 191 192 193 194 195 196
    });
    testWidgets('tracks events and errors of stream until completion', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      final StreamController<String> controller = new StreamController<String>();
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key, stream: controller.stream, builder: snapshotText
      ));
197
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsOneWidget);
198 199 200
      controller.add('1');
      controller.add('2');
      await eventFiring(tester);
201
      expect(find.text('AsyncSnapshot<String>(ConnectionState.active, 2, null)'), findsOneWidget);
202 203 204
      controller.add('3');
      controller.addError('bad');
      await eventFiring(tester);
205
      expect(find.text('AsyncSnapshot<String>(ConnectionState.active, null, bad)'), findsOneWidget);
206 207 208
      controller.add('4');
      controller.close();
      await eventFiring(tester);
209
      expect(find.text('AsyncSnapshot<String>(ConnectionState.done, 4, null)'), findsOneWidget);
210
    });
211 212 213 214 215 216 217
    testWidgets('runs the builder using given initial data', (WidgetTester tester) async {
      final StreamController<String> controller = new StreamController<String>();
      await tester.pumpWidget(new StreamBuilder<String>(
        stream: controller.stream,
        builder: snapshotText,
        initialData: 'I',
      ));
218
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, I, null)'), findsOneWidget);
219 220 221 222 223 224 225 226 227
    });
    testWidgets('ignores initialData when reconfiguring', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key,
        stream: null,
        builder: snapshotText,
        initialData: 'I',
      ));
228
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, I, null)'), findsOneWidget);
229 230 231 232 233 234 235
      final StreamController<String> controller = new StreamController<String>();
      await tester.pumpWidget(new StreamBuilder<String>(
        key: key,
        stream: controller.stream,
        builder: snapshotText,
        initialData: 'Ignored',
      ));
236
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, I, null)'), findsOneWidget);
237
    });
238 239 240 241 242 243 244 245
  });
  group('FutureBuilder and StreamBuilder behave identically on Stream from Future', () {
    testWidgets('when completing with data', (WidgetTester tester) async {
      final Completer<String> completer = new Completer<String>();
      await tester.pumpWidget(new Column(children: <Widget>[
        new FutureBuilder<String>(future: completer.future, builder: snapshotText),
        new StreamBuilder<String>(stream: completer.future.asStream(), builder: snapshotText),
      ]));
246
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsNWidgets(2));
247 248
      completer.complete('hello');
      await eventFiring(tester);
249
      expect(find.text('AsyncSnapshot<String>(ConnectionState.done, hello, null)'), findsNWidgets(2));
250 251 252 253 254 255 256
    });
    testWidgets('when completing with error', (WidgetTester tester) async {
      final Completer<String> completer = new Completer<String>();
      await tester.pumpWidget(new Column(children: <Widget>[
        new FutureBuilder<String>(future: completer.future, builder: snapshotText),
        new StreamBuilder<String>(stream: completer.future.asStream(), builder: snapshotText),
      ]));
257
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, null, null)'), findsNWidgets(2));
258 259
      completer.completeError('bad');
      await eventFiring(tester);
260
      expect(find.text('AsyncSnapshot<String>(ConnectionState.done, null, bad)'), findsNWidgets(2));
261 262 263 264 265 266
    });
    testWidgets('when Future is null', (WidgetTester tester) async {
      await tester.pumpWidget(new Column(children: <Widget>[
        new FutureBuilder<String>(future: null, builder: snapshotText),
        new StreamBuilder<String>(stream: null, builder: snapshotText),
      ]));
267
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, null, null)'), findsNWidgets(2));
268
    });
269 270 271 272 273
    testWidgets('when initialData is used with null Future and Stream', (WidgetTester tester) async {
      await tester.pumpWidget(new Column(children: <Widget>[
        new FutureBuilder<String>(future: null, builder: snapshotText, initialData: 'I'),
        new StreamBuilder<String>(stream: null, builder: snapshotText, initialData: 'I'),
      ]));
274
      expect(find.text('AsyncSnapshot<String>(ConnectionState.none, I, null)'), findsNWidgets(2));
275 276 277 278 279 280 281
    });
    testWidgets('when using initialData and completing with data', (WidgetTester tester) async {
      final Completer<String> completer = new Completer<String>();
      await tester.pumpWidget(new Column(children: <Widget>[
        new FutureBuilder<String>(future: completer.future, builder: snapshotText, initialData: 'I'),
        new StreamBuilder<String>(stream: completer.future.asStream(), builder: snapshotText, initialData: 'I'),
      ]));
282
      expect(find.text('AsyncSnapshot<String>(ConnectionState.waiting, I, null)'), findsNWidgets(2));
283 284
      completer.complete('hello');
      await eventFiring(tester);
285
      expect(find.text('AsyncSnapshot<String>(ConnectionState.done, hello, null)'), findsNWidgets(2));
286
    });
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
  });
  group('StreamBuilderBase', () {
    testWidgets('gracefully handles transition from null stream', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      await tester.pumpWidget(new StringCollector(key: key, stream: null));
      expect(find.text(''), findsOneWidget);
      final StreamController<String> controller = new StreamController<String>();
      await tester.pumpWidget(new StringCollector(key: key, stream: controller.stream));
      expect(find.text('conn'), findsOneWidget);
    });
    testWidgets('gracefully handles transition to null stream', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      final StreamController<String> controller = new StreamController<String>();
      await tester.pumpWidget(new StringCollector(key: key, stream: controller.stream));
      expect(find.text('conn'), findsOneWidget);
      await tester.pumpWidget(new StringCollector(key: key, stream: null));
      expect(find.text('conn, disc'), findsOneWidget);
    });
    testWidgets('gracefully handles transition to other stream', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      final StreamController<String> controllerA = new StreamController<String>();
      final StreamController<String> controllerB = new StreamController<String>();
      await tester.pumpWidget(new StringCollector(key: key, stream: controllerA.stream));
      await tester.pumpWidget(new StringCollector(key: key, stream: controllerB.stream));
      controllerA.add('A');
      controllerB.add('B');
      await eventFiring(tester);
      expect(find.text('conn, disc, conn, data:B'), findsOneWidget);
    });
    testWidgets('tracks events and errors until completion', (WidgetTester tester) async {
      final GlobalKey key = new GlobalKey();
      final StreamController<String> controller = new StreamController<String>();
      await tester.pumpWidget(new StringCollector(key: key, stream: controller.stream));
      controller.add('1');
      controller.addError('bad');
      controller.add('2');
      controller.close();
      await eventFiring(tester);
      expect(find.text('conn, data:1, error:bad, data:2, done'), findsOneWidget);
    });
  });
}

Future<Null> eventFiring(WidgetTester tester) async {
331
  await tester.pump(Duration.zero);
332 333 334
}

class StringCollector extends StreamBuilderBase<String, List<String>> {
335
  const StringCollector({ Key key, Stream<String> stream }) : super(key: key, stream: stream);
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

  @override
  List<String> initial() => <String>[];

  @override
  List<String> afterConnected(List<String> current) => current..add('conn');

  @override
  List<String> afterData(List<String> current, String data) => current..add('data:$data');

  @override
  List<String> afterError(List<String> current, dynamic error) => current..add('error:$error');

  @override
  List<String> afterDone(List<String> current) => current..add('done');

  @override
  List<String> afterDisconnected(List<String> current) => current..add('disc');

  @override
Ian Hickson's avatar
Ian Hickson committed
356
  Widget build(BuildContext context, List<String> currentSummary) => new Text(currentSummary.join(', '), textDirection: TextDirection.ltr);
357
}