[rb] add flaky condition to guards to mark unreliable tests

Author: titusfortner

rb/lib/selenium/webdriver/support/guards.rb

@@ -24,7 +24,7 @@ module Selenium
   module WebDriver
     module Support
       class Guards
-        GUARD_TYPES = %i[except only exclude exclusive].freeze
+        GUARD_TYPES = %i[except only exclude exclusive flaky].freeze
 
         attr_reader :messages
         attr_accessor :bug_tracker

rb/lib/selenium/webdriver/support/guards/guard.rb

@@ -53,7 +53,9 @@ def message
 
             case @type
             when :exclude
-              "Test not guarded because it breaks test run; #{details}"
+              "Test skipped because it breaks test run; #{details}"
+            when :flaky
+              "Test skipped because it is unreliable in this configuration; #{details}"
             when :exclusive
               "Test does not apply to this configuration; #{details}"
             else
@@ -71,9 +73,10 @@ def only?
             @type == :only
           end
 
-          # Bug is present on all configurations specified, but test can not be run because it breaks other tests
+          # Bug is present on all configurations specified, but test can not be run because it breaks other tests,
+          # or it is flaky and unreliable
           def exclude?
-            @type == :exclude
+            @type == :exclude || @type == :flaky
           end
 
           # Test only applies to configurations specified

rb/spec/integration/selenium/webdriver/guard_spec.rb

@@ -33,6 +33,12 @@ module Support
           end
         end
 
+        describe '#flaky' do
+          it 'skips without running', flaky: {browser: :chrome} do
+            raise 'This code will not get executed so it will not fail'
+          end
+        end
+
         describe '#exclusive' do
           it 'skips without running if it does not match', exclusive: {browser: :not_chrome} do
             raise 'This code will not get executed so it will not fail'

rb/spec/unit/selenium/webdriver/guard_spec.rb

@@ -26,10 +26,10 @@ module Support
       describe Guards do
         describe '#new' do
           it 'collects guards from example only for known guard types',
-             except: {}, exclude: {}, exclusive: {}, ignored: {}, only: {} do |example|
+             except: {}, exclude: {}, exclusive: {}, ignored: {}, only: {}, flaky: {} do |example|
             guards = described_class.new(example)
             types = guards.instance_variable_get(:@guards).map { |g| g.instance_variable_get(:@type) }
-            expect(types).to include :except, :only, :exclusive, :exclude
+            expect(types).to include :except, :only, :exclusive, :exclude, :flaky
             expect(types).not_to include :ignored
           end
 
@@ -190,7 +190,13 @@ module Support
           it 'has special message for exclude' do
             guard = described_class.new({reason: 'because'}, :exclude)
 
-            expect(guard.message).to eq('Test not guarded because it breaks test run; because')
+            expect(guard.message).to eq('Test skipped because it breaks test run; because')
+          end
+
+          it 'has special message for flaky' do
+            guard = described_class.new({reason: 'because'}, :flaky)
+
+            expect(guard.message).to eq('Test skipped because it is unreliable in this configuration; because')
           end
 
           it 'has special message for exclusive' do