solr_wrapper 0.0.7 → 1.0.0

data/lib/solr_wrapper/settings.rb

@@ -0,0 +1,148 @@
+require 'delegate'
+require 'faraday'
+
+module SolrWrapper
+  # Configuraton that comes from static and dynamic sources.
+  class Settings < Delegator
+
+    def __getobj__
+      @static_config # return object we are delegating to, required
+    end
+
+    alias static_config __getobj__
+
+    def __setobj__(obj)
+      @static_config = obj
+    end
+
+    def initialize(static_config)
+      super
+      @static_config = static_config
+    end
+
+    ##
+    # Get the host this Solr instance is bound to
+    def host
+      '127.0.0.1'
+    end
+
+    def zookeeper_host
+      @zookeeper_host ||= static_config.zookeeper_port
+      @zookeeper_host ||= host
+    end
+
+    ##
+    # Get the port this Solr instance is running at
+    def port
+      @port ||= static_config.port
+      @port ||= random_open_port.to_s
+    end
+
+    def zookeeper_port
+      @zookeeper_port ||= static_config.zookeeper_port
+      @zookeeper_port ||= "#{port.to_i + 1000}"
+    end
+
+
+    ##
+    # Get a (likely) URL to the solr instance
+    def url
+      "http://#{host}:#{port}/solr/"
+    end
+
+    def instance_dir
+      @instance_dir ||= static_config.instance_dir
+      @instance_dir ||= File.join(tmpdir, File.basename(download_url, ".zip"))
+    end
+
+    def managed?
+      File.exist?(instance_dir)
+    end
+
+    def download_url
+      @download_url ||= static_config.url
+      @download_url ||= default_download_url
+    end
+
+    def solr_zip_path
+      @solr_zip_path ||= static_config.solr_zip_path
+      @solr_zip_path ||= default_solr_zip_path
+    end
+
+    def version_file
+      static_config.version_file || File.join(instance_dir, "VERSION")
+    end
+
+    def md5url
+      if default_download_url == archive_download_url
+        "#{archive_download_url}.md5"
+      else
+        "http://www.us.apache.org/dist/lucene/solr/#{static_config.version}/solr-#{static_config.version}.zip.md5"
+      end
+    end
+
+    def md5sum_path
+      File.join(download_dir, File.basename(md5url))
+    end
+
+    def solr_binary
+      File.join(instance_dir, "bin", "solr")
+    end
+
+    def tmp_save_dir
+      @tmp_save_dir ||= Dir.mktmpdir
+    end
+
+    private
+
+      def tmpdir
+        if defined?(Rails) && Rails.root
+          File.join(Rails.root, 'tmp')
+        else
+          Dir.tmpdir
+        end
+      end
+
+      def default_solr_zip_path
+        File.join(download_dir, File.basename(download_url))
+      end
+
+      def download_dir
+        @download_dir ||= static_config.download_dir
+        FileUtils.mkdir_p @download_dir
+        @download_dir
+      end
+
+      def default_download_url
+        @default_url ||= begin
+          json = open(static_config.mirror_url).read
+          doc = JSON.parse(json)
+          url = doc['preferred'] + doc['path_info']
+
+          response = Faraday.head(url)
+
+          if response.success?
+            url
+          else
+            archive_download_url
+          end
+        end
+      rescue Errno::ECONNRESET, SocketError, Faraday::Error
+        archive_download_url
+      end
+
+      def archive_download_url
+        "https://archive.apache.org/dist/lucene/solr/#{static_config.version}/solr-#{static_config.version}.zip"
+      end
+
+      def random_open_port
+        socket = Socket.new(:INET, :STREAM, 0)
+        begin
+          socket.bind(Addrinfo.tcp('127.0.0.1', 0))
+          socket.local_address.ip_port
+        ensure
+          socket.close
+        end
+      end
+  end
+end

data/lib/solr_wrapper/tasks/solr_wrapper.rake

@@ -0,0 +1,45 @@
+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
+    @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 #{@solr_instance.config.url}"
+      @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.0.7"
-end
+  VERSION = '1.0.0'
+end

data/lib/solr_wrapper.rb

@@ -1,18 +1,44 @@
 require 'solr_wrapper/version'
