hydra-testing 0.0.1

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/Rakefile

@@ -0,0 +1,40 @@
+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
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/**/*.rb']   # optional
+  # t.options = ['--any', '--extra', '--opts'] # optional
+end
+
+task :default => [:rcov, :doc]

data/hydra-testing.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hydra-testing/version"
+require 'bundler'
+
+Gem::Specification.new do |s|
+  s.name        = "hydra-testing"
+  s.version     = Hydra::Testing::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bess Sadler"]
+  s.email       = ["bess@stanford.edu"]
+  s.homepage    = ""
+  s.summary     = %q{Convenience tasks for automated testing for the hydra project.}
+  s.description = %q{Spin up a jetty instance (maybe even 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.rubyforge_project = "hydra-testing"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.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'
+  
+end
+

data/lib/hydra-testing.rb

@@ -0,0 +1,125 @@
+module Hydra
+  module Testing
+    class TestServer
+
+      require 'singleton'
+      include Singleton
+      attr_accessor :port, :jetty_home, :solr_home, :quiet, :fedora_home, :startup_wait      
+      
+      # configure the singleton with some defaults
+      def initialize
+        @pid = nil
+      end
+      
+      class << self
+        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
+        
+        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
+      
+      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
+  end
+end

data/lib/hydra-testing/version.rb

@@ -0,0 +1,5 @@
+module Hydra
+  module Testing
+    VERSION = "0.0.1"
+  end
+end

data/spec/lib/hydra-testing_spec.rb

@@ -0,0 +1,98 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+require File.join(File.dirname(__FILE__), "/../../lib/hydra-testing")
+
+module Hydra
+  module Testing
+    describe TestServer 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 = Hydra::Testing::TestServer.instance
+          ts.class.should eql(Hydra::Testing::TestServer)
+        end
+
+        it "can be configured with a params hash" do
+          ts = Hydra::Testing::TestServer.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 = Hydra::Testing::TestServer.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 = Hydra::Testing::TestServer.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
+          Hydra::Testing::TestServer.any_instance.stubs(:start).returns(true)
+          Hydra::Testing::TestServer.any_instance.stubs(:stop).returns(true)
+          error = Hydra::Testing::TestServer.wrap(@jetty_params) do            
+          end
+          error.should eql(false)
+        end
+        
+        it "configures itself correctly when invoked via the wrap method" do
+          Hydra::Testing::TestServer.any_instance.stubs(:start).returns(true)
+          Hydra::Testing::TestServer.any_instance.stubs(:stop).returns(true)
+          error = Hydra::Testing::TestServer.wrap(@jetty_params) do 
+            ts = Hydra::Testing::TestServer.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
+          Hydra::Testing::TestServer.any_instance.stubs(:start).returns(true)
+          Hydra::Testing::TestServer.any_instance.stubs(:stop).returns(true)
+          error = Hydra::Testing::TestServer.wrap(@jetty_params) do 
+            raise "foo"
+          end
+          error.class.should eql(RuntimeError)
+          error.message.should eql("foo")
+        end
+        
+      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,223 @@
+--- !ruby/object:Gem::Specification 
+name: hydra-testing
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bess Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-06 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"
+  prerelease: false
+  requirement: *id001
+  name: ruby-debug
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id002
+  name: ruby-debug-base
+  type: :development
+- !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"
+  prerelease: false
+  requirement: *id003
+  name: rspec
+  type: :development
+- !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
+  prerelease: false
+  requirement: *id004
+  name: rspec-rails
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id005
+  name: mocha
+  type: :development
+- !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
+  prerelease: false
+  requirement: *id006
+  name: cucumber
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id007
+  name: cucumber-rails
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id008
+  name: gherkin
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id009
+  name: rcov
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id010
+  name: yard
+  type: :development
+description: Spin up a jetty instance (maybe even 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
+- Rakefile
+- hydra-testing.gemspec
+- lib/hydra-testing.rb
+- lib/hydra-testing/version.rb
+- spec/lib/hydra-testing_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: hydra-testing
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Convenience tasks for automated testing for the hydra project.
+test_files: 
+- spec/lib/hydra-testing_spec.rb
+- spec/spec_helper.rb