1185035 - Clean up TaskManager tests to avoid shared state between suites and tests

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Gaia::System::Task Manager, defect)

Description

[Sam Foster [:sfoster] (he/him)]

Although TaskManager is (mostly) instantiable, its tests reuse a single instance, making it hard to test different initialization conditions, and making tests prone to side-effects of previous tests.

Comment 1

[GitHub Autolander Bot]

Attachment: [gaia] sfoster:taskmanager-tests-bug-1185035 > mozilla-b2g:master

Comment 2

[Sam Foster [:sfoster] (he/him)]

Comment on attachment 8635457 [details] [review]
[gaia] sfoster:taskmanager-tests-bug-1185035 > mozilla-b2g:master

This PR extracts the TaskManager unit test changes from the patch on bug 1169012, and applies them to the existing TaskManager. I rolled in the settings changes, and state initialization in the constructor. I've kept the properties on the prototype mostly for the jsdocs. Any other changes are to address instantiability issues - particularly if an instance is started but never shown, or not hidden as expected. 

In the tests themselves, we create a clean instance and set of app fixtures for each test.

Comment 3

[Etienne Segonzac (:etienne)]

Comment on attachment 8635457 [details] [review]
[gaia] sfoster:taskmanager-tests-bug-1185035 > mozilla-b2g:master

Thanks! Much easier to pay attention to the changes.
And consequently, lots of comments on github :)

Comment 4

[Sam Foster [:sfoster] (he/him)]

Comment on attachment 8635457 [details] [review]
[gaia] sfoster:taskmanager-tests-bug-1185035 > mozilla-b2g:master

round 2, I fixed the nits, moved the cleanup to a global teardown. In the global setup I do create a new TaskManager instance and start() it - that seems reasonable as its setup that is normally performed outside task_manager.js.

I did a little more test refactoring - mostly making some of the async tests sync. Some of this was in the course of troubleshooting a bug I introduced that I eventually spotted - but I think its all better than it was. Hopefully you agree :)

Comment 5

[Etienne Segonzac (:etienne)]

Comment on attachment 8635457 [details] [review]
[gaia] sfoster:taskmanager-tests-bug-1185035 > mozilla-b2g:master

Perfect!
Thanks for sticking with it :)

Comment 6

[Sam Foster [:sfoster] (he/him)]

Merged to master: https://github.com/mozilla-b2g/gaia/commit/eaff79aa68e12d533aa1a24ef169b97fe7df2887