1 files changed, 173 insertions, 0 deletions
diff --git a/toolkit/components/search/tests/xpcshell/searchconfigs/test_google.js b/toolkit/components/search/tests/xpcshell/searchconfigs/test_google.js
new file mode 100644
index 0000000000..dc2098b066
--- /dev/null
+++ b/toolkit/components/search/tests/xpcshell/searchconfigs/test_google.js
@@ -0,0 +1,173 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+ChromeUtils.defineESModuleGetters(this, {
+  NimbusFeatures: "resource://nimbus/ExperimentAPI.sys.mjs",
+});
+
+const test = new SearchConfigTest({
+  identifier: "google",
+  aliases: ["@google"],
+  default: {
+    // Included everywhere apart from the exclusions below. These are basically
+    // just excluding what Yandex and Baidu include.
+    excluded: [
+      {
+        regions: ["cn"],
+        locales: {
+          matches: ["zh-CN"],
+        },
+      },
+    ],
+  },
+  available: {
+    excluded: [
+      // Should be available everywhere.
+    ],
+  },
+  details: [
+    {
+      included: [{ regions: ["us"] }],
+      domain: "google.com",
+      telemetryId:
+        SearchUtils.MODIFIED_APP_CHANNEL == "esr"
+          ? "google-b-1-e"
+          : "google-b-1-d",
+      codes:
+        SearchUtils.MODIFIED_APP_CHANNEL == "esr"
+          ? "client=firefox-b-1-e"
+          : "client=firefox-b-1-d",
+    },
+    {
+      excluded: [{ regions: ["us", "by", "kz", "ru", "tr"] }],
+      included: [{}],
+      domain: "google.com",
+      telemetryId:
+        SearchUtils.MODIFIED_APP_CHANNEL == "esr" ? "google-b-e" : "google-b-d",
+      codes:
+        SearchUtils.MODIFIED_APP_CHANNEL == "esr"
+          ? "client=firefox-b-e"
+          : "client=firefox-b-d",
+    },
+    {
+      included: [{ regions: ["by", "kz", "ru", "tr"] }],
+      domain: "google.com",
+      telemetryId: "google-com-nocodes",
+    },
+  ],
+});
+
+add_task(async function setup() {
+  sinon.spy(NimbusFeatures.search, "onUpdate");
+  sinon.stub(NimbusFeatures.search, "ready").resolves();
+  await test.setup();
+});
+
+add_task(async function test_searchConfig_google() {
+  await test.run();
+});
+
+add_task(async function test_searchConfig_google_with_mozparam() {
+  // Test a couple of configurations with a MozParam set up.
+  const TEST_DATA = [
+    {
+      locale: "en-US",
+      region: "US",
+      pref: "google_channel_us",
+      expected: "us_param",
+    },
+    {
+      locale: "en-US",
+      region: "GB",
+      pref: "google_channel_row",
+      expected: "row_param",
+    },
+  ];
+
+  const defaultBranch = Services.prefs.getDefaultBranch(
+    SearchUtils.BROWSER_SEARCH_PREF
+  );
+  for (const testData of TEST_DATA) {
+    defaultBranch.setCharPref("param." + testData.pref, testData.expected);
+  }
+
+  for (const testData of TEST_DATA) {
+    info(`Checking region ${testData.region}, locale ${testData.locale}`);
+    const engines = await test._getEngines(testData.region, testData.locale);
+
+    Assert.ok(
+      engines[0].identifier.startsWith("google"),
+      "Should have the correct engine"
+    );
+    console.log(engines[0]);
+
+    const submission = engines[0].getSubmission("test", URLTYPE_SEARCH_HTML);
+    Assert.ok(
+      submission.uri.query.split("&").includes("channel=" + testData.expected),
+      "Should be including the correct MozParam parameter for the engine"
+    );
+  }
+
+  // Reset the pref values for next tests
+  for (const testData of TEST_DATA) {
+    defaultBranch.setCharPref("param." + testData.pref, "");
+  }
+});
+
+add_task(async function test_searchConfig_google_with_nimbus() {
+  let sandbox = sinon.createSandbox();
+  // Test a couple of configurations with a MozParam set up.
+  const TEST_DATA = [
+    {
+      locale: "en-US",
+      region: "US",
+      expected: "nimbus_us_param",
+    },
+    {
+      locale: "en-US",
+      region: "GB",
+      expected: "nimbus_row_param",
+    },
+  ];
+
+  Assert.ok(
+    NimbusFeatures.search.onUpdate.called,
+    "Should register an update listener for Nimbus experiments"
+  );
+  // Stub getVariable to populate the cache with our expected data
+  sandbox.stub(NimbusFeatures.search, "getVariable").returns([
+    { key: "google_channel_us", value: "nimbus_us_param" },
+    { key: "google_channel_row", value: "nimbus_row_param" },
+  ]);
+  // Set the pref cache with Nimbus values
+  NimbusFeatures.search.onUpdate.firstCall.args[0]();
+
+  for (const testData of TEST_DATA) {
+    info(`Checking region ${testData.region}, locale ${testData.locale}`);
+    const engines = await test._getEngines(testData.region, testData.locale);
+
+    Assert.ok(
+      engines[0].identifier.startsWith("google"),
+      "Should have the correct engine"
+    );
+    console.log(engines[0]);
+
+    const submission = engines[0].getSubmission("test", URLTYPE_SEARCH_HTML);
+    Assert.ok(
+      NimbusFeatures.search.ready.called,
+      "Should wait for Nimbus to get ready"
+    );
+    Assert.ok(
+      NimbusFeatures.search.getVariable,
+      "Should call NimbusFeatures.search.getVariable to populate the cache"
+    );
+    Assert.ok(
+      submission.uri.query.split("&").includes("channel=" + testData.expected),
+      "Should be including the correct MozParam parameter for the engine"
+    );
+  }
+
+  sandbox.restore();
+});