gecko-dev/testing/marionette/permissions.js
James Graham e59f9029ac Bug 1689883 - Provide a marionette implementation of setPermission. r=marionette-reviewers,whimboo,jgraham
This is specialised to just provide some basic/test-only support for the
asyncclipboard permissions, entirely to get the tests working a little better.

Differential Revision: https://phabricator.services.mozilla.com/D105110
2021-02-24 19:51:03 +00:00

68 lines
2.2 KiB
JavaScript

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const EXPORTED_SYMBOLS = ["permissions"];
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const { XPCOMUtils } = ChromeUtils.import(
"resource://gre/modules/XPCOMUtils.jsm"
);
XPCOMUtils.defineLazyModuleGetters(this, {
error: "chrome://marionette/content/error.js",
MarionettePrefs: "chrome://marionette/content/prefs.js",
});
/** @namespace */
this.permissions = {};
/**
* Set a permission's state.
* Note: Currently just a shim to support testdriver's set_permission.
*
* @param {Object} descriptor
* Descriptor with the `name` property.
* @param {string} state
* State of the permission. It can be `granted`, `denied` or `prompt`.
* @param {boolean} oneRealm
* Currently ignored
*
* @throws {UnsupportedOperationError}
* If `marionette.setpermission.enabled` is not set or
* an unsupported permission is used.
*/
permissions.set = function(descriptor, state, oneRealm) {
if (!MarionettePrefs.setPermissionEnabled) {
throw new error.UnsupportedOperationError(
"'Set Permission' is not available"
);
}
const { name } = descriptor;
if (!["clipboard-write", "clipboard-read"].includes(name)) {
throw new error.UnsupportedOperationError(
`'Set Permission' doesn't support '${name}'`
);
}
if (state === "prompt") {
throw new error.UnsupportedOperationError(
"'Set Permission' doesn't support prompt"
);
}
// This is not a real implementation of the permissions API.
// Instead the purpose of this implementation is to have web-platform-tests
// that use `set_permission('clipboard-write|read')` not fail.
// We enable dom.events.testing.asyncClipboard for the whole test suite anyway,
// so no extra permission is necessary.
if (!Services.prefs.getBoolPref("dom.events.testing.asyncClipboard", false)) {
throw new error.UnsupportedOperationError(
"'Set Permission' expected dom.events.testing.asyncClipboard to be set"
);
}
};