Add Unicorn, Puma, nad Exec plugins and tests for Excon::Test::Server

 - Added Unicorn plugin for Excon::Test::Server
 - Added Puma plugin fo Excon::Test::Server
 - Added Exec plugin for Excon::Test::Server (i.e., for sinatra, etc.)
 - Added initial tests for Unicorn, Puma, Exec plugins
 - Renamed Rackup|rackup to Webrick|webrick
 - Load Unicorn, Puma, and Exec plugins from Excon::Test::Server by default
 - Added support for URIs in order to better support ipv6
 - Added conditional ops to delete a unix socket if one still exists
   post-shutdown
 - move check_implementation under private to make ruby < 2.0.0 happy
 - Add nested_const_get to stay compat with ruby < 1.9
 - Specify webrick in with_rackup since puma is in the mix now
 - Changed default rspec format to doc instead of progress
 - used shared examples in excon test server spec
 - define get_abs_path to dry up path helpers
 - let rackup_path helper call get_abs_path
 - define unicorn_path and puma_path to support the web server shared example,
   it calls
   rackup_path
 - rename server_path to exec_path and call get_abs_path
 - Skip any tests when unicorn is the server and platform is jruby
 - Add "bundle exec rake spec" to travis.yml
 - Modify task for rspec to take a format argument, defaults to doc
 - use progress format for rspec on travis for less log
 - Added puma to Gemfile
 - Moved unicorn to groups test and devel

Author: starbelly

.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format d

.travis.yml

@@ -17,5 +17,8 @@ rvm:
   - jruby
   - rbx-3.2
   - ree
-script: "bundle exec shindont"
+script: 
+  - "bundle exec shindont"
+  - "bundle exec rake spec[progress]"
+
 sudo: false

Gemfile

@@ -3,7 +3,8 @@ source "http://rubygems.org"
 gemspec
 
 gem 'jruby-openssl', :platform => :jruby
-gem 'unicorn', :platforms => [:mri, :rbx]
+gem 'puma', :groups => [:development, :test]
+gem 'unicorn', :platforms => [:mri, :rbx], :groups => [:development, :test]
 gem 'rubysl', '~> 2.0', :platform => :rbx
 gem 'rack', '~> 1.6'
 

Gemfile.lock

@@ -28,6 +28,7 @@ GEM
     minitest (4.7.5)
     multi_json (1.3.6)
     open4 (1.3.0)
+    puma (3.6.0)
     rack (1.6.0)
     rack-protection (1.2.0)
       rack
@@ -286,6 +287,7 @@ DEPENDENCIES
   jruby-openssl
   json (>= 1.8.2)
   open4
+  puma
   rack (~> 1.6)
   rake
   rdoc

Rakefile

@@ -46,8 +46,9 @@ end
 require 'shindo/rake'
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new do |t|
-    t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+RSpec::Core::RakeTask.new(:spec, :format) do |t, args|
+    format = args[:format] || 'doc'
+    t.rspec_opts = ["-c", "-f #{format}", "-r ./spec/spec_helper.rb"]
     t.pattern = 'spec/**/*_spec.rb'
 end
 

lib/excon/test/plugin/server/exec.rb

@@ -0,0 +1,23 @@
+module Excon
+  module Test
+    module Plugin
+      module Server
+        module Exec
+          def start(app_str = app)
+            line = ''
+            open_process(app)
+            until line =~ /\Aready\Z/
+              line = error.gets
+              fatal_time = elapsed_time > timeout
+              if fatal_time
+                msg = "executable #{app} has taken too long to start"
+                raise msg
+              end
+            end
+            true
+          end
+        end
+      end
+    end
+  end
+end

lib/excon/test/plugin/server/puma.rb

@@ -0,0 +1,21 @@
+module Excon
+  module Test
+    module Plugin
+      module Server
+        module Puma
+          def start(app_str = app, bind_uri = bind)
+            bind.host = bind_uri.host.gsub(/[\[\]]/, '')
+            open_process('puma', '-b', bind_uri.to_s, app_str)
+            line = ''
+            until line =~ /Use Ctrl-C to stop/
+              line = read.gets
+              fatal_time = elapsed_time > timeout
+              raise 'puma server has taken too long to start' if fatal_time
+            end
+            true
+          end
+        end
+      end
+    end
+  end
+end

