Merge branch 'qa-quarantine-tag-reporting' into 'master'

Add quarantine tag message

See merge request gitlab-org/gitlab!22641

qa/qa/specs/helpers/quarantine.rb

@@ -43,7 +43,23 @@ module QA::Specs::Helpers
         # the quarantined tests when they're not run so that we're aware of them
         skip("Only running tests tagged with :quarantine and any of #{included_filters.keys}") if should_skip_when_focused?(example.metadata, included_filters)
       else
-        skip('In quarantine') if example.metadata.key?(:quarantine)
+        if example.metadata.key?(:quarantine)
+          quarantine_message = %w(In quarantine)
+          quarantine_tag = example.metadata[:quarantine]
+
+          if !!quarantine_tag
+            quarantine_message << case quarantine_tag
+                                  when String
+                                    ": #{quarantine_tag}"
+                                  when Hash
+                                    ": #{quarantine_tag[:issue]}"
+                                  else
+                                    ''
+                                  end
+          end
+
+          skip(quarantine_message.join(' ').strip)
+        end
       end
     end
 

qa/spec/specs/helpers/quarantine_spec.rb

@@ -155,6 +155,26 @@ describe QA::Specs::Helpers::Quarantine do
 
         expect(group.examples.first.execution_result.status).to eq(:passed)
       end
+
+      context 'quarantine message' do
+        shared_examples 'test with quarantine message' do |quarantine_tag|
+          it 'outputs the quarantine message' do
+            group = describe_successfully do
+              it('is quarantined', quarantine: quarantine_tag) {}
+            end
+
+            expect(group.examples.first.execution_result.pending_message)
+              .to eq('In quarantine : for a reason')
+          end
+        end
+
+        it_behaves_like 'test with quarantine message', 'for a reason'
+
+        it_behaves_like 'test with quarantine message', {
+          issue: 'for a reason',
+          environment: [:nightly, :staging]
+        }
+      end
     end
 
     context 'with :quarantine focused' do