sunspot_test 0.2.0 → 0.3.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem "jeweler"
+  gem "rspec"
+end

data/HISTORY

@@ -1,3 +1,6 @@
+0.3.0 - June 11, 2011
+  * Renaming SunspotTestHelper to SunspotTest (thanks ersatzryan)
+  * Enabling testing within rspec specs
 0.2.0 - May 26, 2011
   * Moved requires from "sunspot_test" to "sunspot_test/cucumber" so we didn't conflict with bundler's autorequire.
   * Added non-@search functionality which stubs out the session and consequently speeds up the non-searching tests.

data/README.rdoc

@@ -31,12 +31,30 @@ If you feature is not tagged with @search the environment will use a sunspot tes
       
 Starting solr will depend on your settings in <b>config/sunspot.yml</b> (though this configuration file is optional). If you run into issues remember to look for existing java processes, starting solr may conflict with existing instances. You can also check out http://collectiveidea.com/blog/archives/2011/05/25/testing-with-sunspot-and-cucumber/ which contains a little more information.
 
+== Can it do RSpec?
+
+In spec_helper.rb
+
+  require 'sunspot_test/rspec'
+  
+Then within your specs, you'll need to tag and explicitly commit changes to solr:
+
+  require 'spec_helper'
+  
+  describe "searching", :search => true do
+    it 'returns book results' do
+      book = Factory(:book, :title => "Of Mice and Men")
+      Sunspot.commit
+      Book.search { keywords "mice"}.results.should == [book]
+    end
+  end
+
 == Configuring the timeout
 
 The test suite will try and launch a solr process and wait for 15 seconds for the process to launch. You can configure this timeout by setting the following in env.rb:
 
   
-  SunspotTestHelper.startup_timeout = 60 # will wait 60 seconds for the solr process to start
+  SunspotTest.startup_timeout = 60 # will wait 60 seconds for the solr process to start
   
 
 == Note on Patches/Pull Requests

data/Rakefile

@@ -11,7 +11,6 @@ begin
     gem.homepage = "https://github.com/collectiveidea/sunspot_test"
     gem.authors = ["Zach Moazeni"]
     gem.add_dependency "sunspot_rails", ">= 1.2.1"
-    gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -19,39 +18,39 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-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
-end
-
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
-
-  task :features => :check_dependencies
-rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "sunspot_test #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+# require 'spec/rake/spectask'
+# 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
+# end
+# 
+# begin
+#   require 'cucumber/rake/task'
+#   Cucumber::Rake::Task.new(:features)
+# 
+#   task :features => :check_dependencies
+# rescue LoadError
+#   task :features do
+#     abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+#   end
+# end
+# 
+# task :spec => :check_dependencies
+# 
+# task :default => :spec
+# 
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "sunspot_test #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/sunspot_test.rb

@@ -0,0 +1,78 @@
+require 'sunspot/rails'
+require 'net/http'
+
+module SunspotTest
+  class TimeOutError < StandardError; end;
+  class << self
+
+    attr_writer :solr_startup_timeout
+    attr_writer :server
+
+    def solr_startup_timeout
+      @solr_startup_timeout || 15
+    end
+
+    def setup_solr
+      unstub
+      start_sunspot_server
+    end
+
+    def server
+      @server ||= Sunspot::Rails::Server.new
+    end
+
+    def start_sunspot_server
+      unless @server
+        pid = fork do
+          STDERR.reopen("/dev/null")
+          STDOUT.reopen("/dev/null")
+          server.run
+        end
+
+        at_exit { Process.kill("TERM", pid) }
+
+        wait_until_solr_starts
+      end
+    end
+
+    # Stubs Sunspot calls to Solr server
+    def stub
+      unless @session_stubbed
+        Sunspot.session = Sunspot::Rails::StubSessionProxy.new(original_sunspot_session)
+        @session_stubbed = true
+      end
+    end
+
+    # Resets Sunspot to call Solr server, opposite of stub
+    def unstub
+      if @session_stubbed
+        Sunspot.session = original_sunspot_session
+        @session_stubbed = false
+      end
+    end
+
+    private
+
+    def original_sunspot_session
+      @original_sunspot_session ||= Sunspot.session
+    end
+
+    def wait_until_solr_starts
+      (solr_startup_timeout * 10).times do
+        break if solr_running?
+        sleep(0.1)
+      end
+      raise TimeOutError, "Solr failed to start after #{solr_startup_timeout} seconds" unless solr_running?
+    end
+
+    def solr_running?
+      begin
+        solr_ping_uri = URI.parse("#{Sunspot.session.config.solr.url}/ping")
+        Net::HTTP.get(solr_ping_uri)
+        true # Solr Running
+      rescue
+        false # Solr Not Running
+      end
+    end
+  end
+end

data/lib/sunspot_test/cucumber.rb

