1881739 - Create a SearchTestUtils function to simplify creating configurations for tests

Status: RESOLVED FIXED

(Firefox :: Search, task, P3)

Description

[Mark Banner (:standard8)]

Once we start removing the old search configuration, we should investigate improving our facilities for creating search configurations for tests.

We have a lot of tests where we're fully specifying the configuration we want to use. As a lot of it is boiler plate, it would be nice to have a function that made it simpler, e.g. something like:

SearchTestUtils.createConfig([
  {
    variants: [
      {
        environment: { allRegionsAndLocales: true },
      },
    ],
  },
  {
    variants: [
      {
        environment: { regions: ["FR"] },
      },
    ],
  }
]);

This would create two engines, one that is available everywhere and one that is only available in the FR region. We might want to give them identifiers, so that we can easily reference them in the test code.

Another situation could be creating engines with particular search urls.

The main intent here is to allow boilerplate to be stripped away, and only specify what's needed for the test. This should make it easier to understand what the test is focussing on.

We might also replace SearchTestUtils.useTestEngines completely with this function.

Comment 1

[Moritz Beier [:mbeier]]

Attachment: Bug 1881739 - Create a SearchTestUtils function to simplify creating configurations for tests. r?standard8

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/7866c5548885
Create a SearchTestUtils function to simplify creating configurations for tests. r=Standard8,mcheang,urlbar-reviewers

Comment 3

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/7866c5548885