1295381 - Update https://developer.mozilla.org/en-US/docs/Mozilla/QA/Writing_xpcshell-based_unit_tests to mention add_test and add_task

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: General, defect)

Description

[Mark Hammond [:markh] [:mhammond]]

https://developer.mozilla.org/en-US/docs/Mozilla/QA/Writing_xpcshell-based_unit_tests is out of date. It's no longer necessary for a test to have a run_test() function. New test helpers add_test and add_task often make this unnecessary, but are not mentioned in these docs.

Comment 1

[Eric Shepherd [:sheppy]]

(In reply to Mark Hammond [:markh] from comment #0)
> https://developer.mozilla.org/en-US/docs/Mozilla/QA/Writing_xpcshell-
> based_unit_tests is out of date. It's no longer necessary for a test to have
> a run_test() function. New test helpers add_test and add_task often make
> this unnecessary, but are not mentioned in these docs.

Hi Mark. Unfortunately, the MDN content team has had to deprioritize work on Firefox internals and build documentation, due to the huge amount of content that needs to be done on the web development side and the relatively small supply of writer-hours. Because of that, we encourage teams to maintain their own Firefox internals/test/development content.

We also encourage people who use that documentation to get involved and help update and maintain that content.

See our contributor guide here if you're interested in helping to update that documentation: https://developer.mozilla.org/en-US/docs/MDN/Getting_started

This bug will stay open but I wanted to let you know that the MDN writing staff won't be able to take this on, even though it's legitimate work.

Comment 2

[Ethan Glasser-Camp (:glasserc)]

I took a swing at cleaning up the page in question. What do you think, :markh?

Comment 3

[Mark Hammond [:markh] [:mhammond]]

Thanks Ethan, that looks awesome! I added a note that run_test is optional if add_test and add_task are used, but the additions you made are very comprehensive, thanks.

Comment 4

[Ethan Glasser-Camp (:glasserc)]

I didn't do that much -- almost all that information was already there, just in a different order.