@@ -1,29 +1,15 @@
-require 'net/http'
-
-$original_sunspot_session = Sunspot.session
+require 'sunspot_test'
 
 Before("@searchrunning") do
   $sunspot = true
 end
 
 Before("~@search") do
-  Sunspot.session = Sunspot::Rails::StubSessionProxy.new($original_sunspot_session)
+  SunspotTest.stub
 end
 
 Before("@search") do
-  unless $sunspot
-    $sunspot = Sunspot::Rails::Server.new
-    pid = fork do
-      STDERR.reopen('/dev/null')
-      STDOUT.reopen('/dev/null')
-      $sunspot.run
-    end
-    # shut down the Solr server
-    at_exit { Process.kill('TERM', pid) }
-    SunspotTestHelper.wait_until_solr_starts
-  end
-  
-  Sunspot.session = $original_sunspot_session
+  SunspotTest.setup_solr
   Sunspot.remove_all!
   Sunspot.commit
 end
@@ -31,24 +17,3 @@ end
 AfterStep('@search') do
   Sunspot.commit
 end
-
-module SunspotTestHelper
-  @@startup_timeout = 15
-  def self.startup_timeout; @@startup_timeout; end
-  def self.startup_timeout=(seconds); @@startup_timeout = seconds; end
-  
-  def self.wait_until_solr_starts
-    solr_started = false
-    ping_uri = URI.parse("#{Sunspot.session.config.solr.url}/ping")
-    (@@startup_timeout * 10).times do
-      begin
-        Net::HTTP.get(ping_uri)
-        solr_started = true
-        break
-      rescue
-        sleep(0.1)
-      end
-    end
-    raise "Solr failed to start after 15 seconds" unless solr_started
-  end
-end

data/lib/sunspot_test/rspec.rb

@@ -0,0 +1,13 @@
+require 'sunspot_test'
+
+RSpec.configure do |c|
+  c.before(:all) do
+    SunspotTest.stub
+  end
+  
+  c.before(:all, :search => true) do
+    SunspotTest.setup_solr
+    Sunspot.remove_all!
+    Sunspot.commit
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,5 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'sunspot_test'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
-  
-end
+require 'sunspot'
+require 'sunspot_test'

data/spec/sunspot_test_spec.rb

@@ -1,4 +1,160 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "SunspotTest" do
+describe SunspotTest do
+  describe ".solr_startup_timeout" do
+    after(:all) { SunspotTest.solr_startup_timeout = 15 }
+    it "defaults to 15" do
+      SunspotTest.solr_startup_timeout.should eq(15)
+    end
+
+    it "can be set using .solr_startup_timeout=" do
+      SunspotTest.solr_startup_timeout = 20
+      SunspotTest.solr_startup_timeout.should eq(20)
+    end
+  end
+
+  describe "setup_solr" do
+    it "calls unstub and start_sunspot_server" do
+      SunspotTest.should_receive(:unstub)
+      SunspotTest.should_receive(:start_sunspot_server)
+      SunspotTest.setup_solr
+    end
+  end
+
+  describe "server" do
+    it "creates a new Sunspot Rails Server" do
+      Sunspot::Rails::Server.should_receive(:new)
+      SunspotTest.server
+    end
+  end
+
+  describe ".start_sunspot_server" do
+    context "if server is already started" do
+      before(:each) { SunspotTest.server = true }
+
+      it "does not try to spin up another server" do
+        Kernel.should_not_receive(:fork)
+        SunspotTest.start_sunspot_server
+      end
+    end
+
+    context "if the server has NOT been started" do
+      before(:all) do
+        SunspotTest.stub!(:wait_until_solr_starts) { true }
+      end
+
+      before(:each) do
+        SunspotTest.server = nil
+
+        fake_server = mock("server")
+        SunspotTest.stub!(:server) { fake_server }
+      end
+
+      # was getting funky issues when the test was broken up
+      it "forks the process, redirects stdout/stderr, runs server, sets exit hook, waits for server" do
+
+        SunspotTest.should_receive(:fork) do |&block|
+          STDERR.should_receive(:reopen).with("/dev/null")
+          STDOUT.should_receive(:reopen).with("/dev/null")
+          SunspotTest.server.should_receive(:run)
+          block.call
+        end
+
+        SunspotTest.should_receive(:at_exit) do |&block|
+          Process.should_receive(:kill)
+          block.call
+        end
+
+        SunspotTest.should_receive(:wait_until_solr_starts)
+        SunspotTest.start_sunspot_server
+      end
+    end
+
+    describe ".stub" do
+      context "if the session is already stubbed" do
+        before(:each) { SunspotTest.instance_variable_set(:@session_stubbed, true) }
+
+        it "does nothing" do
+          Sunspot::Rails::StubSessionProxy.should_not_receive(:new)
+
+          SunspotTest.stub
+        end
+      end
+
+      context "if the session is not currently stubbed" do
+        before(:each) { SunspotTest.instance_variable_set(:@session_stubbed, false) }
+
+        it "stubs the Sunspot session and sets @session_stubbed to true" do
+          Sunspot::Rails::StubSessionProxy.should_receive(:new)
+
+          SunspotTest.stub
+        end
+
+        it "sets @session_stubbed to true" do
+          SunspotTest.stub
+          SunspotTest.instance_variable_get(:@session_stubbed).should eq(true)
+        end
+      end
+    end
+
+    describe ".unstub" do
+      context "if the session is not stubbed" do
+        before(:each) { SunspotTest.instance_variable_set(:@session_stubbed, false) }
+        it "does nothing" do
+          SunspotTest.should_not_receive(:original_sunspot_session)
+          SunspotTest.unstub
+        end
+      end
+
+      context "if the session is currently stubbed" do
+        before(:each) { SunspotTest.instance_variable_set(:@session_stubbed, true) }
+
+        it "sets the Sunspot session to the original session" do
+          SunspotTest.should_receive(:original_sunspot_session)
+
+          SunspotTest.unstub
+        end
+
+        it "sets @session_stubbed to true" do
+          SunspotTest.unstub
+          SunspotTest.instance_variable_get(:@session_stubbed).should eq(false)
+        end
+      end
+    end
+
+    describe ".solr_running" do
+      context "if solr is running" do
+        before(:each) { Net::HTTP.stub!(:get).and_return(true) }
+
+        it "returns true" do
+          SunspotTest.send(:solr_running?).should eq(true)
+        end
+      end
+
+      context "if solr is not running" do
+        it "returns false" do
+          SunspotTest.send(:solr_running?).should eq(false)
+        end
+      end
+    end
+    describe ".wait_until_solr_starts" do
+      context "if solr never starts" do
+        before(:each) { SunspotTest.solr_startup_timeout = 2 }
+
+        it "calls solr_running? until solr_startup_timeout raises TimeOutError" do
+          SunspotTest.should_receive(:solr_running?).exactly((SunspotTest.solr_startup_timeout * 10) + 1).times
+
+          lambda { SunspotTest.send(:wait_until_solr_starts) }.should raise_error SunspotTest::TimeOutError, "Solr failed to start after #{SunspotTest.solr_startup_timeout} seconds"
+        end
+      end
+
+      context "if solr is started" do
+        it "calls solr_running? and returns" do
+          SunspotTest.should_receive(:solr_running?).exactly(2).times.and_return(true)
+
+          lambda { SunspotTest.send(:wait_until_solr_starts) }.should_not raise_error
+        end
+      end
+    end
+  end
 end

