Add documentation for long-form examples to testing guide
The following discussion from !92835 (merged) should be addressed:
-
@ddavison started a discussion: (+2 comments) Per the description -
we're using the most recent formatting practices
Do we have these practices documented somewhere? I'm can't seem to find them in the E2E Best Practices or the Testing Best Practices
🤔 (This is in reference to the multi-line RSpec method invocations)
Problem Statement
We have a short-form style of writing examples:
it 'does something', testcase: 'abc123' do
...
end
And a long-form style:
it(
'does something',
quarantine: { only: :production }
) do
...
end
To stay consistent with styles, we should add this to either a style guide, or best practices.
Proposal
Instead of adding to the end-to-end tests, perhaps we should start the best-practice earlier by changing https://docs.gitlab.com/ee/development/testing_guide/best_practices.html
Edited by Dan Davison