jettywrapper 1.2.0 → 1.2.1

data/History.txt

@@ -1,3 +1,6 @@
+1.2.1
+  Fixed :restart task
+
 1.2.0
   Added per environment configuration
   Fixes for JRuby

data/README.textile

@@ -1,64 +1,33 @@
 h1. jettywrapper
 
-This gem is designed to make it easier to run automated tests against jetty. Solr comes bundled in a jetty instance, and the hydra project has taken a similar approach with hydra-jetty, an instance of jetty pre-configured to load fedora, solr, and various other java servlets of use to the hydra project. 
-
-h2. Instructions for the impatient:
-
-bc.. 
-  require 'jettywrapper'
-  desc "Hudson build"
-  task :hudson do
-    if (ENV['RAILS_ENV'] == "test")
-      jetty_params = { 
-        :jetty_home => File.expand_path(File.dirname(__FILE__) + '/../../jetty'), 
-        :quiet => false, 
-        :jetty_port => 8983, 
-        :solr_home => File.expand_path(File.dirname(__FILE__) + '/../../jetty/solr/test-core'),
-        :fedora_home => File.expand_path(File.dirname(__FILE__) + '/../../jetty/fedora/default'),
-        :startup_wait => 30
-        }
-      Rake::Task["db:drop"].invoke
-      Rake::Task["db:migrate"].invoke
-      Rake::Task["db:migrate:plugins"].invoke
-      error = Jettywrapper.wrap(jetty_params) do  
-        Rake::Task["libra_oa:default_fixtures:refresh"].invoke
-        Rake::Task["hydra:fixtures:refresh"].invoke
-        Rake::Task["spec"].invoke
-        Rake::Task["cucumber"].invoke
-      end
-      raise "test failures: #{error}" if error
-    else
-      system("rake hudson RAILS_ENV=test")
-      fail unless $?.success?
-    end
-  end
+This gem is designed to make it easier to integrate a jetty servlet container into a rails project.  
+Jettywrapper provides rake tasks for starting and stopping jetty, as well as a method (Jettywrapper.wrap) that will start the server before the block and stop the server after the block, which is useful for automated testing.
 
-h2. Important note on creating nested rake tasks:
+h2. Configuring Jettywrapper
 
-When creating your rake tasks, keep in mind that rake does not by default propogate up errors raised from system commands.  
-If you use system(), the return value will be false for any exit codes other than 0.  If you use backticks or %x(), you must use $? to check the exit status code 
-after the call.  Failure to do so could result in false successes.
+Jettywrapper starts the process with a list of options that you can specify in config/jetty.yml (otherwise a default is used).  You can provide a per environment configuration, or you can have a default configuration which will be used when a per-environment configuration is not specified.
 
-h3. Example 1: Checking return value from system()
+<pre>default:
+  jetty_port: 8983
+  java_opts:
+    - "-XX:MaxPermSize=128m"
+    - "-Xmx256m"
+</pre>
 
-bc.. 
-  #retval should return false for non-zero exit codes 
-  retval = system("rake hudson RAILS_ENV=test")
-  fail unless retval
 
-h3. Example 2: Checking $? with system()
 
-bc.. 
-  system("rake hudson RAILS_ENV=test")
-  raise "rake hudson encoutered errors" unless $?.success?
+h2. Example rake task:
 
-h3. Example 3: An alternative method: using %x[] or backticks with $?
+bc.. require 'jettywrapper'
+desc "Hudson build"
+task :hudson do
+  jetty_params = Jettywrapper.load_config.merge({:jetty_home => File.expand_path(File.dirname(__FILE__) + '/../jetty')})
+  error = Jettywrapper.wrap(jetty_params) do  
+    Rake::Task["spec"].invoke
+  end
+  raise "test failures: #{error}" if error
+end
 
-bc.. 
-  # %x[] or `` will return everything sent to stdout from the command
-  puts %x[cucumber --tags ~@pending --tags ~@overwritten features]
-  raise "Cucumber failed." unless $?.success?
-  
 h2. Testing the gem 
 
 If you haven't already, clone the git repository

