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 :solr_zip_path)

  • :solr_zip_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) 


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

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.



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

def config
  @config
end

#md5 ⇒ Object (readonly)

Returns the value of attribute md5.



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

def md5
  @md5
end

Instance Method Details

#clean! ⇒ Object

Clean up any files solr_wrapper may have downloaded



226
227
228
229
230
231
232
233
 
# File 'lib/solr_wrapper/instance.rb', line 226

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

#configure ⇒ Object 



241
242
243
244
245
 
# File 'lib/solr_wrapper/instance.rb', line 241

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) 


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/solr_wrapper/instance.rb', line 144

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

  create_options = { p: port }
  create_options[:c] = options[:name] if options[:name]
  create_options[:n] = options[:config_name] if options[:config_name]
  create_options[:d] = options[:dir] if options[:dir]

  Retriable.retriable do
    raise "Not started yet" unless started?
  end

  # short-circuit if we're using persisted data with an existing core/collection
  return if options[:persist] && create_options[:c] && client.exists?(create_options[:c])

  exec("create", create_options)

  options[:name]
end

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

Create a new collection in solr

Parameters:

  • name (String) —

    collection name



203
204
205
 
# File 'lib/solr_wrapper/instance.rb', line 203

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

#downconfig(options = {}) ⇒ Object

Copy the collection configuration from zookeeper to a local directory

Parameters:

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

Options Hash (options):

  • :config_name (String)
  • :dir (String) 


187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/solr_wrapper/instance.rb', line 187

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

  downconfig_options = { downconfig: true, n: options[:name] }
  downconfig_options[:d] = options[:dir] if options[:dir]
  downconfig_options[:z] = options[:zkhost] if options[:zkhost]

  exec 'zk', downconfig_options

  options[:name]
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/solr_wrapper/instance.rb', line 256

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.exist? config.tmp_save_dir
end

#extract_and_configure ⇒ Object 



247
248
249
 
# File 'lib/solr_wrapper/instance.rb', line 247

def extract_and_configure
  extract.tap { configure }
end

#host ⇒ Object 



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

def host
  config.host
end

#instance_dir ⇒ Object 



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

def instance_dir
  config.instance_dir
end

#pid ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/solr_wrapper/instance.rb', line 114

def pid
  return unless config.managed?

  @pid ||= begin
    out = exec('status').read
    out.match(/process (?<pid>\d+) running on port #{port}/) do |m|
      m[:pid].to_i
    end
  end
rescue
  nil
end

#port ⇒ Object 



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

def port
  config.port
end

#remove_instance_dir! ⇒ Object

Clean up any files in the Solr instance dir



237
238
239
 
# File 'lib/solr_wrapper/instance.rb', line 237

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

#restart ⇒ Object

Stop Solr and wait for it to finish exiting



97
98
99
100
101
 
# File 'lib/solr_wrapper/instance.rb', line 97

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



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

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

    # Wait for solr to start
    unless status
      sleep config.poll_interval
    end

    after_start
  end
end

#started? ⇒ Boolean

Is Solr running?

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/solr_wrapper/instance.rb', line 129

def started?
  !!status
end

#status ⇒ Object

Check the status of a managed Solr service



105
106
107
108
109
110
111
112
 
# File 'lib/solr_wrapper/instance.rb', line 105

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



88
89
90
91
92
93
 
# File 'lib/solr_wrapper/instance.rb', line 88

def stop
  if config.managed? && started?
    exec('stop', p: port)
    wait
  end
end

#upconfig(options = {}) ⇒ Object

Update the collection configuration in zookeeper

Parameters:

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

Options Hash (options):

  • :config_name (String)
  • :dir (String) 


169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/solr_wrapper/instance.rb', line 169

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

  upconfig_options = { upconfig: true, n: options[:name] }
  upconfig_options[:d] = options[:dir] if options[:dir]
  upconfig_options[:z] = options[:zkhost] if options[:zkhost]

  exec 'zk', upconfig_options

  options[:name]
end

#url ⇒ Object 



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

def url
  config.url
end

#version ⇒ Object 



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

def version
  config.version
end

#wait ⇒ Object 



133
134
135
136
137
 
# File 'lib/solr_wrapper/instance.rb', line 133

def wait
  while (Process.getpgid(pid) rescue status)
    sleep config.poll_interval
  end
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) 


212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/solr_wrapper/instance.rb', line 212

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

  name = create(options)
  begin
    yield name
  ensure
    delete name unless options[:persist]
  end
end

#wrap(&_block) ⇒ Object 



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

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