form_test.dart 16.5 KB
Newer Older
1 2 3 4 5 6 7 8
// Copyright 2016 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 'package:flutter_test/flutter_test.dart';
import 'package:flutter/material.dart';

void main() {
9
  testWidgets('onSaved callback is called', (WidgetTester tester) async {
10
    final GlobalKey<FormState> formKey = GlobalKey<FormState>();
11 12 13
    String fieldValue;

    Widget builder() {
14 15 16 17 18 19 20 21 22 23 24 25
      return MaterialApp(
        home: MediaQuery(
          data: const MediaQueryData(devicePixelRatio: 1.0),
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Center(
              child: Material(
                child: Form(
                  key: formKey,
                  child: TextFormField(
                    onSaved: (String value) { fieldValue = value; },
                  ),
26
                ),
Ian Hickson's avatar
Ian Hickson committed
27
              ),
28
            ),
29 30
          ),
        ),
31 32
      );
    }
33

34
    await tester.pumpWidget(builder());
35

36
    expect(fieldValue, isNull);
37

38
    Future<void> checkText(String testValue) async {
39
      await tester.enterText(find.byType(TextFormField), testValue);
Matt Perry's avatar
Matt Perry committed
40
      formKey.currentState.save();
41
      // Pumping is unnecessary because callback happens regardless of frames.
42 43
      expect(fieldValue, equals(testValue));
    }
44

45 46
    await checkText('Test');
    await checkText('');
47 48
  });

49 50 51 52
  testWidgets('onChanged callback is called', (WidgetTester tester) async {
    String fieldValue;

    Widget builder() {
53 54 55 56 57 58 59 60 61 62 63
      return MaterialApp(
        home: MediaQuery(
          data: const MediaQueryData(devicePixelRatio: 1.0),
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Center(
              child: Material(
                child: Form(
                  child: TextField(
                    onChanged: (String value) { fieldValue = value; },
                  ),
64
                ),
Ian Hickson's avatar
Ian Hickson committed
65
              ),
66
            ),
67 68
          ),
        ),
69 70 71 72 73 74 75
      );
    }

    await tester.pumpWidget(builder());

    expect(fieldValue, isNull);

76
    Future<void> checkText(String testValue) async {
77
      await tester.enterText(find.byType(TextField), testValue);
78 79 80 81 82 83 84 85
      // pump'ing is unnecessary because callback happens regardless of frames
      expect(fieldValue, equals(testValue));
    }

    await checkText('Test');
    await checkText('');
  });

86
  testWidgets('Validator sets the error text only when validate is called', (WidgetTester tester) async {
87
    final GlobalKey<FormState> formKey = GlobalKey<FormState>();
88
    String errorText(String value) => value + '/error';
89

90
    Widget builder(bool autovalidate) {
91 92 93 94 95 96 97 98 99 100 101 102 103
      return MaterialApp(
        home: MediaQuery(
          data: const MediaQueryData(devicePixelRatio: 1.0),
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Center(
              child: Material(
                child: Form(
                  key: formKey,
                  autovalidate: autovalidate,
                  child: TextFormField(
                    validator: errorText,
                  ),
104
                ),
Ian Hickson's avatar
Ian Hickson committed
105
              ),
106
            ),
107 108
          ),
        ),
109 110
      );
    }
111

112 113
    // Start off not autovalidating.
    await tester.pumpWidget(builder(false));
114

115
    Future<void> checkErrorText(String testValue) async {
116 117
      formKey.currentState.reset();
      await tester.pumpWidget(builder(false));
118 119
      await tester.enterText(find.byType(TextFormField), testValue);
      await tester.pump();
120 121

      // We have to manually validate if we're not autovalidating.
122
      expect(find.text(errorText(testValue)), findsNothing);
123
      formKey.currentState.validate();
124
      await tester.pump();
125
      expect(find.text(errorText(testValue)), findsOneWidget);
126 127 128 129

      // Try again with autovalidation. Should validate immediately.
      formKey.currentState.reset();
      await tester.pumpWidget(builder(true));
130 131
      await tester.enterText(find.byType(TextFormField), testValue);
      await tester.pump();
132

133
      expect(find.text(errorText(testValue)), findsOneWidget);
134
    }
135

136 137
    await checkErrorText('Test');
    await checkErrorText('');
138 139
  });

