jettywrapper 0.0.2

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage
+coverage.data
+*~
+.yardoc
+doc

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7@hydra-testing --create

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.textile

@@ -0,0 +1,28 @@
+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 "New way of running tests"
+  task :newtest do
+    Rake::Task["rake:db:test:clone_structure"].invoke
+    Rake::Task["rake:hydra:jetty:config_fedora"].invoke
+    Rake::Task["rake:hydra:jetty:config"].invoke
+    jetty_params = { 
+      :jetty_home => "/usr/local/projects/hydra-hydrus/jetty", 
+      :quiet => false, 
+      :jetty_port => 8983, 
+      :solr_home => "/usr/local/projects/hydra-hydrus/jetty/solr/test-core",
+      :startup_wait => 30
+      }
+    error = Jettywrapper.wrap(jetty_params) do   
+      # Rake::Task["libra_oa:default_fixtures:refresh"].invoke 
+      Rake::Task["rake:hydra:default_fixtures:load"].invoke       
+      Rake::Task["rake:spec"].invoke 
+      Rake::Task["rake:cucumber"].invoke 
+    end 
+    raise "test failures: #{error}" if error
+  end

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rake'
+require 'bundler'
+require 'spec/rake/spectask'
+require 'yard'
+
+Bundler::GemHelper.install_tasks
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = %w{--exclude spec\/*,gems\/*,ruby\/* --aggregate coverage.data}
+end
+
+task :clean do
+  puts 'Cleaning old coverage.data'
+  FileUtils.rm('coverage.data') if(File.exists? 'coverage.data')
+end
+
+# Use yard to build docs
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  project_root = File.expand_path(File.dirname(__FILE__))
+  doc_destination = File.join(project_root, 'doc')
+
+  YARD::Rake::YardocTask.new(:doc) do |yt|
+    yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) + 
+                 [ File.join(project_root, 'README.textile') ]
+    yt.options = ['--output-dir', doc_destination, '--readme', 'README.textile']
+  end
+rescue LoadError
+  desc "Generate YARD Documentation"
+  task :doc do
+    abort "Please install the YARD gem to generate rdoc."
+  end
+end
+
+task :default => [:rcov, :doc]

data/jettywrapper.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jettywrapper/version"
+require 'bundler'
+
+Gem::Specification.new do |s|
+  s.name        = "jettywrapper"
+  s.version     = GEMVERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bess Sadler"]
+  s.email       = ["bess@stanford.edu"]
+  s.homepage    = ""
+  s.summary     = %q{Convenience tasks for working with jetty from within a ruby project.}
+  s.description = %q{Spin up a jetty instance (e.g., the one at https://github.com/projecthydra/hydra-jetty) and wrap test in it. This lets us run tests against a real copy of solr and fedora.}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  # s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.required_rubygems_version = ">= 1.3.6"
+  
+  # Bundler will install these gems too if you've checked this out from source from git and run 'bundle install'
+  # It will not add these as dependencies if you require lyber-core for other projects
+  s.add_development_dependency "ruby-debug"
+  s.add_development_dependency "ruby-debug-base"
+  s.add_development_dependency "rspec", "< 2.0" # We're not ready to upgrade to rspec 2
+  s.add_development_dependency 'rspec-rails', '<2.0.0' # rspec-rails 2.0.0 requires Rails 3.
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'cucumber', '>=0.8.5'
+  s.add_development_dependency 'cucumber-rails'
+  s.add_development_dependency 'gherkin'
+  s.add_development_dependency 'rcov'
+  
+  s.add_development_dependency 'yard', '0.6.5'  # Yard > 0.6.5 won't generate docs.
+                                                # I don't know why & don't have time to 
+                                                # debug it right now
+  
+  s.add_development_dependency 'RedCloth'
+  
+end
+

data/lib/jettywrapper.rb

@@ -0,0 +1,157 @@
+# Jettywrapper is a Singleton class, so you can only create one jetty instance at a time.
+
+class Jettywrapper
+  
+  require 'singleton'
+  include Singleton
+  
+  attr_accessor :port         # What port should jetty start on? Default is 8888
+  attr_accessor :jetty_home   # Where is jetty located? 
+  attr_accessor :startup_wait # After jetty starts, how long to wait until starting the tests? 
+  attr_accessor :quiet        # Keep quiet about jetty output?
+  attr_accessor :solr_home    # Where is solr located? Default is jetty_home/solr
+  attr_accessor :fedora_home  # Where is fedora located? Default is jetty_home/fedora
+  
+  # configure the singleton with some defaults
+  def initialize
+    @pid = nil
+  end
+  
+  class << self
+    
+    # Set the jetty parameters. It accepts a Hash of symbols. 
+    # @param [Hash<Symbol>] params
+    # @param [Symbol] :jetty_home Required. Where is jetty located? 
+    # @param [Symbol] :jetty_port What port should jetty start on? Default is 8888
+    # @param [Symbol] :startup_wait After jetty starts, how long to wait before running tests? If you don't let jetty start all the way before running the tests, they'll fail because they can't reach jetty.
+    # @param [Symbol] :solr_home Where is solr? Default is jetty_home/solr
+    # @param [Symbol] :fedora_home Where is fedora? Default is jetty_home/fedora
+    # @param [Symbol] :quiet Keep quiet about jetty output? Default is true. 
+    def configure(params = {})
+      hydra_server = self.instance
+      hydra_server.quiet = params[:quiet].nil? ? true : params[:quiet]
+      if defined?(Rails.root)
+       base_path = Rails.root
+      else
+       raise "You must set either RAILS_ROOT or :jetty_home 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.fedora_home = params[:fedora_home] || File.join( hydra_server.jetty_home, "fedora","default")
+      hydra_server.port = params[:jetty_port] || 8888
+      hydra_server.startup_wait = params[:startup_wait] || 5
+      return hydra_server
+    end
+     
+    # Wrap the tests. Startup jetty, yield to the test task, capture any errors, shutdown
+    # jetty, and return the error. 
+    # @example Using this method in a rake task
+    #   require 'jettywrapper'
+    #   desc "Spin up jetty and run tests against it"
+    #   task :newtest do
+    #     jetty_params = { 
+    #       :jetty_home => "/path/to/jetty", 
+    #       :quiet => false, 
+    #       :jetty_port => 8983, 
+    #       :startup_wait => 30
+    #     }
+    #     error = Jettywrapper.wrap(jetty_params) do   
+    #       Rake::Task["rake:spec"].invoke 
+    #       Rake::Task["rake:cucumber"].invoke 
+    #     end 
+    #     raise "test failures: #{error}" if error
+    #   end
+    def wrap(params = {})
+      error = false
+      jetty_server = self.instance
+      jetty_server.quiet = params[:quiet] || true
+      jetty_server.jetty_home = params[:jetty_home]
+      jetty_server.solr_home = params[:solr_home]
+      jetty_server.port = params[:jetty_port] || 8888
+      jetty_server.startup_wait = params[:startup_wait] || 5
+      jetty_server.fedora_home = params[:fedora_home] || File.join( jetty_server.jetty_home, "fedora","default")
+
+      begin
+        # puts "starting jetty on #{RUBY_PLATFORM}"
+        jetty_server.start
+        sleep jetty_server.startup_wait
+        yield
+      rescue
+        error = $!
+        puts "*** Error starting hydra-jetty: #{error}"
+      ensure
+        # puts "stopping jetty server"
+        jetty_server.stop
+      end
+
+      return error
+    end
+     
+   end #end of class << self
+   
+   # What command is being run to invoke jetty? 
+   def jetty_command
+     "java -Djetty.port=#{@port} -Dsolr.solr.home=#{@solr_home} -jar start.jar"
+   end
+   
+   def start
+     puts "jetty_home: #{@jetty_home}"
+     puts "solr_home: #{@solr_home}"
+     puts "jetty_command: #{jetty_command}"
+     platform_specific_start
+   end
+   
+   def stop
+     platform_specific_stop
+   end
+   
+   if RUBY_PLATFORM =~ /mswin32/
+     require 'win32/process'
+   
+     # start the solr server
+     def platform_specific_start
+       Dir.chdir(@jetty_home) do
+         @pid = Process.create(
+               :app_name         => jetty_command,
+               :creation_flags   => Process::DETACHED_PROCESS,
+               :process_inherit  => false,
+               :thread_inherit   => true,
+               :cwd              => "#{@jetty_home}"
+            ).process_id
+       end
+     end
+   
+     # stop a running solr server
+     def platform_specific_stop
+       Process.kill(1, @pid)
+       Process.wait
+     end
+   else # Not Windows
+   
+     def jruby_raise_error?
+       raise 'JRuby requires that you start solr manually, then run "rake spec" or "rake features"' if defined?(JRUBY_VERSION)
+     end
+   
+     # start the solr server
+     def platform_specific_start
+   
+       jruby_raise_error?
+   
+       puts self.inspect
+       Dir.chdir(@jetty_home) do
+         @pid = fork do
+           STDERR.close if @quiet
+           exec jetty_command
+         end
+       end
+     end
+   
+     # stop a running solr server
+     def platform_specific_stop
+       jruby_raise_error?
+       Process.kill('TERM', @pid)
+       Process.wait
+     end
+  end
+
+end

data/lib/jettywrapper/version.rb

@@ -0,0 +1 @@
+GEMVERSION = "0.0.2"

data/spec/lib/jettywrapper_spec.rb

@@ -0,0 +1,96 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+require File.join(File.dirname(__FILE__), "/../../lib/jettywrapper")
+
+module Hydra
+  describe Jettywrapper do
+    
+    before(:all) do
+      @jetty_params = {
+        :quiet => false,
+        :jetty_home => "/path/to/jetty",
+        :jetty_port => 8888,
+        :solr_home => "/path/to/solr",
+        :fedora_home => "/path/to/fedora",
+        :startup_wait => 0
+      }
+    end
+    
+    context "instantiation" do
+      it "can be instantiated" do
+        ts = Jettywrapper.instance
+        ts.class.should eql(Jettywrapper)
+      end
+
+      it "can be configured with a params hash" do
+        ts = Jettywrapper.configure(@jetty_params) 
+        ts.quiet.should == false
+        ts.jetty_home.should == "/path/to/jetty"
+        ts.port.should == 8888
+        ts.solr_home.should == '/path/to/solr'
+        ts.fedora_home.should == '/path/to/fedora'
+        ts.startup_wait.should == 0
+      end
+
+      # passing in a hash is no longer optional
+      it "raises an error when called without a :jetty_home value" do
+          lambda { ts = Jettywrapper.configure }.should raise_exception
+      end
+
+      it "should override nil params with defaults" do
+        jetty_params = {
+          :quiet => nil,
+          :jetty_home => '/path/to/jetty',
+          :jetty_port => nil,
+          :solr_home => nil,
+          :fedora_home => nil,
+          :startup_wait => nil
+        }
+
+        ts = Jettywrapper.configure(jetty_params) 
+        ts.quiet.should == true
+        ts.jetty_home.should == "/path/to/jetty"
+        ts.port.should == 8888
+        ts.solr_home.should == File.join(ts.jetty_home, "solr")
+        ts.fedora_home.should == File.join(ts.jetty_home, "fedora","default")
+        ts.startup_wait.should == 5
+      end
+    end # end of instantiation context
+    
+    context "wrapping a task" do
+      it "wraps another method" do
+        Jettywrapper.any_instance.stubs(:start).returns(true)
+        Jettywrapper.any_instance.stubs(:stop).returns(true)
+        error = Jettywrapper.wrap(@jetty_params) do            
+        end
+        error.should eql(false)
+      end
+      
+      it "configures itself correctly when invoked via the wrap method" do
+        Jettywrapper.any_instance.stubs(:start).returns(true)
+        Jettywrapper.any_instance.stubs(:stop).returns(true)
+        error = Jettywrapper.wrap(@jetty_params) do 
+          ts = Jettywrapper.instance 
+          ts.quiet.should == true
+          ts.jetty_home.should == "/path/to/jetty"
+          ts.port.should == 8888
+          ts.solr_home.should == "/path/to/solr"
+          ts.fedora_home.should == "/path/to/fedora"
+          ts.startup_wait.should == 0     
+        end
+        error.should eql(false)
+      end
+      
+      it "captures any errors produced" do
+        Jettywrapper.any_instance.stubs(:start).returns(true)
+        Jettywrapper.any_instance.stubs(:stop).returns(true)
+        error = Jettywrapper.wrap(@jetty_params) do 
+          raise "foo"
+        end
+        error.class.should eql(RuntimeError)
+        error.message.should eql("foo")
+      end
+      
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$: << File.join(File.dirname(__FILE__), "/../../lib")
+require 'spec/autorun'
+# require 'spec/rails'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,239 @@
+--- !ruby/object:Gem::Specification 
+name: jettywrapper
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Bess Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id001
+  prerelease: false
+  name: ruby-debug
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id002
+  prerelease: false
+  name: ruby-debug-base
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  requirement: *id003
+  prerelease: false
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  requirement: *id004
+  prerelease: false
+  name: rspec-rails
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id005
+  prerelease: false
+  name: mocha
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 0
+        - 8
+        - 5
+        version: 0.8.5
+  type: :development
+  requirement: *id006
+  prerelease: false
+  name: cucumber
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id007
+  prerelease: false
+  name: cucumber-rails
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id008
+  prerelease: false
+  name: gherkin
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id009
+  prerelease: false
+  name: rcov
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 6
+        - 5
+        version: 0.6.5
+  type: :development
+  requirement: *id010
+  prerelease: false
+  name: yard
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id011
+  prerelease: false
+  name: RedCloth
+description: Spin up a jetty instance (e.g., the one at https://github.com/projecthydra/hydra-jetty) and wrap test in it. This lets us run tests against a real copy of solr and fedora.
+email: 
+- bess@stanford.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.textile
+- Rakefile
+- jettywrapper.gemspec
+- lib/jettywrapper.rb
+- lib/jettywrapper/version.rb
+- spec/lib/jettywrapper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Convenience tasks for working with jetty from within a ruby project.
+test_files: []
+