diff options
| author | Paul Slaughter <pslaughter@gitlab.com> | 2019-09-06 09:39:54 -0500 |
|---|---|---|
| committer | Paul Slaughter <pslaughter@gitlab.com> | 2019-09-09 08:50:40 -0500 |
| commit | 0dad0729b12833d3ebebe8e25ac8265871adb864 (patch) | |
| tree | 9546010d38d827f2ff8c8ceb5ef18461341dfb9f | |
| parent | 35023d435ddd4c4709f06ea24ebd92480a1a64cb (diff) | |
| download | gitlab-ce-docs-update-jest-with-when-to-use-section.tar.gz | |
Add when to use Jest section in frontend_testingdocs-update-jest-with-when-to-use-section
| -rw-r--r-- | doc/development/testing_guide/frontend_testing.md | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/development/testing_guide/frontend_testing.md b/doc/development/testing_guide/frontend_testing.md index 7dc89a3fcdb..386210bcb77 100644 --- a/doc/development/testing_guide/frontend_testing.md +++ b/doc/development/testing_guide/frontend_testing.md @@ -20,9 +20,18 @@ We have started to migrate frontend tests to the [Jest](https://jestjs.io) testi Jest tests can be found in `/spec/frontend` and `/ee/spec/frontend` in EE. -It is not yet a requirement to use Jest. You can view the -[epic](https://gitlab.com/groups/gitlab-org/-/epics/873) of issues -we need to solve before being able to use Jest for all our needs. +### When should I use Jest over Karma? + +If you need to update an existing Karma test file (found in `spec/javascripts`), you do not +need to migrate the whole spec to Jest. Simply updating the karma spec to test your change +is fine. It is probably more appropriate to migrate to Jest in a separate merge request. + +If you need to create a new test file, we strongly recommend creating one in Jest. This will +help support our migration and we think you'll love using Jest. + +As always, please use discretion. Jest solves a lot of issues we experienced in Karma and +provides a better developer experience, however there are potentially unexpected issues +which could arise (especially with testing against browser specific features). ### Differences to Karma |