hydra-head 3.0.0pre1

data/solr_conf/solr.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!--
+ All (relative) paths are relative to the installation path
+  
+  persistent: Save changes made via the API to this file
+  sharedLib: path to a lib directory that will be shared across all cores
+-->
+<solr persistent="false">
+
+  <!--
+  adminPath: RequestHandler path to manage cores.  
+    If 'null' (or absent), cores will not be manageable via REST
+  -->
+  <cores adminPath="/admin/cores">
+    <core name="core0" instanceDir="core0" />
+    <core name="core1" instanceDir="core1" />
+  </cores>
+</solr>

data/tasks/hydra-head-fixtures.rake

@@ -0,0 +1,54 @@
+#require 'rake/testtask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+namespace :hyhead do
+  namespace :fixture do
+    desc "Call hydra:delete"
+    task :delete => ["hyhead:use_test_app"] do
+      puts %x[rake hydra:delete]
+      FileUtils.cd('../../')
+    end
+    
+    desc "Call hydra:harvest_fixture"
+    task :harvest => ["hyhead:use_test_app"] do
+      puts %x[rake hydra:harvest_fixture]
+      FileUtils.cd('../../')
+    end
+    
+    desc "Call hydra:import_fixture from within the test app"
+    task :import => ["hyhead:use_test_app"] do
+      puts %x[rake hydra:import_fixture]
+      FileUtils.cd('../../')
+    end
+    
+    
+    desc "Call hydra:refresh_fixture from within the test app"
+    task :refresh => ["hyhead:use_test_app"] do
+      puts %x[rake hydra:refresh_fixture]
+      FileUtils.cd('../../')
+    end
+  end
+  
+  namespace :fixtures do
+    
+    desc "Call hydra:fixtures:refresh from within the test app"
+    task :refresh => ["hyhead:use_test_app"] do
+      puts %x[rake hydra:fixtures:refresh]
+      FileUtils.cd('../../')
+    end
+    # task :load => ["hyhead:use_test_app"] do
+    #   Rake::Task['hydra:default_fixtures:load'].invoke
+    # end
+    # task :delete do
+    #   Rake::Task['hydra:default_fixtures:delete'].invoke
+    # end
+    
+    
+    desc "Call hydra:purge_range"
+    task :purge_range => ["hyhead:use_test_app"] do
+      puts %x[rake hydra:purge_range]
+      FileUtils.cd('../../')
+    end
+  end
+end

data/tasks/hydra-head.rake