data/sunspot_test.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sunspot_test}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Zach Moazeni"]
-  s.date = %q{2011-05-26}
+  s.date = %q{2011-06-11}
   s.description = %q{Testing sunspot with cucumber can be a pain. This gem will automatically start/stop solr with cucumber scenarios tagged with @search}
   s.email = %q{zach@collectiveidea.com}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "Gemfile",
     "HISTORY",
     "LICENSE",
     "README.rdoc",
@@ -26,7 +27,7 @@ Gem::Specification.new do |s|
     "features/support/env.rb",
     "lib/sunspot_test.rb",
     "lib/sunspot_test/cucumber.rb",
-    "spec/spec.opts",
+    "lib/sunspot_test/rspec.rb",
     "spec/spec_helper.rb",
     "spec/sunspot_test_spec.rb",
     "sunspot_test.gemspec"
@@ -40,15 +41,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_runtime_dependency(%q<sunspot_rails>, [">= 1.2.1"])
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<sunspot_rails>, [">= 1.2.1"])
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
     end
   else
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<sunspot_rails>, [">= 1.2.1"])
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sunspot_test
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Zach Moazeni
@@ -15,41 +15,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-26 00:00:00 -04:00
+date: 2011-06-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: sunspot_rails
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  name: jeweler
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
+        hash: 3
         segments: 
-        - 1
-        - 2
-        - 1
-        version: 1.2.1
-  type: :runtime
-  version_requirements: *id001
+        - 0
+        version: "0"
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: rspec
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  name: sunspot_rails
+  type: :runtime
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 29
         segments: 
         - 1
         - 2
-        - 9
-        version: 1.2.9
-  type: :development
-  version_requirements: *id002
+        - 1
+        version: 1.2.1
+  requirement: *id003
 description: Testing sunspot with cucumber can be a pain. This gem will automatically start/stop solr with cucumber scenarios tagged with @search
 email: zach@collectiveidea.com
 executables: []
@@ -61,6 +73,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- Gemfile
 - HISTORY
 - LICENSE
 - README.rdoc
@@ -69,7 +82,7 @@ files:
 - features/support/env.rb
 - lib/sunspot_test.rb
 - lib/sunspot_test/cucumber.rb
-- spec/spec.opts
+- lib/sunspot_test/rspec.rb
 - spec/spec_helper.rb
 - spec/sunspot_test_spec.rb
 - sunspot_test.gemspec

data/spec/spec.opts

@@ -1 +0,0 @@
---color