chrome/test/data/webui/extensions/extension_keyboard_shortcuts_test.js

// 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.

/** @fileoverview Suite of tests for extension-keyboard-shortcuts. */
cr.define('extension_shortcut_tests', function() {
  /** @enum {string} */
  const TestNames = {
    IsValidKeyCode: 'isValidKeyCode',
    KeyStrokeToString: 'keystrokeToString',
    Layout: 'Layout',
    ScopeChange: 'ScopeChange',
  };

  const suiteName = 'ExtensionShortcutTest';

  suite(suiteName, function() {
    /** @type {extensions.KeyboardShortcuts} */
    let keyboardShortcuts;
    /** @type {chrome.developerPrivate.ExtensionInfo} */
    let noCommand;
    /** @type {chrome.developerPrivate.ExtensionInfo} */
    let oneCommand;
    /** @type {chrome.developerPrivate.ExtensionInfo} */
    let twoCommands;

    setup(function() {
      PolymerTest.clearBody();
      keyboardShortcuts = new extensions.KeyboardShortcuts();
      keyboardShortcuts.delegate = new extensions.TestService();

      const createInfo = extension_test_util.createExtensionInfo;
      noCommands = createInfo({id: 'a'.repeat(32)});
      oneCommand = createInfo({
        id: 'b'.repeat(32),
        commands: [{
          description: 'Description',
          keybinding: 'Ctrl+W',
          name: 'bCommand',
          isActive: true,
          scope: 'CHROME',
          isExtensionAction: true,
        }]
      });
      twoCommands = createInfo({
        id: 'c'.repeat(32),
        commands: [
          {
            description: 'Another Description',
            keybinding: 'Alt+F4',
            name: 'cCommand',
            isActive: true,
            scope: 'GLOBAL',
            isExtensionAction: false,
          },
          {
            description: 'Yet Another Description',
            keybinding: '',
            name: 'cCommand2',
            isActive: false,
            scope: 'CHROME',
            isExtensionAction: false,
          }
        ]
      });

      keyboardShortcuts.set('items', [noCommands, oneCommand, twoCommands]);

      document.body.appendChild(keyboardShortcuts);

      Polymer.dom.flush();
    });

    test(assert(TestNames.Layout), function() {
      const isVisibleOnCard = function(e, s) {
        // We check the light DOM in the card because it's a regular old div,
        // rather than a fancy-schmancy custom element.
        return extension_test_util.isVisible(e, s, true);
      };
      const cards =
          keyboardShortcuts.$$('#container').querySelectorAll('.shortcut-card');
      assertEquals(2, cards.length);

      const card1 = cards[0];
      expectEquals(
          oneCommand.name, card1.querySelector('.card-title span').textContent);
      let commands = card1.querySelectorAll('.command-entry');
      assertEquals(1, commands.length);
      expectTrue(isVisibleOnCard(commands[0], '.command-name'));
      expectTrue(isVisibleOnCard(commands[0], 'select.md-select'));

      const card2 = cards[1];
      commands = card2.querySelectorAll('.command-entry');
      assertEquals(2, commands.length);
    });

    test(TestNames.IsValidKeyCode, function() {
      expectTrue(extensions.isValidKeyCode('A'.charCodeAt(0)));
      expectTrue(extensions.isValidKeyCode('F'.charCodeAt(0)));
      expectTrue(extensions.isValidKeyCode('Z'.charCodeAt(0)));
      expectTrue(extensions.isValidKeyCode('4'.charCodeAt(0)));
      expectTrue(extensions.isValidKeyCode(extensions.Key.PageUp));
      expectTrue(extensions.isValidKeyCode(extensions.Key.MediaPlayPause));
      expectTrue(extensions.isValidKeyCode(extensions.Key.Down));
      expectFalse(extensions.isValidKeyCode(16));   // Shift
      expectFalse(extensions.isValidKeyCode(17));   // Ctrl
      expectFalse(extensions.isValidKeyCode(18));   // Alt
      expectFalse(extensions.isValidKeyCode(113));  // F2
      expectFalse(extensions.isValidKeyCode(144));  // Num Lock
      expectFalse(extensions.isValidKeyCode(43));   // +
      expectFalse(extensions.isValidKeyCode(27));   // Escape
    });

    test(TestNames.KeyStrokeToString, function() {
      // Creating an event with the KeyboardEvent ctor doesn't work. Fake it.
      const e = {keyCode: 'A'.charCodeAt(0)};
      expectEquals('A', extensions.keystrokeToString(e));
      e.ctrlKey = true;
      expectEquals('Ctrl+A', extensions.keystrokeToString(e));
      e.shiftKey = true;
      expectEquals('Ctrl+Shift+A', extensions.keystrokeToString(e));
    });

    test(TestNames.ScopeChange, function() {
      const selectElement = keyboardShortcuts.$$('select');
      selectElement.value = 'GLOBAL';
      selectElement.dispatchEvent(new CustomEvent('change'));
      return keyboardShortcuts.delegate
          .whenCalled('updateExtensionCommandScope')
          .then(params => {
            assertEquals(oneCommand.id, params[0]);
            assertEquals(oneCommand.commands[0].name, params[1]);
            assertEquals(selectElement.value, params[2]);
          });
    });
  });

  return {
    suiteName: suiteName,
    TestNames: TestNames,
  };
});