+require 'solr_wrapper/configuration'
+require 'solr_wrapper/settings'
+require 'solr_wrapper/md5'
+require 'solr_wrapper/downloader'
 require 'solr_wrapper/instance'
+require 'solr_wrapper/client'
 
 module SolrWrapper
   def self.default_solr_version
-    "5.0.0"
+    'latest'
   end
 
-  def self.default_instance options = {}
-    @default_instance ||= SolrWrapper::Instance.new options
+  def self.default_solr_port
+    '8983'
+  end
+
+  def self.default_instance_options
+    @default_instance_options ||= {
+      port: SolrWrapper.default_solr_port,
+      version: SolrWrapper.default_solr_version
+    }
+  end
+
+  def self.default_instance_options=(options)
+    @default_instance_options = options
+  end
+
+  def self.default_instance(options = {})
+    @default_instance ||= instance(default_instance_options)
+  end
+
+  def self.instance(options = {})
+    SolrWrapper::Instance.new(options)
   end
 
   ##
   # Ensures a Solr service is running before executing the block
-  def self.wrap options = {}, &block
-    default_instance(options).wrap &block
+  def self.wrap(options = {}, &block)
+    instance(options).wrap &block
   end
-end
+
+  class SolrWrapperError < StandardError; end
+end

data/solr_wrapper.gemspec

@@ -13,10 +13,12 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "faraday"
   spec.add_dependency "rubyzip"
   spec.add_dependency "ruby-progressbar"
 
@@ -26,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simple_solr_client"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "webmock"
 end

data/spec/fixtures/another_sample_config.yml

@@ -0,0 +1,2 @@
+port: 9998
+verbose: true

data/spec/fixtures/sample_config.yml

@@ -0,0 +1,8 @@
+port: 9999
+collection:
+  dir: solr/config/
+  name: project-development
+  persist: false
+configsets:
+  - dir: solr/config/
+    name: project-development-configset

data/spec/lib/solr_wrapper/client_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe SolrWrapper::Client do
+  subject { described_class.new('http://localhost:8983/solr/') }
+
+  describe '#exists?' do
+    it 'checks if a solrcloud collection exists' do
+      stub_request(:get, 'http://localhost:8983/solr/admin/collections?action=LIST&wt=json').to_return(body: '{ "collections": ["x", "y", "z"]}')
+      stub_request(:get, 'http://localhost:8983/solr/admin/cores?action=STATUS&wt=json&core=a').to_return(body: '{ "status": { "a": {} } }')
+
+      expect(subject.exists?('x')).to eq true
+      expect(subject.exists?('a')).to eq false
+    end
+
+    it 'checks if a solr core exists' do
+      stub_request(:get, 'http://localhost:8983/solr/admin/collections?action=LIST&wt=json').to_return(body: '{ "error": { "msg": "Solr instance is not running in SolrCloud mode."} }')
+
+      stub_request(:get, 'http://localhost:8983/solr/admin/cores?action=STATUS&wt=json&core=x').to_return(body: '{ "status": { "x": { "name": "x" } } }')
+      stub_request(:get, 'http://localhost:8983/solr/admin/cores?action=STATUS&wt=json&core=a').to_return(body: '{ "status": { "a": {} } }')
+
+      expect(subject.exists?('x')).to eq true
+      expect(subject.exists?('a')).to eq false
+    end
+  end
+end

