Bug 1863400 - Part 1: Move about:welcome mochitest-browser tests to browser/components/aboutwelcome folder. r=pdahiya,Gijs

This clones many of the ESLint rules from browser/components/newtab over as well.

Differential Revision: https://phabricator.services.mozilla.com/D193116

Author: mikeconley

browser/components/aboutwelcome/moz.build

@@ -0,0 +1,12 @@
+# -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*-
+# vim: set filetype=python:
+# 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/.
+
+with Files("**"):
+    BUG_COMPONENT = ("Firefox", "Messaging System")
+
+BROWSER_CHROME_MANIFESTS += [
+    "tests/browser/browser.toml",
+]

browser/components/aboutwelcome/tests/browser/browser.toml

@@ -0,0 +1,58 @@
+[DEFAULT]
+support-files = [
+  "head.js",
+]
+
+prefs = [
+  "intl.multilingual.aboutWelcome.languageMismatchEnabled=false",
+  "browser.attribution.macos.enabled=true",
+]
+
+["browser_aboutwelcome_attribution.js"]
+skip-if = [
+  "os == 'linux'", # Test setup only implemented for OSX and Windows
+  "os == 'win' && msix", # These tests rely on the ability to write postSigningData, which we can't do in MSIX builds. https://bugzilla.mozilla.org/show_bug.cgi?id=1805911
+]
+
+["browser_aboutwelcome_configurable_ui.js"]
+skip-if = ["os == 'linux' && bits == 64 && debug"] # Bug 1784548
+
+["browser_aboutwelcome_fxa_signin_flow.js"]
+
+["browser_aboutwelcome_glean.js"]
+
+["browser_aboutwelcome_import.js"]
+fail-if = ["a11y_checks"] # Bug 1854514 clicked primary button may not be focusable
+
+["browser_aboutwelcome_mobile_downloads.js"]
+
+["browser_aboutwelcome_multistage_addonspicker.js"]
+
+["browser_aboutwelcome_multistage_default.js"]
+
+["browser_aboutwelcome_multistage_experimentAPI.js"]
+
+["browser_aboutwelcome_multistage_languageSwitcher.js"]
+skip-if = ["os == 'linux' && bits == 64"] # Bug 1757875
+
+["browser_aboutwelcome_multistage_mr.js"]
+skip-if = ["os == 'linux' && bits == 64 && debug"] # Bug 1812050
+
+["browser_aboutwelcome_multistage_video.js"]
+
+["browser_aboutwelcome_observer.js"]
+https_first_disabled = true
+
+["browser_aboutwelcome_rtamo.js"]
+skip-if = [
+  "os == 'linux'", # Test setup only implemented for OSX and Windows
+  "os == 'win' && msix", # These tests rely on the ability to write postSigningData, which we can't do in MSIX builds. https://bugzilla.mozilla.org/show_bug.cgi?id=1805911
+]
+
+["browser_aboutwelcome_screen_targeting.js"]
+
+["browser_aboutwelcome_upgrade_multistage_mr.js"]
+skip-if = [
+  "win11_2009 && debug",
+  "os == 'linux' && debug", # Bug 1804804 - disabled on win && linux for extremely high failure rate
+]

browser/components/newtab/test/browser/browser_aboutwelcome_attribution.js renamed to browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_attribution.js