data/lib/jettywrapper.rb

@@ -23,6 +23,7 @@ class Jettywrapper
   attr_accessor :solr_home    # Where is solr located? Default is jetty_home/solr
   attr_accessor :base_path    # The root of the application. Used for determining where log files and PID files should go.
   attr_accessor :java_opts    # Options to pass to java (ex. ["-Xmx512mb", "-Xms128mb"])
+  attr_accessor :port         # The port jetty should listen on
   
   # configure the singleton with some defaults
   def initialize(params = {})
@@ -70,9 +71,9 @@ class Jettywrapper
     # @param [Symbol] :quiet Keep quiet about jetty output? Default is true. 
     # @param [Symbol] :java_opts A list of options to pass to the jvm 
     def configure(params = {})
-      hydra_server = self.instance
-      hydra_server.reset_process!
-      hydra_server.quiet = params[:quiet].nil? ? true : params[:quiet]
+      jetty_server = self.instance
+      jetty_server.reset_process!
+      jetty_server.quiet = params[:quiet].nil? ? true : params[:quiet]
       if defined?(Rails.root)
        base_path = Rails.root
       elsif defined?(APP_ROOT)
@@ -80,12 +81,12 @@ class Jettywrapper
       else
        raise "You must set either Rails.root, APP_ROOT or pass :jetty_home as a parameter so I know where jetty is" unless params[:jetty_home]
       end
-      hydra_server.jetty_home = params[:jetty_home] || File.expand_path(File.join(base_path, 'jetty'))
-      hydra_server.solr_home = params[:solr_home]  || File.join( hydra_server.jetty_home, "solr")
-      hydra_server.port = params[:jetty_port] || 8888
-      hydra_server.startup_wait = params[:startup_wait] || 5
-      hydra_server.java_opts = params[:java_opts] || []
-      return hydra_server
+      jetty_server.jetty_home = params[:jetty_home] || File.expand_path(File.join(base_path, 'jetty'))
+      jetty_server.solr_home = params[:solr_home]  || File.join( jetty_server.jetty_home, "solr")
+      jetty_server.port = params[:jetty_port] || 8888
+      jetty_server.startup_wait = params[:startup_wait] || 5
+      jetty_server.java_opts = params[:java_opts] || []
+      return jetty_server
     end
    
      
@@ -113,11 +114,10 @@ class Jettywrapper
 
       begin
         jetty_server.start
-        sleep jetty_server.startup_wait
         yield
       rescue
         error = $!
-        puts "*** Error starting hydra-jetty: #{error}"
+        puts "*** Error starting jetty: #{error}"
       ensure
         # puts "stopping jetty server"
         jetty_server.stop
@@ -243,8 +243,8 @@ class Jettywrapper
          logger.warn "Removing stale PID file at #{pid_path}"
          File.delete(pid_path)
        end
-       if Jettywrapper.is_port_in_use?(@jetty_port)
-         raise("Port #{self.jetty_port} is already in use.")
+       if Jettywrapper.is_port_in_use?(self.port)
+         raise("Port #{self.port} is already in use.")
        end
      end
      Dir.chdir(@jetty_home) do
@@ -259,13 +259,25 @@ class Jettywrapper
      f.puts "#{process.pid}"
      f.close
      logger.debug "Wrote pid file to #{pid_path} with value #{process.pid}"
+     startup_wait!
+   end
+
+   # Wait for the jetty server to start and begin listening for requests
+   def startup_wait!
+     begin
+     Timeout::timeout(startup_wait) do
+       sleep 1 until (Jettywrapper.is_port_in_use? self.port)
+     end 
+     rescue Timeout::Error
+       logger.warn "Waited #{startup_wait} seconds for jetty to start, but it is not yet listening on port #{self.port}. Continuing anyway."
+     end
    end
  
    def process
      @process ||= begin
         process = ChildProcess.build(*jetty_command)
         if self.quiet
