[docs] Add testing section #7101
Merged
Conversation
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
Member
oliviertassinari
commented
Jun 10, 2017
•
oliviertassinari
commented
- Yes, 97% coverage 馃槏 .
- Normalise the badges with shields
- Normalise and clean the test API
- Closes Material UI components complicate testing of other (general) components significantly聽#4664
oliviertassinari
added
docs
mbrookes
reviewed
Jun 10, 2017
| ## Internal | ||
|
|
||
| We take tests seriously, we have written and we maintain **a wide range** of tests so we can | ||
| iterate with confidence on the components. For instance, the visual regression tests provided by [Argos-CI](https://www.argos-ci.com/callemall/material-ui) have proven to be really helpful. |
There was a problem hiding this comment.
馃槃 Well I guess you deserve the link juice!
There was a problem hiding this comment.
Thanks for the review 馃
docs/src/pages/guides/testing.md
Outdated
|
|
||
| ## Userspace | ||
|
|
||
| But what about writing tests in userspace? Material-UI styling infrastructure relies on the context feature of React to work correcly. You are going to need that context when testing your react components with ours. |
docs/src/pages/guides/testing.md
Outdated
| ### Shallow rendering | ||
|
|
||
| Shallow rendering is useful to constrain yourself to testing a component as a unit, and to ensure that your tests aren't indirectly asserting on behavior of child components. | ||
| We expose a `createShallow()` function for that situation. However, you will most likely not need it for most of the simple situations. |
There was a problem hiding this comment.
'this situation'
'not need it most of the time.'
docs/src/pages/guides/testing.md
Outdated
| ### Full DOM rendering | ||
|
|
||
| Full DOM rendering is ideal for use cases where you have components that may interact with DOM APIs, or may require the full lifecycle in order to fully test the component (i.e., `componentDidMount` etc.). | ||
| We expose a `createMount()` function for that situation. |
docs/src/pages/guides/testing.md
Outdated
|
|
||
| Rendering to string is useful to test the behavior of the components that are used on the server. | ||
| You can take advantage of it to assert the generated HTML string. | ||
| We expose a `createRender()` function for that sitation. |
docs/src/pages/guides/testing.md
Outdated
| ### `createShallow([options]) => shallow` | ||
|
|
||
| Generate an enhanced shallow function with the needed context. | ||
| You can find the API of the `shallow` function following [that link](http://airbnb.io/enzyme/docs/api/shallow.html). |
There was a problem hiding this comment.
'this link' (although good practice is that the anchor text is somewhat descriptive of the target: 'Please refer to the API documentation for further details of the shallow function.'
docs/src/pages/guides/testing.md
Outdated
| ### `createMount([options]) => mount` | ||
|
|
||
| Generate an enhanced mount function with the needed context. | ||
| You can find the API of the `mount` function following [that link](http://airbnb.io/enzyme/docs/api/mount.html). |
docs/src/pages/guides/testing.md
Outdated
| ### `createRender([options]) => render` | ||
|
|
||
| Generate a render to string function with the needed context. | ||
| You can find the API of the `render` function following [that link](http://airbnb.io/enzyme/docs/api/render.html). |
|
AND... it's gone :( |
|
@FDiskas What do you mean? |
|
Can't find this in v0.19.2 |
|
@FDiskas You will find it on the documentation of the v1-beta branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.