blacklight 3.0pre1 → 3.0pre2

data/lib/railties/all_tests.rake

@@ -0,0 +1,11 @@
+namespace :blacklight do
+  desc "Run Blacklight cucumber and rspec"
+  task :all_tests => ['blacklight:spec:with_solr', 'blacklight:cucumber:with_solr']
+
+  namespace :all_tests do
+    desc "Run Blacklight rspec and cucumber tests with rcov"
+    rm "blacklight-coverage.data" if File.exist?("blacklight-coverage.data")
+    task :rcov => ['blacklight:spec:rcov', 'blacklight:cucumber:rcov']
+  end
+end
+

data/lib/railties/blacklight.rake

@@ -11,56 +11,4 @@ namespace :blacklight do
 
 end
   
-# Rake tasks for Blacklight plugin
-
-# if you would like to see solr startup messages on STDERR
-# when starting solr test server during functional tests use:
-# 
-#    rake SOLR_CONSOLE=true
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_solr_server.rb'))
-
-
-SOLR_PARAMS = {
-  :quiet => ENV['SOLR_CONSOLE'] ? false : true,
-  :jetty_home => ENV['SOLR_JETTY_HOME'] || File.expand_path('./jetty'),
-  :jetty_port => ENV['SOLR_JETTY_PORT'] || 8888,
-  :solr_home => ENV['SOLR_HOME'] || File.expand_path('./jetty/solr')
-}
-
-NO_JETTY_MSG = "In order to use solr:spec, you much checkout Blacklight-jetty from our github repository, and place it in the root of your application under the directory /jetty. \n  prompt> git clone git@github.com:projectblacklight/blacklight-jetty.git jetty \n You will also need to pupulate your test instance of solr with test data.  You can do this with: \n prompt>  rake solr:marc:index_test_data RAILS_ENV=test" 
-
-namespace :solr do
-  
-  desc "Calls RSpec Examples wrapped in the test instance of Solr"
-  task :spec do
-    raise NO_JETTY_MSG unless File.exists? SOLR_PARAMS[:jetty_home]
-    # wrap tests with a test-specific Solr server
-    error = TestSolrServer.wrap(SOLR_PARAMS) do
-      rm_f "coverage.data"
-      Rake::Task["rake:spec"].invoke 
-      #puts `ps aux | grep start.jar` 
-    end
-    raise "test failures: #{error}" if error
-  end
-  
-  desc "Calls Cucumber Features wrapped in the test instance of Solr"
-  task :features do
-    # wrap tests with a test-specific Solr server
-    error = TestSolrServer.wrap(SOLR_PARAMS) do
-      Rake::Task["cucumber:all"].invoke 
-      #puts `ps aux | grep start.jar` 
-    end
-    raise "test failures: #{error}" if error
-  end
-  
-  desc "Runs all features and specs"
-  task :all do
-    error = TestSolrServer.wrap(SOLR_PARAMS) do
-      Rake::Task["rake:spec"].invoke
-      Rake::Task["cucumber:all"].invoke
-    end
-    raise "test failures: #{error}" if error
-  end
-  
-end
 

data/lib/railties/blacklight_cucumber.rake

@@ -0,0 +1,125 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+# Blacklight customization, trick Cucumber into looking in our current
+# location for Rails.root, even though we're going to give it features
+# from elsewhere. 
+ENV['RAILS_ROOT'] = Rails.root
+
+# blacklight_features, where to find features inside blacklight source?
+blacklight_features = File.expand_path("./test_support/features", Blacklight.root)
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :blacklight do
+    namespace :cucumber do
+      Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
+        # Blacklight customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = blacklight_features
+        
+        t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'default'
+      end
+
+      Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
+        # Blacklight customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = blacklight_features
+        
+        
+        t.binary = vendored_cucumber_bin
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'wip'
+      end
+  
+      Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+        # Blacklight customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = blacklight_features
+        
+        t.binary = vendored_cucumber_bin
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'rerun'
+      end
+
+      Cucumber::Rake::Task.new({:rcov => 'db:test:prepare'}, 'Run features with rcov') do |t|
+        # Blacklight customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = blacklight_features
+        
+        t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'default'
+        t.rcov = true
+        t.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/ --aggregate blacklight-coverage.data}
+        t.rcov_opts << %[-o "blacklight-coverage"]
+      end
+  
+  
+      desc 'Run all features'
+      task :all => [:ok, :wip]
+      
+      
+      # Solr wrapper. for now just for blacklight:cucumber, plan to
+      # provide it for all variants eventually.
+      # if you would like to see solr startup messages on STDERR
+      # when starting solr test server during functional tests use:
+      # 
+      #    rake SOLR_CONSOLE=true
+      require File.expand_path('../jetty_solr_server.rb', __FILE__)
+      desc "blacklight:cucumber with jetty/solr launch"
+      task :with_solr do      
+        # wrap tests with a test-specific Solr server
+        # Need to look  up where the test jetty is located
+        # from solr.yml, we don't hardcode it anymore. 
+
+        solr_yml_path = locate_path("config", "solr.yml")
+        jetty_path = if ( File.exists?( solr_yml_path ))
+            solr_config = YAML::load(File.open(solr_yml_path))
+            solr_config["test"]["jetty_path"] if solr_config["test"]
+        end   
+        raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
+        
+        JettySolrServer.new(
+          :jetty_home => File.expand_path(jetty_path, Rails.root), 
+          :sleep_after_start => 2).wrap do 
+            Rake::Task["blacklight:cucumber"].invoke 
+        end     
+      end      
+      
+    end
+    
+    desc 'Alias for blacklight:cucumber:ok'
+    task :cucumber => 'blacklight:cucumber:ok'
+        
+  end
+
+
+  
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have ActiveRecord, append a no-op task that we can depend upon.
+  task 'db:test:prepare' do
+  end
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/lib/railties/blacklight_rspec.rake

