972093 - Detect run_next_test() executed during add_task()

Status: RESOLVED FIXED

(Testing :: XPCShell Harness, defect)

Description

[Gregory Szorc [:gps]]

A few times I've seen weird xpcshell test bugs and behavior caused by calling run_next_test() in an add_task() test. e.g.

add_task(function* () {
   Assert.ok(true);
   run_next_test();
});

This is absurdly difficult to decipher from the test runner output and is fully preventable. Let's update head.js and ensure this pattern aborts immediately with a very clear error message.

Comment 1

[Gregory Szorc [:gps]]

Attachment: Detect run_next_test() during add_task()

If an xpcshell test called run_next_test() from inside an add_task(),
bad things would happen. This patch detects that behavior and aborts the
test immediately with an actionable error message.

https://tbpl.mozilla.org/?tree=Try&rev=231f64241141

Comment 2

[Gregory Szorc [:gps]]

Attachment: Detect run_next_test() during add_task()

I rolled some failures in automation into this patch. I'll keep
refreshing until I find them all. Some of these changes may have already
landed on other trees. hg should handle the merge like a boss, though.

https://tbpl.mozilla.org/?tree=Try&rev=0541461c56bd

Comment 3

[Richard Newman [:rnewman]]

Comment on attachment 8375272 [details] [diff] [review]
Detect run_next_test() during add_task()

Review of attachment 8375272 [details] [diff] [review]:
-----------------------------------------------------------------

Uplift it! :D

Comment 4

[Gregory Szorc [:gps]]

https://hg.mozilla.org/integration/fx-team/rev/8b0e7e6aa1df

Comment 5

[:Gijs (he/him)]

https://hg.mozilla.org/mozilla-central/rev/8b0e7e6aa1df