-          process.io.stderr = File.open("jettywrapper.log", "w+")
+          process.io.stderr = File.open(File.expand_path("jettywrapper.log"), "w+")
           process.io.stdout = process.io.stderr
            logger.warn "Logging jettywrapper stdout to #{File.expand_path(process.io.stderr.path)}"
         else

data/lib/jettywrapper/version.rb

@@ -1 +1 @@
-GEMVERSION = "1.2.0"
+GEMVERSION = "1.2.1"

data/lib/tasks/jettywrapper.rake

@@ -22,7 +22,7 @@ namespace :jetty do
   end
   
   desc "Restarts jetty"
-  task :restart do
+  task :restart => :environment do
     Jettywrapper.stop(JETTY_CONFIG)
     Jettywrapper.start(JETTY_CONFIG)
   end

data/spec/lib/jettywrapper_integration_spec.rb

@@ -12,7 +12,8 @@ module Hydra
       
       it "starts" do
         jetty_params = {
-          :jetty_home => File.expand_path("#{File.dirname(__FILE__)}/../../jetty")
+          :jetty_home => File.expand_path("#{File.dirname(__FILE__)}/../../jetty"),
+          :startup_wait => 30
         }
         Jettywrapper.configure(jetty_params) 
         ts = Jettywrapper.instance
@@ -22,7 +23,6 @@ module Hydra
         ts.logger.debug "Jetty started from rspec at #{ts.pid}"
         pid_from_file = File.open( ts.pid_path ) { |f| f.gets.to_i }
         ts.pid.should eql(pid_from_file)
-        sleep 30 # give jetty time to start
       
         # Can we connect to solr?
         require 'net/http' 
@@ -34,14 +34,14 @@ module Hydra
       
       it "won't start if it's already running" do
         jetty_params = {
-          :jetty_home => File.expand_path("#{File.dirname(__FILE__)}/../../jetty")
+          :jetty_home => File.expand_path("#{File.dirname(__FILE__)}/../../jetty"),
+          :startup_wait => 30
         }
         Jettywrapper.configure(jetty_params) 
         ts = Jettywrapper.instance
         ts.logger.debug "Stopping jetty from rspec."
         ts.stop
         ts.start
-        sleep 30
         ts.logger.debug "Jetty started from rspec at #{ts.pid}"
         response = Net::HTTP.get_response(URI.parse("http://localhost:8888/solr/development/admin/"))
         response.code.should eql("200")
@@ -52,13 +52,13 @@ module Hydra
       it "can check to see whether a port is already in use" do
         params = {
           :jetty_home => File.expand_path("#{File.dirname(__FILE__)}/../../jetty"),
-          :jetty_port => '9999'
+          :jetty_port => '9999',
+          :startup_wait => 30
         }
         Jettywrapper.stop(params) 
         sleep 10
         Jettywrapper.is_port_in_use?(params[:jetty_port]).should eql(false)
         Jettywrapper.start(params) 
-        sleep 30
         Jettywrapper.is_port_in_use?(params[:jetty_port]).should eql(true)
         Jettywrapper.stop(params) 
       end
@@ -66,13 +66,13 @@ module Hydra
       it "raises an error if you try to start a jetty that is already running" do
         jetty_params = {
           :jetty_home => File.expand_path("#{File.dirname(__FILE__)}/../../jetty"),
-          :jetty_port => '8983'
+          :jetty_port => '8983',
+          :startup_wait => 30
         }
         ts = Jettywrapper.configure(jetty_params) 
         ts.stop
         ts.pid_file?.should eql(false)
         ts.start
-        sleep 30
         lambda{ ts.start }.should raise_exception
         ts.stop
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jettywrapper
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 1
   - 2
-  - 0
-  version: 1.2.0
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - Bess Sadler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-29 00:00:00 -06:00
+date: 2012-01-11 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency