solr_wrapper 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f93c8c8e3f7fa76db872d7a78d3248f92cf2339b
-  data.tar.gz: ba80a71c7d8ca4efe0f75332fe36e58b3da1e4b2
+  metadata.gz: 02801c03fb674022382afba55cb728b5ec82d177
+  data.tar.gz: e042c59c01ab0ed69f48a0415032c5e5f798ae4b
 SHA512:
-  metadata.gz: d943fd2c94733672e648d3496b581ace396de3d553be1d7e006f1e085598fdf1acde4a0ca60e0ff2f90cb32bf6c13b26d77f6113ae7ff1a286679a99f232542b
-  data.tar.gz: 916ab091e2af478a5a18f4a3fc782ea9dd65ebe0fbcea97203bc50f9178faec61ed7d7a4d7e8d153668c02ff80024a8174221431225d8a8e1d8a63a214fe80b7
+  metadata.gz: 36168cce73a5fef10a0e683068363955f94f23cfc92132f6bf856b89d75605f9a804506aa8d2cd6bdc07acdc930f5053fb43a6aab7eeac311eb9d427b9f04d06
+  data.tar.gz: c9e006036531e1e31a23b3babda62345a1c6742d741d7ede1fa4f2eeac579f3dd3372dacfc9f6be6924dfdee883bc594b9b1f39882fe17f52db90f077cd16466

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 sudo: false
 rvm:
   - 2.2.0
-  - jruby
+  - jruby-9.0.1.0
 cache:
   directories:
   - /tmp/solr-5.1.0

data/README.md

@@ -11,18 +11,67 @@ end
 Or with Solr and a solr collection:
 
 ```ruby
-  subject.wrap do |solr|
-    solr.with_collection(dir: File.join(FIXTURES_DIR, "basic_configs")) do |collection_name|
-    end
+SolrWrapper.wrap do |solr|
+  solr.with_collection(dir: File.join(FIXTURES_DIR, "basic_configs")) do |collection_name|
   end
+end
 ```
 
 ## Basic Options
 
 ```ruby
-SolrWrapper.wrap port: 8983, verbose: true, managed: true 
+SolrWrapper.wrap port: 8983,
+                 verbose: true,
+                 managed: true,
+                 instance_dir: '/opt/solr'
 ```
 
