-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds docs section about testing #687
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
## Testing your application | ||
|
||
### Used libraries | ||
|
||
RSK comes with the following libraries for testing purposes: | ||
|
||
- [Mocha](https://mochajs.org/) - Node.js and browser test runner | ||
- [Chai](http://chaijs.com/) - Assertion library | ||
- [Enzyme](https://github.com/airbnb/enzyme) - Testing utilities for React | ||
|
||
You may also want to take a look at the following related packages: | ||
|
||
- [jsdom](https://github.com/tmpvar/jsdom) | ||
- [react-addons-test-utils](https://www.npmjs.com/package/react-addons-test-utils) | ||
|
||
### Running tests | ||
|
||
To test your application simply run the | ||
[`npm test`](https://github.com/kriasoft/react-starter-kit/blob/b22b1810461cec9c53eedffe632a3ce70a6b29a3/package.json#L154) | ||
command which will: | ||
- recursively find all files ending with `.test.js` in your `src/` directory | ||
- mocha execute found files | ||
|
||
```bash | ||
npm test | ||
``` | ||
|
||
### Conventions | ||
|
||
- test filenames MUST end with `test.js` or `npm test` will not be able to detect them | ||
- test filenames SHOULD be named after the related component (e.g. create `Login.test.js` for | ||
`Login.js` component) | ||
|
||
### Basic example | ||
|
||
To help you on your way RSK comes with the following | ||
[basic test case](https://github.com/kriasoft/react-starter-kit/blob/master/src/components/App/App.test.js) | ||
you can use as a starting point: | ||
|
||
```js | ||
import React from 'react'; | ||
import { expect } from 'chai'; | ||
import { shallow } from 'enzyme'; | ||
import App from './App'; | ||
|
||
describe('App', () => { | ||
|
||
it('renders children correctly', () => { | ||
const wrapper = shallow( | ||
<App context={{ insertCss: () => {} }}> | ||
<div className="child" /> | ||
</App> | ||
); | ||
|
||
expect(wrapper.contains(<div className="child" />)).to.be.true; | ||
}); | ||
|
||
}); | ||
``` | ||
|
||
### React-intl example | ||
|
||
React-intl users MUST render/wrap components inside an IntlProvider like the example below: | ||
|
||
The example below example is a drop-in test for the RSK `Header` component: | ||
|
||
```js | ||
import React from 'react'; | ||
import Header from './Header'; | ||
import IntlProvider from 'react-intl'; | ||
import Navigation from '../../components/Navigation'; | ||
|
||
describe('A test suite for <Header />', () => { | ||
|
||
it('should contain a <Navigation/> component', () => { | ||
it('rendering', () => { | ||
const wrapper = renderIntoDocument(<IntlProvider locale="en"><Header /></IntlProvider>); | ||
expect(wrapper.find(Navigation)).to.have.length(1); | ||
}); | ||
}); | ||
|
||
}); | ||
``` | ||
|
||
Please note that NOT using IntlProvider will produce the following error: | ||
|
||
> Invariant Violation: [React Intl] Could not find required `intl` object. <IntlProvider> | ||
> needs to exist in the component ancestry. | ||
### Linting | ||
|
||
Running RSK eslint will also scan your test files: | ||
|
||
```bash | ||
npm run eslint | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this will run only |
||
``` | ||
|
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.
please, remove
+
signs (copied from diff probably) at beginning of lines