test_text_input.dart 7.67 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';
6
import 'dart:typed_data';
7 8

import 'package:flutter/services.dart';
9
import 'package:flutter_test/flutter_test.dart';
10
import 'package:flutter/foundation.dart';
11

12 13
import 'widget_tester.dart';

14 15
export 'package:flutter/services.dart' show TextEditingValue, TextInputAction;

16 17 18 19 20 21 22 23 24 25
/// A testing stub for the system's onscreen keyboard.
///
/// Typical app tests will not need to use this class directly.
///
/// See also:
///
/// * [WidgetTester.enterText], which uses this class to simulate keyboard input.
/// * [WidgetTester.showKeyboard], which uses this class to simulate showing the
///   popup keyboard and initializing its text.
class TestTextInput {
26 27 28 29 30 31 32 33 34 35 36 37 38
  /// Create a fake keyboard backend.
  ///
  /// The [onCleared] argument may be set to be notified of when the keyboard
  /// is dismissed.
  TestTextInput({ this.onCleared });

  /// Called when the keyboard goes away.
  ///
  /// To use the methods on this API that send fake keyboard messages (such as
  /// [updateEditingValue], [enterText], or [receiveAction]), the keyboard must
  /// first be requested, e.g. using [WidgetTester.showKeyboard].
  final VoidCallback onCleared;

39 40 41
  /// The messenger which sends the bytes for this channel, not null.
  BinaryMessenger get _binaryMessenger => ServicesBinding.instance.defaultBinaryMessenger;

Dan Field's avatar
Dan Field committed
42 43 44 45 46 47 48 49 50 51 52 53
  /// Resets any internal state of this object and calls [register].
  ///
  /// This method is invoked by the testing framework between tests. It should
  /// not ordinarily be called by tests directly.
  void resetAndRegister() {
    log.clear();
    editingState = null;
    setClientArgs = null;
    _client = 0;
    _isVisible = false;
    register();
  }
54
  /// Installs this object as a mock handler for [SystemChannels.textInput].
55
  void register() {
56
    SystemChannels.textInput.setMockMethodCallHandler(_handleTextInputCall);
57
    _isRegistered = true;
58 59
  }

60 61 62 63 64 65 66
  /// Removes this object as a mock handler for [SystemChannels.textInput].
  ///
  /// After calling this method, the channel will exchange messages with the
  /// Flutter engine. Use this with [FlutterDriver] tests that need to display
  /// on-screen keyboard provided by the operating system.
  void unregister() {
    SystemChannels.textInput.setMockMethodCallHandler(null);
67
    _isRegistered = false;
68 69
  }

70 71 72 73 74 75
  /// Log for method calls.
  ///
  /// For all registered channels, handled calls are added to the list. Can
  /// be cleaned using [clearLog].
  final List<MethodCall> log = <MethodCall>[];

76 77 78
  /// Whether this [TestTextInput] is registered with [SystemChannels.textInput].
  ///
  /// Use [register] and [unregister] methods to control this value.
Dan Field's avatar
Dan Field committed
79
  // TODO(dnfield): This is unreliable. https://github.com/flutter/flutter/issues/47180
80 81 82
  bool get isRegistered => _isRegistered;
  bool _isRegistered = false;

83 84 85
  /// Whether there are any active clients listening to text input.
  bool get hasAnyClients => _client > 0;

86
  int _client = 0;
87

88 89 90
  /// Arguments supplied to the TextInput.setClient method call.
  Map<String, dynamic> setClientArgs;

91 92 93 94 95 96
  /// The last set of arguments that [TextInputConnection.setEditingState] sent
  /// to the embedder.
  ///
  /// This is a map representation of a [TextEditingValue] object. For example,
  /// it will have a `text` entry whose value matches the most recent
  /// [TextEditingValue.text] that was sent to the embedder.
97 98
  Map<String, dynamic> editingState;

99
  Future<dynamic> _handleTextInputCall(MethodCall methodCall) async {
100
    log.add(methodCall);
101
    switch (methodCall.method) {
102
      case 'TextInput.setClient':
103 104
        _client = methodCall.arguments[0] as int;
        setClientArgs = methodCall.arguments[1] as Map<String, dynamic>;
105
        break;
106 107 108
      case 'TextInput.clearClient':
        _client = 0;
        _isVisible = false;
109 110
        if (onCleared != null)
          onCleared();
111
        break;
112
      case 'TextInput.setEditingState':
113
        editingState = methodCall.arguments as Map<String, dynamic>;
114
        break;
115 116 117 118 119 120
      case 'TextInput.show':
        _isVisible = true;
        break;
      case 'TextInput.hide':
        _isVisible = false;
        break;
121 122 123
    }
  }

124 125 126 127 128
  /// Whether the onscreen keyboard is visible to the user.
  bool get isVisible => _isVisible;
  bool _isVisible = false;

