Commit Graph

271 Commits

Author SHA1 Message Date
ddavison e61495610d
Documentation for dynamic element validation
First iteration on the documentation for how
dynamic element validation works within the
GitLab QA framework and how to utilize it
2019-06-05 16:14:47 -07:00
ddavison eb066f649b
Consolidate documentation written for e2e tests under dev docs
Previously the documentation was separated.  If we want to bake
quality into the product, how better than to include everything
we use directly in the development documentation

Signed-off-by: ddavison <ddavison@gitlab.com>

Fix broken internal doc link

Move documentation for page objects to the e2e section
2019-05-30 22:10:33 -07:00
Winnie Hellmann 37fae2de11 Add documentation for frontend fixtures 2019-05-27 23:59:26 +00:00
Achilleas Pipinellis 8ec7ecf0bc
Use relative URLs in development docs
This is part of https://gitlab.com/gitlab-org/gitlab-ce/issues/61945
2019-05-27 11:13:40 -04:00
Rémy Coutable 0c9b9a70f4
Document the on-demand run of MySQL tests
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-05-22 21:47:32 +02:00
Rémy Coutable 6145ddf515
Revert "Merge branch 'revert-04c3c6dd' into 'master'"
This reverts commit 744f1f2e70, reversing
changes made to c4d930e5f5.
2019-05-22 21:47:32 +02:00
Kamil Trzciński 4f20c9de6f Revert "Merge branch 'reorganize-tests-jobs-by-level' into 'master'"
This reverts merge request !27514
2019-05-22 11:45:46 +00:00
Kamil Trzciński 04c3c6dd5a Merge branch 'reorganize-tests-jobs-by-level' into 'master'
Reorganize test jobs by level

See merge request gitlab-org/gitlab-ce!27514
2019-05-22 10:21:38 +00:00
Winnie Hellmann e1b3162739 Document the differences between Karma and Jest setup 2019-05-21 18:38:27 +00:00
Rémy Coutable 4d9c76e9e4
Reorganize test jobs by level
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-05-20 14:31:58 +02:00
Luke Duncalfe db7dabea67 Link to testing guide for feature flag spec info
In order for there to be a single source of truth.
2019-05-17 18:36:52 +00:00
Rémy Coutable 3889163386
Document what to do if review jobs keep failing
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-05-16 17:28:23 +02:00
Winnie Hellmann a0c4645257 Provide alternatives to using setTimeout in frontend tests 2019-05-09 00:20:41 +02:00
Evan Read c135061ff9 Avoid links requiring permissions 2019-04-29 09:33:08 +00:00
Rémy Coutable a374131b1e
Update development Review Apps documentation with the latest changes
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-04-24 19:25:37 +02:00
Rémy Coutable b16ee077ff
Better document the current states of our testing levels
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-04-17 15:50:10 +02:00
Rémy Coutable 78654a8c6a
Add missing team and stage labels in the workflow labels doc
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-04-10 17:53:15 +02:00
Heinrich Lee Yu 84ec11131d Add doc when rspec-set won't work 2019-04-05 20:41:58 +08:00
Rémy Coutable bd3a12bdc0
Improve the Review Apps documentation by using gitlab-rails console
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-04-04 17:49:09 +02:00
Simon Knox f54e4eb10f Add docs for debugging Jest tests 2019-04-03 12:50:30 +00:00
Rémy Coutable 1e3c09d8ef
Document the branch naming conventions for QA-only changes
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-03-28 11:47:22 +01:00
Zeff Morgan 127828c64a Update testing guide to reference test design 2019-03-26 15:40:10 -04:00
Rémy Coutable 4793b2818b
Mention review-qa-all in the end-to-end tests documentation
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-03-25 12:27:03 +01:00
Clement Ho c238ba7f73 Merge branch 'winh-yarn-test-command' into 'master'
Introduce yarn test to run Jest and Karma

See merge request gitlab-org/gitlab-ce!26320
2019-03-20 15:49:12 +00:00
Winnie Hellmann 4fca4b79f5 Update docs on running frontend tests 2019-03-19 22:19:05 +01:00
Winnie Hellmann 00db78214c Remove static HAML fixtures from frontend testing guide 2019-03-19 16:54:41 +01:00
Mek Stittri 297ce3e586 Merge branch 'docs-improve-package-and-qa-documentation' into 'master'
Document better the package-and-qa job

