Cleaned up tests and made them more robust

Author: bert-mccutchen

spec/ruby/nginx_add_spec.rb

@@ -7,43 +7,53 @@
     Ruby::Nginx.add!(
       domain: "example.test",
       port: Puma::Configuration::DEFAULTS[:tcp_port],
-      root_path: RSpec.configuration.dummy_dir,
+      root_path: RSpec.configuration.dummy_path,
       ssl: true,
       log: true
     )
   end
 
   it "adds the hosts mapping" do
-    hosts = File.read("/etc/hosts")
-    expect(hosts).to include("example.test")
+    RetryExpectation.new(limit: 30, delay: 1).attempt do
+      hosts = File.read("/etc/hosts")
+      expect(hosts).to include("example.test")
+    end
   end
 
   it "creates the NGINX configuration" do
-    path = File.expand_path("~/.ruby-nginx/servers/ruby_nginx_example_test.conf")
-    expect(File.exist?(path)).to be_truthy
+    RetryExpectation.new(limit: 30, delay: 1).attempt do
+      path = File.expand_path("~/.ruby-nginx/servers/ruby_nginx_example_test.conf")
+      expect(File.exist?(path)).to be_truthy
+    end
   end
 
   it "creates the SSL certificate" do
-    path = File.expand_path("~/.ruby-nginx/certs/_example.test.pem")
-    expect(File.exist?(path)).to be_truthy
+    RetryExpectation.new(limit: 30, delay: 1).attempt do
+      path = File.expand_path("~/.ruby-nginx/certs/_example.test.pem")
+      expect(File.exist?(path)).to be_truthy
 
-    path = File.expand_path("~/.ruby-nginx/certs/_example.test-key.pem")
-    expect(File.exist?(path)).to be_truthy
+      path = File.expand_path("~/.ruby-nginx/certs/_example.test-key.pem")
+      expect(File.exist?(path)).to be_truthy
+    end
   end
 
   it "creates the log files" do
-    path = File.expand_path("~/.ruby-nginx/logs/example.test.access.log")
-    expect(File.exist?(path)).to be_truthy
+    RetryExpectation.new(limit: 30, delay: 1).attempt do
+      path = File.expand_path("~/.ruby-nginx/logs/example.test.access.log")
+      expect(File.exist?(path)).to be_truthy
 
-    path = File.expand_path("~/.ruby-nginx/logs/example.test.error.log")
-    expect(File.exist?(path)).to be_truthy
+      path = File.expand_path("~/.ruby-nginx/logs/example.test.error.log")
+      expect(File.exist?(path)).to be_truthy
+    end
   end
 
   it "successfully builds up a NGINX site" do
-    html = `curl -s http://example.test`
-    expect(html).to include("Hello, from Ruby NGINX!")
+    RetryExpectation.new(limit: 30, delay: 1).attempt do
+      html = `curl -s http://example.test`
+      expect(html).to include("Hello, from Ruby NGINX!")
 
-    html = `curl -s https://example.test`
-    expect(html).to include("Hello, from Ruby NGINX!")
+      html = `curl -s https://example.test`
+      expect(html).to include("Hello, from Ruby NGINX!")
+    end
   end
 end

spec/ruby/nginx_remove_spec.rb

@@ -6,21 +6,26 @@
   end
 
   it "removes the hosts mapping" do
-    hosts = File.read("/etc/hosts")
-    expect(hosts).not_to include("example.test")
+    RetryExpectation.new(limit: 30, delay: 1).attempt do
+      hosts = File.read("/etc/hosts")
+      expect(hosts).not_to include("example.test")
+    end
   end
 
   it "deletes the NGINX configuration" do
-    path = File.expand_path("~/.ruby-nginx/servers/ruby_nginx_example_test.conf")
-    expect(File.exist?(path)).to be_falsey
+    RetryExpectation.new(limit: 30, delay: 1).attempt do
+      path = File.expand_path("~/.ruby-nginx/servers/ruby_nginx_example_test.conf")
+      expect(File.exist?(path)).to be_falsey
+    end
   end
 
   it "successfully tears down a NGINX site" do
-    sleep(1) # Sometimes the system takes a second to lose the DNS host mapping.
-    html = `curl -s http://example.test`
-    expect(html).to eq("")
+    RetryExpectation.new(limit: 30, delay: 1).attempt do
+      html = `curl -s http://example.test`
+      expect(html).to eq("")
 
-    html = `curl -s https://example.test`
-    expect(html).to eq("")
+      html = `curl -s https://example.test`
+      expect(html).to eq("")
+    end
   end
 end

spec/spec_helper.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require "puma"
-require "puma/cli"
 require "ruby/nginx"
 
-ENV["SKIP_PROMPT"] = "true"
+Dir[File.expand_path("support/**/*.rb", __dir__)].each { |file| require file }
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
@@ -17,18 +15,18 @@
     c.syntax = :expect
   end
 
-  config.add_setting :dummy_dir
-  config.dummy_dir = File.expand_path("./dummy", __dir__)
+  config.add_setting :dummy_path
+  config.dummy_path = File.expand_path("./dummy", __dir__)
 
   config.before(:suite) do
-    print "Starting Dummy Server"
-    $dummy_server = Thread.new do # standard:disable Style/GlobalVars
-      Puma::CLI.new(["-s", "--dir=#{RSpec.configuration.dummy_dir}"]).run
-    end
+    puts "Starting Dummy Server"
+    DummyServer.instance.start
+  rescue
+    DummyServer.instance.stop
   end
 
   config.after(:suite) do
-    print "Stopping Dummy Server"
-    $dummy_server.exit if $dummy_server.alive? # standard:disable Style/GlobalVars
+    puts "Stopping Dummy Server"
+    DummyServer.instance.stop
   end
 end

spec/support/dummy_server.rb

@@ -0,0 +1,29 @@
+require "puma"
+require "puma/cli"
+require "singleton"
+
+ENV["SKIP_PROMPT"] = "true"
+DUMMY_PATH = File.expand_path("../dummy", __dir__)
+
+class DummyServer
+  include Singleton
+
+  def initialize
+    @semaphore = Mutex.new
+    @server = nil
+  end
+
+  def start
+    @semaphore.synchronize do
+      @server = Thread.new do # standard:disable Style/GlobalVars
+        Puma::CLI.new(["-s", "--dir=#{DUMMY_PATH}"]).run
+      end
+    end
+  end
+
+  def stop
+    @semaphore.synchronize do
+      @server.exit if @server.alive?
+    end
+  end
+end

spec/support/retry_expectation.rb

@@ -0,0 +1,16 @@
+class RetryExpectation
+  def initialize(limit:, delay:)
+    @limit = limit
+    @delay = delay
+    @count = 0
+  end
+
+  def attempt
+    yield
+  rescue RSpec::Expectations::ExpectationNotMetError
+    raise if @count >= @limit
+    sleep(@delay) if @delay
+    @count += 1
+    retry
+  end
+end