Skip to content

[QA] Replace all BUG_IN_CODE comments with type: :bug

Summary

Our current quarantining process dictates that we add a comment to our ruby code using

# BUG_IN_CODE

We should change this to use the new quarantine message hash.

Improvements

Before

# BUG_IN_CODE
it 'is quarantined', quarantine: 'https://gitlab.com/gitlab-org/gitlab/issues/12345'
  ...
end

After

it 'is quarantined', quarantine: { issue: 'https://gitlab.com/gitlab-org/gitlab/issues/12345', type: :bug }
  ...
end

Risks

Line length might present a problem, but I don't think we should keep a 80 char hard limit.

Involved components

  • qa/qa/specs/helpers/quarantine.rb
  • All specs that contain BUG_IN_CODE

Optional: Intended side effects

We will be able to pull reporting on example.metadata[:quarantine][:type] and sort on bugs.