140
  testWidgets('Multiple TextFormFields communicate', (WidgetTester tester) async {
141 142
    final GlobalKey<FormState> formKey = GlobalKey<FormState>();
    final GlobalKey<FormFieldState<String>> fieldKey = GlobalKey<FormFieldState<String>>();
143
    // Input 2's validator depends on a input 1's value.
144
    String errorText(String input) => '${fieldKey.currentState.value}/error';
145 146

    Widget builder() {
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
      return MaterialApp(
        home: MediaQuery(
          data: const MediaQueryData(devicePixelRatio: 1.0),
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Center(
              child: Material(
                child: Form(
                  key: formKey,
                  autovalidate: true,
                  child: ListView(
                    children: <Widget>[
                      TextFormField(
                        key: fieldKey,
                      ),
                      TextFormField(
                        validator: errorText,
                      ),
                    ],
                  ),
167
                ),
168
              ),
169
            ),
170 171
          ),
        ),
172 173
      );
    }
174

175
    await tester.pumpWidget(builder());
176

177
    Future<void> checkErrorText(String testValue) async {
178
      await tester.enterText(find.byType(TextFormField).first, testValue);
179
      await tester.pump();
180

181
      // Check for a new Text widget with our error text.
Matt Perry's avatar
Matt Perry committed
182
      expect(find.text(testValue + '/error'), findsOneWidget);
183
      return;
184
    }
185

186 187
    await checkErrorText('Test');
    await checkErrorText('');
188
  });
189

190
  testWidgets('Provide initial value to input when no controller is specified', (WidgetTester tester) async {
191
    const String initialValue = 'hello';
192
    final GlobalKey<FormFieldState<String>> inputKey = GlobalKey<FormFieldState<String>>();
193 194

    Widget builder() {
195 196 197 198 199 200 201 202 203 204 205 206
      return MaterialApp(
        home: MediaQuery(
          data: const MediaQueryData(devicePixelRatio: 1.0),
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Center(
              child: Material(
                child: Form(
                  child: TextFormField(
                    key: inputKey,
                    initialValue: 'hello',
                  ),
207
                ),
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
              ),
            ),
          ),
        ),
      );
    }

    await tester.pumpWidget(builder());
    await tester.showKeyboard(find.byType(TextFormField));

    // initial value should be loaded into keyboard editing state
    expect(tester.testTextInput.editingState, isNotNull);
    expect(tester.testTextInput.editingState['text'], equals(initialValue));

    // initial value should also be visible in the raw input line
    final EditableTextState editableText = tester.state(find.byType(EditableText));
    expect(editableText.widget.controller.text, equals(initialValue));

    // sanity check, make sure we can still edit the text and everything updates
    expect(inputKey.currentState.value, equals(initialValue));
    await tester.enterText(find.byType(TextFormField), 'world');
    await tester.pump();
    expect(inputKey.currentState.value, equals('world'));
    expect(editableText.widget.controller.text, equals('world'));
  });

