File: braille_ime_unittest.js

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (348 lines) | stat: -rw-r--r-- 10,351 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

/**
 * @fileoverview Unit test for the Braille IME.
 */

GEN_INCLUDE(['../common/testing/e2e_test_base.js']);

/**
 * Mock Chrome event supporting one listener.
 */
class MockEvent {
  constructor() {
    /** @type {Function?} */
    this.listener = null;
  }

  /**
   * @param {Function} listener
   */
  addListener(listener) {
    assertTrue(this.listener === null);
    this.listener = listener;
  }

  /**
   * Dispatches an event to the listener if any.
   * @param {...*} var_args Arguments to pass to the event listener.
   * @return {*} Return value from listener or {@code undefined} if no
   *     listener.
   */
  dispatch() {
    if (this.listener) {
      return this.listener.apply(null, arguments);
    }
  }
}


/**
 * Mock port that supports the {@code onMessage} and {@code onDisconnect}
 * events as well as {@code postMessage}.
 */
class MockPort {
  constructor() {
    this.onMessage = new MockEvent();
    this.onDisconnect = new MockEvent();
    /** @type {Array<Object>} */
    this.messages = [];
  }

  /**
   * Stores {@code message} in this object.
   * @param {Object} message Message to store.
   */
  postMessage(message) {
    this.messages.push(message);
  }
}

/**
 * Mock chrome.storage.local mv2, supports set and get.
 */
class MockLocalStorage {
  constructor() {
    this.store = {};
  }

  /**
   * Set the keyed storage.
   * @param {Object}
   */
  set(obj, callback) {
    for (let key in obj) {
      this.store[key] = obj[key];
    }
    callback();
  }

  /**
   * Gets the current storage. This function will only work with a callback
   * provided, like chrome.storage.local.set mv2.
   * @param {Array<string>} key for receiving specific store entries, ignored.
   * @param {function()}
   */
  get(keys, callback) {
    callback(this.store);
  }
}

/**
 * Engine ID as specified in manifest.
 * @const {string}
 */
const ENGINE_ID = 'braille';

/** Test fixture for the braille IME unit test. */
BrailleImeUnitTest = class extends E2ETestBase {
  /** @override */
  testGenPreamble() {
    super.testGenPreamble();
    // Use the accessibility common extension to house this test suite.
    GEN(`
  base::OnceClosure load_cb =
      base::BindOnce(&ash::AccessibilityManager::EnableAutoclick,
          base::Unretained(ash::AccessibilityManager::Get()),
          true);
    `);
    super.testGenPreambleCommon('kAccessibilityCommonExtensionId');
  }

  /** @override */
  async setUpDeferred() {
    await super.setUpDeferred();
    await importModule('BrailleIme', '/braille_ime/braille_ime.js');
    assertNotNullNorUndefined(BrailleIme);

    chrome = chrome || {};
    chrome.input = chrome.input || {};
    chrome.input.ime = chrome.input.ime || {};
    chrome.runtime = chrome.runtime || {};
    chrome.storage = chrome.storage || {local: new MockLocalStorage()};

    this.lastSentKeyRequestId_ = 0;
    this.lastHandledKeyRequestId_ = undefined;
    this.lastHandledKeyResult_ = undefined;
    chrome.input.ime.keyEventHandled = function(requestId, result) {
      this.lastHandledKeyRequestId_ = Number(requestId);
      this.lastHandledKeyResult_ = result;
    }.bind(this);
    this.createIme();
  }

  createIme() {
    var IME_EVENTS = [
      'onActivate',
      'onDeactivated',
      'onFocus',
      'onBlur',
      'onInputContextUpdate',
      'onKeyEvent',
      'onReset',
      'onMenuItemActivated',
    ];
    for (var i = 0, name; name = IME_EVENTS[i]; ++i) {
      this[name] = chrome.input.ime[name] = new MockEvent();
    }
    chrome.input.ime.setMenuItems = function(parameters) {
      this.menuItems = parameters.items;
    }.bind(this);
    chrome.runtime.connect = function() {
      this.port = new MockPort();
      return this.port;
    }.bind(this);
    this.menuItems = null;
    this.port = null;
    this.ime = new BrailleIme();
    this.ime.init();
  }

  activateIme() {
    this.onActivate.dispatch(ENGINE_ID);
    assertDeepEquals(this.port.messages, [{type: 'activeState', active: true}]);
    this.port.messages.length = 0;
  }

  sendKeyEvent_(type, code, extra) {
    var event = {type, code, requestId: (++this.lastSentKeyRequestId_) + ''};
    for (var key in extra) {
      event[key] = extra[key];
    }
    this.onKeyEvent.dispatch(ENGINE_ID, event);
    if (this.lastSentKeyRequestId_ === this.lastHandledKeyRequestId_) {
      return this.lastHandledKeyResult_;
    }
  }

  sendKeyDown(code, extra) {
    return this.sendKeyEvent_('keydown', code, extra);
  }

  sendKeyUp(code, extra) {
    return this.sendKeyEvent_('keyup', code, extra);
  }
};


