Minitest assertions and indexing controls.

[robacarp]

This adds support for index update assertions, and methods to control search index cleaning in a Minitest environment.

Critiques and suggestions welcome. One necessary improvement is better integration with the Chewy ORM interoperability layer. Currently the SearchIndexReceiver#indexed? and #deleted? methods expect an object to respond to #id. I'm happy to continue the work and enhance the integration if it's welcome, but I'd like some feedback before investing more time into it. We are currently using these testing helpers as is and they're functional for our needs.

The ideas and implementation in the SearchIndexReceiver mock class is largely ported directly from the rspec/update_index implementation of update_index and friends. I'm sure it would be possible to make both test suites leverage the functionality if desired, but my rspec is rusty at best.

Additions to a project test_helper.rb:

require 'chewy/minitest/helpers'

Chewy.strategy(:bypass)

And to an example test file:

require 'test_helper'

class UsersIndexTest < ActiveSupport::TestCase
  include Chewy::Minitest::Helpers

  # Optionally, enable indexing for all tests in this file.
  index_everything!

  test 'users index contains expected fields' do
    expected_fields = [:id, :email, :name, :username, :first_name, :last_name]
    meta_fields = [:_score, :_explanation]

    # Enables communicating with the test Elastic server for this block
    run_indexing do
      user = create :user
    end

    # Query Elastic for the record just added
    record = UsersIndex.filter { _id == user.entity.id }.first
    given_fields = record.attributes.keys.map &:to_sym
    assert_equal (expected_fields + meta_fields).sort, given_fields.sort
  end

  test 'creating a user causes the users index to be updated' do
    user = build :user

    # validates some change happened in UsersIndex
    updates = assert_indexes UsersIndex::Users do
      user.save
    end

    # validates that the updates contained an index request for the object
    assert updates.indexed? user

    # also possible, though perhaps not necessary in this example:
    # validates that an object is not deleted from the index
    refute updates.deleted? user
  end

end

Related to #392

[pyromaniac]

require 'chewy/minitest' ?

[pyromaniac]

Does it makes sense to add some specs for this?

[robacarp]

@pyromaniac yes, and I'll add them 👍

[robacarp]

@pyromaniac I'd appreciate another look when you have a chance. I had a bit of a brain warp wiring up rspec to test the minitest helper, and I'm pretty out of date on my rspec style, but I think it's at least mostly tested.

[robacarp]

I'm having a hard time replicating the test failures Travis is reporting on my workstation. I had not been running Ruby 2.0.0-p598, but even after installing it I don't see those failures. They appear to be indicating that the version of active support it's loading with bundle exec rake doesn't support the class_methods part of ActiveSupport::Concern, but I'm not sure.

[pyromaniac]

It seems to be about AS < 4.2, it is not about ruby

[pyromaniac]

Everything seems to be ok, just fix the specs and I'll merge it

[pyromaniac]

Hey, is it ready?

[robacarp]

Yep. Thanks!

On Aug 6, 2016, at 02:55, Arkadiy Zabazhanov notifications@github.com wrote:

Hey, is it ready?

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.

[pyromaniac]

Great job! Thanks!