diff options
Diffstat (limited to 'comm/mail/components/extensions/test/xpcshell/test_ext_messages.js')
| -rw-r--r-- | comm/mail/components/extensions/test/xpcshell/test_ext_messages.js | 730 |
1 files changed, 730 insertions, 0 deletions
diff --git a/comm/mail/components/extensions/test/xpcshell/test_ext_messages.js b/comm/mail/components/extensions/test/xpcshell/test_ext_messages.js new file mode 100644 index 0000000000..24b2cb1484 --- /dev/null +++ b/comm/mail/components/extensions/test/xpcshell/test_ext_messages.js @@ -0,0 +1,730 @@ +/* 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"; + +var { ExtensionTestUtils } = ChromeUtils.importESModule( + "resource://testing-common/ExtensionXPCShellUtils.sys.mjs" +); +var { ExtensionsUI } = ChromeUtils.import( + "resource:///modules/ExtensionsUI.jsm" +); + +let account, rootFolder, subFolders; +add_task( + { + skip_if: () => IS_NNTP, + }, + async function setup() { + account = createAccount(); + rootFolder = account.incomingServer.rootFolder; + subFolders = { + test3: await createSubfolder(rootFolder, "test3"), + test4: await createSubfolder(rootFolder, "test4"), + trash: rootFolder.getChildNamed("Trash"), + }; + await createMessages(subFolders.trash, 99); + await createMessages(subFolders.test4, 1); + } +); + +add_task(async function non_canonical_permission_description_mapping() { + let { msgs } = ExtensionsUI._buildStrings({ + addon: { name: "FakeExtension" }, + permissions: { + origins: [], + permissions: ["accountsRead", "messagesMove"], + }, + }); + equal(2, msgs.length, "Correct amount of descriptions"); + equal( + "See your mail accounts, their identities and their folders", + msgs[0], + "Correct description for accountsRead" + ); + equal( + "Copy or move your email messages (including moving them to the trash folder)", + msgs[1], + "Correct description for messagesMove" + ); +}); + +add_task( + { + skip_if: () => IS_NNTP, + }, + async function test_pagination() { + let files = { + "background.js": async () => { + // Test a response of 99 messages at 10 messages per page. + let [folder] = await window.waitForMessage(); + let page = await browser.messages.list(folder); + browser.test.assertEq(36, page.id.length); + browser.test.assertEq(10, page.messages.length); + + let originalPageId = page.id; + let numPages = 1; + let numMessages = 10; + while (page.id) { + page = await browser.messages.continueList(page.id); + browser.test.assertTrue(page.messages.length > 0); + numPages++; + numMessages += page.messages.length; + if (numMessages < 99) { + browser.test.assertEq(originalPageId, page.id); + } else { + browser.test.assertEq(null, page.id); + } + } + browser.test.assertEq(10, numPages); + browser.test.assertEq(99, numMessages); + + browser.test.assertRejects( + browser.messages.continueList(originalPageId), + /No message list for id .*\. Have you reached the end of a list\?/ + ); + + await window.sendMessage("setPref"); + + // Do the same test, but with the default 100 messages per page. + page = await browser.messages.list(folder); + browser.test.assertEq(null, page.id); + browser.test.assertEq(99, page.messages.length); + + browser.test.notifyPass("finished"); + }, + "utils.js": await getUtilsJS(), + }; + let extension = ExtensionTestUtils.loadExtension({ + files, + manifest: { + background: { scripts: ["utils.js", "background.js"] }, + permissions: ["accountsRead", "messagesRead"], + }, + }); + + Services.prefs.setIntPref("extensions.webextensions.messagesPerPage", 10); + + await extension.startup(); + extension.sendMessage({ accountId: account.key, path: "/Trash" }); + + await extension.awaitMessage("setPref"); + Services.prefs.clearUserPref("extensions.webextensions.messagesPerPage"); + extension.sendMessage(); + + await extension.awaitFinish("finished"); + await extension.unload(); + } +); + +add_task( + { + skip_if: () => IS_NNTP, + }, + async function test_delete_without_permission() { + let files = { + "background.js": async () => { + let [accountId] = await window.waitForMessage(); + let { folders } = await browser.accounts.get(accountId); + let testFolder4 = folders.find(f => f.name == "test4"); + + let { messages: folder4Messages } = await browser.messages.list( + testFolder4 + ); + + // Try to delete a message. + await browser.test.assertThrows( + () => browser.messages.delete([folder4Messages[0].id], true), + `browser.messages.delete is not a function`, + "Should reject deleting without proper permission" + ); + + browser.test.notifyPass("finished"); + }, + "utils.js": await getUtilsJS(), + }; + let extension = ExtensionTestUtils.loadExtension({ + files, + manifest: { + background: { scripts: ["utils.js", "background.js"] }, + browser_specific_settings: { + gecko: { id: "messages.delete@mochi.test" }, + }, + permissions: ["accountsRead", "messagesMove", "messagesRead"], + }, + }); + + await extension.startup(); + extension.sendMessage(account.key); + await extension.awaitFinish("finished"); + await extension.unload(); + } +); + +add_task( + { + skip_if: () => IS_NNTP, + }, + async function test_move_and_copy_without_permission() { + let files = { + "background.js": async () => { + let [accountId] = await window.waitForMessage(); + let { folders } = await browser.accounts.get(accountId); + let testFolder4 = folders.find(f => f.name == "test4"); + let testFolder3 = folders.find(f => f.name == "test3"); + + let { messages: folder4Messages } = await browser.messages.list( + testFolder4 + ); + + // Try to move a message. + await browser.test.assertRejects( + browser.messages.move([folder4Messages[0].id], testFolder3), + `Using messages.move() requires the "accountsRead" and the "messagesMove" permission`, + "Should reject move without proper permission" + ); + + // Try to copy a message. + await browser.test.assertRejects( + browser.messages.copy([folder4Messages[0].id], testFolder3), + `Using messages.copy() requires the "accountsRead" and the "messagesMove" permission`, + "Should reject copy without proper permission" + ); + + browser.test.notifyPass("finished"); + }, + "utils.js": await getUtilsJS(), + }; + let extension = ExtensionTestUtils.loadExtension({ + files, + manifest: { + background: { scripts: ["utils.js", "background.js"] }, + browser_specific_settings: { + gecko: { id: "messages.move@mochi.test" }, + }, + permissions: ["messagesRead", "accountsRead"], + }, + }); + + await extension.startup(); + extension.sendMessage(account.key); + await extension.awaitFinish("finished"); + await extension.unload(); + } +); + +add_task( + { + skip_if: () => IS_NNTP, + }, + async function test_tags() { + let files = { + "background.js": async () => { + let [accountId] = await window.waitForMessage(); + let { folders } = await browser.accounts.get(accountId); + let testFolder4 = folders.find(f => f.name == "test4"); + let { messages: folder4Messages } = await browser.messages.list( + testFolder4 + ); + + let tags1 = await browser.messages.listTags(); + window.assertDeepEqual( + [ + { + key: "$label1", + tag: "Important", + color: "#FF0000", + ordinal: "", + }, + { + key: "$label2", + tag: "Work", + color: "#FF9900", + ordinal: "", + }, + { + key: "$label3", + tag: "Personal", + color: "#009900", + ordinal: "", + }, + { + key: "$label4", + tag: "To Do", + color: "#3333FF", + ordinal: "", + }, + { + key: "$label5", + tag: "Later", + color: "#993399", + ordinal: "", + }, + ], + tags1 + ); + + // Test some allowed special chars and that the key is created as lower + // case. + let goodKeys = [ + "TestKey", + "Test_Key", + "Test\\Key", + "Test}Key", + "Test&Key", + "Test!Key", + "Test§Key", + "Test$Key", + "Test=Key", + "Test?Key", + ]; + for (let key of goodKeys) { + await browser.messages.createTag(key, "Test Tag", "#123456"); + let goodTags = await browser.messages.listTags(); + window.assertDeepEqual( + [ + { + key: "$label1", + tag: "Important", + color: "#FF0000", + ordinal: "", + }, + { + key: "$label2", + tag: "Work", + color: "#FF9900", + ordinal: "", + }, + { + key: "$label3", + tag: "Personal", + color: "#009900", + ordinal: "", + }, + { + key: "$label4", + tag: "To Do", + color: "#3333FF", + ordinal: "", + }, + { + key: "$label5", + tag: "Later", + color: "#993399", + ordinal: "", + }, + { + key: key.toLowerCase(), + tag: "Test Tag", + color: "#123456", + ordinal: "", + }, + ], + goodTags + ); + await browser.messages.deleteTag(key.toLowerCase()); + } + + await browser.messages.createTag("custom_tag", "Custom Tag", "#123456"); + let tags2 = await browser.messages.listTags(); + window.assertDeepEqual( + [ + { + key: "$label1", + tag: "Important", + color: "#FF0000", + ordinal: "", + }, + { + key: "$label2", + tag: "Work", + color: "#FF9900", + ordinal: "", + }, + { + key: "$label3", + tag: "Personal", + color: "#009900", + ordinal: "", + }, + { + key: "$label4", + tag: "To Do", + color: "#3333FF", + ordinal: "", + }, + { + key: "$label5", + tag: "Later", + color: "#993399", + ordinal: "", + }, + { + key: "custom_tag", + tag: "Custom Tag", + color: "#123456", + ordinal: "", + }, + ], + tags2 + ); + + await browser.messages.updateTag("$label5", { + tag: "Much Later", + color: "#225599", + }); + let tags3 = await browser.messages.listTags(); + window.assertDeepEqual( + [ + { + key: "$label1", + tag: "Important", + color: "#FF0000", + ordinal: "", + }, + { + key: "$label2", + tag: "Work", + color: "#FF9900", + ordinal: "", + }, + { + key: "$label3", + tag: "Personal", + color: "#009900", + ordinal: "", + }, + { + key: "$label4", + tag: "To Do", + color: "#3333FF", + ordinal: "", + }, + { + key: "$label5", + tag: "Much Later", + color: "#225599", + ordinal: "", + }, + { + key: "custom_tag", + tag: "Custom Tag", + color: "#123456", + ordinal: "", + }, + ], + tags3 + ); + + // Test rejects for createTag(). + let badKeys = [ + "Bad Key", + "Bad%Key", + "Bad/Key", + "Bad*Key", + 'Bad"Key', + "Bad{Key}", + "Bad(Key)", + "Bad<Key>", + ]; + for (let badKey of badKeys) { + await browser.test.assertThrows( + () => + browser.messages.createTag(badKey, "Important Stuff", "#223344"), + /Type error for parameter key/, + `Should reject creating an invalid key: ${badKey}` + ); + } + + await browser.test.assertThrows( + () => + browser.messages.createTag( + "GoodKeyBadColor", + "Important Stuff", + "#223" + ), + /Type error for parameter color /, + "Should reject creating a key using an invalid short color" + ); + + await browser.test.assertThrows( + () => + browser.messages.createTag( + "GoodKeyBadColor", + "Important Stuff", + "123223" + ), + /Type error for parameter color /, + "Should reject creating a key using an invalid color without leading #" + ); + + await browser.test.assertRejects( + browser.messages.createTag("$label5", "Important Stuff", "#223344"), + `Specified key already exists: $label5`, + "Should reject creating a key which exists already" + ); + + await browser.test.assertRejects( + browser.messages.createTag( + "Custom_Tag", + "Important Stuff", + "#223344" + ), + `Specified key already exists: custom_tag`, + "Should reject creating a key which exists already" + ); + + await browser.test.assertRejects( + browser.messages.createTag("GoodKey", "Important", "#223344"), + `Specified tag already exists: Important`, + "Should reject creating a key using a tag which exists already" + ); + + // Test rejects for updateTag(); + await browser.test.assertThrows( + () => browser.messages.updateTag("Bad Key", { tag: "Much Later" }), + /Type error for parameter key/, + "Should reject updating an invalid key" + ); + + await browser.test.assertThrows( + () => + browser.messages.updateTag("GoodKeyBadColor", { color: "123223" }), + /Error processing color/, + "Should reject updating a key using an invalid color" + ); + + await browser.test.assertRejects( + browser.messages.updateTag("$label50", { tag: "Much Later" }), + `Specified key does not exist: $label50`, + "Should reject updating an unknown key" + ); + + await browser.test.assertRejects( + browser.messages.updateTag("$label5", { tag: "Important" }), + `Specified tag already exists: Important`, + "Should reject updating a key using a tag which exists already" + ); + + // Test rejects for deleteTag(); + await browser.test.assertThrows( + () => browser.messages.deleteTag("Bad Key"), + /Type error for parameter key/, + "Should reject deleting an invalid key" + ); + + await browser.test.assertRejects( + browser.messages.deleteTag("$label50"), + `Specified key does not exist: $label50`, + "Should reject deleting an unknown key" + ); + + // Test tagging messages, deleting tag and re-creating tag. + await browser.messages.update(folder4Messages[0].id, { + tags: ["custom_tag"], + }); + let message1 = await browser.messages.get(folder4Messages[0].id); + window.assertDeepEqual(["custom_tag"], message1.tags); + + await browser.messages.deleteTag("custom_tag"); + let message2 = await browser.messages.get(folder4Messages[0].id); + window.assertDeepEqual([], message2.tags); + + await browser.messages.createTag("custom_tag", "Custom Tag", "#123456"); + let message3 = await browser.messages.get(folder4Messages[0].id); + window.assertDeepEqual(["custom_tag"], message3.tags); + + // Test deleting built-in tag. + await browser.messages.deleteTag("$label5"); + let tags4 = await browser.messages.listTags(); + window.assertDeepEqual( + [ + { + key: "$label1", + tag: "Important", + color: "#FF0000", + ordinal: "", + }, + { + key: "$label2", + tag: "Work", + color: "#FF9900", + ordinal: "", + }, + { + key: "$label3", + tag: "Personal", + color: "#009900", + ordinal: "", + }, + { + key: "$label4", + tag: "To Do", + color: "#3333FF", + ordinal: "", + }, + { + key: "custom_tag", + tag: "Custom Tag", + color: "#123456", + ordinal: "", + }, + ], + tags4 + ); + + // Clean up. + await browser.messages.update(folder4Messages[0].id, { tags: [] }); + await browser.messages.deleteTag("custom_tag"); + await browser.messages.createTag("$label5", "Later", "#993399"); + browser.test.notifyPass("finished"); + }, + "utils.js": await getUtilsJS(), + }; + let extension = ExtensionTestUtils.loadExtension({ + files, + manifest: { + background: { scripts: ["utils.js", "background.js"] }, + permissions: ["messagesRead", "accountsRead", "messagesTags"], + }, + }); + + await extension.startup(); + extension.sendMessage(account.key); + await extension.awaitFinish("finished"); + await extension.unload(); + } +); + +add_task( + { + skip_if: () => IS_NNTP, + }, + async function test_tags_no_permission() { + let files = { + "background.js": async () => { + await browser.test.assertThrows( + () => + browser.messages.createTag( + "custom_tag", + "Important Stuff", + "#223344" + ), + /browser.messages.createTag is not a function/, + "Should reject creating tags without messagesTags permission" + ); + + await browser.test.assertThrows( + () => browser.messages.updateTag("$label5", { tag: "Much Later" }), + /browser.messages.updateTag is not a function/, + "Should reject updating tags without messagesTags permission" + ); + + await browser.test.assertThrows( + () => browser.messages.deleteTag("$label5"), + /browser.messages.deleteTag is not a function/, + "Should reject deleting tags without messagesTags permission" + ); + + browser.test.notifyPass("finished"); + }, + "utils.js": await getUtilsJS(), + }; + let extension = ExtensionTestUtils.loadExtension({ + files, + manifest: { + background: { scripts: ["utils.js", "background.js"] }, + permissions: ["messagesRead", "accountsRead"], + }, + }); + + await extension.startup(); + extension.sendMessage(account.key); + await extension.awaitFinish("finished"); + await extension.unload(); + } +); + +// The IMAP fakeserver just can't handle this. +add_task({ skip_if: () => IS_IMAP || IS_NNTP }, async function test_archive() { + let account2 = createAccount(); + account2.addIdentity(MailServices.accounts.createIdentity()); + let inbox2 = await createSubfolder( + account2.incomingServer.rootFolder, + "test" + ); + await createMessages(inbox2, 15); + + let month = 10; + for (let message of inbox2.messages) { + message.date = new Date(2018, month++, 15) * 1000; + } + + let files = { + "background.js": async () => { + let [accountId] = await window.waitForMessage(); + + let accountBefore = await browser.accounts.get(accountId); + browser.test.assertEq(3, accountBefore.folders.length); + browser.test.assertEq("/test", accountBefore.folders[2].path); + + let messagesBefore = await browser.messages.list( + accountBefore.folders[2] + ); + browser.test.assertEq(15, messagesBefore.messages.length); + await browser.messages.archive(messagesBefore.messages.map(m => m.id)); + + let accountAfter = await browser.accounts.get(accountId); + browser.test.assertEq(4, accountAfter.folders.length); + browser.test.assertEq("/test", accountAfter.folders[3].path); + browser.test.assertEq("/Archives", accountAfter.folders[0].path); + browser.test.assertEq(3, accountAfter.folders[0].subFolders.length); + browser.test.assertEq( + "/Archives/2018", + accountAfter.folders[0].subFolders[0].path + ); + browser.test.assertEq( + "/Archives/2019", + accountAfter.folders[0].subFolders[1].path + ); + browser.test.assertEq( + "/Archives/2020", + accountAfter.folders[0].subFolders[2].path + ); + + let messagesAfter = await browser.messages.list(accountAfter.folders[3]); + browser.test.assertEq(0, messagesAfter.messages.length); + + let messages2018 = await browser.messages.list( + accountAfter.folders[0].subFolders[0] + ); + browser.test.assertEq(2, messages2018.messages.length); + + let messages2019 = await browser.messages.list( + accountAfter.folders[0].subFolders[1] + ); + browser.test.assertEq(12, messages2019.messages.length); + + let messages2020 = await browser.messages.list( + accountAfter.folders[0].subFolders[2] + ); + browser.test.assertEq(1, messages2020.messages.length); + + browser.test.notifyPass("finished"); + }, + "utils.js": await getUtilsJS(), + }; + let extension = ExtensionTestUtils.loadExtension({ + files, + manifest: { + background: { scripts: ["utils.js", "background.js"] }, + permissions: ["accountsRead", "messagesMove", "messagesRead"], + }, + }); + + await extension.startup(); + extension.sendMessage(account2.key); + await extension.awaitFinish("finished"); + await extension.unload(); +}); |