AX_TEST_F('BrailleImeUnitTest', 'KeysWhenStandardKeyboardDisabled', function() {
  this.activateIme();
  assertFalse(this.sendKeyDown('KeyF'));
  assertFalse(this.sendKeyDown('KeyD'));
  assertFalse(this.sendKeyUp('KeyD'));
  assertFalse(this.sendKeyUp('KeyF'));
  assertEquals(0, this.port.messages.length);
});

AX_TEST_F('BrailleImeUnitTest', 'KeysWhenStandardKeysEnabled', function() {
  this.activateIme();
  assertFalse(this.menuItems[0].checked);
  this.onMenuItemActivated.dispatch(ENGINE_ID, this.menuItems[0].id);
  assertTrue(this.menuItems[0].checked);
  // Type the letters 'b' and 'c' and verify the right dots get sent.
  assertTrue(this.sendKeyDown('KeyF'));
  assertTrue(this.sendKeyDown('KeyD'));
  assertTrue(this.sendKeyUp('KeyD'));
  assertTrue(this.sendKeyUp('KeyF'));
  assertTrue(this.sendKeyDown('KeyJ'));
  assertTrue(this.sendKeyDown('KeyF'));
  assertTrue(this.sendKeyUp('KeyJ'));
  assertTrue(this.sendKeyUp('KeyF'));

  // Make sure that other keys are not handled, either by themselves or while
  // one of the 'braille keys' is pressed.
  assertFalse(this.sendKeyDown('KeyX'));
  assertFalse(this.sendKeyUp('KeyX'));

  assertTrue(this.sendKeyDown('KeyS'));   // Dot 3
  assertFalse(this.sendKeyDown('KeyG'));  // To the right of dot 1.
  assertTrue(this.sendKeyUp('KeyS'));
  assertFalse(this.sendKeyUp('KeyG'));

  // Keys like Ctrl L should not be handled, despite L being a dot key.
  var ctrlFlag = {ctrlKey: true};
  assertFalse(this.sendKeyDown('ControlLeft', ctrlFlag));
  assertFalse(this.sendKeyDown('KeyL', ctrlFlag));
  assertFalse(this.sendKeyUp('KeyL', ctrlFlag));
  assertFalse(this.sendKeyUp('ControlLeft', ctrlFlag));

  // Space key by itself should send a blank cell.
  assertTrue(this.sendKeyDown('Space'));
  assertTrue(this.sendKeyUp('Space'));

  // Space and braille dots results in no event.
  assertTrue(this.sendKeyDown('Space'));
  assertTrue(this.sendKeyDown('KeyF'));
  assertTrue(this.sendKeyUp('Space'));
  assertTrue(this.sendKeyUp('KeyF'));
  // Send the braille key first, still no event should be produced.
  assertTrue(this.sendKeyDown('KeyF'));
  assertTrue(this.sendKeyDown('Space'));
  assertTrue(this.sendKeyUp('Space'));
  assertTrue(this.sendKeyUp('KeyF'));

  assertDeepEquals(this.port.messages, [
    {type: 'brailleDots', dots: 0x03},
    {type: 'brailleDots', dots: 0x09},
    {type: 'brailleDots', dots: 0},
  ]);
});