@@ -541,6 +541,7 @@ add_task(async function test_AWMultistage_can_restore_theme() {
       this.id = id;
       this.isActive = isActive;
     }
+
     enable() {
       for (let addon of fakeAddons) {
         addon.isActive = false;

browser/components/newtab/test/browser/browser_aboutwelcome_configurable_ui.js renamed to browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_configurable_ui.js

@@ -21,7 +21,8 @@ add_task(function initSandbox() {
  *
  * The returned function flushes the spy of all of the matching button click events, and
  * returns the events.
- * @returns {() => TelemetryEvents[]}
+ *
+ * @returns {function(): TelemetryEvents[]}
  */
 async function spyOnTelemetryButtonClicks(browser) {
   let aboutWelcomeActor = await getAboutWelcomeParent(browser);

browser/components/newtab/test/browser/browser_aboutwelcome_fxa_signin_flow.js renamed to browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_fxa_signin_flow.js

@@ -55,7 +55,7 @@ add_setup(async () => {
  * @param {Array} screensToTest
  *    A list of which screen ids to be displayed
  *
- * @returns Promise<Window>
+ * @returns {Promise<Window>}
  *    Resolves to the window global object for the dialog once it has been
  *    opened
  */

browser/components/newtab/test/browser/browser_aboutwelcome_glean.js renamed to browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_glean.js

@@ -0,0 +1,152 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+ChromeUtils.defineESModuleGetters(this, {
+  FxAccounts: "resource://gre/modules/FxAccounts.sys.mjs",
+  sinon: "resource://testing-common/Sinon.sys.mjs",
+});
+
+XPCOMUtils.defineLazyModuleGetters(this, {
+  QueryCache: "resource://activity-stream/lib/ASRouterTargeting.jsm",
+});
+
+// Set the content pref to make it available across tests
+const ABOUT_WELCOME_OVERRIDE_CONTENT_PREF = "browser.aboutwelcome.screens";
+
+function popPrefs() {
+  return SpecialPowers.popPrefEnv();
+}
+function pushPrefs(...prefs) {
+  return SpecialPowers.pushPrefEnv({ set: prefs });
+}
+
+async function getAboutWelcomeParent(browser) {
+  let windowGlobalParent = browser.browsingContext.currentWindowGlobal;
+  return windowGlobalParent.getActor("AboutWelcome");
+}
+
+async function setAboutWelcomeMultiStage(value = "") {
+  return pushPrefs([ABOUT_WELCOME_OVERRIDE_CONTENT_PREF, value]);
+}
+
+async function setAboutWelcomePref(value) {
+  return pushPrefs(["browser.aboutwelcome.enabled", value]);
+}
+
+async function openMRAboutWelcome() {
+  await setAboutWelcomePref(true); // NB: Calls pushPrefs
+  let tab = await BrowserTestUtils.openNewForegroundTab(
+    gBrowser,
+    "about:welcome",
+    true
+  );
+
+  return {
+    browser: tab.linkedBrowser,
+    cleanup: async () => {
+      BrowserTestUtils.removeTab(tab);
+      await popPrefs(); // for setAboutWelcomePref()
+    },
+  };
+}
+
+async function onButtonClick(browser, elementId) {
+  await ContentTask.spawn(
+    browser,
+    { elementId },
+    async ({ elementId: buttonId }) => {
+      let button = await ContentTaskUtils.waitForCondition(
+        () => content.document.querySelector(buttonId),
+        buttonId
+      );
+      button.click();
+    }
+  );
+}
+
+async function clearHistoryAndBookmarks() {
+  await PlacesUtils.bookmarks.eraseEverything();
+  await PlacesUtils.history.clear();
+  QueryCache.expireAll();
+}
+
+/**
+ * Setup functions to test welcome UI
+ */
+async function test_screen_content(
+  browser,
+  experiment,
+  expectedSelectors = [],
+  unexpectedSelectors = []
+) {
+  await ContentTask.spawn(
+    browser,
+    { expectedSelectors, experiment, unexpectedSelectors },
+    async ({
+      expectedSelectors: expected,
+      experiment: experimentName,
+      unexpectedSelectors: unexpected,
+    }) => {
+      for (let selector of expected) {
+        await ContentTaskUtils.waitForCondition(
+          () => content.document.querySelector(selector),
+          `Should render ${selector} in ${experimentName}`
+        );
+      }
+      for (let selector of unexpected) {
+        ok(
+          !content.document.querySelector(selector),
+          `Should not render ${selector} in ${experimentName}`
+        );
+      }
+
+      if (experimentName === "home") {
+        Assert.equal(
+          content.document.location.href,
+          "about:home",
+          "Navigated to about:home"
+        );
+      } else {
+        Assert.equal(
+          content.document.location.href,
+          "about:welcome",
+          "Navigated to a welcome screen"
+        );
+      }
+    }
+  );
+}
+
+async function test_element_styles(
+  browser,
+  elementSelector,
+  expectedStyles = {},
+  unexpectedStyles = {}
+) {
+  await ContentTask.spawn(
+    browser,
+    [elementSelector, expectedStyles, unexpectedStyles],
+    async ([selector, expected, unexpected]) => {
+      const element = await ContentTaskUtils.waitForCondition(() =>
+        content.document.querySelector(selector)
+      );
+      const computedStyles = content.window.getComputedStyle(element);
+      Object.entries(expected).forEach(([attr, val]) =>
+        is(
+          computedStyles[attr],
+          val,
+          `${selector} should have computed ${attr} of ${val}`
+        )
+      );
+      Object.entries(unexpected).forEach(([attr, val]) =>
+        isnot(
+          computedStyles[attr],
+          val,
+          `${selector} should not have computed ${attr} of ${val}`
+        )
+      );
+    }
+  );
+}

browser/components/newtab/test/browser/browser_aboutwelcome_import.js renamed to browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_import.js

@@ -29,6 +29,7 @@ with Files("controlcenter/**"):
 DIRS += [
     "about",
     "aboutlogins",
+    "aboutwelcome",
     "attribution",
     "contentanalysis",
     "contextualidentity",

browser/components/newtab/test/browser/browser_aboutwelcome_mobile_downloads.js renamed to browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_mobile_downloads.js

@@ -21,63 +21,6 @@ prefs = [
   "browser.newtabpage.activity-stream.feeds.section.topstories=true",
   "browser.newtabpage.activity-stream.feeds.section.topstories.options={\"provider_name\":\"\"}",
   "messaging-system.log=all",
-  "intl.multilingual.aboutWelcome.languageMismatchEnabled=false",
-  "browser.attribution.macos.enabled=true",
-]
-
-["browser_aboutwelcome_attribution.js"]
-skip-if = [
-  "os == 'linux'", # Test setup only implemented for OSX and Windows
-  "os == 'win' && msix", # These tests rely on the ability to write postSigningData, which we can't do in MSIX builds. https://bugzilla.mozilla.org/show_bug.cgi?id=1805911
-]
-
-["browser_aboutwelcome_configurable_ui.js"]
-skip-if = ["os == 'linux' && bits == 64 && debug"] # Bug 1784548
-
-["browser_aboutwelcome_fxa_signin_flow.js"]
-
-["browser_aboutwelcome_glean.js"]
-
-["browser_aboutwelcome_import.js"]
-fail-if = ["a11y_checks"] # Bug 1854514 clicked primary button may not be focusable
-
-["browser_aboutwelcome_mobile_downloads.js"]
-
-["browser_aboutwelcome_multistage_addonspicker.js"]
-
-["browser_aboutwelcome_multistage_default.js"]
-
-["browser_aboutwelcome_multistage_experimentAPI.js"]
-
-["browser_aboutwelcome_multistage_languageSwitcher.js"]
-skip-if = [
-  "os == 'linux' && bits == 64", # Bug 1757875
-  "verify",
-]
-
-["browser_aboutwelcome_multistage_mr.js"]
-skip-if = [
-  "os == 'linux' && bits == 64 && debug", # Bug 1812050
-  "os == 'linux' && tsan && verify",
-]
-
-["browser_aboutwelcome_multistage_video.js"]
-
-["browser_aboutwelcome_observer.js"]
-https_first_disabled = true
-
-["browser_aboutwelcome_rtamo.js"]
-skip-if = [
-  "os == 'linux'", # Test setup only implemented for OSX and Windows
-  "os == 'win' && msix", # These tests rely on the ability to write postSigningData, which we can't do in MSIX builds. https://bugzilla.mozilla.org/show_bug.cgi?id=1805911
-]
-
-["browser_aboutwelcome_screen_targeting.js"]
-
-["browser_aboutwelcome_upgrade_multistage_mr.js"]
-skip-if = [
-  "win11_2009 && debug",
-  "os == 'linux' && debug", # Bug 1804804 - disabled on win && linux for extremely high failure rate
 ]
 
 ["browser_as_load_location.js"]