diff options
| author | Rémy Coutable <remy@rymai.me> | 2019-09-05 13:06:39 +0200 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2019-09-11 14:54:28 +0200 |
| commit | 5cb60a1f9875fcec0d1715801ab3b804084b9d4d (patch) | |
| tree | 539fb6b0a00c180d7dd95a2a749aab5d08fa0756 | |
| parent | 285910265eace3fedcf3cb28aa93054b24a07ceb (diff) | |
| download | gitlab-ce-22992-default-sidekiq-to-fake-mode-in-test-env.tar.gz | |
Document the new :sidekiq_inline trait22992-default-sidekiq-to-fake-mode-in-test-env
Signed-off-by: Rémy Coutable <remy@rymai.me>
| -rw-r--r-- | doc/development/testing_guide/best_practices.md | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/development/testing_guide/best_practices.md b/doc/development/testing_guide/best_practices.md index 0f982c3a48b..c75ee0f64bd 100644 --- a/doc/development/testing_guide/best_practices.md +++ b/doc/development/testing_guide/best_practices.md @@ -318,9 +318,16 @@ However, if a spec makes direct Redis calls, it should mark itself with the `:clean_gitlab_redis_queues` traits as appropriate. Sidekiq jobs are typically not run in specs, but this behaviour can be altered -in each spec through the use of `perform_enqueued_jobs` blocks. Any spec that -causes Sidekiq jobs to be pushed to Redis should use the `:sidekiq` trait, to -ensure that they are removed once the spec completes. +in each spec through the use of `perform_enqueued_jobs` blocks. +Any spec that causes Sidekiq jobs to be pushed to Redis should use the +`:sidekiq_inline` trait, to ensure that they are removed once the spec completes. + +The `:sidekiq_inline_tech_debt` trait was added when [Sidekiq inline mode was +changed to fake mode](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/31662) +to all the examples that needed Sidekiq to actually process jobs. Examples with +this trait should be either fixed to not rely on Sidekiq processing jobs, or their +`:sidekiq_inline_tech_debt` trait should be updated to `:sidekiq_inline` if the +processing of background jobs is needed/expected. #### Filesystem |