diff options
Diffstat (limited to 'comm/mailnews/test/resources/alertTestUtils.js')
| -rw-r--r-- | comm/mailnews/test/resources/alertTestUtils.js | 487 |
1 files changed, 487 insertions, 0 deletions
diff --git a/comm/mailnews/test/resources/alertTestUtils.js b/comm/mailnews/test/resources/alertTestUtils.js new file mode 100644 index 0000000000..2b757480e1 --- /dev/null +++ b/comm/mailnews/test/resources/alertTestUtils.js @@ -0,0 +1,487 @@ +/* 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/. */ + +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* + * This file provides support for writing mailnews tests that require hooking + * into the alerts system. Normally these tests would require a UI and fail in + * debug mode, but with this method you can hook into the alerts system and + * avoid the UI. + * + * This file registers prompts for nsIWindowWatcher::getNewPrompter and also + * registers a nsIPromptService service. nsIWindowWatcher::getNewAuthPrompter + * is also implemented but returns the nsILoginManagerPrompter as this would + * be expected when running mailnews. + * + * To register the system: + * + * function run_test() { + * registerAlertTestUtils(); + * // ... + * } + * + * You can then hook into the alerts just by defining a function of the same + * name as the interface function: + * + * function alert(aDialogTitle, aText) { + * // do my check + * } + * + * Interface functions that do not have equivalent functions defined and get + * called will be treated as unexpected, and therefore they will call + * do_throw(). + */ +/* globals alert, confirm, prompt */ + +var { MailServices } = ChromeUtils.import( + "resource:///modules/MailServices.jsm" +); +var { MockRegistrar } = ChromeUtils.importESModule( + "resource://testing-common/MockRegistrar.sys.mjs" +); + +var LoginInfo = Components.Constructor( + "@mozilla.org/login-manager/loginInfo;1", + "nsILoginInfo", + "init" +); + +// Wrapper to the nsIPrompt interface. +// This allows the send code to attempt to display errors to the user without +// failing. +var alertUtilsPrompts = { + alert(aDialogTitle, aText) { + if (typeof alert == "function") { + alert(aDialogTitle, aText); + return; + } + + do_throw("alert unexpectedly called: " + aText + "\n"); + }, + + alertCheck(aDialogTitle, aText, aCheckMsg, aCheckState) { + if (typeof alertCheck == "function") { + // eslint-disable-next-line no-undef + alertCheck(aDialogTitle, aText, aCheckMsg, aCheckState); + return; + } + + do_throw("alertCheck unexpectedly called: " + aText + "\n"); + }, + + confirm(aDialogTitle, aText) { + if (typeof confirm == "function") { + return confirm(aDialogTitle, aText); + } + + do_throw("confirm unexpectedly called: " + aText + "\n"); + return false; + }, + + confirmCheck(aDialogTitle, aText, aCheckMsg, aCheckState) { + if (typeof confirmCheck == "function") { + // eslint-disable-next-line no-undef + return confirmCheck(aDialogTitle, aText, aCheckMsg, aCheckState); + } + + do_throw("confirmCheck unexpectedly called: " + aText + "\n"); + return false; + }, + + confirmEx( + aDialogTitle, + aText, + aButtonFlags, + aButton0Title, + aButton1Title, + aButton2Title, + aCheckMsg, + aCheckState + ) { + if (typeof confirmEx == "function") { + // eslint-disable-next-line no-undef + return confirmEx( + aDialogTitle, + aText, + aButtonFlags, + aButton0Title, + aButton1Title, + aButton2Title, + aCheckMsg, + aCheckState + ); + } + + do_throw("confirmEx unexpectedly called: " + aText + "\n"); + return 0; + }, + + prompt(aDialogTitle, aText, aValue, aCheckMsg, aCheckState) { + if (typeof prompt == "function") { + return prompt(aDialogTitle, aText, aValue, aCheckMsg, aCheckState); + } + + do_throw("prompt unexpectedly called: " + aText + "\n"); + return false; + }, + + promptUsernameAndPassword( + aDialogTitle, + aText, + aUsername, + aPassword, + aCheckMsg, + aCheckState + ) { + if (typeof promptUsernameAndPassword == "function") { + // eslint-disable-next-line no-undef + return promptUsernameAndPassword( + aDialogTitle, + aText, + aUsername, + aPassword, + aCheckMsg, + aCheckState + ); + } + + do_throw("promptUsernameAndPassword unexpectedly called: " + aText + "\n"); + return false; + }, + + promptPassword(aDialogTitle, aText, aPassword, aCheckMsg, aCheckState) { + if (typeof promptPassword == "function") { + // eslint-disable-next-line no-undef + return promptPassword( + aDialogTitle, + aText, + aPassword, + aCheckMsg, + aCheckState + ); + } + + do_throw("promptPassword unexpectedly called: " + aText + "\n"); + return false; + }, + + select(aDialogTitle, aText, aCount, aSelectList, aOutSelection) { + if (typeof select == "function") { + // eslint-disable-next-line no-undef + return select(aDialogTitle, aText, aCount, aSelectList, aOutSelection); + } + + do_throw("select unexpectedly called: " + aText + "\n"); + return false; + }, + + QueryInterface: ChromeUtils.generateQI(["nsIPrompt"]), +}; + +var alertUtilsPromptService = { + alert(aParent, aDialogTitle, aText) { + if (typeof alertPS == "function") { + // eslint-disable-next-line no-undef + alertPS(aParent, aDialogTitle, aText); + return; + } + + do_throw("alertPS unexpectedly called: " + aText + "\n"); + }, + + alertCheck(aParent, aDialogTitle, aText, aCheckMsg, aCheckState) { + if (typeof alertCheckPS == "function") { + // eslint-disable-next-line no-undef + alertCheckPS(aParent, aDialogTitle, aText, aCheckMsg, aCheckState); + return; + } + + do_throw("alertCheckPS unexpectedly called: " + aText + "\n"); + }, + + confirm(aParent, aDialogTitle, aText) { + if (typeof confirmPS == "function") { + // eslint-disable-next-line no-undef + return confirmPS(aParent, aDialogTitle, aText); + } + + do_throw("confirmPS unexpectedly called: " + aText + "\n"); + return false; + }, + + confirmCheck(aParent, aDialogTitle, aText, aCheckMsg, aCheckState) { + if (typeof confirmCheckPS == "function") { + // eslint-disable-next-line no-undef + return confirmCheckPS( + aParent, + aDialogTitle, + aText, + aCheckMsg, + aCheckState + ); + } + + do_throw("confirmCheckPS unexpectedly called: " + aText + "\n"); + return false; + }, + + confirmEx( + aParent, + aDialogTitle, + aText, + aButtonFlags, + aButton0Title, + aButton1Title, + aButton2Title, + aCheckMsg, + aCheckState + ) { + if (typeof confirmExPS == "function") { + // eslint-disable-next-line no-undef + return confirmExPS( + aParent, + aDialogTitle, + aText, + aButtonFlags, + aButton0Title, + aButton1Title, + aButton2Title, + aCheckMsg, + aCheckState + ); + } + + do_throw("confirmExPS unexpectedly called: " + aText + "\n"); + return 0; + }, + + prompt(aParent, aDialogTitle, aText, aValue) { + if (typeof promptPS == "function") { + // eslint-disable-next-line no-undef + return promptPS(aParent, aDialogTitle, aText, aValue); + } + + do_throw("promptPS unexpectedly called: " + aText + "\n"); + return false; + }, + + promptUsernameAndPassword( + aParent, + aDialogTitle, + aText, + aUsername, + aPassword + ) { + if (typeof promptUsernameAndPasswordPS == "function") { + // eslint-disable-next-line no-undef + return promptUsernameAndPasswordPS( + aParent, + aDialogTitle, + aText, + aUsername, + aPassword + ); + } + + do_throw( + "promptUsernameAndPasswordPS unexpectedly called: " + aText + "\n" + ); + return false; + }, + + promptPassword(aParent, aDialogTitle, aText, aPassword) { + if (typeof promptPasswordPS == "function") { + // eslint-disable-next-line no-undef + return promptPasswordPS(aParent, aDialogTitle, aText, aPassword); + } + + do_throw("promptPasswordPS unexpectedly called: " + aText + "\n"); + return false; + }, + + select(aParent, aDialogTitle, aText, aCount, aSelectList, aOutSelection) { + if (typeof selectPS == "function") { + // eslint-disable-next-line no-undef + return selectPS( + aParent, + aDialogTitle, + aText, + aCount, + aSelectList, + aOutSelection + ); + } + + do_throw("selectPS unexpectedly called: " + aText + "\n"); + return false; + }, + + createInstance(iid) { + return this.QueryInterface(iid); + }, + + QueryInterface: ChromeUtils.generateQI([ + "nsIPromptService", + "nsIPromptService2", + ]), +}; + +var alertUtilsWindowWatcher = { + getNewPrompter(aParent) { + return alertUtilsPrompts; + }, + + getNewAuthPrompter(aParent) { + return Cc["@mozilla.org/login-manager/authprompter;1"].getService( + Ci.nsIAuthPrompt + ); + }, + + QueryInterface: ChromeUtils.generateQI(["nsIWindowWatcher"]), +}; + +// Special prompt that ensures we get prompted for logins. Calls +// promptPasswordPS/promptUsernameAndPasswordPS directly, rather than through +// the prompt service, because the function signature changed and no longer +// allows a "save password" check box. +let alertUtilsMsgAuthPrompt = { + QueryInterface: ChromeUtils.generateQI(["nsIAuthPrompt"]), + + _getFormattedOrigin(aURI) { + let uri; + if (aURI instanceof Ci.nsIURI) { + uri = aURI; + } else { + uri = Services.io.newURI(aURI); + } + + return uri.scheme + "://" + uri.displayHostPort; + }, + + _getRealmInfo(aRealmString) { + var httpRealm = /^.+ \(.+\)$/; + if (httpRealm.test(aRealmString)) { + return [null, null, null]; + } + + var uri = Services.io.newURI(aRealmString); + var pathname = ""; + + if (uri.pathQueryRef != "/") { + pathname = uri.pathQueryRef; + } + + var formattedOrigin = this._getFormattedOrigin(uri); + + return [formattedOrigin, formattedOrigin + pathname, uri.username]; + }, + + promptUsernameAndPassword( + aDialogTitle, + aText, + aPasswordRealm, + aSavePassword, + aUsername, + aPassword + ) { + var checkBox = { value: false }; + var checkBoxLabel = null; + var [origin, realm] = this._getRealmInfo(aPasswordRealm); + + if (typeof promptUsernameAndPasswordPS != "function") { + throw new Error( + "promptUsernameAndPasswordPS unexpectedly called: " + aText + "\n" + ); + } + + // eslint-disable-next-line no-undef + var ok = promptUsernameAndPasswordPS( + this._chromeWindow, + aDialogTitle, + aText, + aUsername, + aPassword, + checkBoxLabel, + checkBox + ); + + if (!ok || !checkBox.value || !origin) { + return ok; + } + + if (!aPassword.value) { + return ok; + } + + let newLogin = new LoginInfo( + origin, + null, + realm, + aUsername.value, + aPassword.value + ); + Services.logins.addLogin(newLogin); + + return ok; + }, + + promptPassword( + aDialogTitle, + aText, + aPasswordRealm, + aSavePassword, + aPassword + ) { + var checkBox = { value: false }; + var checkBoxLabel = null; + var [origin, realm, username] = this._getRealmInfo(aPasswordRealm); + + username = decodeURIComponent(username); + + if (typeof promptPasswordPS != "function") { + throw new Error("promptPasswordPS unexpectedly called: " + aText + "\n"); + } + + // eslint-disable-next-line no-undef + var ok = promptPasswordPS( + this._chromeWindow, + aDialogTitle, + aText, + aPassword, + checkBoxLabel, + checkBox + ); + + if (ok && checkBox.value && origin && aPassword.value) { + let newLogin = new LoginInfo( + origin, + null, + realm, + username, + aPassword.value + ); + + Services.logins.addLogin(newLogin); + } + + return ok; + }, +}; + +function registerAlertTestUtils() { + MockRegistrar.register( + "@mozilla.org/embedcomp/window-watcher;1", + alertUtilsWindowWatcher + ); + MockRegistrar.register( + "@mozilla.org/messenger/msgAuthPrompt;1", + alertUtilsMsgAuthPrompt + ); + MockRegistrar.register("@mozilla.org/prompter;1", alertUtilsPromptService); + Services.prompt = alertUtilsPromptService; +} + +var gDummyMsgWindow = Cc["@mozilla.org/messenger/msgwindow;1"].createInstance( + Ci.nsIMsgWindow +); |