debian-mirror-gitlab/doc/development/testing_guide/index.md

68 lines
2.6 KiB
Markdown
Raw Normal View History

2018-03-17 18:26:18 +05:30
# Testing standards and style guidelines
This document describes various guidelines and best practices for automated
testing of the GitLab project.
It is meant to be an _extension_ of the [thoughtbot testing
2020-05-24 23:13:21 +05:30
style guide](https://github.com/thoughtbot/guides/tree/master/style/testing). If
2018-03-17 18:26:18 +05:30
this guide defines a rule that contradicts the thoughtbot guide, this guide
takes precedence. Some guidelines may be repeated verbatim to stress their
importance.
## Overview
2020-05-24 23:13:21 +05:30
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.
2019-12-04 20:38:33 +05:30
On the frontend side, we're using [Jest](https://jestjs.io/) and [Karma](http://karma-runner.github.io/)/[Jasmine](https://jasmine.github.io/) for JavaScript unit and
2018-03-17 18:26:18 +05:30
integration testing.
Following are two great articles that everyone should read to understand what
automated testing means, and what are its principles:
2019-12-21 20:55:43 +05:30
- [Five Factor Testing](https://madeintandem.com/blog/five-factor-testing/): Why do we need tests?
2020-06-23 00:09:42 +05:30
- [Principles of Automated Testing](https://www.lihaoyi.com/post/PrinciplesofAutomatedTesting.html): Levels of testing. Prioritize tests. Cost of tests.
2018-03-17 18:26:18 +05:30
## [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-07-07 11:18:12 +05:30
Everything you should know about how to write good tests: Test Design, RSpec, FactoryBot,
2018-03-17 18:26:18 +05:30
system tests, parameterized tests etc.
## [Frontend testing standards and style guidelines](frontend_testing.md)
Everything you should know about how to write good Frontend tests: Karma,
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.
## [GitLab tests in the Continuous Integration (CI) context](ci.md)
How GitLab test suite is run in the CI context: setup, caches, artifacts,
parallelization, monitoring.
2018-12-05 23:21:45 +05:30
## [Review apps](review_apps.md)
How review apps are set up for GitLab CE/EE and how to use them.
2018-03-17 18:26:18 +05:30
## [Testing Rake tasks](testing_rake_tasks.md)
Everything you should know about how to test Rake tasks.
2019-09-04 21:01:54 +05:30
## [End-to-end tests](end_to_end/index.md)
2018-03-17 18:26:18 +05:30
Everything you should know about how to run end-to-end tests using
2020-06-23 00:09:42 +05:30
[GitLab QA](https://gitlab.com/gitlab-org/gitlab-qa) testing framework.
2018-03-17 18:26:18 +05:30
2019-12-21 20:55:43 +05:30
## [Migrations tests](testing_migrations_guide.md)
Everything you should know about how to test migrations.
2018-03-17 18:26:18 +05:30
[Return to Development documentation](../README.md)