@@ -0,0 +1,128 @@
+# Blacklight customization of the Rake tasks that come with rspec-2, to run
+# specs located in alternate location (inside BL plugin), and to provide
+# rake tasks for jetty/solr wrapping. 
+#
+# Same tasks as in ordinary rspec, but prefixed with blacklight:. 
+#
+# rspec2 keeps it's rake tasks inside it's own code, it doesn't generate them. 
+# We had to copy them from there and modify, may have to be done again
+# if rspec2 changes a lot, but this code looks relatively cleanish. 
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+  Rake.application.instance_variable_get('@tasks')['default'].prerequisites.delete('test')
+  
+  spec_prereq = Rails.configuration.generators.options[:rails][:orm] == :active_record ?  "db:test:prepare" : :noop
+  task :noop do; end
+  #task :default => :spec
+  
+  blacklight_spec = File.expand_path("./test_support/spec", Blacklight.root)
+  
+  # Set env variable to tell our spec/spec_helper.rb where we really are,
+  # so it doesn't have to guess with relative path, which will be wrong
+  # since we allow spec_dir to be in a remote location. spec_helper.rb
+  # needs it before Rails.root is defined there, even though we can
+  # oddly get it here, i dunno. 
+  ENV['RAILS_ROOT'] = Rails.root
+  
+  namespace :blacklight do
+    
+    desc "Run all specs in spec directory (excluding plugin specs)"
+    RSpec::Core::RakeTask.new(:spec => spec_prereq) do |t|
+      # the user might not have run rspec generator because they don't
+      # actually need it, but without an ./.rspec they won't get color,
+      # let's insist. 
+      t.rspec_opts = "--colour"
+      
+      # pattern directory name defaults to ./**/*_spec.rb, but has a more concise command line echo
+      t.pattern = "#{blacklight_spec}"      
+    end
+    
+    # Don't understand what this does or how to make it use our remote stats_directory
+    #task :stats => "spec:statsetup"
+    
+    namespace :spec do
+      [:requests, :models, :controllers, :views, :helpers, :mailers, :lib, :routing].each do |sub|
+        desc "Run the code examples in spec/#{sub}"
+        RSpec::Core::RakeTask.new(sub => spec_prereq) do |t|
+          # the user might not have run rspec generator because they don't
+          # actually need it, but without an ./.rspec they won't get color,
+          # let's insist. 
+          t.rspec_opts = "--colour"
+          
+          # pattern directory name defaults to ./**/*_spec.rb, but has a more concise command line echo
+          t.pattern = "#{blacklight_spec}/#{sub}" 
+        end
+      end
+    
+      desc "Run all specs with rcov"
+      RSpec::Core::RakeTask.new(:rcov => spec_prereq) do |t|
+        t.rcov = true
+        # pattern directory name defaults to ./**/*_spec.rb, but has a more concise command line echo
+        t.pattern = File.join(blacklight_spec, "/**/*_spec.rb")
+          t.rspec_opts = "--colour"
+        t.rcov_opts = '-o "blacklight-coverage" --exclude /gems/,/Library/,/usr/,lib/tasks,.bundle,config,/lib/rspec/,/lib/rspec-'
+      end
+      
+      # Blacklight. Solr wrapper. for now just for blacklight:spec, plan to
+      # provide it for all variants eventually.
+      # if you would like to see solr startup messages on STDERR
+      # when starting solr test server during functional tests use:
+      # 
+      #    rake SOLR_CONSOLE=true      
+      require File.expand_path('../jetty_solr_server.rb', __FILE__)
+      desc "blacklight:solr with jetty/solr launch"
+      task :with_solr do    
+        # wrap tests with a test-specific Solr server
+        # Need to look  up where the test jetty is located
+        # from solr.yml, we don't hardcode it anymore. 
+
+        solr_yml_path = locate_path("config", "solr.yml")
+        jetty_path = if ( File.exists?( solr_yml_path ))
+            solr_config = YAML::load(File.open(solr_yml_path))
+            solr_config["test"]["jetty_path"] if solr_config["test"]
+        end   
+        raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
+
+        
+        # wrap tests with a test-specific Solr server
+        JettySolrServer.new(
+          :jetty_home => File.expand_path(jetty_path, Rails.root), 
+          :sleep_after_start => 2).wrap do          
+            Rake::Task["blacklight:spec"].invoke 
+        end             
+      end
+      
+    
+      # Don't understand what this does or how to make it use our remote stats_directory.
+      # task :statsetup do
+        # require 'rails/code_statistics'
+        # ::STATS_DIRECTORIES << %w(Model\ specs spec/models) if File.exist?('spec/models')
+        # ::STATS_DIRECTORIES << %w(View\ specs spec/views) if File.exist?('spec/views')
+        # ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers) if File.exist?('spec/controllers')
+        # ::STATS_DIRECTORIES << %w(Helper\ specs spec/helpers) if File.exist?('spec/helpers')
+        # ::STATS_DIRECTORIES << %w(Library\ specs spec/lib) if File.exist?('spec/lib')
+        # ::STATS_DIRECTORIES << %w(Mailer\ specs spec/mailers) if File.exist?('spec/mailers')
+        # ::STATS_DIRECTORIES << %w(Routing\ specs spec/routing) if File.exist?('spec/routing')
+        # ::STATS_DIRECTORIES << %w(Request\ specs spec/requests) if File.exist?('spec/requests')
+        # ::CodeStatistics::TEST_TYPES << "Model specs" if File.exist?('spec/models')
+        # ::CodeStatistics::TEST_TYPES << "View specs" if File.exist?('spec/views')
+        # ::CodeStatistics::TEST_TYPES << "Controller specs" if File.exist?('spec/controllers')
+        # ::CodeStatistics::TEST_TYPES << "Helper specs" if File.exist?('spec/helpers')
+        # ::CodeStatistics::TEST_TYPES << "Library specs" if File.exist?('spec/lib')
+        # ::CodeStatistics::TEST_TYPES << "Mailer specs" if File.exist?('spec/mailers')
+        # ::CodeStatistics::TEST_TYPES << "Routing specs" if File.exist?('spec/routing')
+        # ::CodeStatistics::TEST_TYPES << "Request specs" if File.exist?('spec/requests')
+      # end
+    end
+  end  
+rescue LoadError
+  # This rescue pattern stolen from cucumber; rspec didn't need it before since
+  # tasks only lived in rspec gem itself, but for Blacklight since we're copying
+  # these tasks into BL, we use the rescue so you can still run BL (without
+  # these tasks) even if you don't have rspec installed. 
+  desc 'rspec rake tasks not available (rspec not installed)'
+  task :spec do
+    abort 'Rspec rake tasks  not available. Be sure to install rspec gems. '
+  end
+end

data/lib/railties/{test_solr_server.rb → jetty_solr_server.rb}

@@ -14,37 +14,28 @@
 # The behavior of TestSolrServer can be modified prior to start() by changing 
 # port, solr_home, and quiet properties.
 
-class TestSolrServer
-  require 'singleton'
-  include Singleton
-  attr_accessor :port, :jetty_home, :solr_home, :quiet
+class JettySolrServer
+  attr_accessor :port, :jetty_home, :solr_home, :quiet, :sleep_after_start, :pid
 
   # configure the singleton with some defaults
-  def initialize
+  def initialize(params = {})
     @pid = nil
+    self.quiet = params.has_key?(:quiet) ? !!params[:quiet] : true
+    self.jetty_home = params[:jetty_home]
+    self.solr_home = params[:solr_home] || File.expand_path("./solr", self.jetty_home)
+    self.port = params[:jetty_port] || 8888
+    self.sleep_after_start = params[:sleep_after_start]
   end
 
-  def self.wrap(params = {})
-    error = false
-    solr_server = self.instance
-    solr_server.quiet = params[:quiet] || true
-    solr_server.jetty_home = params[:jetty_home]
-    solr_server.solr_home = params[:solr_home]
-    solr_server.port = params[:jetty_port] || 8888
+  def wrap        
+    puts "JettySolrServer: starting server on #{RUBY_PLATFORM}"
+    self.start
     begin
-      puts "starting solr server on #{RUBY_PLATFORM}"
-      solr_server.start
-      sleep params[:startup_wait] || 5
       yield
-    rescue
-      error = $!
-      puts "*** Solr/Jetty Startup Error: #{error}"
-    ensure
-      puts "stopping solr server"
-      solr_server.stop
+    ensure      
+      puts "JettySolrServer: stopping solr server"
+      self.stop
     end
