Skip to content

Commit a7e8939

Browse files
committed
Improve the testing documentation
Signed-off-by: Rémy Coutable <[email protected]>
1 parent 6de5aad commit a7e8939

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

doc/development/testing.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -95,29 +95,6 @@ possible).
9595
[Poltergeist]: https://github.com/teamcapybara/capybara#poltergeist
9696
[RackTest]: https://github.com/teamcapybara/capybara#racktest
9797

98-
### Black-box tests or End-to-end tests
99-
100-
GitLab consists of [multiple pieces] such as [GitLab Shell], [GitLab Workhorse],
101-
[Gitaly], [GitLab Pages], [GitLab Runner], and GitLab Rails. All theses pieces
102-
are configured and packaged by [GitLab Omnibus].
103-
104-
[GitLab QA] is a tool that allows to test that all these pieces integrate well
105-
together by building a Docker image for a given version of GitLab Rails and
106-
running feature tests (i.e. using Capybara) against it.
107-
108-
The actual test scenarios and steps are [part of GitLab Rails] so that they're
109-
always in-sync with the codebase.
110-
111-
[multiple pieces]: ./architecture.md#components
112-
[GitLab Shell]: https://gitlab.com/gitlab-org/gitlab-shell
113-
[GitLab Workhorse]: https://gitlab.com/gitlab-org/gitlab-workhorse
114-
[Gitaly]: https://gitlab.com/gitlab-org/gitaly
115-
[GitLab Pages]: https://gitlab.com/gitlab-org/gitlab-pages
116-
[GitLab Runner]: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner
117-
[GitLab Omnibus]: https://gitlab.com/gitlab-org/omnibus-gitlab
118-
[GitLab QA]: https://gitlab.com/gitlab-org/gitlab-qa
119-
[part of GitLab Rails]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/qa
120-
12198
#### Best practices
12299

123100
- Create only the necessary records in the database
@@ -150,6 +127,29 @@ The reasons why we should follow these best practices are as follows:
150127
of tests). This is slower than transactions, however, so we want to use
151128
truncation only when necessary.
152129

130+
### Black-box tests or End-to-end tests
131+
132+
GitLab consists of [multiple pieces] such as [GitLab Shell], [GitLab Workhorse],
133+
[Gitaly], [GitLab Pages], [GitLab Runner], and GitLab Rails. All theses pieces
134+
are configured and packaged by [GitLab Omnibus].
135+
136+
[GitLab QA] is a tool that allows to test that all these pieces integrate well
137+
together by building a Docker image for a given version of GitLab Rails and
138+
running feature tests (i.e. using Capybara) against it.
139+
140+
The actual test scenarios and steps are [part of GitLab Rails] so that they're
141+
always in-sync with the codebase.
142+
143+
[multiple pieces]: ./architecture.md#components
144+
[GitLab Shell]: https://gitlab.com/gitlab-org/gitlab-shell
145+
[GitLab Workhorse]: https://gitlab.com/gitlab-org/gitlab-workhorse
146+
[Gitaly]: https://gitlab.com/gitlab-org/gitaly
147+
[GitLab Pages]: https://gitlab.com/gitlab-org/gitlab-pages
148+
[GitLab Runner]: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner
149+
[GitLab Omnibus]: https://gitlab.com/gitlab-org/omnibus-gitlab
150+
[GitLab QA]: https://gitlab.com/gitlab-org/gitlab-qa
151+
[part of GitLab Rails]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/qa
152+
153153
## How to test at the correct level?
154154

155155
As many things in life, deciding what to test at each level of testing is a

0 commit comments

Comments
 (0)