diff options
Diffstat (limited to 'comm/mail/components/addrbook/test/browser/head.js')
| -rw-r--r-- | comm/mail/components/addrbook/test/browser/head.js | 445 |
1 files changed, 445 insertions, 0 deletions
diff --git a/comm/mail/components/addrbook/test/browser/head.js b/comm/mail/components/addrbook/test/browser/head.js new file mode 100644 index 0000000000..37fc445410 --- /dev/null +++ b/comm/mail/components/addrbook/test/browser/head.js @@ -0,0 +1,445 @@ +/* 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/. */ + +var { MailServices } = ChromeUtils.import( + "resource:///modules/MailServices.jsm" +); + +const personalBook = MailServices.ab.getDirectoryFromId("ldap_2.servers.pab"); +const historyBook = MailServices.ab.getDirectoryFromId( + "ldap_2.servers.history" +); + +add_setup(async () => { + // Force the window to be full screen to avoid issues with buttons not being + // reachable. This is a temporary solution while we update the details pane + // UI to be properly responsive and wrap elements correctly. + window.fullScreen = true; +}); + +// We want to check that everything has been removed/reset, but if we register +// a cleanup function here, it will run before any other cleanup function has +// had a chance to run. Instead, when it runs register another cleanup +// function which will run last. +registerCleanupFunction(function () { + registerCleanupFunction(async function () { + Assert.equal( + MailServices.ab.directories.length, + 2, + "Only Personal ab and Collected Addresses should be left." + ); + for (let directory of MailServices.ab.directories) { + if ( + directory.dirPrefId == "ldap_2.servers.history" || + directory.dirPrefId == "ldap_2.servers.pab" + ) { + Assert.equal( + directory.childCardCount, + 0, + `All contacts should have been removed from ${directory.dirName}` + ); + if (directory.childCardCount) { + directory.deleteCards(directory.childCards); + } + } else { + await promiseDirectoryRemoved(directory.URI); + } + } + closeAddressBookWindow(); + + // TODO: convert this to UID. + Services.prefs.clearUserPref("mail.addr_book.view.startupURI"); + Services.prefs.clearUserPref("mail.addr_book.view.startupURIisDefault"); + + // Some tests that open new windows don't return focus to the main window + // in a way that satisfies mochitest, and the test times out. + Services.focus.focusedWindow = window; + // Focus an element in the main window, then blur it again to avoid it + // hijacking keypresses. + let mainWindowElement = document.getElementById("button-appmenu"); + mainWindowElement.focus(); + mainWindowElement.blur(); + // Reset the window to its default size. + window.fullScreen = false; + }); +}); + +async function openAddressBookWindow() { + return new Promise(resolve => { + window.openTab("addressBookTab", { + onLoad(event, browser) { + resolve(browser.contentWindow); + }, + }); + }); +} + +function closeAddressBookWindow() { + let abTab = getAddressBookTab(); + if (abTab) { + let tabmail = document.getElementById("tabmail"); + tabmail.closeTab(abTab); + } +} + +function getAddressBookTab() { + let tabmail = document.getElementById("tabmail"); + return tabmail.tabInfo.find( + t => t.browser?.currentURI.spec == "about:addressbook" + ); +} + +function getAddressBookWindow() { + let tab = getAddressBookTab(); + return tab?.browser.contentWindow; +} + +async function openAllAddressBooks() { + let abWindow = getAddressBookWindow(); + EventUtils.synthesizeMouseAtCenter( + abWindow.document.querySelector("#books > li"), + {}, + abWindow + ); + await new Promise(r => abWindow.setTimeout(r)); +} + +function openDirectory(directory) { + let abWindow = getAddressBookWindow(); + let row = abWindow.booksList.getRowForUID(directory.UID); + EventUtils.synthesizeMouseAtCenter(row.querySelector("span"), {}, abWindow); +} + +function createAddressBook(dirName, type = Ci.nsIAbManager.JS_DIRECTORY_TYPE) { + let prefName = MailServices.ab.newAddressBook(dirName, null, type); + return MailServices.ab.getDirectoryFromId(prefName); +} + +async function createAddressBookWithUI(abName) { + let newAddressBookPromise = promiseLoadSubDialog( + "chrome://messenger/content/addressbook/abAddressBookNameDialog.xhtml" + ); + + let abWindow = getAddressBookWindow(); + EventUtils.synthesizeMouseAtCenter( + abWindow.document.getElementById("toolbarCreateBook"), + {}, + abWindow + ); + + let abNameDialog = await newAddressBookPromise; + EventUtils.sendString(abName, abNameDialog); + abNameDialog.document.querySelector("dialog").getButton("accept").click(); + + let addressBook = MailServices.ab.directories.find( + directory => directory.dirName == abName + ); + + Assert.ok(addressBook, "a new address book was created"); + + // At this point we need to wait for the UI to update. + await new Promise(r => abWindow.setTimeout(r)); + + return addressBook; +} + +function createContact(firstName, lastName, displayName, primaryEmail) { + let contact = Cc["@mozilla.org/addressbook/cardproperty;1"].createInstance( + Ci.nsIAbCard + ); + contact.displayName = displayName ?? `${firstName} ${lastName}`; + contact.firstName = firstName; + contact.lastName = lastName; + contact.primaryEmail = + primaryEmail ?? `${firstName}.${lastName}@invalid`.toLowerCase(); + return contact; +} + +function createMailingList(name) { + let list = Cc["@mozilla.org/addressbook/directoryproperty;1"].createInstance( + Ci.nsIAbDirectory + ); + list.isMailList = true; + list.dirName = name; + return list; +} + +async function createMailingListWithUI(mlParent, mlName) { + openDirectory(mlParent); + + let newAddressBookPromise = promiseLoadSubDialog( + "chrome://messenger/content/addressbook/abMailListDialog.xhtml" + ); + + let abWindow = getAddressBookWindow(); + EventUtils.synthesizeMouseAtCenter( + abWindow.document.getElementById("toolbarCreateList"), + {}, + abWindow + ); + + let abListDialog = await newAddressBookPromise; + let abListDocument = abListDialog.document; + await new Promise(resolve => abListDialog.setTimeout(resolve)); + + abListDocument.getElementById("abPopup").value = mlParent.URI; + abListDocument.getElementById("ListName").value = mlName; + abListDocument.querySelector("dialog").getButton("accept").click(); + + let list = mlParent.childNodes.find(list => list.dirName == mlName); + + Assert.ok(list, "a new list was created"); + + // At this point we need to wait for the UI to update. + await new Promise(r => abWindow.setTimeout(r)); + + return list; +} + +function checkDirectoryDisplayed(directory) { + let abWindow = getAddressBookWindow(); + let booksList = abWindow.document.getElementById("books"); + let cardsList = abWindow.cardsPane.cardsList; + + if (directory) { + Assert.equal( + booksList.selectedIndex, + booksList.getIndexForUID(directory.UID) + ); + Assert.equal(cardsList.view.directory?.UID, directory.UID); + } else { + Assert.equal(booksList.selectedIndex, 0); + Assert.ok(!cardsList.view.directory); + } +} + +function checkCardsListed(...expectedCards) { + checkNamesListed( + ...expectedCards.map(card => + card.isMailList ? card.dirName : card.displayName + ) + ); + + let abWindow = getAddressBookWindow(); + let cardsList = abWindow.document.getElementById("cards"); + for (let i = 0; i < expectedCards.length; i++) { + let row = cardsList.getRowAtIndex(i); + Assert.equal( + row.classList.contains("MailList"), + expectedCards[i].isMailList, + `row ${ + expectedCards[i].isMailList ? "should" : "should not" + } be a mailing list row` + ); + Assert.equal( + row.address.textContent, + expectedCards[i].primaryEmail ?? "", + "correct address should be displayed" + ); + Assert.equal( + row.avatar.childElementCount, + 1, + "only one avatar image should be displayed" + ); + } +} + +function checkNamesListed(...expectedNames) { + let abWindow = getAddressBookWindow(); + let cardsList = abWindow.document.getElementById("cards"); + let expectedCount = expectedNames.length; + + Assert.equal( + cardsList.view.rowCount, + expectedCount, + "Tree view has the right number of rows" + ); + + for (let i = 0; i < expectedCount; i++) { + Assert.equal( + cardsList.view.getCellText(i, { id: "GeneratedName" }), + expectedNames[i], + "view should give the correct name" + ); + Assert.equal( + cardsList.getRowAtIndex(i).querySelector(".generatedname-column, .name") + .textContent, + expectedNames[i], + "correct name should be displayed" + ); + } +} + +function checkPlaceholders(expectedVisible = []) { + let abWindow = getAddressBookWindow(); + let placeholder = abWindow.cardsPane.cardsList.placeholder; + + if (!expectedVisible.length) { + Assert.ok( + BrowserTestUtils.is_hidden(placeholder), + "placeholders are hidden" + ); + return; + } + + for (let element of placeholder.children) { + let id = element.id; + if (expectedVisible.includes(id)) { + Assert.ok(BrowserTestUtils.is_visible(element), `${id} is visible`); + } else { + Assert.ok(BrowserTestUtils.is_hidden(element), `${id} is hidden`); + } + } +} + +async function showSortMenu(name, value) { + let abWindow = getAddressBookWindow(); + let abDocument = abWindow.document; + + let displayButton = abDocument.getElementById("displayButton"); + let sortContext = abDocument.getElementById("sortContext"); + let shownPromise = BrowserTestUtils.waitForEvent(sortContext, "popupshown"); + EventUtils.synthesizeMouseAtCenter(displayButton, {}, abWindow); + await shownPromise; + let hiddenPromise = BrowserTestUtils.waitForEvent(sortContext, "popuphidden"); + sortContext.activateItem( + sortContext.querySelector(`[name="${name}"][value="${value}"]`) + ); + if (name == "toggle") { + sortContext.hidePopup(); + } + await hiddenPromise; +} + +async function showPickerMenu(name, value) { + let abWindow = getAddressBookWindow(); + let cardsHeader = abWindow.cardsPane.table.header; + let pickerButton = cardsHeader.querySelector( + `th[is="tree-view-table-column-picker"] button` + ); + let menupopup = cardsHeader.querySelector( + `th[is="tree-view-table-column-picker"] menupopup` + ); + let shownPromise = BrowserTestUtils.waitForEvent(menupopup, "popupshown"); + EventUtils.synthesizeMouseAtCenter(pickerButton, {}, abWindow); + await shownPromise; + let hiddenPromise = BrowserTestUtils.waitForEvent(menupopup, "popuphidden"); + menupopup.activateItem( + menupopup.querySelector(`[name="${name}"][value="${value}"]`) + ); + if (name == "toggle") { + menupopup.hidePopup(); + } + await hiddenPromise; +} + +async function toggleLayout() { + let abWindow = getAddressBookWindow(); + let abDocument = abWindow.document; + + let displayButton = abDocument.getElementById("displayButton"); + let sortContext = abDocument.getElementById("sortContext"); + let shownPromise = BrowserTestUtils.waitForEvent(sortContext, "popupshown"); + EventUtils.synthesizeMouseAtCenter(displayButton, {}, abWindow); + await shownPromise; + let hiddenPromise = BrowserTestUtils.waitForEvent(sortContext, "popuphidden"); + sortContext.activateItem(abDocument.getElementById("sortContextTableLayout")); + await hiddenPromise; +} + +async function checkComposeWindow(composeWindow, ...expectedAddresses) { + await BrowserTestUtils.waitForEvent(composeWindow, "compose-editor-ready"); + let composeDocument = composeWindow.document; + let toAddrRow = composeDocument.getElementById("addressRowTo"); + + let pills = toAddrRow.querySelectorAll("mail-address-pill"); + Assert.equal(pills.length, expectedAddresses.length); + for (let i = 0; i < expectedAddresses.length; i++) { + Assert.equal(pills[i].label, expectedAddresses[i]); + } + + await Promise.all([ + BrowserTestUtils.closeWindow(composeWindow), + BrowserTestUtils.waitForEvent(window, "activate"), + ]); +} + +function promiseDirectoryRemoved(uri) { + let removePromise = TestUtils.topicObserved("addrbook-directory-deleted"); + MailServices.ab.deleteAddressBook(uri); + return removePromise; +} + +function promiseLoadSubDialog(url) { + let abWindow = getAddressBookWindow(); + + return new Promise((resolve, reject) => { + abWindow.SubDialog._dialogStack.addEventListener( + "dialogopen", + function dialogopen(aEvent) { + if ( + aEvent.detail.dialog._frame.contentWindow.location == "about:blank" + ) { + return; + } + abWindow.SubDialog._dialogStack.removeEventListener( + "dialogopen", + dialogopen + ); + + Assert.equal( + aEvent.detail.dialog._frame.contentWindow.location.toString(), + url, + "Check the proper URL is loaded" + ); + + // Check visibility + Assert.ok( + BrowserTestUtils.is_visible( + aEvent.detail.dialog._overlay, + "Overlay is visible" + ) + ); + + // Check that stylesheets were injected + let expectedStyleSheetURLs = + aEvent.detail.dialog._injectedStyleSheets.slice(0); + for (let styleSheet of aEvent.detail.dialog._frame.contentDocument + .styleSheets) { + let i = expectedStyleSheetURLs.indexOf(styleSheet.href); + if (i >= 0) { + info("found " + styleSheet.href); + expectedStyleSheetURLs.splice(i, 1); + } + } + Assert.equal( + expectedStyleSheetURLs.length, + 0, + "All expectedStyleSheetURLs should have been found" + ); + + // Wait for the next event tick to make sure the remaining part of the + // testcase runs after the dialog gets ready for input. + executeSoon(() => resolve(aEvent.detail.dialog._frame.contentWindow)); + } + ); + }); +} + +function formatVCard(strings, ...values) { + let arr = []; + for (let str of strings) { + arr.push(str); + arr.push(values.shift()); + } + let lines = arr.join("").split("\n"); + let indent = lines[1].length - lines[1].trimLeft().length; + let outLines = []; + for (let line of lines) { + if (line.length > 0) { + outLines.push(line.substring(indent) + "\r\n"); + } + } + return outLines.join(""); +} |