234
  testWidgets('Controller defines initial value', (WidgetTester tester) async {
235
    final TextEditingController controller = TextEditingController(text: 'hello');
236
    const String initialValue = 'hello';
237
    final GlobalKey<FormFieldState<String>> inputKey = GlobalKey<FormFieldState<String>>();
238 239

    Widget builder() {
240 241 242 243 244 245 246 247 248 249 250 251
      return MaterialApp(
        home: MediaQuery(
          data: const MediaQueryData(devicePixelRatio: 1.0),
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Center(
              child: Material(
                child: Form(
                  child: TextFormField(
                    key: inputKey,
                    controller: controller,
                  ),
252
                ),
Ian Hickson's avatar
Ian Hickson committed
253
              ),
254
            ),
255 256
          ),
        ),
257 258 259 260
      );
    }

    await tester.pumpWidget(builder());
261
    await tester.showKeyboard(find.byType(TextFormField));
262 263

    // initial value should be loaded into keyboard editing state
264 265
    expect(tester.testTextInput.editingState, isNotNull);
    expect(tester.testTextInput.editingState['text'], equals(initialValue));
266 267

    // initial value should also be visible in the raw input line
268
    final EditableTextState editableText = tester.state(find.byType(EditableText));
269
    expect(editableText.widget.controller.text, equals(initialValue));
270
    expect(controller.text, equals(initialValue));
271 272

    // sanity check, make sure we can still edit the text and everything updates
273
    expect(inputKey.currentState.value, equals(initialValue));
274
    await tester.enterText(find.byType(TextFormField), 'world');
275
    await tester.pump();
276
    expect(inputKey.currentState.value, equals('world'));
277
    expect(editableText.widget.controller.text, equals('world'));
278 279 280 281
    expect(controller.text, equals('world'));
  });

  testWidgets('TextFormField resets to its initial value', (WidgetTester tester) async {
282 283 284
    final GlobalKey<FormState> formKey = GlobalKey<FormState>();
    final GlobalKey<FormFieldState<String>> inputKey = GlobalKey<FormFieldState<String>>();
    final TextEditingController controller = TextEditingController(text: 'Plover');
285 286

    Widget builder() {
287 288 289 290 291 292 293 294 295 296 297 298 299 300
      return MaterialApp(
        home: MediaQuery(
          data: const MediaQueryData(devicePixelRatio: 1.0),
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Center(
              child: Material(
                child: Form(
                  key: formKey,
                  child: TextFormField(
                    key: inputKey,
                    controller: controller,
                    // initialValue is 'Plover'
                  ),
301
                ),
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
              ),
            ),
          ),
        ),
      );
    }
    await tester.pumpWidget(builder());
    await tester.showKeyboard(find.byType(TextFormField));
    final EditableTextState editableText = tester.state(find.byType(EditableText));

    // overwrite initial value.
    controller.text = 'Xyzzy';
    await tester.idle();
    expect(editableText.widget.controller.text, equals('Xyzzy'));
    expect(inputKey.currentState.value, equals('Xyzzy'));
    expect(controller.text, equals('Xyzzy'));

    // verify value resets to initialValue on reset.
    formKey.currentState.reset();
    await tester.idle();
322 323 324
    expect(inputKey.currentState.value, equals('Plover'));
    expect(editableText.widget.controller.text, equals('Plover'));
    expect(controller.text, equals('Plover'));
325 326 327
  });

  testWidgets('TextEditingController updates to/from form field value', (WidgetTester tester) async {
328 329 330
    final TextEditingController controller1 = TextEditingController(text: 'Foo');
    final TextEditingController controller2 = TextEditingController(text: 'Bar');
    final GlobalKey<FormFieldState<String>> inputKey = GlobalKey<FormFieldState<String>>();
331 332 333 334 335

    TextEditingController currentController;
    StateSetter setState;

    Widget builder() {
336
      return StatefulBuilder(
337 338
        builder: (BuildContext context, StateSetter setter) {
          setState = setter;
339 340 341 342 343 344 345 346 347 348 349 350
          return MaterialApp(
            home: MediaQuery(
              data: const MediaQueryData(devicePixelRatio: 1.0),
              child: Directionality(
                textDirection: TextDirection.ltr,
                child: Center(
                  child: Material(
                    child: Form(
                      child: TextFormField(
                        key: inputKey,
                        controller: currentController,
                      ),
351
                    ),
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
                  ),
                ),
              ),
            ),
          );
        },
      );
    }

    await tester.pumpWidget(builder());
    await tester.showKeyboard(find.byType(TextFormField));

    // verify initially empty.
    expect(tester.testTextInput.editingState, isNotNull);
    expect(tester.testTextInput.editingState['text'], isEmpty);
    final EditableTextState editableText = tester.state(find.byType(EditableText));
    expect(editableText.widget.controller.text, isEmpty);

    // verify changing the controller from null to controller1 sets the value.
    setState(() {
      currentController = controller1;
    });
    await tester.pump();
    expect(editableText.widget.controller.text, equals('Foo'));
    expect(inputKey.currentState.value, equals('Foo'));

    // verify changes to controller1 text are visible in text field and set in form value.
    controller1.text = 'Wobble';
    await tester.idle();
    expect(editableText.widget.controller.text, equals('Wobble'));
    expect(inputKey.currentState.value, equals('Wobble'));

    // verify changes to the field text update the form value and controller1.
    await tester.enterText(find.byType(TextFormField), 'Wibble');
    await tester.pump();
    expect(inputKey.currentState.value, equals('Wibble'));
    expect(editableText.widget.controller.text, equals('Wibble'));
    expect(controller1.text, equals('Wibble'));

    // verify that switching from controller1 to controller2 is handled.
    setState(() {
      currentController = controller2;
    });
    await tester.pump();
    expect(inputKey.currentState.value, equals('Bar'));
    expect(editableText.widget.controller.text, equals('Bar'));
    expect(controller2.text, equals('Bar'));
    expect(controller1.text, equals('Wibble'));

    // verify changes to controller2 text are visible in text field and set in form value.
    controller2.text = 'Xyzzy';
    await tester.idle();
    expect(editableText.widget.controller.text, equals('Xyzzy'));
    expect(inputKey.currentState.value, equals('Xyzzy'));
    expect(controller1.text, equals('Wibble'));

    // verify changes to controller1 text are not visible in text field or set in form value.
    controller1.text = 'Plugh';
    await tester.idle();
    expect(editableText.widget.controller.text, equals('Xyzzy'));
    expect(inputKey.currentState.value, equals('Xyzzy'));
    expect(controller1.text, equals('Plugh'));

    // verify that switching from controller2 to null is handled.
    setState(() {
      currentController = null;
    });
    await tester.pump();
    expect(inputKey.currentState.value, equals('Xyzzy'));
    expect(editableText.widget.controller.text, equals('Xyzzy'));
    expect(controller2.text, equals('Xyzzy'));
    expect(controller1.text, equals('Plugh'));

    // verify that changes to the field text update the form value but not the previous controllers.
    await tester.enterText(find.byType(TextFormField), 'Plover');
    await tester.pump();
    expect(inputKey.currentState.value, equals('Plover'));
    expect(editableText.widget.controller.text, equals('Plover'));
    expect(controller1.text, equals('Plugh'));
    expect(controller2.text, equals('Xyzzy'));
Matt Perry's avatar
Matt Perry committed
432 433
  });

