Refactor flaky specs skip

- define FLAKY_ENV const instead of flaky_env? helper
- use `:flaky` tag on examples to mark that it should be excluded on
  `FLAKY_ENV`, instead of `skip "..." if FLAKY_ENV`
- do not run tests coverage analysis on FLAKY_ENV

Author: ixti

spec/spec_helper.rb

@@ -1,30 +1,29 @@
 # frozen_string_literal: true
-# coding: utf-8
 
-require "simplecov"
-require "coveralls"
+# Are we in a flaky environment?
+FLAKY_ENV = defined?(JRUBY_VERSION) && ENV["CI"]
+
+unless FLAKY_ENV
+  require "simplecov"
+  require "coveralls"
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
-  [
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-)
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+    [
+      SimpleCov::Formatter::HTMLFormatter,
+      Coveralls::SimpleCov::Formatter
+    ]
+  )
 
-SimpleCov.start do
-  add_filter "/spec/"
-  minimum_coverage 80
+  SimpleCov.start do
+    add_filter "/spec/"
+    minimum_coverage 80
+  end
 end
 
 require "http"
 require "rspec/its"
 require "support/capture_warning"
 
-# Are we in a flaky environment?
-def flaky_env?
-  defined?(JRUBY_VERSION) && ENV["CI"]
-end
-
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
@@ -50,6 +49,7 @@ def flaky_env?
   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
   # get run.
   config.filter_run :focus
+  config.filter_run_excluding :flaky if FLAKY_ENV
   config.run_all_when_everything_filtered = true
 
   # Limits the available syntax to the non-monkey patched syntax that is recommended.

spec/support/http_handling_shared.rb

@@ -50,19 +50,15 @@
         context "of 0" do
           let(:read_timeout) { 0 }
 
-          it "times out" do
-            skip "flaky environment" if flaky_env?
+          it "times out", :flaky do
             expect { response }.to raise_error(HTTP::TimeoutError, /Read/i)
           end
         end
 
         context "of 2.5" do
           let(:read_timeout) { 2.5 }
 
-          it "does not time out" do
-            # TODO: investigate sporadic JRuby timeouts on CI
-            skip "flaky environment" if flaky_env?
-
+          it "does not time out", :flaky do
             expect { client.get("#{server.endpoint}/sleep").body.to_s }.to_not raise_error
           end
         end
@@ -96,10 +92,7 @@
 
         let(:read_timeout) { 2.5 }
 
-        it "does not timeout" do
-          # TODO: investigate sporadic JRuby timeouts on CI
-          skip "flaky environment" if flaky_env?
-
+        it "does not timeout", :flaky do
           client.get("#{server.endpoint}/sleep").body.to_s
           client.get("#{server.endpoint}/sleep").body.to_s
         end
@@ -130,9 +123,7 @@
       end
 
       context "on a mixed state" do
-        it "re-opens the connection" do
-          skip "flaky environment" if flaky_env?
-
+        it "re-opens the connection", :flaky do
           first_socket_id = client.get("#{server.endpoint}/socket/1").body.to_s
 
           client.instance_variable_set(:@state, :dirty)
@@ -163,9 +154,7 @@
       end
 
       context "with a socket issue" do
-        it "transparently reopens" do
-          skip "flaky environment" if flaky_env?
-
+        it "transparently reopens", :flaky do
           first_socket_id = client.get("#{server.endpoint}/socket").body.to_s
           expect(first_socket_id).to_not eq("")
           # Kill off the sockets we used
@@ -195,9 +184,7 @@
     context "when disabled" do
       let(:options) { {} }
 
-      it "opens new sockets" do
-        skip "flaky environment" if flaky_env?
-
+      it "opens new sockets", :flaky do
         expect(sockets_used).to_not include("")
         expect(sockets_used.uniq.length).to eq(2)
       end