kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Improve testing best practices guidelines

Browse source 
It mentions that explicitly defining dependencies in sources is
preferred over defining such dependencies only in spec files.
This commit is contained in:
Grzegorz Bizon 2018-05-15 13:34:49 +02:00
parent d134c0fb70
commit 7186f0de65
1 changed files with 5 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/development/testing_guide/best_practices.md
View file

@ -141,20 +141,14 @@ dependencies. `fast_spec_helper` also loads all ActiveSupport extensions,
including core extensions that are commonly used in the Rails environment.
Note that in some cases, you might still have to load some dependencies using
`require_dependency` in your `*_spec.rb` file, like when a code is using gems.
`require_dependency` when a code is using gems or a dependency is not located
in `lib/`.
For example, if you want to test your code that is calling the
`Gitlab::UntrustedRegexp` class, which under the hood uses `re2` library, you
should be able to define a test using follow code snippet.
```ruby
require 'fast_spec_helper'
require_dependency 're2'
describe Gitlab::MyModule::MyClass do
# ...
end
```
should either add `require_dependency 're2'` to files in your library that
need `re2` gem, to make this requirement explicit, or you can add it to the
spec itself, but the former is preferred.
It takes around one second to load tests that are using `fast_spec_helper`
instead of 30+ seconds in case of a regular `spec_helper`.