@@ -0,0 +1,247 @@
+#require 'rake/testtask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'thor/core_ext/file_binary_read'
+
+namespace :hyhead do
+
+  desc "Execute Continuous Integration build (docs, tests with coverage)"
+  task :ci do
+    Rake::Task["hyhead:doc"].invoke
+    Rake::Task["hydra:jetty:config"].invoke
+    
+    require 'jettywrapper'
+    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'),
+      :fedora_home => File.expand_path(File.dirname(__FILE__) + '/../jetty/fedora/default'),
+      :startup_wait => 30
+      }
+
+    # does this make jetty run in TEST environment???
+    error = Jettywrapper.wrap(jetty_params) do
+      Rake::Task['hyhead:setup_test_app'].invoke
+      puts %x[rake hyhead:fixtures:refresh RAILS_ENV=test] # calling hydra:fixtures:refresh from the root of the test app
+      Rake::Task['hyhead:test'].invoke
+    end
+    raise "test failures: #{error}" if error
+  end
+
+  
+  desc "Easiest way to run rspec tests. Copies code to host plugins dir, loads fixtures, then runs specs - need to have jetty running."
+  task :spec => "rspec:setup_and_run"
+  
+  namespace :rspec do
+      
+    desc "Run the hydra-head specs - need to have jetty running, test host set up and fixtures loaded."
+    task :run => :use_test_app do
+			puts "Running rspec tests"
+			puts  %x[rake hyhead:spec:run]
+      FileUtils.cd('../../')
+    end
+    
+    desc "Sets up test host, loads fixtures, then runs specs - need to have jetty running."
+    task :setup_and_run => ["hyhead:setup_test_app"] do
+			puts "Reloading fixtures"
+      puts %x[rake hyhead:fixtures:refresh RAILS_ENV=test] # calling hydra:fixtures:refresh from the root of the test app
+      Rake::Task["hyhead:rspec:run"].invoke
+    end
+        
+  end
+
+  
+  # The following is a task named :doc which generates documentation using yard
+  begin
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+    project_root = File.expand_path("#{File.dirname(__FILE__)}/../")
+    doc_destination = File.join(project_root, 'doc')
+    if !File.exists?(doc_destination) 
+      FileUtils.mkdir_p(doc_destination)
+    end
+
+    YARD::Rake::YardocTask.new(:doc) do |yt|
+      readme_filename = 'README.textile'
+      textile_docs = []
+      Dir[File.join(project_root, "*.textile")].each_with_index do |f, index| 
+        unless f.include?("/#{readme_filename}") # Skip readme, which is already built by the --readme option
+          textile_docs << '-'
+          textile_docs << f
+        end
+      end
+      yt.files   = Dir.glob(File.join(project_root, '*.rb')) + 
+                   Dir.glob(File.join(project_root, 'app', '**', '*.rb')) + 
+                   Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) + 
+                   textile_docs
+      yt.options = ['--output-dir', doc_destination, '--readme', readme_filename]
+    end
+  rescue LoadError
+    desc "Generate YARD Documentation"
+    task :doc do
+      abort "Please install the YARD gem to generate rdoc."
+    end
+  end
+  
+  #
+  # Cucumber
+  #
+  
+  
+  # desc "Easieset way to run cucumber tests. Sets up test host, refreshes fixtures and runs cucumber tests"
+  # task :cucumber => "cucumber:setup_and_run"
+  task :cucumber => "cucumber:run"
+  
+
+  namespace :cucumber do
+   
+   desc "Run cucumber tests for hyhead - need to have jetty running, test host set up and fixtures loaded."
+   task :run => :set_test_host_path do
+     Dir.chdir(TEST_HOST_PATH)
+     puts "Running cucumber features in test host app"
+     puts %x[rake hyhead:cucumber]
+     # puts %x[cucumber --color --tags ~@pending --tags ~@overwritten features]
+     raise "Cucumber tests failed" unless $?.success?
+     FileUtils.cd('../../')
+   end
+ 
+   # desc "Sets up test host, loads fixtures, then runs cucumber features - need to have jetty running."
+   # task :setup_and_run => ["hyhead:setup_test_app", "hyhead:remove_features_from_host", "hyhead:copy_features_to_host"] do
+   #   system("rake hydra:fixtures:refresh environment=test")
+   #   Rake::Task["hyhead:cucumber:run"].invoke
+   # end    
+  end
+   
+# Not sure if these are necessary - MZ 09Jul2011 
+  # desc "Copy current contents of the features directory into TEST_HOST_PATH/test_support/features"
+  # task :copy_features_to_host => [:set_test_host_path] do
+  #   features_dir = "#{TEST_HOST_PATH}/test_support/features"
+  #   excluded = [".", ".."]
+  #   FileUtils.mkdir_p(features_dir)
+  #   puts "Copying features to #{features_dir}"
+  #   # puts %x[ls -l test_support/features/mods_asset_search_result.feature]
+  #   %x[cp -R test_support/features/* #{features_dir}]
+  # end
+  # 
+  # desc "Remove TEST_HOST_PATH/test_support/features"
+  # task :remove_features_from_host => [:set_test_host_path] do
+  #   features_dir = "#{TEST_HOST_PATH}/test_support/features"
+  #   puts "Emptying out #{features_dir}"
+  #   %x[rm -rf #{features_dir}]
+  # end
+  
+  
+  #
+  # Misc Tasks
+  #
+  
+  desc "Creates a new test app"
+  task :setup_test_app => [:set_test_host_path] do
+    # Thor::Util.load_thorfile('tasks/test_app_builder.thor', nil, nil)
+    # klass, task = Thor::Util.find_class_and_task_by_namespace("hydra:test_app_builder:build")
+    # klass.start([task])
+      path = TEST_HOST_PATH
+      errors = []
+      puts "Cleaning out test app path"
+      %x[rm -fr #{path}]
+      errors << 'Error removing test app' unless $?.success?
+
+      FileUtils.mkdir_p(path)
+      
+      puts "Copying over .rvmrc file"
+      FileUtils.cp("./test_support/etc/rvmrc",File.join(path,".rvmrc"))
+      FileUtils.cd("tmp")
+      system("source ./test_app/.rvmrc")
+      
+      puts "Installing rails, bundler and devise"
+      %x[gem install --no-rdoc --no-ri 'rails']
+      %x[gem install --no-rdoc --no-ri 'bundler']
+      %x[gem install --no-rdoc --no-ri 'devise']
+      
+      puts "Generating new rails app"
+      %x[rails new test_app]
+      errors << 'Error generating new rails test app' unless $?.success?
+      FileUtils.cd('test_app')
+      
+      FileUtils.rm('public/index.html')
+
+
+      after = 'TestApp::Application.configure do'
+      replace!( "#{path}/config/environments/test.rb",  /#{after}/, "#{after}\n    config.log_level = :warn\n")
+      
+
+      puts "Copying Gemfile from test_support/etc"
+      FileUtils.cp('../../test_support/etc/Gemfile','./Gemfile')
+
+      puts "Creating local vendor/cache dir and copying gems from hyhead-rails3 gemset"
+      FileUtils.cp_r(File.join('..','..','vendor','cache'), './vendor')
+      
+      puts "Copying fixtures into test app spec/fixtures directory"
+      FileUtils.mkdir_p( File.join('.','test_support') )
+      FileUtils.cp_r(File.join('..','..','test_support','fixtures'), File.join('.','test_support','fixtures'))
+      
+      puts "Executing bundle install --local"
+      %x[bundle install --local]
+      errors << 'Error running bundle install in test app' unless $?.success?
+
+      puts "Installing cucumber in test app"
+      %x[rails g cucumber:install]
+      errors << 'Error installing cucumber in test app' unless $?.success?
+
+      puts "generating default blacklight install"
+      %x[rails generate blacklight --devise]
+      errors << 'Error generating default blacklight install' unless $?.success?
+      
+      puts "generating default hydra-head install"
+      %x[rails generate hydra:head -df]  # using -f to force overwriting of solr.yml
+      errors << 'Error generating default hydra-head install' unless $?.success?
+
+      puts "Running rake db:migrate"
+      %x[rake db:migrate]
+      %x[rake db:migrate RAILS_ENV=test]
+      raise "Errors: #{errors.join("; ")}" unless errors.empty?
+
+
+    
+    FileUtils.cd('../../')
+    
+
+  end
+  
+  task :set_test_host_path do
+    TEST_HOST_PATH = File.join(File.expand_path(File.dirname(__FILE__)),'..','tmp','test_app')
+  end
+  
+  #
+  # Test
+  #
+
+  desc "Run tests against test app"
+  task :test => [:use_test_app]  do
+    
+    puts "Running rspec tests"
+    puts  %x[rake hyhead:spec:rcov]
+
+    puts "Running cucumber tests"
+    puts %x[rake hyhead:cucumber]
+
+    FileUtils.cd('../../')
+    puts "Completed test suite"
+  end
+  
+  desc "Make sure the test app is installed, then run the tasks from its root directory"
+  task :use_test_app => [:set_test_host_path] do
+    Rake::Task['hyhead:setup_test_app'].invoke unless File.exist?(TEST_HOST_PATH)
+    FileUtils.cd(TEST_HOST_PATH)
+  end
+end
+
+
+        # Adds the content to the file.
+        #
+        def replace!(destination, regexp, string)
+          content = File.binread(destination)
+          content.gsub!(regexp, string)
+          File.open(destination, 'wb') { |file| file.write(content) }
+        end

data/tasks/hydra_jetty.rake

@@ -0,0 +1,79 @@
+require "hydra/testing_server"
+
+# if you would like to see solr startup messages on STDERR
+# when starting solr test server during functional tests use:
+# 
+#    rake SOLR_CONSOLE=true
+JETTY_PARAMS = {
+  :quiet => ENV['HYDRA_CONSOLE'] ? false : true,
+  :jetty_home => ENV['HYDRA_JETTY_HOME'],
+  :jetty_port => 8983,
+  :solr_home => ENV['HYDRA_SOLR_HOME'],
+  :fedora_home => ENV['HYDRA_SOLR_HOME']
+}
+
+#:jetty_port => ENV['HYDRA_JETTY_PORT'],
+namespace :hydra do
+  namespace :jetty do
+    desc "Starts the bundled Hydra Testing Server"
+    task :start do
+      Hydra::TestingServer.configure(JETTY_PARAMS)
+      Hydra::TestingServer.instance.start
+    end
+    
+    desc "Stops the bundled Hydra Testing Server"
+    task :stop do
+      Hydra::TestingServer.instance.stop
+    end
+    
+    desc "Restarts the bundled Hydra Testing Server"
+    task :restart do
+      Hydra::TestingServer.instance.stop
+      Hydra::TestingServer.configure(JETTY_PARAMS)
+      Hydra::TestingServer.instance.start
+    end
+
+    desc "Copies the default Solr & Fedora configs into the bundled Hydra Testing Server"
+    task :config do
+      Rake::Task["hydra:jetty:config_fedora"].invoke
+      Rake::Task["hydra:jetty:config_solr"].invoke
+    end
+    
+    desc "Copies the default SOLR config for the bundled Hydra Testing Server"
+    task :config_solr do
+      FileList['solr_conf/conf/*'].each do |f|  
+        cp("#{f}", 'jetty/solr/development-core/conf/', :verbose => true)
+        cp("#{f}", 'jetty/solr/test-core/conf/', :verbose => true)
+    end
+
+    end
+
+    desc "Copies a custom fedora config for the bundled Hydra Testing Server"
+    task :config_fedora do
+      # load a custom fedora.fcfg - 
+      if defined?(Rails.root)
+        app_root = Rails.root
+      else
+        app_root = File.join(File.dirname(__FILE__),"..")
+      end
+       
+      fcfg = File.join(app_root,"fedora_conf","conf","fedora.fcfg")
+      puts "PWD:: #{FileUtils.pwd}"
+      if File.exists?(fcfg)
+        puts "copying over fedora.fcfg"
+        cp("#{fcfg}", 'jetty/fedora/default/server/config/', :verbose => true)
+      else
+        puts "#{fcfg} file not found -- skipping fedora config"
+      end
+    end
+
+    desc "Copies the default SOLR config files and starts up the fedora instance."
+    task :load => [:config, :start]
+
+    desc "Returns the status of the Hydra::TestingServer."
+    task :status do
+      status = Hydra::TestingServer.instance.pid ? "Running: #{Hydra::TestingServer.instance.pid}" : "Not running"
+      puts status
+    end
+  end
+end

data/tasks/replicator.rake

@@ -0,0 +1,27 @@
+namespace :replicator do
+  
+  desc 'Copy a fedora object of the given pid.'
+  task :copy_object => :environment do 
+    if ENV['PID']
+      replicator = Solrizer::Replicator.new
+      replicator.replicate_object(ENV['PID'])
+    else
+      puts "You must provide a pid using the format 'replicator::copy_object PID=sample:pid'."
+    end
+  end
+  
+  desc 'Copy all objects in the repository.'
+  task :copy_objects => :environment do
+  
+    if ENV['REPLICATOR_LIST']
+      REPLICATOR_LIST = ENV['REPLICATOR_LIST']
+    end
+  
+    replicator = Solrizer::Replicator.new
+    puts "Source URL: #{ActiveFedora.fedora_config[:url]}"
+    puts "Destination URL: #{replicator.configs["destination"]["fedora"]["url"]}"
+    replicator.replicate_objects
+    puts "Replicator task complete."
+  end
+  
+end

data/tasks/solrizer-fedora.rake

@@ -0,0 +1,53 @@
+namespace :solrizer do
+  
+  namespace :fedora  do
+    desc 'Index a fedora object of the given pid.'
+    task :solrize => [:init, :environment] do 
+      index_full_text = ENV['FULL_TEXT'] == 'true'
+      if ENV['PID']
+        puts "indexing #{ENV['PID'].inspect}"
+        solrizer = Solrizer::Fedora::Solrizer.new :index_full_text=> index_full_text
+        solrizer.solrize(ENV['PID'])
+        puts "Finished shelving #{ENV['PID']}"
+      else
+        puts "You must provide a pid using the format 'solrizer::solrize_object PID=sample:pid'."
+      end
+    end
+  
+    desc 'Index all objects in the repository.'
+    task :solrize_objects => [:init, :environment] do
+      index_full_text = ENV['FULL_TEXT'] == 'true'
+      if ENV['INDEX_LIST']
+        @@index_list = ENV['INDEX_LIST']
+      end
+    
+      puts "Re-indexing Fedora Repository."
+      puts "Fedora URL: #{ActiveFedora.fedora_config[:url]}"
+      puts "Fedora Solr URL: #{ActiveFedora.solr_config[:url]}"
+      puts "Blacklight Solr Config: #{Blacklight.solr_config.inspect}"
+      puts "Doing full text index." if index_full_text
+      solrizer = Solrizer::Fedora::Solrizer.new :index_full_text=> index_full_text
+      solrizer.solrize_objects
+      puts "Solrizer task complete."
+    end  
+    
+    desc 'Remove fedora-system objects from index'
+    task :forget_system_objects => :init do
+      objects = ::Fedora::Repository.instance.find_objects("pid~fedora-system:*")
+      objects.each do |obj|
+        logger.debug "Deleting solr doc for #{obj.pid} from #{ActiveFedora.solr_config[:url]}"
+        ActiveFedora::SolrService.instance.conn.delete(obj.pid) 
+      end
+    end
+    
+    desc "Init solrizer-fedora configuration" 
+    task :init do
+      if !ENV["environment"].nil? 
+        RAILS_ENV = ENV["environment"]
+      end
+      # Don't need to do anything.  The gem handles loading all configurations for you.
+      # ActiveFedora.init
+    end
+  end
+  
+end