data/spec/lib/solr_wrapper/configuration_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe SolrWrapper::Configuration do
+  let(:config) { described_class.new options }
+
+  describe "#port" do
+    subject { config.port }
+
+    context "when port is set to nil" do
+      let(:options) { { port: nil } }
+      it { is_expected.to eq nil }
+    end
+
+    context "when port is not set" do
+      let(:options) { {} }
+      it { is_expected.to eq '8983' }
+    end
+
+    context "when a port is provided" do
+      let(:options) { { port: '8888' } }
+      it { is_expected.to eq '8888' }
+    end
+  end
+
+  describe "#load_configs" do
+    before do
+      allow(config).to receive(:default_configuration_paths).and_return([])
+    end
+    context 'with a single config file' do
+      let(:options) { { config: 'spec/fixtures/sample_config.yml' } }
+      it "uses values from the config file" do
+        expect(config.port).to eq '9999'
+      end
+    end
+    context 'with multiple config files' do
+      let(:options) { { config: ['spec/fixtures/sample_config.yml', 'spec/fixtures/another_sample_config.yml'] } }
+      it "uses values from the config file" do
+        expect(config.port).to eq '9998'
+        expect(config.verbose?).to eq true
+      end
+    end
+  end
+
+  describe "#collection_options" do
+    before do
+      allow(config).to receive(:default_configuration_paths).and_return([])
+    end
+    let(:options) { { config: 'spec/fixtures/sample_config.yml' } }
+    it "uses values from the config file" do
+      expect(config.collection_options).to eq(name: 'project-development', dir: 'solr/config/', persist: false)
+    end
+  end
+
+  describe '#configsets' do
+    before do
+      allow(config).to receive(:default_configuration_paths).and_return([])
+    end
+    let(:options) { { config: 'spec/fixtures/sample_config.yml' } }
+
+    it 'uses values from the config file' do
+      expect(config.configsets).to include(name: 'project-development-configset', dir: 'solr/config/')
+    end
+  end
+
+  describe '#version' do
+    context 'when it is a version number' do
+      let(:options) { { version: 'x.y.z' } }
+
+      it 'uses that version' do
+        expect(config.version).to eq 'x.y.z'
+      end
+    end
+
+    context 'when it is "latest"' do
+      let(:options) { { version: 'latest'} }
+
+      before do
+        stub_request(:get, 'https://svn.apache.org/repos/asf/lucene/cms/trunk/content/latestversion.mdtext').to_return(body: 'z.y.x')
+      end
+
+      it 'fetches the latest version number from apache' do
+        expect(config.version).to eq 'z.y.x'
+      end
+    end
+  end
+end

data/spec/lib/solr_wrapper/instance_spec.rb

@@ -1,19 +1,166 @@
 require 'spec_helper'
 
 describe SolrWrapper::Instance do
-  subject { SolrWrapper::Instance.new }
-  let(:client) { SimpleSolrClient::Client.new("http://localhost:#{subject.port}/solr/") }
+  let(:options) { {} }
+  let(:solr_instance) { SolrWrapper::Instance.new(options) }
+  subject { solr_instance }
+  let(:client) { SimpleSolrClient::Client.new(subject.url) }
+
   describe "#with_collection" do
-    it "should create a new anonymous collection" do
+    let(:options) { { cloud: false } }
+    context "without a name" do
+      it "creates a new anonymous collection" do
+        subject.wrap do |solr|
+          solr.with_collection(dir: File.join(FIXTURES_DIR, "basic_configs")) do |collection_name|
+            core = client.core(collection_name)
+            unless defined? JRUBY_VERSION
+              expect(core.schema.field('id').name).to eq 'id'
+              expect(core.schema.field('id').stored).to eq true
+            end
+          end
+        end
+      end
+    end
+    context "with a config file" do
+      before do
+        allow(solr_instance.config).to receive(:collection_options)
+          .and_return(name: 'project-development', dir: 'solr/config/')
+        allow(solr_instance).to receive(:delete)
+      end
+
+      it "creates a new collection with options from the config" do
+        expect(solr_instance).to receive(:create).with(
+          hash_including(name: "project-development", dir: anything))
+        solr_instance.with_collection(dir: File.join(FIXTURES_DIR, "basic_configs")) {}
+      end
+    end
+
+    context 'persistent collections' do
+      it "creates a new collection with options from the config" do
+        expect(solr_instance).to receive(:create).with(
+          hash_including(name: 'project-development'))
+        expect(solr_instance).not_to receive(:delete)
+        solr_instance.with_collection(name: 'project-development', dir: 'solr/config/', persist: true) {}
+      end
+
+      describe 'single solr node' do
+        it 'allows persistent collection on restart' do
+          subject.wrap do |solr|
+            solr.with_collection(name: 'solr-node-persistent-core', dir: File.join(FIXTURES_DIR, 'basic_configs'), persist: true) {}
+          end
+
+          subject.wrap do |solr|
+            solr.with_collection(name: 'solr-node-persistent-core', dir: File.join(FIXTURES_DIR, 'basic_configs'), persist: true) {}
+            solr.delete 'solr-node-persistent-core'
+          end
+        end
+      end
+
+      describe 'solr cloud' do
+        let(:options) { { cloud: true } }
+
+        it 'allows persistent collection on restart' do
+          subject.wrap do |solr|
+            config_name = solr.upconfig dir: File.join(FIXTURES_DIR, 'basic_configs')
+            solr.with_collection(name: 'solr-cloud-persistent-collection', config_name: config_name, persist: true) {}
+          end
+
+          subject.wrap do |solr|
+            solr.with_collection(name: 'solr-cloud-persistent-collection', persist: true) {}
+            solr.delete 'solr-cloud-persistent-collection'
+          end
+        end
+      end
+    end
+  end
+
+  context 'with a SolrCloud instance' do
+    let(:options) { { cloud: true } }
+    it 'can upload configurations' do
       subject.wrap do |solr|
