Class: SolrWrapper::Instance

Inherits:
Object
  • Object
show all
Defined in:
lib/solr_wrapper/instance.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Instance

Returns a new instance of Instance.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :url (String)
  • :instance_dir (String) —

    Directory to store the solr index files

  • :version (String) —

    Solr version to download and install

  • :port (String) —

    port to run Solr on

  • :cloud (Boolean) —

    Run solr in cloud mode

  • :version_file (String) —

    Local path to store the currently installed version

  • :download_dir (String) —

    Local directory to store the downloaded Solr zip and its md5 file in (overridden by :download_path)

  • :download_path (String) —

    Local path for storing the downloaded Solr zip file

  • :validate (Boolean) —

    Should solr_wrapper download a new md5 and (re-)validate the zip file? (default: trueF)

  • :md5sum (String) —

    Path/URL to MD5 checksum

  • :solr_xml (String) —

    Path to Solr configuration

  • :extra_lib_dir (String) —

    Path to directory containing extra libraries to copy into instance_dir/lib

  • :verbose (Boolean) —

    return verbose info when running solr commands

  • :ignore_md5sum (Boolean)
  • :solr_options (Hash)
  • :env (Hash)
  • :config (String) 


36
37
38
39
 
# File 'lib/solr_wrapper/instance.rb', line 36

def initialize(options = {})
  @config = Settings.new(Configuration.new(options))
  @md5 = MD5.new(@config)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



15
16
17
 
# File 'lib/solr_wrapper/instance.rb', line 15

def config
  @config
end

#md5 ⇒ Object (readonly)

Returns the value of attribute md5.



15
16
17
 
# File 'lib/solr_wrapper/instance.rb', line 15

def md5
  @md5
end

#pid ⇒ Object (readonly)

Returns the value of attribute pid.



15
16
17
 
# File 'lib/solr_wrapper/instance.rb', line 15

def pid
  @pid
end

Instance Method Details

#clean! ⇒ Object

Clean up any files solr_wrapper may have downloaded



165
166
167
168
169
170
171
172
 
# File 'lib/solr_wrapper/instance.rb', line 165

def clean!
  stop
  remove_instance_dir!
  FileUtils.remove_entry(config.download_path) if File.exists?(config.download_path)
  FileUtils.remove_entry(config.tmp_save_dir, true) if File.exists? config.tmp_save_dir
  md5.clean!
  FileUtils.remove_entry(config.version_file) if File.exists? config.version_file
end

#configure ⇒ Object 



180
181
182
183
184
 
# File 'lib/solr_wrapper/instance.rb', line 180

def configure
  raise_error_unless_extracted
  FileUtils.cp config.solr_xml, File.join(config.instance_dir, 'server', 'solr', 'solr.xml') if config.solr_xml
  FileUtils.cp_r File.join(config.extra_lib_dir, '.'), File.join(config.instance_dir, 'server', 'solr', 'lib') if config.extra_lib_dir
end

#create(options = {}) ⇒ Object

Create a new collection in solr

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :name (String)
  • :dir (String) 


128
129
130
131
132
133
134
135
136
137
 
# File 'lib/solr_wrapper/instance.rb', line 128

def create(options = {})
  options[:name] ||= SecureRandom.hex

  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

#delete(name, _options = {}) ⇒ Object

Create a new collection in solr

Parameters:

  • name (String) —

    collection name



142
143
144
 
# File 'lib/solr_wrapper/instance.rb', line 142

def delete(name, _options = {})
  exec("delete", c: name, p: port)
end

#extract ⇒ String

extract a copy of solr to instance_dir Does noting if solr already exists at instance_dir

Returns:

  • (String) —

    instance_dir Directory where solr has been installed



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/solr_wrapper/instance.rb', line 195

