Skip to content

Instantly share code, notes, and snippets.

@treble37
Created February 3, 2015 05:46
Show Gist options
  • Star 10 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save treble37/956526105e9655713469 to your computer and use it in GitHub Desktop.
Save treble37/956526105e9655713469 to your computer and use it in GitHub Desktop.
Step 1 - Testing ElasticSearch - spec_helper.rb
# This file was generated by the `rails generate rspec:install` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
# The generated `.rspec` file contains `--require spec_helper` which will cause this
# file to always be loaded, without a need to explicitly require it in any files.
#
# Given that it is always loaded, you are encouraged to keep this file as
# light-weight as possible. Requiring heavyweight dependencies from this file
# will add to the boot time of your test suite on EVERY test run, even for an
# individual file that may not need all of that loaded. Instead, make a
# separate helper file that requires this one and then use it only in the specs
# that actually need it.
#
# The `.rspec` file also contains a few flags that are not defaults but that
# users commonly want.
#
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
require "codeclimate-test-reporter"
CodeClimate::TestReporter.start
ENV["RAILS_ENV"] ||= 'test'
require File.expand_path("../../config/environment", __FILE__)
require 'rspec/rails'
require 'webmock/rspec'
require 'vcr'
require 'rake'
require 'elasticsearch/extensions/test/cluster/tasks'
Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
# Checks for pending migrations before tests are run.
# If you are not using ActiveRecord, you can remove this line.
#ActiveRecord::Migration.check_pending!
ENV["TEST_CLUSTER_NODES"] = "2" # need to set so we trigger correct ES defaults
RSpec.configure do |config|
# The settings below are suggested to provide a good initial experience
# with RSpec, but feel free to customize to your heart's content.
=begin
# These two settings work together to allow you to limit a spec run
# to individual examples or groups you care about by tagging them with
# `:focus` metadata. When nothing is tagged with `:focus`, all examples
# get run.
config.filter_run :focus
config.run_all_when_everything_filtered = true
# Many RSpec users commonly either run the entire suite or an individual
# file, and it's useful to allow more verbose output when running an
# individual spec file.
if config.files_to_run.one?
# Use the documentation formatter for detailed output,
# unless a formatter has already been configured
# (e.g. via a command-line flag).
config.default_formatter = 'doc'
end
# Print the 10 slowest examples and example groups at the
# end of the spec run, to help surface which specs are running
# particularly slow.
config.profile_examples = 10
# Run specs in random order to surface order dependencies. If you find an
# order dependency and want to debug it, you can fix the order by providing
# the seed, which is printed after each run.
# --seed 1234
config.order = :random
# Seed global randomization in this process using the `--seed` CLI option.
# Setting this allows you to use `--seed` to deterministically reproduce
# test failures related to randomization by passing the same `--seed` value
# as the one that triggered the failure.
Kernel.srand config.seed
# rspec-expectations config goes here. You can use an alternate
# assertion/expectation library such as wrong or the stdlib/minitest
# assertions if you prefer.
config.expect_with :rspec do |expectations|
# Enable only the newer, non-monkey-patching expect syntax.
# For more details, see:
# - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
expectations.syntax = :expect
end
# rspec-mocks config goes here. You can use an alternate test double
# library (such as bogus or mocha) by changing the `mock_with` option here.
config.mock_with :rspec do |mocks|
# Enable only the newer, non-monkey-patching expect syntax.
# For more details, see:
# - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
mocks.syntax = :expect
# Prevents you from mocking or stubbing a method that does not exist on
# a real object. This is generally recommended.
mocks.verify_partial_doubles = true
end
=end
config.around :each, elasticsearch: true do |example|
[Post].each do |model|
model.__elasticsearch__.create_index!(force: true)
model.__elasticsearch__.refresh_index!
end
example.run
Post.__elasticsearch__.client.indices.delete index: Post.index_name
end
config.use_transactional_fixtures = false
config.infer_base_class_for_anonymous_controllers = false
config.include RocketPants::TestHelper, :type => :controller
config.include RocketPants::RSpecMatchers, :type => :controller
config.include FactoryGirl::Syntax::Methods
config.include ApiHelper, :type => :api
end
@ain
Copy link

ain commented Sep 20, 2016

Thanks a lot for sharing the 3 codepieces! Very valuable.

@romankovt
Copy link

romankovt commented Nov 26, 2017

thanks for your gist.
in config.around :each you need to traverse searchable models not only during creating indexes but after example.run as well, so the refined example should look something like:

SEARCHABLE_MODELS = [ModelName]
config.around :each, elasticsearch: true do |example|
  SEARCHABLE_MODELS.each do |model|
    model.__elasticsearch__.create_index!(force: true)
    model.__elasticsearch__.refresh_index!
  end

  example.run

  SEARCHABLE_MODELS.each do |model|
    model.__elasticsearch__.client.indices.delete index: model.index_name
  end
end

@jailalawat
Copy link

jailalawat commented Oct 7, 2020

Ref: https://medium.com/@rowanoulton/testing-elasticsearch-in-rails-22a3296d989

config.before :each, elasticsearch: true do
    ActiveRecord::Base.descendants.each do |model|
      if model.respond_to?(:__elasticsearch__)
        begin
          model.__elasticsearch__.create_index!
          model.__elasticsearch__.refresh_index!
        rescue Elasticsearch::Transport::Transport::Errors::NotFound => e
          # This kills "Index does not exist" errors being written to console
          # by this: https://github.com/elastic/elasticsearch-rails/blob/738c63efacc167b6e8faae3b01a1a0135cfc8bbb/elasticsearch-model/lib/elasticsearch/model/indexing.rb#L268
        rescue => e
          STDERR.puts "There was an error creating the elasticsearch index for #{model.name}: #{e.inspect}"
        end
      end
    end
  end

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment