2020-10-30 18:08:56 +00:00
---
stage: none
group: unassigned
2022-09-21 21:13:33 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-10-30 18:08:56 +00:00
---
2017-10-11 05:59:34 +00:00
# Testing standards and style guidelines
This document describes various guidelines and best practices for automated
testing of the GitLab project.
2022-08-24 00:12:25 +00:00
It is meant to be an _extension_ of the
2022-08-08 03:09:21 +00:00
[Thoughtbot testing style guide ](https://github.com/thoughtbot/guides/tree/master/testing-rspec ). If
2021-02-04 21:09:06 +00:00
this guide defines a rule that contradicts the Thoughtbot guide, this guide
2017-10-11 05:59:34 +00:00
takes precedence. Some guidelines may be repeated verbatim to stress their
importance.
## Overview
2020-04-21 15:21:10 +00:00
GitLab is built on top of [Ruby on Rails ](https://rubyonrails.org/ ), and we're using [RSpec ](https://github.com/rspec/rspec-rails#feature-specs ) for all
the backend tests, with [Capybara ](https://github.com/teamcapybara/capybara ) for end-to-end integration testing.
2021-09-03 15:10:48 +00:00
On the frontend side, we're using [Jest ](https://jestjs.io/ ) for JavaScript unit and
2017-10-11 05:59:34 +00:00
integration testing.
Following are two great articles that everyone should read to understand what
automated testing means, and what are its principles:
2019-09-27 12:06:07 +00:00
- [Five Factor Testing ](https://madeintandem.com/blog/five-factor-testing/ ): Why do we need tests?
2020-06-04 21:08:11 +00:00
- [Principles of Automated Testing ](https://www.lihaoyi.com/post/PrinciplesofAutomatedTesting.html ): Levels of testing. Prioritize tests. Cost of tests.
2017-10-11 05:59:34 +00:00
## [Testing levels](testing_levels.md)
Learn about the different testing levels, and how to decide at what level your
changes should be tested.
## [Testing best practices](best_practices.md)
2019-03-26 19:40:10 +00:00
Everything you should know about how to write good tests: Test Design, RSpec, FactoryBot,
2017-10-11 05:59:34 +00:00
system tests, parameterized tests etc.
## [Frontend testing standards and style guidelines](frontend_testing.md)
2021-09-03 15:10:48 +00:00
Everything you should know about how to write good Frontend tests: Jest,
2017-10-11 05:59:34 +00:00
testing promises, stubbing etc.
## [Flaky tests](flaky_tests.md)
What are flaky tests, the different kind of flaky tests we encountered, and what
we do about them.
2021-10-13 12:12:20 +00:00
## [GitLab pipelines](../pipelines.md)
2017-10-11 05:59:34 +00:00
How GitLab test suite is run in the CI context: setup, caches, artifacts,
parallelization, monitoring.
2018-09-06 19:28:23 +00:00
## [Review apps](review_apps.md)
How review apps are set up for GitLab CE/EE and how to use them.
2017-10-11 05:59:34 +00:00
## [Testing Rake tasks](testing_rake_tasks.md)
Everything you should know about how to test Rake tasks.
2019-05-22 01:34:12 +00:00
## [End-to-end tests](end_to_end/index.md)
2017-12-20 13:05:02 +00:00
2018-01-02 13:22:48 +00:00
Everything you should know about how to run end-to-end tests using
2020-06-03 21:08:23 +00:00
[GitLab QA ](https://gitlab.com/gitlab-org/gitlab-qa ) testing framework.
2017-12-20 13:05:02 +00:00
2019-10-04 12:06:14 +00:00
## [Migrations tests](testing_migrations_guide.md)
Everything you should know about how to test migrations.
2022-06-14 06:09:22 +00:00
## [Contract tests](contract/index.md)
Introduction to contract testing, how to run the tests, and how to write them.
2021-06-28 12:38:12 +00:00
[Return to Development documentation ](../index.md )
