1044743 - Use the correct promise testing pattern in keyboard unit tests

Status: RESOLVED DUPLICATE of bug 1047837

(Firefox OS Graveyard :: Gaia::Keyboard, defect)

Description

[Tim Guan-tin Chien [:timdream] (please needinfo)]

It turned out I was using the wrong pattern for testing promise outcome in many of the unit tests since I start using promise in keyboard app.

For detail, please read dev-gaia: "aync testing with promises in mocha"

We need to correct these pattern into the correct one so that these tests, when failed, won't timed out but correctly display the error messages.

Marking dependency to bug 1040598 because this bug need to wait for the code changes there.

Blocks bug 1040603 because to write a promise-based queue we need to first properly test the current ones.

Comment 1

[Tim Guan-tin Chien [:timdream] (please needinfo)]

I am not entirely sure if this bug is still valid as the pattern might have been corrected on other bugs.

Anyway, the correct pattern should be

PromiseToAssert.then(function(result) {
  ... (asset the result and other properties on this timing)
}, function(e) {
  e && return e;
  assert.isTrue(false, 'Should not reject.');
}).then(done, done);

IMHO this is better than what was suggested on dev-gaia because you don't need to create another function block.

Comment 2

[Tim Guan-tin Chien [:timdream] (please needinfo)]

Sorry, this should be 

PromiseToAssert.then(function(result) {
  ... (asset the result and other properties on this timing)
}, function(e) {
  if (e) { return e; }
  assert.isTrue(false, 'Should not reject.');
}).then(done, done);

Comment 3

[watson.serrano]

This seems like a good first bug. 
Can I do it?

Comment 4

[Tim Guan-tin Chien [:timdream] (please needinfo)]

Please do. Do you know where to start?

Comment 5

[watson.serrano]

Hi Tim Thanks a lot for leting me do this bug.

I don't really know where to start. 

I imagine that the first thing to do is to read all that there is related to tests in Gaia probably starting with https://developer.mozilla.org/en-US/Firefox_OS/Platform/Automated_testing/Gaia_unit_tests

I could not find "aync testing with promises in mocha" can you please point me to it so that I don't miss it.

Second I think I will have to go to gaia/apps/keyboard/test and search for all the tests that have the wrong patterns and fix them.

Once the code is correct I will have to try to submit a patch following the instructions on https://developer.mozilla.org/en-US/Firefox_OS/Developing_Gaia/Submitting_a_Gaia_patch

Am I on the right track?

Comment 6

[Tim Guan-tin Chien [:timdream] (please needinfo)]

Yes, that's the plan. Thank you for the contribution.

Comment 7

[Tim Guan-tin Chien [:timdream] (please needinfo)]

Dup over to bug 1047837 since I've fix this in the patch along the way, and inactivity of this bug.