See merge request gitlab-org/gitlab-ce!25978
2019-03-15 15:46:39 +00:00
Marcel Amirault 4478fc37fb Docs: Fix a link that fails the link test 2019-03-15 05:10:56 +00:00
Luke Bennett 14f625b35b Fix jest link in frontend_testing.md 2019-03-13 21:09:35 +00:00
Rémy Coutable d19c60be2a
Document better the package-and-qa job
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-03-13 11:32:27 +01:00
Luke Bennett b1184de452 Update setTestTimeout documentation 2019-03-12 03:00:12 +00:00
Luke Bennett cef55d9d29 Remove polyfill warnings from the FE testing docs 2019-03-11 14:23:45 +00:00
Mike Lewis 5e0beb39bb Merge branch 'jest-docs' into 'master'
Add jest to frontend_testing docs

See merge request gitlab-org/gitlab-ce!25748
2019-03-07 15:54:53 +00:00
Luke Bennett a69e191bd5 Apply suggestion to doc/development/testing_guide/frontend_testing.md 2019-03-07 12:24:13 +00:00
Marcel Amirault 9c8dc7ddf6 Docs: Fix broken anchors in development docs 2019-03-05 13:06:32 +00:00
Luke Bennett c82758263a
Add jest to frontend_testing docs 2019-03-04 22:55:52 +00:00
Douwe Maan 7d1216016c Merge branch 'patch-31' into 'master'
Update best_practices.md let section to also reference let! variables.

See merge request gitlab-org/gitlab-ce!22496
2019-02-28 13:24:23 +00:00
Ramya Authappan 68cafb38ee Enabling performance metrics on Review Apps 2019-02-28 10:14:19 +00:00
Stan Hu bea565cacc Bring back mentions of Redash
This reverts commit 676e0a3260.
It was removed when we thought we were moving to Looker.
2019-02-27 14:04:18 -08:00
Evan Read eb86630959 Ensure all lists are surrounded by new lines
Markdown renderers find it easier to determine
where lists start and end when lists are surrounded
by new lines.

For consistency, also ensure entries in the list
are aligned when they span multipls lines.
2019-02-22 13:17:10 +00:00
Douglas Barbosa Alexandre 7ff0c8ae57 Merge branch 'ce-9858-follow-up-on-a-bug-that-happens-when-using-a-factory-built-object-in-the-where-block-of-rspec-parameterized-tablesyntax' into 'master'
Fix and document an RSpec::Parameterized::TableSyntax edge-case

See merge request gitlab-org/gitlab-ce!25438
2019-02-21 19:57:14 +00:00
Luke Bennett cb28bcf568 Separate spyOnDependency docs examples 2019-02-21 03:47:08 +00:00
Rémy Coutable b85b6590e5
Fix and document an RSpec::Parameterized::TableSyntax edge-case
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-02-20 19:51:26 +01:00
Rémy Coutable cc64ce8a15
Document how to enable feature flags on Review Apps
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-02-20 19:11:25 +01:00
Mark Lapierre 75b2df681b Update QA docs
Use consistent language (end-to-end instead of integration).

Clarify purpose of `qa/specs/features/` vs. `spec`
2019-02-19 21:44:08 +00:00
Rémy Coutable ef33aee260
Improve the Review Apps documentation
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-02-12 14:47:33 +01:00
Marcel Amirault 9d6a8003e0 Docs: Realign more CE docs that diverged from EE unnecessarily (second MR) 2019-02-12 12:39:48 +00:00
Rémy Coutable f8a10191f0
Use $CI_COMMIT_REF_NAME for tags in trigger-build
Also, pass GITLAB_VERSION and GITLAB_ASSETS_TAG to CNG triggered
pipelines.

Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-01-24 08:43:11 +01:00
Evan Read c2c2d04b3a Fix most instances of bare URLs in markdown 2019-01-24 06:52:33 +00:00
Rémy Coutable 29e5cd5f8d
Improve Review Apps documentation
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-01-23 16:47:46 +01:00
Rémy Coutable 41fba95757 Apply suggestion to doc/development/testing_guide/flaky_tests.md 2019-01-17 11:29:57 +00:00
Rémy Coutable e6dea31365
Document better the process around quarantined tests
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-01-17 11:23:36 +01:00
Rémy Coutable 642bd8ce29
Allow to quarantine tests
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-01-15 14:43:02 +01:00
Evan Read d98560c1f5 Make unordered lists conform to styleguide
- Also makes other minor Markdown fixes that were near the main fixes.
2019-01-08 12:21:09 +10:00
Sam Bigelow 8b7aa1e443 Update best_practices.md 2018-12-12 20:54:44 +00:00
Sam Bigelow 78cad022cb Document how to run rspec tests 2018-12-12 20:49:17 +00:00
Douglas Barbosa Alexandre e80f89337b Merge branch '54610-allow-review-jobs-to-fail' into 'master'
Retry the review-{deploy,qa} jobs twice, and allow them to fail

Closes #54610 and #54717

See merge request gitlab-org/gitlab-ce!23510
2018-12-06 17:49:20 +00:00
Rémy Coutable 75ae3af19b
Add an 'How-To' section to the Review Apps doc
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-12-06 10:06:15 +01:00
Stan Hu 676e0a3260 Remove mentions of Redash
Related links:

* https://gitlab.com/gitlab-com/Product/issues/5
* https://gitlab.com/meltano/looker/issues/294
2018-12-05 10:34:16 -08:00
Sean McGivern e8db29d086 Merge branch '49570-add-review_qa-job' into 'master'
Add an automatic job to run QA smoke tests against Review Apps

Closes #49570

See merge request gitlab-org/gitlab-ce!22853
2018-11-28 10:39:56 +00:00
Rémy Coutable f4b8ecbf9f
Add a manual job to run QA against a Review App
1. Renames review to review-deploy.
2. Renames stop_review to review-stop.
3. Adds a build-qa-image job to the prepare stage and save the QA
  Docker image as artifact (example:
  https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/120967019).
4. Adds a manual review-qa job to the test stage to run QA tests
  against the Review App (example:
  https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/120967238).
5. Make the review-deploy job plays the review-qa job as soon as the
  Review App is deployed (example:
  https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/120988775).
6. Updates the Review Apps documentation accordingly.

Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-11-26 14:49:03 +01:00
Takuya Noguchi e238882d0c Eliminate duplicated words
Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>
2018-11-22 15:44:32 +09:00
George Tsiolis d2d8b935e2 Fix typos in docs 2018-11-16 12:05:55 +02:00
Mek Stittri 03e46cf72b Merge branch 'docs-quality/team-tasks-24' into 'master'
Improve the 'Testing levels' documentation

Closes gitlab-org/quality/team-tasks#24

See merge request gitlab-org/gitlab-ce!21505
2018-11-13 00:29:16 +00:00
Rémy Coutable 1813bb989b
Improve the Review Apps documentation a bit
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-11-08 20:00:49 +01:00
Rémy Coutable 35616708ff
Improve the 'Testing levels' documentation
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-11-06 22:17:38 +01:00
Mark Lapierre 25be3f83af Fix Review Apps testing guide
Changes from docs review
2018-10-29 20:10:56 +00:00
Mark Lapierre df17f35528 Update review apps testing guide
Review Apps are now deployed automatically.
Note that if auth fails you might need to stop and redeploy the app.
2018-10-26 15:17:54 +00:00
Rémy Coutable 173b1436b1 Merge branch '51366-custom-repos-trait-docs' into 'master'
Document the :repository and :custom_repo traits

Closes #51366

