1791974 - Extend SearchTestUtils utility functions to provide options for automatically setting an installed engine as default

Status: RESOLVED FIXED

(Firefox :: Search, task, P3)

Description

[Mark Banner (:standard8)]

In working on a different bug that was changing the setDefault and setDefaultPrivate interfaces, I realised that we have a lot of boilerplate in tests along the lines of:

let originalEngine = await Services.search.getDefault
await SearchTestUtils.installSearchExtension(...);
const defaultEngine = Services.search.getEngineByName("Example");
await Services.search.setDefault(defaultEngine);
registerCleanupFunction(async => {
  await Services.search.setDefault(originalEngine);
});

Generally the purpose of this is to set an alternative engine as default for use in the tests - for suggestions or other reasons.

If we added an additional argument to the various install functions to set the engine as default, we could avoid most of this boilerplate. We may also be able to use resetToAppDefaultEngine in the cleanup function.

Comment 1

[Mark Banner (:standard8)]

Try push (from before I restructured the patches slightly): https://treeherder.mozilla.org/jobs?repo=try&revision=2c4adb78cf88218d4850a51f9633a5407e107c05

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1791974 - Add set as default (private) search engine options to SearchTestUtils.promiseNewSearchEngine. r?mcheang!

Comment 3

[Mark Banner (:standard8)]

Attachment: Bug 1791974 - Add set as default (private) search engine options to SearchTestUtils.installSearchExtension. r?mcheang!

and convert existing would-be-broken consumers to use the new format arguments

Depends on D161043

Comment 4

[Mark Banner (:standard8)]

Attachment: Bug 1791974 - Use setAsDefault* parameters where appropriate for consumers of SearchTestUtils.installSearchExtension. r?mcheang!

Depends on D161044

Comment 5

[Mark Banner (:standard8)]

Updated try push: https://treeherder.mozilla.org/jobs?repo=try&revision=ae61761c6418e37de3385648afffe59dfdd0375e&selectedTaskRun=Ysgi8xWwTIGNPlDsEOwpGA.0

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e20401f6948b
Add set as default (private) search engine options to SearchTestUtils.promiseNewSearchEngine. r=mcheang
https://hg.mozilla.org/integration/autoland/rev/182ff17fa508
Add set as default (private) search engine options to SearchTestUtils.installSearchExtension. r=mcheang
https://hg.mozilla.org/integration/autoland/rev/4c5648a82120
Use setAsDefault* parameters where appropriate for consumers of SearchTestUtils.installSearchExtension. r=mcheang

Comment 7

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/e20401f6948b
https://hg.mozilla.org/mozilla-central/rev/182ff17fa508
https://hg.mozilla.org/mozilla-central/rev/4c5648a82120