+Options:
+
+|Option         |                                         |
+|---------------|-----------------------------------------|
+| instance_dir  | Directory to store the solr index files |
+| url           | URL of the Zip file to download |
+| version       | Solr version to download and install |
+| port          | port to run Solr on |
+| version_file  | Local path to store the currently installed version |
+| download_path | Local path for storing the downloaded Solr zip file |
+| md5sum        | Path/URL to MD5 checksum |
+| solr_xml      | Path to Solr configuration |
+| verbose       | (Boolean) |
+| managed       | (Boolean) |
+| ignore_md5sum | (Boolean) |
+| solr_options  | (Hash) |
+| env           | (Hash) |
+
 ```ruby
-solr.with_collection(name: 'collection_name', dir: 'path_to_solr_confiigs')
-```
+solr.with_collection(name: 'collection_name', dir: 'path_to_solr_configs')
+```
+
+## From the command line
+
+```console
+$ solr_wrapper -p 8983
+```
+
+## Rake tasks
+
+SolrWrapper provides rake tasks for installing, starting and stopping solr.  To include the tasks in your Rake environment, add this to your Rakefile
+
+```ruby
+  require 'solr_wrapper/rake_task'
+```
+
+You can configure the tasks by setting `SolrWrapper.default_instance_options`.  For example:
+
+```ruby
+SolrWrapper.default_instance_options = {
+    verbose: true,
+    cloud: true,
+    port: '8888',
+    version: '5.3.1',
+    instance_dir: 'solr',
+    download_dir: 'tmp'
+}
+require 'solr_wrapper/rake_task'
+```

data/exe/solr_wrapper

@@ -4,6 +4,7 @@ require 'solr_wrapper'
 require 'optparse'
 
 options = {}
+collection_options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: solr_wrapper [options]"
 
@@ -18,13 +19,36 @@ OptionParser.new do |opts|
   opts.on("-pPORT", "--port PORT", "Specify the port Solr should run at (default: 8983)") do |p|
     options[:port] = p
   end
+
+  opts.on("-c", "--cloud", "Run solr in cloud mode") do |c|
+    options[:cloud] = c
+  end
+
+  opts.on("-iDIR", "--instance_directory DIR", "Install/use solr at the given directory") do |d|
+    options[:instance_dir] = d
+  end
+
+  opts.on("-lDIR", "--lib_directory DIR", "Grab extra libs from this directory") do |d|
+    options[:extra_lib_dir] = d
+  end
+
+  opts.on("-nNAME", "--collection_name NAME", "Create a default solr collection with the given name") do |c|
+    collection_options[:name] = c
+  end
+
+  opts.on("-dDIR", "--collection_config DIR", "Create a default solr collection with the files from the given directory") do |d|
+    collection_options[:dir] = d
+  end
+
 end.parse!
 
 # default to verbose
 options[:verbose] = true if options[:verbose].nil?
 
 SolrWrapper.wrap(options) do |conn|
-  while conn.status
-    sleep 1
+  conn.with_collection(collection_options) do
+    while conn.status
+      sleep 1
+    end
   end
 end

data/lib/solr_wrapper/instance.rb

@@ -15,15 +15,18 @@ module SolrWrapper
     ##
     # @param [Hash] options
     # @option options [String] :url
-    # @option options [String] :version
-    # @option options [String] :port
-    # @option options [String] :version_file
-    # @option options [String] :instance_dir
-    # @option options [String] :download_path
-    # @option options [String] :md5sum
-    # @option options [String] :solr_xml
-    # @option options [Boolean] :verbose
-    # @option options [Boolean] :managed
+    # @option options [String] :instance_dir Directory to store the solr index files
+    # @option options [String] :version Solr version to download and install
+    # @option options [String] :port port to run Solr on
+    # @option options [Boolean] :cloud Run solr in cloud mode
+    # @option options [String] :version_file Local path to store the currently installed version
+    # @option options [String] :download_dir Local directory to store the downloaded Solr zip and its md5 file in (overridden by :download_path)
+    # @option options [String] :download_path Local path for storing the downloaded Solr zip file
+    # @option options [Boolean] :validate Should solr_wrapper download a new md5 and (re-)validate the zip file? (default: trueF)
+    # @option options [String] :md5sum Path/URL to MD5 checksum
+    # @option options [String] :solr_xml Path to Solr configuration
+    # @option options [String] :extra_lib_dir Path to directory containing extra libraries to copy into instance_dir/lib
+    # @option options [Boolean] :verbose return verbose info when running solr commands
     # @option options [Boolean] :ignore_md5sum
     # @option options [Hash] :solr_options
     # @option options [Hash] :env
@@ -32,6 +35,7 @@ module SolrWrapper
     end
 
     def wrap(&_block)
+      extract_and_configure
       start
       yield self
     ensure
@@ -41,9 +45,9 @@ module SolrWrapper
     ##
     # Start Solr and wait for it to become available
     def start
-      extract
+      extract_and_configure
       if managed?
-        exec('start', p: port)
+        exec('start', p: port, c: options[:cloud])
 
         # Wait for solr to start
         unless status
@@ -67,12 +71,20 @@ module SolrWrapper
       @pid = nil
     end
 
+    ##
+    # Stop Solr and wait for it to finish exiting
+    def restart
+      if managed? && started?
+        exec('restart', p: port, c: options[:cloud])
+      end
+    end
+
     ##
     # Check the status of a managed Solr service
     def status
       return true unless managed?
 
-      out = exec('status', output: true).read
+      out = exec('status').read
       out =~ /running on port #{port}/
     end
 
@@ -90,7 +102,10 @@ module SolrWrapper
     def create(options = {})
       options[:name] ||= SecureRandom.hex
 
-      exec("create", c: options[:name], d: options[:dir], p: port)
+      create_options = { p: port }
+      create_options[:c] = options[:name] if options[:name]
+      create_options[:d] = options[:dir] if options[:dir]
+      exec("create", create_options)
 
       options[:name]
     end
@@ -108,6 +123,8 @@ module SolrWrapper
     # @option options [String] :name
     # @option options [String] :dir
     def with_collection(options = {})
+      return yield if options.empty?
+
       name = create(options)
       begin
         yield name
@@ -126,24 +143,48 @@ module SolrWrapper
     # Clean up any files solr_wrapper may have downloaded
     def clean!
       stop
-      FileUtils.remove_entry(download_path) if File.exists? download_path
+      remove_instance_dir!
+      FileUtils.remove_entry(download_path) if File.exists?(download_path)
       FileUtils.remove_entry(tmp_save_dir, true) if File.exists? tmp_save_dir
-      FileUtils.remove_entry(instance_dir, true) if File.exists? instance_dir
       FileUtils.remove_entry(md5sum_path) if File.exists? md5sum_path
       FileUtils.remove_entry(version_file) if File.exists? version_file
     end
 
+    ##
+    # Clean up any files in the Solr instance dir
+    def remove_instance_dir!
+      FileUtils.remove_entry(instance_dir, true) if File.exists? instance_dir
+    end
+
     ##
     # Get a (likely) URL to the solr instance
     def url
       "http://127.0.0.1:#{port}/solr/"
     end
 
-    protected
+    def configure
+      raise_error_unless_extracted
+      FileUtils.cp options[:solr_xml], File.join(instance_dir, 'server', 'solr', 'solr.xml') if options[:solr_xml]
+      FileUtils.cp_r File.join(options[:extra_lib_dir], '.'), File.join(instance_dir, 'server', 'solr', 'lib') if options[:extra_lib_dir]
+    end
+
+    def instance_dir
+      @instance_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(download_url, ".zip")))
+    end
+
+    def extract_and_configure
+      instance_dir = extract
+      configure
+      instance_dir
+    end
 
     # rubocop:disable Lint/RescueException
+
+    # extract a copy of solr to instance_dir
+    # Does noting if solr already exists at instance_dir
+    # @return [String] instance_dir Directory where solr has been installed
     def extract
-      return solr_dir if File.exists?(solr_binary) && extracted_version == version
+      return instance_dir if extracted?
 
       zip_path = download
 
@@ -162,32 +203,37 @@ module SolrWrapper
       end
 
       begin
-        FileUtils.remove_dir(solr_dir, true)
-        FileUtils.cp_r File.join(tmp_save_dir, File.basename(download_url, ".zip")), solr_dir
+        FileUtils.remove_dir(instance_dir, true)
+        FileUtils.cp_r File.join(tmp_save_dir, File.basename(download_url, ".zip")), instance_dir
         self.extracted_version = version
         FileUtils.chmod 0755, solr_binary
       rescue Exception => e
-        abort "Unable to copy #{tmp_save_dir} to #{solr_dir}: #{e.message}"
+        abort "Unable to copy #{tmp_save_dir} to #{instance_dir}: #{e.message}"
       end
 
-      configure
-
-      solr_dir
+      instance_dir
     ensure
       FileUtils.remove_entry tmp_save_dir if File.exists? tmp_save_dir
     end
     # rubocop:enable Lint/RescueException
 
+    protected
+
+    def extracted?
+      File.exists?(solr_binary) && extracted_version == version
+    end
+
     def download
       unless File.exists?(download_path) && validate?(download_path)
         fetch_with_progressbar download_url, download_path
         validate! download_path
       end
-
       download_path
     end
 
     def validate?(file)
+      return true if options[:validate] == false
+
       Digest::MD5.file(file).hexdigest == expected_md5sum
     end
 
@@ -199,10 +245,27 @@ module SolrWrapper
 
     ##
     # Run a bin/solr command
+    # @param [String] cmd command to run
+    # @param [Hash] options key-value pairs to transform into command line arguments
+    # @return [StringIO] an IO object for the executed shell command
     # @see https://github.com/apache/lucene-solr/blob/trunk/solr/bin/solr
+    # If you want to pass a boolean flag, include it in the +options+ hash with its value set to +true+
+    # the key will be converted into a boolean flag for you.
+    # @example start solr in cloud mode on port 8983
+    #   exec('start', {p: '8983', c: true})
     def exec(cmd, options = {})
-      output = !!options.delete(:output)
-      args = [solr_binary, cmd] + solr_options.merge(options).map { |k, v| ["-#{k}", "#{v}"] }.flatten
+      silence_output = !options.delete(:output)
+
+      args = [solr_binary, cmd] + solr_options.merge(options).map do |k, v|
+        case v
+        when true
+          "-#{k}"
+        when false, nil
+          # don't return anything
+        else
+          ["-#{k}", "#{v}"]
+        end
+      end.flatten.compact
 
       if IO.respond_to? :popen4
         # JRuby
@@ -210,44 +273,40 @@ module SolrWrapper
         pid, input, output, error = IO.popen4(env_str + " " + args.join(" "))
         @pid = pid
         stringio = StringIO.new
-        if verbose? && !output
+        if verbose? && !silence_output
           IO.copy_stream(output, $stderr)
           IO.copy_stream(error, $stderr)
         else
           IO.copy_stream(output, stringio)
           IO.copy_stream(error, stringio)
         end
+
         input.close
         output.close
         error.close
-
-        stringio.rewind
-
-        if $? != 0
-          raise "Failed to execute solr #{cmd}: #{stringio.read}"
-        end
-
-        stringio
+        exit_status = Process.waitpid2(@pid).last
       else
         IO.popen(env, args + [err: [:child, :out]]) do |io|
           stringio = StringIO.new
-          if verbose? && !output
+
+          if verbose? && !silence_output
             IO.copy_stream(io, $stderr)
           else
             IO.copy_stream(io, stringio)
           end
+
           @pid = io.pid
 
           _, exit_status = Process.wait2(io.pid)
-          stringio.rewind
-
-          if exit_status != 0
-            raise "Failed to execute solr #{cmd}: #{stringio.read}"
-          end
-
-          stringio
         end
       end
+
+      stringio.rewind
+      if exit_status != 0
+        raise "Failed to execute solr #{cmd}: #{stringio.read}"
+      end
+
+      stringio
     end
 
     private
@@ -290,11 +349,13 @@ module SolrWrapper
     end
 
     def default_download_path
-      File.join(Dir.tmpdir, File.basename(download_url))
+      File.join(download_dir, File.basename(download_url))
     end
 
-    def solr_dir
-      @solr_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(download_url, ".zip")))
+    def download_dir
+      @download_dir ||= options.fetch(:download_dir, Dir.tmpdir)
+      FileUtils.mkdir_p @download_dir
+      @download_dir
     end
 
     def verbose?
@@ -302,11 +363,11 @@ module SolrWrapper
     end
 
     def managed?
-      !!options.fetch(:managed, true)
+      File.exists?(instance_dir)
     end
 
     def version_file
-      options.fetch(:version_file, File.join(solr_dir, "VERSION"))
+      options.fetch(:version_file, File.join(instance_dir, "VERSION"))
     end
 
     def expected_md5sum
@@ -314,11 +375,11 @@ module SolrWrapper
     end
 
     def solr_binary
-      File.join(solr_dir, "bin", "solr")
+      File.join(instance_dir, "bin", "solr")
     end
 
     def md5sum_path
-      File.join(Dir.tmpdir, File.basename(md5url))
+      File.join(download_dir, File.basename(md5url))
     end
 
     def tmp_save_dir
@@ -357,8 +418,8 @@ module SolrWrapper
       end
     end
 
-    def configure
-      FileUtils.cp options[:solr_xml], File.join(solr_dir, "server", "solr", "solr.xml") if options[:solr_xml]
+    def raise_error_unless_extracted
+      raise RuntimeError, "there is no solr instance at #{instance_dir}.  Run SolrWrapper.extract first." unless extracted?
     end
   end
 end

data/lib/solr_wrapper/rake_task.rb

@@ -0,0 +1,5 @@
+module SolrWrapper
+  module RakeTask
+    Dir[File.expand_path(File.join(File.dirname(__FILE__),"tasks/*.rake"))].each { |ext| load ext } if defined?(Rake)
+  end
+end

data/lib/solr_wrapper/tasks/solr_wrapper.rake

@@ -0,0 +1,46 @@
+require 'solr_wrapper'
+
+## These tasks get loaded into the host context when solr_wrapper is required
+namespace :solr do
+  desc "Load the solr options and solr instance"
+  task :environment do
+    SolrWrapper.default_instance_options[:download_dir] ||= Rails.root.to_s + '/tmp' if defined? Rails
+    @solr_instance = SolrWrapper.default_instance
+  end
+
+  desc 'Install a clean version of solr. Replaces the existing copy if there is one.'
+  task clean: :environment do
+    puts "Installing clean version of solr at #{File.expand_path(@solr_instance.instance_dir)}"
+    @solr_instance.remove_instance_dir!
+    @solr_instance.extract_and_configure
+  end
+
+  desc 'start solr'
+  task start: :environment do
+    begin
+      puts "Starting solr at #{File.expand_path(@solr_instance.instance_dir)} with options #{@solr_instance.options}"
+      @solr_instance.start
+    rescue => e
+      if e.message.include?("Port #{@solr_instance.port} is already being used by another process")
+        puts "FAILED. Port #{@solr_instance.port} is already being used."
+        puts " Did you already have solr running?"
+        puts "  a) YES: Continue as you were. Solr is running."
+        puts "  b) NO: Either set SOLR_OPTIONS[:port] to a different value or stop the process that's using port #{@solr_instance.port}."
+      else
+        raise "Failed to start solr. #{e.class}: #{e.message}"
+      end
+    end
+  end
+
+  desc 'restart solr'
+  task restart: :environment do
+    puts "Restarting solr"
+    @solr_instance.restart
+  end
+
+  desc 'stop solr'
+  task stop: :environment do
+    @solr_instance.stop
+  end
+
+end

data/lib/solr_wrapper/version.rb

@@ -1,3 +1,3 @@
 module SolrWrapper
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/solr_wrapper.rb

@@ -3,11 +3,15 @@ require 'solr_wrapper/instance'
 
 module SolrWrapper
   def self.default_solr_version
-    '5.3.0'
+    '5.3.1'
+  end
+
+  def self.default_instance_options
+    @default_instance_options ||= {}
   end
 
   def self.default_instance(options = {})
-    @default_instance ||= SolrWrapper::Instance.new options
+    @default_instance ||= SolrWrapper::Instance.new default_instance_options.merge(options)
   end
 
   ##

data/spec/lib/solr_wrapper/instance_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe SolrWrapper::Instance do
-  subject { SolrWrapper::Instance.new }
+  let(:solr_instance) { SolrWrapper::Instance.new }
+  subject { solr_instance }
   let(:client) { SimpleSolrClient::Client.new("http://localhost:#{subject.port}/solr/") }
   describe "#with_collection" do
     it "should create a new anonymous collection" do
@@ -16,4 +17,25 @@ describe SolrWrapper::Instance do
       end
     end
   end
+  describe 'exec' do
+    let(:cmd) { 'start' }
+    let(:options) { { p: '4098', help: true } }
+    subject { solr_instance.send(:exec, cmd, options) }
+    it 'runs the command' do
+      result_io = subject
+      expect(result_io.read).to include('Usage: solr start')
+    end
+    it 'accepts boolean flags' do
+      result_io = solr_instance.send(:exec, 'start', p: '4098', help: true)
+      expect(result_io.read).to include('Usage: solr start')
+    end
+
+    describe 'when something goes wrong' do
+      let(:cmd) { 'healthcheck' }
+      let(:options) { { z: 'localhost:5098' } }
+      it 'raises an error with the output from the shell command' do
+        expect { subject }.to raise_error(RuntimeError, /Failed to execute solr healthcheck: collection parameter is required!/)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2015-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -117,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".rubocop_hound.yml"
 - ".rubocop_todo.yml"
@@ -129,6 +130,8 @@ files:
 - exe/solr_wrapper
 - lib/solr_wrapper.rb
 - lib/solr_wrapper/instance.rb
+- lib/solr_wrapper/rake_task.rb
+- lib/solr_wrapper/tasks/solr_wrapper.rake
 - lib/solr_wrapper/version.rb
 - solr_wrapper.gemspec
 - spec/fixtures/basic_configs/_rest_managed.json
@@ -162,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Solr 5 service wrapper