Skip to Content Skip to Search

module ActiveRecord::Assertions::QueryAssertions

Public instance methods

assert_no_queries(&block)

Permalink

Asserts that no SQL queries are executed in the given block.

Source code GitHub 
# File activerecord/lib/active_record/testing/query_assertions.rb, line 29
def assert_no_queries(&block)
  assert_queries(0, &block)
end

assert_queries(expected_count, matcher: nil, &block)

Permalink

Asserts that the number of SQL queries executed in the given block matches the expected count.

assert_queries(1) { Post.first }

If the :matcher option is provided, only queries that match the matcher are counted.

assert_queries(1, matcher: /LIMIT \?/) { Post.first }
Source code GitHub 
# File activerecord/lib/active_record/testing/query_assertions.rb, line 14
def assert_queries(expected_count, matcher: nil, &block)
  ActiveRecord::Base.connection.materialize_transactions

  queries = []
  callback = lambda do |*, payload|
    queries << payload[:sql] if %w[ SCHEMA TRANSACTION ].exclude?(payload[:name]) && (matcher.nil? || payload[:sql].match(matcher))
  end
  ActiveSupport::Notifications.subscribed(callback, "sql.active_record") do
    result = _assert_nothing_raised_or_warn("assert_queries", &block)
    assert_equal expected_count, queries.size, "#{queries.size} instead of #{expected_count} queries were executed. Queries: #{queries.join("\n\n")}"
    result
  end
end

Definition files