lib/excon/test/plugin/server/rackup.rb

@@ -0,0 +1,35 @@
+module Excon
+  module Test
+    module Plugin
+      module Server
+        module Unicorn
+          def start(app_str = app, bind_uri = bind)
+            bind_uri = URI.parse(bind_uri) unless bind_uri.is_a? URI::Generic
+            is_unix_socket = (bind_uri.scheme == "unix")
+            if is_unix_socket
+              bind_str = bind_uri.to_s
+            else
+              host = bind_uri.host.gsub(/[\[\]]/, '')
+              bind_str = "#{host}:#{bind_uri.port}"
+            end
+            args = [ 
+              'unicorn', 
+              '--no-default-middleware', 
+              '-l',
+              bind_str,  
+              app_str
+            ]
+            open_process(*args)
+            line = ''
+            until line =~ /worker\=0 ready/
+              line = error.gets
+              fatal_time = elapsed_time > timeout
+              raise 'unicorn server has taken too long to start' if fatal_time
+            end
+            true
+          end
+        end
+      end
+    end
+  end
+end

lib/excon/test/plugin/server/unicorn.rb

@@ -0,0 +1,23 @@
+module Excon
+  module Test
+    module Plugin
+      module Server
+        module Webrick
+          def start(app_str = app, bind_uri = bind)
+            bind_uri = URI.parse(bind_uri) unless bind_uri.is_a? URI::Generic
+            host = bind_uri.host.gsub(/[\[\]]/, '')
+            port = bind_uri.port.to_s
+            open_process('rackup', '-s', 'webrick', '--host', host, '--port', port, app_str)
+            line = ''
+            until line =~ /HTTPServer#start/
+              line = error.gets
+              fatal_time = elapsed_time > timeout
+              raise 'webrick server has taken too long to start' if fatal_time
+            end
+            true
+          end
+        end
+      end
+    end
+  end
+end

lib/excon/test/plugin/server/webrick.rb

@@ -1,6 +1,10 @@
 require 'open4'
 require 'excon'
-require 'excon/test/plugin/server/rackup'
+require 'excon/test/plugin/server/webrick'
+require 'excon/test/plugin/server/unicorn'
+require 'excon/test/plugin/server/puma'
+require 'excon/test/plugin/server/exec'
+
 
 module Excon
   module Test
@@ -19,27 +23,22 @@ def initialize(args)
         # TODO: Validate these args
         @server = args.keys.first
         @app = args[server]
-        @bind = args[:bind]
+        args[:bind] ||= 'tcp://127.0.0.1:9292'
+        @bind = URI.parse(args[:bind])
+        @is_unix_socket = (@bind.scheme == 'unix')
+        @bind.host = @bind.host.gsub(/[\[\]]/, '') unless @is_unix_socket
         if args[:timeout]
           @timeout = args[:timeout]
         else
           # Double the default timeout if jruby because of the startup cost
           @timeout = RUBY_PLATFORM == "java" ? 20 : 10
         end
         name = @server.to_s.split('_').collect(&:capitalize).join
-        plug = "Excon::Test::Plugin::Server::#{name}"
-        self.extend Kernel.const_get plug
+        plug = nested_const_get("Excon::Test::Plugin::Server::#{name}")
+        self.extend plug
         check_implementation(plug)
       end
 
-      private def check_implementation(plug)
-        INSTANCE_REQUIRES.each do |m|
-          unless self.respond_to? m
-            raise "FATAL: #{plug} does not implement ##{m}"
-          end
-        end
-      end
-
       def open_process(*args)
         if RUBY_PLATFORM == 'java'
           @pid, @write, @read, @error = IO.popen4(*args)
@@ -62,6 +61,12 @@ def stop
           GC.enable if RUBY_VERSION < '1.9'
           Process.wait(pid)
         end
+
+        if @is_unix_socket
+          socket = @bind.path
+          File.delete(socket) if File.exist?(socket)
+        end
+
         # TODO: Ensure process is really dead
         dump_errors
         true