def extract
  return config.instance_dir if extracted?

  zip_path = download

  begin
    Zip::File.open(zip_path) do |zip_file|
      # Handle entries one by one
      zip_file.each do |entry|
        dest_file = File.join(config.tmp_save_dir, entry.name)
        FileUtils.remove_entry(dest_file, true)
        entry.extract(dest_file)
      end
    end

  rescue Exception => e
    abort "Unable to unzip #{zip_path} into #{config.tmp_save_dir}: #{e.message}"
  end

  begin
    FileUtils.remove_dir(config.instance_dir, true)
    FileUtils.cp_r File.join(config.tmp_save_dir, File.basename(config.download_url, ".zip")), config.instance_dir
    self.extracted_version = config.version
    FileUtils.chmod 0755, config.solr_binary
  rescue Exception => e
    abort "Unable to copy #{config.tmp_save_dir} to #{config.instance_dir}: #{e.message}"
  end

  config.instance_dir
ensure
  FileUtils.remove_entry config.tmp_save_dir if File.exists? config.tmp_save_dir
end

#extract_and_configure ⇒ Object 



186
187
188
 
# File 'lib/solr_wrapper/instance.rb', line 186

def extract_and_configure
  extract.tap { configure }
end

#host ⇒ Object 



41
42
43
 
# File 'lib/solr_wrapper/instance.rb', line 41

def host
  config.host
end

#instance_dir ⇒ Object 



53
54
55
 
# File 'lib/solr_wrapper/instance.rb', line 53

def instance_dir
  config.instance_dir
end

#port ⇒ Object 



45
46
47
 
# File 'lib/solr_wrapper/instance.rb', line 45

def port
  config.port
end

#remove_instance_dir! ⇒ Object

Clean up any files in the Solr instance dir



176
177
178
 
# File 'lib/solr_wrapper/instance.rb', line 176

def remove_instance_dir!
  FileUtils.remove_entry(instance_dir, true) if File.exists? instance_dir
end

#restart ⇒ Object

Stop Solr and wait for it to finish exiting



100
101
102
103
104
 
# File 'lib/solr_wrapper/instance.rb', line 100

def restart
  if config.managed? && started?
    exec('restart', p: port, c: config.cloud)
  end
end

#start ⇒ Object

Start Solr and wait for it to become available



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/solr_wrapper/instance.rb', line 71

def start
  extract_and_configure
  if config.managed?
    exec('start', p: port, c: config.cloud)

    # Wait for solr to start
    unless status
      sleep 1
    end
  end
end

#started? ⇒ Boolean

Is Solr running?

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/solr_wrapper/instance.rb', line 119

def started?
  !!status
end

#status ⇒ Object

Check the status of a managed Solr service



108
109
110
111
112
113
114
115
 
# File 'lib/solr_wrapper/instance.rb', line 108

def status
  return true unless config.managed?

  out = exec('status').read
  out =~ /running on port #{port}/
rescue
  false
end

#stop ⇒ Object

Stop Solr and wait for it to finish exiting



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/solr_wrapper/instance.rb', line 85

def stop
  if config.managed? && started?

    exec('stop', p: port)
    # Wait for solr to stop
    while status
      sleep 1
    end
  end

  @pid = nil
end

#url ⇒ Object 



49
50
51
 
# File 'lib/solr_wrapper/instance.rb', line 49

def url
  config.url
end

#version ⇒ Object 



57
58
59
 
# File 'lib/solr_wrapper/instance.rb', line 57

def version
  config.version
end

#with_collection(options = {}) ⇒ Object

Create a new collection, run the block, and then clean up the collection

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :name (String)
  • :dir (String) 


151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/solr_wrapper/instance.rb', line 151

def with_collection(options = {})
  options = config.collection_options.merge(options)
  return yield if options.empty?

  name = create(options)
  begin
    yield name
  ensure
    delete name
  end
end

#wrap(&_block) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/solr_wrapper/instance.rb', line 61

def wrap(&_block)
  extract_and_configure
  start
  yield self
ensure
  stop
end