1755159 - Document how to use `add_setup` in tests

Status: NEW

(Testing :: Mochitest, enhancement)

Description

[Mathew Hodson]

The new add_setup method and the proper way to use it should be documented somewhere on https://firefox-source-docs.mozilla.org/.

Comment 1

[Mathew Hodson]

I see this page https://firefox-source-docs.mozilla.org/testing/xpcshell/index.html

That documents add_task and registerCleanupFunction, but it's specifcally about xpcshell tests. Can the the new add_setup be used in xpcshell tests?

Comment 2

[:Gijs (he/him)]

(In reply to Mathew Hodson from comment #1)

I see this page https://firefox-source-docs.mozilla.org/testing/xpcshell/index.html

That documents add_task and registerCleanupFunction, but it's specifcally about xpcshell tests. Can the the new add_setup be used in xpcshell tests?

No, it is specific to browser chrome tests, at least right now - sadly all our frameworks (mochitest plain, browser and xpcshell) have their own add_task implementation (and would need their own add_setup implementation). As far as I know the main mochitest/browser documentation that used to exist on MDN is still not migrated to fx-source-docs, and I think doing that is probably more pressing than documenting add_setup.

Comment 3

[Valentin Gosu [:valentin] (he/him)]

(In reply to :Gijs (he/him) from comment #2)
As far as I know the main mochitest/browser documentation that used to exist on MDN is still not migrated to fx-source-docs, and I think doing that is probably more pressing than documenting add_setup.

See bug 1740033. The old mochitest docs are in the MDN archive