Fail a test if its callback returns a promise that rejects #441
Conversation
|
The build is failing because the stack in the test is slightly different in the different versions of node. It still runs correctly, but the assertion fails because it's not exactly the same TAP output. Not sure how to deal with that. EDIT: fixed this with a regex hack. Not sure if there is a better way. |
test/promises/fail.js
Outdated
| @@ -0,0 +1,12 @@ | |||
| var test = require('../../'); | |||
|
|
|||
| test('promise', function (t) { | |||
There was a problem hiding this comment.
this test should be skipped when typeof Promise === 'undefined'
There was a problem hiding this comment.
I skipped them using node-tap in promise_fail.js, here https://github.com/substack/tape/pull/441/files#diff-0e44c4bcf1645d05ba9b5c2e44250c26R8
If that variable skip is truthy, then these test files aren't even run. (the builds that don't support promises show the skip in the output)
Should I switch to using test.skip in tape?
There was a problem hiding this comment.
hm - these tests need to continue to use tap, but it'd be ideal for the skip logic to be in each test file.
There was a problem hiding this comment.
It would produce a different (non-failing) TAP output then, which would fail the tap test instead of skipping it.
Should I put it in both? Maybe a comment explaining that they'll be skipped?
There was a problem hiding this comment.
ah yes, i like putting something in both - a generic "skip" mechanism in the tap test, and a specific one to promises here?
There was a problem hiding this comment.
Added a commit for this. It looks at the beginning of the stdout from the test, and if it's "skip", then it passes the test. Each test logs "skip" if Promise is undefined.
Is that what you had in mind?
test/promises/subTests.js
Outdated
| @@ -0,0 +1,13 @@ | |||
| var test = require('../../'); | |||
|
|
|||
| test('promise', function (t) { | |||
lib/test.js
Outdated
| this.emit('run'); | ||
|
|
||
| if (typeof Promise !== 'undefined') { |
There was a problem hiding this comment.
let's ensure Promise is a function, as is Promise.resolve
There was a problem hiding this comment.
done. Also changed in lib/test.js
test/promise_fail.js
Outdated
| var rowsString = rows.toString('utf8'); | ||
|
|
||
| // if the output starts with skip, then skip this test | ||
| if (/^skip/.test(rowsString)) { |
There was a problem hiding this comment.
Added a commit that only runs the test if promises are supported.
Before it would still run the test and print the TAP output after 'skip'
|
@KayleePop this needs to be rebased now that #472 has landed. I'm hoping the tests can be preserved :-) |
|
Rebased! I just left master's implementation alone and only rebased the tests in. The only differences were that this branch checked that |
Changes since v5.0.0-next.0: - [Breaking] fail any assertion after `.end()` is called (#489( - [Breaking] tests with no callback are failed TODO tests (#69) - [Breaking] equality functions: throw when < 2 arguments are provided - [Breaking] add "exports" to restrict public API - [Breaking] `throws`: bring into line with node’s `assert.throws` - [Breaking] use default `require.extensions` collection instead of the magic Array `['.js']` (#396) - [Fix] error stack file path can contain parens/spaces - [Refactor] make everything strict mode - [Refactor] Avoid setting message property on primitives; use strict mode to catch this (#490) - [Refactor] generalize error message from calling `.end` more than once - [Dev Deps] update `eslint` - [Tests] improve some failure output by adding messages - [Tests] handle stack trace variation in node <= 0.8 - [Tests] ensure bin/tape is linted - [Tests] Fail a test if its callback returns a promise that rejects (#441) - [eslint] fix remaining undeclared variables (#488) - [eslint] Fix leaking variable in tests - [eslint] fix object key spacing Changes since v4.12.1: - [Breaking] `error` should not emit `expected`/`actual` diags (#455) - [Breaking] support passing in an async function for the test callback (#472) - [Breaking] update `deep-equal` to v2 - [Deps] update `resolve` - [meta] change dep semver prefix from ~ to ^
This is mentioned here #208 (comment)
The benefit is that you can use async functions as the test callback without unexpected results like hanging with no output in the browser.
If the global variable
Promiseisn't defined, then nothing is changed.