-
-    return error
   end
   
   def jetty_command
@@ -52,10 +43,14 @@ class TestSolrServer
   end
   
   def start
-    puts "jetty_home: #{@jetty_home}"
-    puts "solr_home: #{@solr_home}"
-    puts "jetty_command: #{jetty_command}"
+    puts "\nexecuting: #{jetty_command}\n\n"
+    
     platform_specific_start
+    
+    if self.sleep_after_start
+      puts "sleeping #{self.sleep_after_start}s waiting for startup."
+      sleep self.sleep_after_start
+    end
   end
   
   def stop
@@ -86,15 +81,13 @@ class TestSolrServer
   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)
+      raise 'JRuby requires that you start solr manually."' 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
@@ -112,19 +105,3 @@ class TestSolrServer
   end
 
 end
-# 
-# puts "hello"
-# SOLR_PARAMS = {
-#   :quiet => ENV['SOLR_CONSOLE'] ? false : true,
-#   :jetty_home => ENV['SOLR_JETTY_HOME'] || File.expand_path('../../jetty'),
-#   :jetty_port => ENV['SOLR_JETTY_PORT'] || 8888,
-#   :solr_home => ENV['SOLR_HOME'] || File.expand_path('test')
-# }
-# 
-# # wrap functional tests with a test-specific Solr server
-# got_error = TestSolrServer.wrap(SOLR_PARAMS) do
-#   puts `ps aux | grep start.jar` 
-# end
-# 
-# raise "test failures" if got_error
-# 

data/lib/railties/solr_marc.rake

@@ -14,8 +14,12 @@ namespace :solr do
     
     desc "Index the supplied test data into Solr"
     task :index_test_data do
-      ENV['MARC_FILE'] = locate_path("spec", "data", "test_data.utf8.mrc")
-
+      # for now we are assuming test data is located in BL source checkout. 
+      ENV['MARC_FILE'] = File.expand_path("./test_support/data/test_data.utf8.mrc", Blacklight.root )
+      
+      # solr_path and solr_war_path will be picked up from 
+      # jetty_path in solr.yml by main work task. 
+      
       Rake::Task[ "solr:marc:index:work" ].invoke
     end
     
@@ -117,11 +121,23 @@ def compute_arguments
   # Solr URL, find from solr.yml, app or plugin
   # use :replicate_master_url for current env if present, otherwise :url
   # for current env. 
+  # Also take jetty_path from there if present. 
   solr_yml_path = locate_path("config", "solr.yml")
   if ( File.exists?( solr_yml_path ))
     solr_config = YAML::load(File.open(solr_yml_path))
-    arguments[:solr_url] = solr_config[ ::Rails.env ]['url'] if solr_config[::Rails.env]
+    if c = solr_config[::Rails.env]
+      arguments[:solr_url] = c['url']    
+      if c['jetty_path']
+        arguments[:solr_path] = File.expand_path(File.join(c['jetty_path'], "solr"), Rails.root)
+        arguments[:solr_war_path] = File.expand_path(File.join(c['jetty_path'], "webapps", "solr.war"), Rails.root)
+      end
+    end
   end
+  
+  # solrmarc.solr.war.path and solr.path, for now pull out of ENV
+  # if present. In progress. jrochkind 25 Apr 2011. 
+  arguments[:solr_war_path] = ENV["SOLR_WAR_PATH"] if ENV["SOLR_WAR_PATH"]
+  arguments[:solr_path] = ENV['SOLR_PATH'] if ENV['SOLR_PATH']
 
 
   return arguments
@@ -130,14 +146,17 @@ end
 def solrmarc_command_line(arguments)
   cmd = "java #{arguments[:solrmarc_mem_arg]} "
   cmd += " -Dsolr.hosturl=#{arguments[:solr_url]} " unless arguments[:solr_url].blank?
+  
+  cmd += " -Dsolrmarc.solr.war.path=#{arguments[:solr_war_path]}" unless arguments[:solr_war_path].blank?
+  cmd += " -Dsolr.path=#{arguments[:solr_path]}" unless arguments[:solr_path].blank?
+  
   cmd += " -jar #{arguments[:solrmarc_jar_path]} #{arguments[:config_properties_path]} #{arguments["MARC_FILE"]}"  
   return cmd  
 end
 
 
 def locate_path(*subpath_fragments)
-  local_root = File.expand_path File.join(File.dirname(__FILE__), '..', '..')
-  puts "The local_root is #{local_root}"
+  local_root = File.expand_path File.join(File.dirname(__FILE__), '..', '..')  
   subpath = subpath_fragments.join('/')
   base_match = [Rails.root, local_root].find do |base|
     File.exists? File.join(base, subpath)