Adding a CONTRIBUTING file with a strategy for implementing tests #774
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
mattcorner
reviewed
Nov 29, 2023
|
|
||
| Playwright tests should be added when you need to test the functionality of your application in a real browser environment. These tests are essential for assessing your application in an actual browser setting. They are ideal for scenarios involving user interactions, DOM testing, and other browser-dependent functionalities. Playwright is particularly effective for end-to-end testing, ensuring the user's overall experience with the application is as intended. | ||
|
|
||
| On the other hand, Jest tests are more suitable for unit testing JavaScript or TypeScript code. These tests focus on evaluating individual functions or components in isolation, bypassing the need for a browser. Jest tests are generally quicker and more concentrated, perfect for examining the internal logic of your application's code. |
There was a problem hiding this comment.
We should maybe expand on this a bit more with some examples. As a UI component library it kind of reads like everything should be a playwright test unless its a plain javascript utility function, but its more subtle than that.
Some examples of valid Jest tests that I can think of:
- Testing react hooks that do not interact with the dom. e.g. useVehicleSelection
- Testing components with no / little user interactivity e.g. Copyright
- Testing component styling e.g. ColorModeToggle
Listing some examples here will hopefully paint a better picture for developers when deciding which testing framework to use. We should include some good playwright case example too. e.g.
Some strong cases for Playwright tests that I can think of:
- Testing interactions that rely on browser dom functionality such as clientWidth. e.g. TextOverflowTooltip which is untestable in jest.
- Testing component workflows that rely on a lot of user inteaction e.g. VehicleSelect
There was a problem hiding this comment.
This is a great suggestion that did not occur to us. Thanks Matt. I'll add it in.
mattcorner
approved these changes
Nov 30, 2023
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.
Changes
Introduction of a
CONTRIBUTING.mdfile to IPG-Automotive/react-ui where the definition of which test framework will be used to perform tests on componentsAuthor checklist before assigning a reviewer
Branch has been run in docker.Appropriate tests have been added.