-        solr.with_collection(dir: File.join(FIXTURES_DIR, "basic_configs")) do |collection_name|
+        config_name = solr.upconfig dir: File.join(FIXTURES_DIR, 'basic_configs')
+        Dir.mktmpdir do |dir|
+          solr.downconfig name: config_name, dir: dir
+        end
+        solr.with_collection(config_name: config_name) do |collection_name|
           core = client.core(collection_name)
           unless defined? JRUBY_VERSION
-            expect(core.schema.field('id').name).to eq 'id'
-            expect(core.schema.field('id').stored).to eq true
+            expect(core.all.size).to eq 0
           end
         end
       end
     end
+
+    context 'with a config file' do
+      before do
+        allow(solr_instance.config).to receive(:configsets)
+          .and_return([name: 'project-development', dir: 'solr/config/'])
+      end
+
+      it 'creates a new configsets with options from the config' do
+        expect(subject).to receive(:upconfig).with(
+          hash_including(name: 'project-development', dir: anything))
+
+        subject.wrap do
+          # no-op
+        end
+      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
+
+  describe "#host" do
+    subject { solr_instance.host }
+    it { is_expected.to eq '127.0.0.1' }
+  end
+
+  describe "#port" do
+    subject { solr_instance.port }
+    it { is_expected.to eq '8983' }
+  end
+
+  describe "#url" do
+    subject { solr_instance.url }
+    it { is_expected.to eq 'http://127.0.0.1:8983/solr/' }
+  end
+
+  describe "#instance_dir" do
+    subject { solr_instance.instance_dir }
+    it { is_expected.to start_with Dir.tmpdir }
+  end
+
+  describe "#version" do
+    before do
+      allow(solr_instance.config).to receive(:version).and_return('solr-version-number')
+    end
+
+    subject { solr_instance.version }
+    it { is_expected.to eq 'solr-version-number' }
+  end
+
+  describe "#md5" do
+    subject { solr_instance.md5 }
+    it { is_expected.to be_instance_of SolrWrapper::MD5 }
   end
-end
+end

data/spec/lib/solr_wrapper_spec.rb

@@ -4,12 +4,27 @@ describe SolrWrapper do
   describe ".wrap" do
     it "should launch solr" do
       SolrWrapper.wrap do |solr|
-        expect {
+        expect do
           Timeout::timeout(15) do
             TCPSocket.new('127.0.0.1', solr.port).close
           end
-        }.not_to raise_exception
+        end.not_to raise_exception
       end
     end
   end
-end
+
+  describe '.instance' do
+    context 'without arguments' do
+      it 'inherits the defaults' do
+        expect(SolrWrapper.instance.port).to eq '8983'
+      end
+    end
+  end
+
+  describe ".default_instance_options=" do
+    it "sets default options" do
+      SolrWrapper.default_instance_options = { port: '1234' }
+      expect(SolrWrapper.default_instance_options[:port]). to eq '1234'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,9 +5,11 @@ require 'solr_wrapper'
 require 'simple_solr_client'
 
 require 'rspec'
+require 'webmock/rspec'
 
-FIXTURES_DIR = File.expand_path("fixtures", File.dirname(__FILE__))
+WebMock.allow_net_connect!
 
-RSpec.configure do |config|
+FIXTURES_DIR = File.expand_path("fixtures", File.dirname(__FILE__))
 
-end
+RSpec.configure do |_config|
+end