summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/test/xpcshell/test_ext_manifest_commands.js
blob: 8196ab0e24722d2878222b92f9eeee09c3bb86d5 (plain)
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
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";

add_task(async function test_manifest_commands() {
  const validShortcuts = [
    "Ctrl+Y",
    "MacCtrl+Y",
    "Command+Y",
    "Alt+Shift+Y",
    "Ctrl+Alt+Y",
    "F1",
    "MediaNextTrack",
  ];
  const invalidShortcuts = ["Shift+Y", "Y", "Ctrl+Ctrl+Y", "Ctrl+Command+Y"];

  async function validateShortcut(shortcut, isValid) {
    let normalized = await ExtensionTestUtils.normalizeManifest({
      commands: {
        "toggle-feature": {
          suggested_key: { default: shortcut },
          description: "Send a 'toggle-feature' event to the extension",
        },
      },
    });
    if (isValid) {
      ok(!normalized.error, "There should be no manifest errors.");
    } else {
      let expectedError =
        String.raw`Error processing commands.toggle-feature.suggested_key.default: Error: ` +
        String.raw`Value "${shortcut}" must consist of ` +
        String.raw`either a combination of one or two modifiers, including ` +
        String.raw`a mandatory primary modifier and a key, separated by '+', ` +
        String.raw`or a media key. For details see: ` +
        String.raw`https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/commands#Key_combinations`;

      ok(
        normalized.error.includes(expectedError),
        `The manifest error ${JSON.stringify(
          normalized.error
        )} must contain ${JSON.stringify(expectedError)}`
      );
    }
  }

  for (let shortcut of validShortcuts) {
    validateShortcut(shortcut, true);
  }
  for (let shortcut of invalidShortcuts) {
    validateShortcut(shortcut, false);
  }
});