1613322 - DevTools ToolboxTask should define common helpers info, is, ok ... for all tests

Status: RESOLVED FIXED

(DevTools :: General, task, P3)

Description

[Julian Descottes [:jdescottes]]

What were you doing?

Follow up to the review of https://phabricator.services.mozilla.com/D61570
Some tests in devtools/client/framework/browser-toolbox/test/ add helper functions to the "ToolboxTask" scope:

  await ToolboxTask.importFunctions({
    info: msg => dump(msg + "\n"),
    is: (a, b, description) => {
      let msg =
        "'" + JSON.stringify(a) + "' is equal to '" + JSON.stringify(b) + "'";
      if (description) {
        msg += " - " + description;
      }
      if (a !== b) {
        msg = "FAILURE: " + msg;
        dump(msg + "\n");
        throw new Error(msg);
      } else {
        msg = "SUCCESS: " + msg;
        dump(msg + "\n");
      }
    },
    ok: (a, description) => {
      let msg = "'" + JSON.stringify(a) + "' is true";
      if (description) {
        msg += " - " + description;
      }
      if (!a) {
        msg = "FAILURE: " + msg;
        dump(msg + "\n");
        throw new Error(msg);
      } else {
        msg = "SUCCESS: " + msg;
        dump(msg + "\n");
      }
    },
    waitUntil,
  });

What happened?

Each test has to redefine the imported functions, leading to inconsistent tests.

What should have happened?

Common helpers should be defined once and always inserted in the BrowserToolbox tasks.

Comment 1

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1613322 - Define common test helpers for browser toolbox tasks.

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/05b8b0f2f8fe
Define common test helpers for browser toolbox tasks. r=jdescottes

Comment 3

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/05b8b0f2f8fe