See merge request gitlab-org/gitlab-ce!22480
2018-10-22 06:47:58 +00:00
Nick Thomas a5ee4e0d7b
Document how GitLab keeps its tests pristine 2018-10-19 18:08:41 +01:00
Artur Martsinkovskyi cb275a33e3 Update best_practices.md let section to also reference let! variables. 2018-10-19 15:38:30 +00:00
Nick Thomas 2953798e7e
Document the :repository and :custom_repo traits 2018-10-19 03:09:37 +01:00
Dylan Griffith f5f5d6ea1f Resolve "Un-vendor CI templates" 2018-09-26 15:39:27 +00:00
Rémy Coutable 03b0d3d6bb
Document review apps setup for gitlab-{ce,ee}
Signed-off-by: Rémy Coutable <remy@rymai.me>
Signed-off-by: ddavison <ddavison@gitlab.com>
2018-09-17 13:40:14 -04:00
Brett Walker b0be58a1b3 Resolve "CE documentation is not CommonMark compliant" 2018-09-06 16:52:18 +00:00
Dan Davison d67936b68f add initial smoke tests and documentation 2018-08-20 18:13:54 +00:00
Toon Claes 13afac6533 First version of pry_debugging.md 2018-07-20 11:56:17 +02:00
Winnie Hellmann d8013704b6 Document that we don't want to wait in tests 2018-07-09 14:53:33 +00:00
Winnie Hellmann 0fbd948b8d Add link to hack for styling Capybara HTML dumps 2018-05-31 14:03:46 +00:00
Rémy Coutable 920becb784 Merge branch 'backstage/gb/improve-fast-specs-helper' into 'master'
Improve fast specs helper to autoload the library

See merge request gitlab-org/gitlab-ce!18903
2018-05-15 13:27:04 +00:00
Grzegorz Bizon 7186f0de65 Improve testing best practices guidelines
It mentions that explicitly defining dependencies in sources is
preferred over defining such dependencies only in spec files.
2018-05-15 14:43:39 +02:00
Grzegorz Bizon d134c0fb70 Update docs describing `fast_spec_helper` best practices 2018-05-15 10:38:00 +02:00
blackst0ne c3882c2611 Clean up docs 2018-05-14 18:53:57 +11:00
Stan Hu 204af2e101 Support resetting of Prometheus metrics between test runs
Adding the :prometheus tag to an rspec test will clear out
memory-mapped files and reset the registry.

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/39968
2018-05-09 14:33:42 -07:00
Mike Greiling 6b1e4ad5e8 Fix memory and performance issues in Karma test suite 2018-05-01 17:40:35 +00:00
Pascal Borreli 12e3eff462 Fixed typos 2018-04-27 08:50:05 +00:00
Clement Ho b173e56461 Merge branch '30998-add-babel-rewire-plugin' into 'master'
Resolve "Add some way to mock and spy on default ES modules"

Closes #30998

See merge request gitlab-org/gitlab-ce!18116
2018-04-24 14:00:59 +00:00
Michael Kozono 407a800456 Add Capybara debugging methods to docs 2018-04-23 19:52:45 +00:00
Rémy Coutable 5b44097cf7
Address latest feedback
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-04-23 13:02:07 +02:00
Rémy Coutable fe919f95b1
Document the new 'spec/fast_spec_helper.rb' file
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-04-23 12:20:30 +02:00
Rémy Coutable 023d4f6f2f
Move spec helpers/matchers/shared examples/contexts to their relevant folder
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-04-23 12:20:30 +02:00
Mike Greiling 44783480be
document the spyOnDependency method 2018-04-23 00:54:21 -05:00
Grzegorz Bizon 27a5deea38 Rename #qa slack channel to #quality in docs 2018-04-19 09:28:08 +02:00
Lukas Eipert bd1b2c665f
use commander for safer cli argument parsing 2018-04-11 00:34:18 +02:00
Lukas Eipert 029180f016
add documentation for karma testing with specific files/folders 2018-04-10 12:03:46 +02:00
Toon Claes 88dffa45ce Rename `package-qa` in docs
In gitlab-org/gitlab-ce!17807 the `package-qa` job was renamed to
`package-and-qa`. But it was not renamed in the docs. So this change
fixes that.
2018-03-19 10:04:23 +01:00
Rémy Coutable 2bdb578032
Port some RuboCop and doc changes from EE
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-02-13 16:33:00 +01:00
Clement Ho b593565538 Add note about live_debug only working on javascript enabled specs 2018-01-22 17:50:39 +00:00
Anwar El Wakil 408e3cc1c4 Update best_practices.md
Remove duplicate list item in "General Guidelines" Section.
2018-01-19 13:15:35 +00:00
Andrew Newdigate 0cc25f0f1b Update end_to_end_tests.md 2018-01-11 12:05:55 +00:00
Grzegorz Bizon 8bdc6c74e8 Rephrase paragraph about e2e tests in merge requests in docs 2018-01-05 15:32:41 +01:00
Grzegorz Bizon e8acb3f117 Copy-edit end-to-end testing guide documentation 2018-01-04 12:09:14 +01:00
Grzegorz Bizon 124ffb2134 Fix link to end-to-end testing docs from test pyramid 2018-01-02 14:42:28 +01:00
Grzegorz Bizon 1aa25a3fe3 Copy-edit end-to-end testing guidelines 2018-01-02 14:37:01 +01:00
Grzegorz Bizon 51bb5abe26 Link to end to end test guideline from test pyramid 2018-01-02 14:30:29 +01:00
Grzegorz Bizon 629d966c48 Extend documentation on end-to-end integration tests 2018-01-02 14:22:48 +01:00
Grzegorz Bizon 1f50eb4f57 Add docs about end-to-end testing / GitLab QA tests 2018-01-02 13:39:09 +01:00
Rémy Coutable 4af9d592c5 Replace factory_girl_rails with factory_bot_rails
I've followed the [upgrade guide](https://github.com/thoughtbot/factory_bot/blob/4-9-0-stable/UPGRADE_FROM_FACTORY_GIRL.md) and ran these two commands:

```
grep -e FactoryGirl **/*.rake **/*.rb -s -l | xargs sed -i "" "s|FactoryGirl|FactoryBot|"
grep -e factory_girl **/*.rake **/*.rb -s -l | xargs sed -i "" "s|factory_girl|factory_bot|"
```

Signed-off-by: Rémy Coutable <remy@rymai.me>
2017-12-14 15:01:55 +01:00
Marcia Ramos 506a4e7530 Merge branch 'docs/gitlab-runner' into 'master'
Change to new GitLab Runner name

Closes #39636

See merge request gitlab-org/gitlab-ce!15101
2017-11-02 12:33:35 +00:00
Douwe Maan 4d6830ec50 Merge branch 'patch-28' into 'master'
Add debugging section to testing_guide/best_practices.md.

See merge request gitlab-org/gitlab-ce!14858
2017-11-02 11:58:54 +00:00
Rémy Coutable 0364e07447
Address Douwe's feedback
Signed-off-by: Rémy Coutable <remy@rymai.me>
2017-11-02 12:02:51 +01:00
Achilleas Pipinellis 69b4c5c011 Exclude comments from specific docs 2017-11-01 15:56:40 +00:00
Achilleas Pipinellis 6bd2d594d7
Change to new GitLab Runner name 2017-10-31 11:20:40 +02:00
Rémy Coutable 1c17ddba66
Simplify the live debugger resume mechanism: press any key
Signed-off-by: Rémy Coutable <remy@rymai.me>
2017-10-26 18:03:33 +02:00
Eric Eastwood 43377979c6 Check for element before evaluate_script
Tip from
https://robots.thoughtbot.com/write-reliable-asynchronous-integration-tests-with-capybara#directly-interacting-with-javascript
2017-10-19 14:01:15 -05:00
Rémy Coutable a3368a988d
Improve the LiveDebugger exit handler and documentation
Signed-off-by: Rémy Coutable <remy@rymai.me>
2017-10-17 17:42:21 +02:00
Rémy Coutable 9bccea6e34
Add LiveDebugger#live_debug to debug Capybara in feature tests.
Signed-off-by: Rémy Coutable <remy@rymai.me>
2017-10-16 10:50:12 +02:00
Clement Ho 88bd5fa274 Update best_practices.md 2017-10-12 21:38:52 +00:00
Fatih Acet 77d636cc16 Add debugging section to testing_guide/best_practices.md. 2017-10-12 21:29:32 +00:00
Rémy Coutable 9e5cb67e9d
Fix a missing link and create a separate "Testing guides" section
Signed-off-by: Rémy Coutable <remy@rymai.me>
2017-10-11 16:33:57 +02:00
Rémy Coutable 676840ff9c Refactor the Development documentation, and divide the Testing documentation into multiple pages 2017-10-11 05:59:34 +00:00