AX_TEST_F('BrailleImeUnitTest', 'TestBackspaceKey', function() {
  this.activateIme();
  // Enable standard keyboard feature.
  assertFalse(this.menuItems[0].checked);
  this.onMenuItemActivated.dispatch(ENGINE_ID, this.menuItems[0].id);
  assertTrue(this.menuItems[0].checked);

  assertEquals(undefined, this.sendKeyDown('Backspace'));
  assertDeepEquals(
      this.port.messages,
      [{type: 'backspace', requestId: this.lastSentKeyRequestId_ + ''}]);
  this.port.onMessage.dispatch({
    type: 'keyEventHandled',
    requestId: this.lastSentKeyRequestId_ + '',
    result: true,
  });
  assertEquals(this.lastSentKeyRequestId_, this.lastHandledKeyRequestId_);
  assertTrue(this.lastHandledKeyResult_);
});

AX_TEST_F(
    'BrailleImeUnitTest', 'UseStandardKeyboardSettingPreserved', function() {
      this.activateIme();
      assertFalse(this.menuItems[0].checked);
      this.onMenuItemActivated.dispatch(ENGINE_ID, this.menuItems[0].id);
      assertTrue(this.menuItems[0].checked);
      // Create a new instance and make sure the setting is still turned on.
      this.createIme();
      this.activateIme();
      assertTrue(this.menuItems[0].checked);
    });

AX_TEST_F('BrailleImeUnitTest', 'ReplaceText', function() {
  var CONTEXT_ID = 1;
  var hasSelection = false;
  var text = 'Hi, ';
  chrome.input.ime.commitText = function(params) {
    assertEquals(CONTEXT_ID, params.contextID);
    text += params.text;
  };
  chrome.input.ime.deleteSurroundingText = function(params, callback) {
    assertEquals(ENGINE_ID, params.engineID);
    assertEquals(CONTEXT_ID, params.contextID);
    assertEquals(0, params.offset + params.length);
    if (hasSelection) {
      assertEquals(0, params.length);
      hasSelection = false;
    } else {
      text = text.slice(0, params.offset);
    }
    callback();
  };
  var sendReplaceText = function(deleteBefore, newText) {
    this.port.onMessage.dispatch(
        {type: 'replaceText', contextID: CONTEXT_ID, deleteBefore, newText});
  }.bind(this);
  this.activateIme();
  sendReplaceText(0, 'hello!');
  assertEquals('Hi, hello!', text);
  hasSelection = true;
  sendReplaceText('hello!'.length, 'good bye!');
  assertFalse(hasSelection);
  assertEquals('Hi, good bye!', text);
});

AX_TEST_F('BrailleImeUnitTest', 'Uncommitted', function() {
  var CONTEXT_ID = 1;
  var text = '';
  chrome.input.ime.commitText = function(params) {
    assertEquals(CONTEXT_ID, params.contextID);
    text += params.text;
  };
  var sendSetUncommitted = function(text) {
    this.port.onMessage.dispatch(
        {type: 'setUncommitted', contextID: CONTEXT_ID, text});
  }.bind(this);
  var sendCommitUncommitted = function(contextID) {
    this.port.onMessage.dispatch({type: 'commitUncommitted', contextID});
  }.bind(this);

  this.activateIme();
  sendSetUncommitted('Hi');
  assertEquals('', text);
  sendSetUncommitted('Hello');
  sendCommitUncommitted(CONTEXT_ID);
  assertEquals('Hello', text);
  sendSetUncommitted(' there!');
  sendCommitUncommitted(CONTEXT_ID + 1);
  assertEquals('Hello', text);

  sendSetUncommitted(' you!');
  assertFalse(this.sendKeyDown('KeyY'));
  assertEquals('Hello you!', text);
  assertFalse(this.sendKeyUp('KeyY'));
  assertEquals('Hello you!', text);
});