434
  testWidgets('No crash when a TextFormField is removed from the tree', (WidgetTester tester) async {
435
    final GlobalKey<FormState> formKey = GlobalKey<FormState>();
Matt Perry's avatar
Matt Perry committed
436 437 438
    String fieldValue;

    Widget builder(bool remove) {
439 440 441 442 443 444 445 446 447 448 449 450 451 452
      return MaterialApp(
        home: MediaQuery(
          data: const MediaQueryData(devicePixelRatio: 1.0),
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Center(
              child: Material(
                child: Form(
                  key: formKey,
                  child: remove ? Container() : TextFormField(
                    autofocus: true,
                    onSaved: (String value) { fieldValue = value; },
                    validator: (String value) { return value.isEmpty ? null : 'yes'; },
                  ),
453
                ),
Ian Hickson's avatar
Ian Hickson committed
454
              ),
455
            ),
456 457
          ),
        ),
Matt Perry's avatar
Matt Perry committed
458 459 460 461 462 463
      );
    }

    await tester.pumpWidget(builder(false));

    expect(fieldValue, isNull);
464
    expect(formKey.currentState.validate(), isTrue);
Matt Perry's avatar
Matt Perry committed
465

466
    await tester.enterText(find.byType(TextFormField), 'Test');
Matt Perry's avatar
Matt Perry committed
467 468
    await tester.pumpWidget(builder(false));

469
    // Form wasn't saved yet.
Matt Perry's avatar
Matt Perry committed
470
    expect(fieldValue, null);
471
    expect(formKey.currentState.validate(), isFalse);
Matt Perry's avatar
Matt Perry committed
472 473 474 475 476

    formKey.currentState.save();

    // Now fieldValue is saved.
    expect(fieldValue, 'Test');
477
    expect(formKey.currentState.validate(), isFalse);
Matt Perry's avatar
Matt Perry committed
478 479 480

    // Now remove the field with an error.
    await tester.pumpWidget(builder(true));
481

Matt Perry's avatar
Matt Perry committed
482 483 484
    // Reset the form. Should not crash.
    formKey.currentState.reset();
    formKey.currentState.save();
485
    expect(formKey.currentState.validate(), isTrue);
486
  });
487
}