Add error throwing to 'it'/'test' for incorrect arguments. #5558
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| /** | ||
| * Copyright (c) 2015-present, Facebook, Inc. All rights reserved. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @flow | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| let circusIt; | ||
| let circusTest; | ||
|
|
||
| //using jest-jasmine2's 'it' to test jest-circus's 'it'. Had to differentiate | ||
| //the two with this aliaser. | ||
|
|
||
| const aliasCircusIt = () => { | ||
| const {it, test} = require('../index.js'); | ||
| circusIt = it; | ||
| circusTest = test; | ||
| }; | ||
|
|
||
| aliasCircusIt(); | ||
|
|
||
| //A few of these tests require incorrect types to throw errors and thus pass | ||
| //the test. The typechecks on jest-circus would prevent that, so | ||
| //this file has been listed in the .flowconfig ignore section. | ||
|
|
||
| describe('test/it error throwing', () => { | ||
| it(`it doesn't throw an error with valid arguments`, () => { | ||
| expect(() => { | ||
| circusIt('test1', () => {}); | ||
| }).not.toThrowError(); | ||
| }); | ||
| it(`it throws error with missing callback function`, () => { | ||
| expect(() => { | ||
| // $FlowFixMe: Easy, we're testing runitme errors here | ||
| circusIt('test2'); | ||
| }).toThrowError('Missing second argument. It must be a callback function.'); | ||
| }); | ||
| it(`it throws an error when first argument isn't a string`, () => { | ||
| expect(() => { | ||
| // $FlowFixMe: Easy, we're testing runitme errors here | ||
| circusIt(() => {}); | ||
| }).toThrowError(`Invalid first argument, () => {}. It must be a string.`); | ||
| }); | ||
| it('it throws an error when callback function is not a function', () => { | ||
| expect(() => { | ||
| // $FlowFixMe: Easy, we're testing runitme errors here | ||
| circusIt('test4', 'test4b'); | ||
| }).toThrowError( | ||
| `Invalid second argument, test4b. It must be a callback function.`, | ||
| ); | ||
| }); | ||
| it(`test doesn't throw an error with valid arguments`, () => { | ||
| expect(() => { | ||
| circusTest('test5', () => {}); | ||
| }).not.toThrowError(); | ||
| }); | ||
| it(`test throws error with missing callback function`, () => { | ||
| expect(() => { | ||
| // $FlowFixMe: Easy, we're testing runitme errors here | ||
| circusTest('test6'); | ||
| }).toThrowError('Missing second argument. It must be a callback function.'); | ||
| }); | ||
| it(`test throws an error when first argument isn't a string`, () => { | ||
| expect(() => { | ||
| // $FlowFixMe: Easy, we're testing runitme errors here | ||
| circusTest(() => {}); | ||
| }).toThrowError(`Invalid first argument, () => {}. It must be a string.`); | ||
| }); | ||
| it('test throws an error when callback function is not a function', () => { | ||
| expect(() => { | ||
| // $FlowFixMe: Easy, we're testing runitme errors here | ||
| circusTest('test8', 'test8b'); | ||
| }).toThrowError( | ||
| `Invalid second argument, test8b. It must be a callback function.`, | ||
| ); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| /** | ||
| * Copyright (c) 2015-present, Facebook, Inc. All rights reserved. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| describe('test/it error throwing', () => { | ||
| it(`it throws error with missing callback function`, () => { | ||
| expect(() => { | ||
| it('test1'); | ||
| }).toThrowError('Missing second argument. It must be a callback function.'); | ||
| }); | ||
| it(`it throws an error when first argument isn't a string`, () => { | ||
| expect(() => { | ||
| it(() => {}); | ||
| }).toThrowError(`Invalid first argument, () => {}. It must be a string.`); | ||
| }); | ||
| it('it throws an error when callback function is not a function', () => { | ||
| expect(() => { | ||
| it('test3', 'test3b'); | ||
| }).toThrowError( | ||
| `Invalid second argument, test3b. It must be a callback function.`, | ||
| ); | ||
| }); | ||
| test(`test throws error with missing callback function`, () => { | ||
| expect(() => { | ||
| test('test4'); | ||
| }).toThrowError('Missing second argument. It must be a callback function.'); | ||
| }); | ||
| test(`test throws an error when first argument isn't a string`, () => { | ||
| expect(() => { | ||
| test(() => {}); | ||
| }).toThrowError(`Invalid first argument, () => {}. It must be a string.`); | ||
| }); | ||
| test('test throws an error when callback function is not a function', () => { | ||
| expect(() => { | ||
| test('test6', 'test6b'); | ||
| }).toThrowError( | ||
| `Invalid second argument, test6b. It must be a callback function.`, | ||
| ); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -424,6 +424,21 @@ export default function(j$) { | |
| }; | ||
|
|
||
| this.it = function(description, fn, timeout) { | ||
| if (typeof description !== 'string') { | ||
| throw new Error( | ||
| `Invalid first argument, ${description}. It must be a string.`, | ||
| ); | ||
| } | ||
| if (fn === undefined) { | ||
|
There was a problem hiding this comment. Ok, cool. So to clarify: add an
but still throw the error for There was a problem hiding this comment. I think "yes", but it's too breaking. But I think we should do it for the next version. (I'm all for adding @cpojer thoughts? There was a problem hiding this comment. I'm not sure about |
||
| throw new Error( | ||
| 'Missing second argument. It must be a callback function.', | ||
| ); | ||
| } | ||
| if (typeof fn !== 'function') { | ||
| throw new Error( | ||
| `Invalid second argument, ${fn}. It must be a callback function.`, | ||
| ); | ||
| } | ||
| const spec = specFactory( | ||
| description, | ||
| fn, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SimenB , that's to truncate the overly long relative path that jest-message-util generates between the
__test__folder and jest itself when it runs the integration tests forglobal.test.js. Looks like this on my machine with it:packages/jest-jasmine2/build/jasmine/Env.js:433:15and like this without it:
../../../../../../../Users/brian/Documents/projects/opensource/jest/packages/jest-jasmine2/build/jasmine/Env.js:4It's needed for snapshots in the CI tests, so it can pass on any computer. I can add a comment in there explaining if you think it warrants it? Or try a different approach if you'd rather.