@@ -81,6 +86,22 @@ def dump_errors
           puts line if in_err
         end
       end
+
+      private
+
+      def nested_const_get(namespace)
+        namespace.split('::').inject(Object) do |mod, klass|
+          mod.const_get(klass)
+        end
+      end
+
+      def check_implementation(plug)
+        INSTANCE_REQUIRES.each do |m|
+          unless self.respond_to? m
+            raise "FATAL: #{plug} does not implement ##{m}"
+          end
+        end
+      end
     end
   end
 end

lib/excon/test/server.rb

@@ -1,12 +1,51 @@
 require 'spec_helper'
 
-describe Excon::Test::Server do
-  context 'when rackup' do
-    it 'starts a new a app' do
-      instance = Excon::Test::Server.new(rackup: rackup_path('basic.ru'),  bind: '127.0.0.1')
-      expect(instance).to be_a(Excon::Test::Server)
+# The variable file should be renamed to something better - starbelly
+shared_examples_for "a web server" do |plugin, file, bind_str = nil|
+    plugin = plugin.to_sym unless plugin.is_a? Symbol
+
+    if plugin == :unicorn && RUBY_PLATFORM == "java"
+      before { skip("until unicorn supports jruby") }
+    end
+
+    abs_file = Object.send("#{plugin}_path", file)
+    instance = nil
+    args = { plugin => abs_file}
+    args[:bind] = bind_str unless bind_str.nil?
+
+    it "returns an instance" do
+      instance = Excon::Test::Server.new(args)
+      expect(instance).to be_instance_of Excon::Test::Server
+    end
+ 
+    it 'starts the server' do
       expect(instance.start).to be true
+    end
+
+    it 'stops the server' do
       expect(instance.stop).to be true
     end
+end
+
+describe Excon::Test::Server do
+  context 'when webrick' do
+    it_should_behave_like "a web server", :webrick, 'basic.ru'
+  end
+
+  context 'when unicorn' do
+    it_should_behave_like "a web server", :unicorn, 'streaming.ru'
+  end
+
+  context "when unicorn is given a unix socket uri" do
+    socket_uri = 'unix:///tmp/unicorn.socket'
+    it_should_behave_like "a web server", :unicorn, 'streaming.ru', socket_uri
+  end
+
+  context 'when puma' do
+    it_should_behave_like "a web server", :puma, 'streaming.ru'
+  end
+
+  context 'when executable' do
+    it_should_behave_like "a web server", :exec, 'good.rb' 
   end
 end

spec/excon_test_server_spec.rb

@@ -106,12 +106,21 @@
 
 end
 
+# Todo: s/tests/specs when migration is complete
+def get_abs_path(*parts)
+  File.join(File.expand_path('../..', __FILE__), 'tests', *parts)
+end
+
 def rackup_path(*parts)
-  File.join(File.expand_path('../..', __FILE__), 'tests', 'rackups', *parts)
+  get_abs_path('rackups', *parts)
 end
 
-# TODO: Delete above method and uncommend this one when rackup tests are
-# ported
-#def rackup_path(*parts)
-#    File.expand_path(File.join(File.dirname(__FILE__), 'rackups', *parts))
-#end
+def webrick_path(*parts) rackup_path(*parts); end
+
+def unicorn_path(*parts) rackup_path(*parts); end
+
+def puma_path(*parts) rackup_path(*parts); end
+
+def exec_path(*parts)
+  get_abs_path('servers', *parts)
+end

spec/spec_helper.rb

@@ -234,9 +234,9 @@ def rackup_path(*parts)
 def with_rackup(name, host="127.0.0.1")
   unless RUBY_PLATFORM == 'java'
     GC.disable if RUBY_VERSION < '1.9'
-    pid, w, r, e = Open4.popen4("rackup", "--host", host, rackup_path(name))
+    pid, w, r, e = Open4.popen4("rackup", "-s", "webrick", "--host", host, rackup_path(name))
   else
-    pid, w, r, e = IO.popen4("rackup", "--host", host, rackup_path(name))
+    pid, w, r, e = IO.popen4("rackup", "-s", "webrick", "--host", host, rackup_path(name))
   end
   until e.gets =~ /HTTPServer#start:/; end
   yield