Revision control
Copy as Markdown
Other Tools
/* 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
/**
* Tests for the notification displayed when Bcc recipients are used while
* encryption is enabled.
*/
"use strict";
var { MailServices } = ChromeUtils.importESModule(
);
var { OpenPGPTestUtils } = ChromeUtils.importESModule(
);
var { be_in_folder } = ChromeUtils.importESModule(
);
var { close_compose_window, open_compose_new_mail, setup_msg_contents } =
ChromeUtils.importESModule(
);
let bobAcct;
async function waitCheckEncryptionStateDone(win) {
return BrowserTestUtils.waitForEvent(
win.document,
"encryption-state-checked"
);
}
/**
* Setup an account with OpenPGP for testing.
*/
add_setup(async function () {
bobAcct = MailServices.accounts.createAccount();
bobAcct.incomingServer = MailServices.accounts.createIncomingServer(
"bob",
"openpgp.example",
"imap"
);
const bobIdentity = MailServices.accounts.createIdentity();
bobIdentity.email = "bob@openpgp.example";
bobAcct.addIdentity(bobIdentity);
const [id] = await OpenPGPTestUtils.importPrivateKey(
window,
new FileUtils.File(
getTestFilePath(
"../openpgp/data/keys/bob@openpgp.example-0xfbfcc82a015e7330-secret.asc"
)
)
);
Assert.ok(id, "private key id received");
bobIdentity.setUnicharAttribute("openpgp_key_id", id.split("0x").join(""));
registerCleanupFunction(() => {
MailServices.accounts.removeIncomingServer(bobAcct.incomingServer, true);
MailServices.accounts.removeAccount(bobAcct, true);
});
});
/**
* Test the warning is shown when encryption is enabled.
*/
add_task(async function testWarningShowsWhenEncryptionEnabled() {
await be_in_folder(bobAcct.incomingServer.rootFolder);
const cwc = await open_compose_new_mail();
Assert.ok(!cwc.gSendEncrypted);
// This toggle will trigger checkEncryptionState(), request that
// an event will be sent after the next call to checkEncryptionState
// has completed.
let checkDonePromise = waitCheckEncryptionStateDone(cwc);
await OpenPGPTestUtils.toggleMessageEncryption(cwc);
await checkDonePromise;
Assert.ok(cwc.gSendEncrypted);
EventUtils.synthesizeMouseAtCenter(
cwc.document.getElementById("addr_bccShowAddressRowButton"),
{},
cwc
);
// setup_msg_contents will trigger checkEncryptionState.
checkDonePromise = waitCheckEncryptionStateDone(cwc);
await setup_msg_contents(
cwc,
"test@example.org",
"Encryption Enabled ",
"",
"bccAddrInput"
);
await checkDonePromise;
// Warning should show when encryption enabled
await BrowserTestUtils.waitForCondition(
() =>
cwc.gComposeNotification.getNotificationWithValue(
"warnEncryptedBccRecipients"
),
"Timeout waiting for warnEncryptedBccRecipients notification"
);
await close_compose_window(cwc);
});
/**
* Test dismissing the warning works.
*/
add_task(async function testNotificationDismissal() {
await be_in_folder(bobAcct.incomingServer.rootFolder);
const cwc = await open_compose_new_mail();
Assert.ok(!cwc.gSendEncrypted);
// This toggle will trigger checkEncryptionState(), request that
// an event will be sent after the next call to checkEncryptionState
// has completed.
let checkDonePromise = waitCheckEncryptionStateDone(cwc);
await OpenPGPTestUtils.toggleMessageEncryption(cwc);
await checkDonePromise;
Assert.ok(cwc.gSendEncrypted);
EventUtils.synthesizeMouseAtCenter(
cwc.document.getElementById("addr_bccShowAddressRowButton"),
{},
cwc
);
// setup_msg_contents will trigger checkEncryptionState.
checkDonePromise = waitCheckEncryptionStateDone(cwc);
await setup_msg_contents(
cwc,
"test@example.org",
"Warning Dismissal",
"",
"bccAddrInput"
);
await checkDonePromise;
// Warning should show when encryption enabled
await BrowserTestUtils.waitForCondition(
() =>
cwc.gComposeNotification.getNotificationWithValue(
"warnEncryptedBccRecipients"
),
"Timeout waiting for warnEncryptedBccRecipients notification"
);
const notificationHidden = BrowserTestUtils.waitForCondition(
() =>
!cwc.gComposeNotification.getNotificationWithValue(
"warnEncryptedBccRecipients"
),
"notification was not removed in time"
);
const notification = cwc.gComposeNotification.getNotificationWithValue(
"warnEncryptedBccRecipients"
);
EventUtils.synthesizeMouseAtCenter(
notification.buttonContainer.lastElementChild,
{},
cwc
);
await notificationHidden;
Assert.ok(
!cwc.gComposeNotification.getNotificationWithValue(
"warnEncryptedBccRecipients"
),
"notification should be removed"
);
// setup_msg_contents will trigger checkEncryptionState.
checkDonePromise = waitCheckEncryptionStateDone(cwc);
await setup_msg_contents(cwc, "test2@example.org", "", "", "bccAddrInput");
await checkDonePromise;
// Give the notification some time to incorrectly appear.
// eslint-disable-next-line mozilla/no-arbitrary-setTimeout
await new Promise(resolve => setTimeout(resolve, 500));
Assert.ok(
!cwc.gComposeNotification.getNotificationWithValue(
"warnEncryptedBccRecipients"
),
"notification should not reappear after dismissal"
);
await close_compose_window(cwc);
});
/**
* Test the warning does not show when encryption is not enabled.
*/
add_task(async function testNoWarningWhenEncryptionDisabled() {
await be_in_folder(bobAcct.incomingServer.rootFolder);
const cwc = await open_compose_new_mail();
Assert.ok(!window.gSendEncrypted);
EventUtils.synthesizeMouseAtCenter(
cwc.document.getElementById("addr_bccShowAddressRowButton"),
{},
cwc
);
// setup_msg_contents will trigger checkEncryptionState.
const checkDonePromise = waitCheckEncryptionStateDone(cwc);
await setup_msg_contents(
cwc,
"test@example.org",
"No Warning ",
"",
"bccAddrInput"
);
await checkDonePromise;
// Give the notification some time to incorrectly appear.
// eslint-disable-next-line mozilla/no-arbitrary-setTimeout
await new Promise(resolve => setTimeout(resolve, 500));
Assert.ok(
!cwc.gComposeNotification.getNotificationWithValue(
"warnEncryptedBccRecipients"
),
"warning should not show when encryption disabled"
);
await close_compose_window(cwc);
});
/**
* Test the warning does not show when the Bcc recipient is the sender.
*/
add_task(async function testNoWarningWhenBccRecipientIsSender() {
await be_in_folder(bobAcct.incomingServer.rootFolder);
const cwc = await open_compose_new_mail();
Assert.ok(!window.gSendEncrypted);
EventUtils.synthesizeMouseAtCenter(
cwc.document.getElementById("addr_bccShowAddressRowButton"),
{},
cwc
);
// setup_msg_contents will trigger checkEncryptionState.
const checkDonePromise = waitCheckEncryptionStateDone(cwc);
await setup_msg_contents(
cwc,
"bob@openpgp.example",
"Bcc Self",
"",
"bccAddrInput"
);
await checkDonePromise;
// Give the notification some time to incorrectly appear.
// eslint-disable-next-line mozilla/no-arbitrary-setTimeout
await new Promise(resolve => setTimeout(resolve, 500));
Assert.ok(
!cwc.gComposeNotification.getNotificationWithValue(
"warnEncryptedBccRecipients"
),
"warning should not show when Bcc recipient is the sender"
);
await close_compose_window(cwc);
});