  /// Simulates the user changing the [TextEditingValue] to the given value.
129
  void updateEditingValue(TextEditingValue value) {
130 131
    // Not using the `expect` function because in the case of a FlutterDriver
    // test this code does not run in a package:test test zone.
132
    if (_client == 0)
133
      throw TestFailure('Tried to use TestTextInput with no keyboard attached. You must use WidgetTester.showKeyboard() first.');
134
    _binaryMessenger.handlePlatformMessage(
135 136
      SystemChannels.textInput.name,
      SystemChannels.textInput.codec.encodeMethodCall(
137
        MethodCall(
138
          'TextInputClient.updateEditingState',
139
          <dynamic>[_client, value.toJSON()],
140 141
        ),
      ),
142
      (ByteData data) { /* response from framework is discarded */ },
143
    );
144 145
  }

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
  /// Simulates the user closing the text input connection.
  ///
  /// For example:
  /// - User pressed the home button and sent the application to background.
  /// - User closed the virtual keyboard.
  void closeConnection() {
    // Not using the `expect` function because in the case of a FlutterDriver
    // test this code does not run in a package:test test zone.
    if (_client == 0)
      throw TestFailure('Tried to use TestTextInput with no keyboard attached. You must use WidgetTester.showKeyboard() first.');
    _binaryMessenger.handlePlatformMessage(
      SystemChannels.textInput.name,
      SystemChannels.textInput.codec.encodeMethodCall(
        MethodCall(
          'TextInputClient.onConnectionClosed',
           <dynamic>[_client,]
        ),
      ),
      (ByteData data) { /* response from framework is discarded */ },
    );
  }

168
  /// Simulates the user typing the given text.
169
  void enterText(String text) {
170
    updateEditingValue(TextEditingValue(
171 172 173
      text: text,
    ));
  }
174

175 176 177
  /// Simulates the user pressing one of the [TextInputAction] buttons.
  /// Does not check that the [TextInputAction] performed is an acceptable one
  /// based on the `inputAction` [setClientArgs].
178
  Future<void> receiveAction(TextInputAction action) async {
179 180 181 182
    return TestAsyncUtils.guard(() {
      // Not using the `expect` function because in the case of a FlutterDriver
      // test this code does not run in a package:test test zone.
      if (_client == 0) {
183
        throw TestFailure('Tried to use TestTextInput with no keyboard attached. You must use WidgetTester.showKeyboard() first.');
184 185
      }

186
      final Completer<void> completer = Completer<void>();
187

188
      _binaryMessenger.handlePlatformMessage(
189 190
        SystemChannels.textInput.name,
        SystemChannels.textInput.codec.encodeMethodCall(
191
          MethodCall(
192 193 194
            'TextInputClient.performAction',
            <dynamic>[_client, action.toString()],
          ),
195
        ),
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
        (ByteData data) {
          try {
            // Decoding throws a PlatformException if the data represents an
            // error, and that's all we care about here.
            SystemChannels.textInput.codec.decodeEnvelope(data);

            // No error was found. Complete without issue.
            completer.complete();
          } catch (error) {
            // An exception occurred as a result of receiveAction()'ing. Report
            // that error.
            completer.completeError(error);
          }
        },
      );

      return completer.future;
    });
214 215
  }

216 217 218 219
  /// Simulates the user hiding the onscreen keyboard.
  void hide() {
    _isVisible = false;
  }
220
}