method

assert_queries_count

v8.1.1 - Show latest stable - Class: ActiveRecord::Assertions::QueryAssertions

assert_queries_count(count = nil, include_schema: false, &block)

public

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

# Check for exact number of queries
assert_queries_count(1) { Post.first }

# Check for any number of queries
assert_queries_count { Post.first }

Any unmaterialized transactions will be materialized to ensure only queries attempted intside the block are counted.

If the :include_schema option is provided, any queries (including schema related) are counted. Setting this option also skips leasing a connection to materialize pending transactions since we want to count queries executed at connection open (e.g., type map).

assert_queries_count(1, include_schema: true) { Post.columns }

# File activerecord/lib/active_record/testing/query_assertions.rb, line 24
      def assert_queries_count(count = nil, include_schema: false, &block)
        ActiveRecord::Base.lease_connection.materialize_transactions unless include_schema

        counter = SQLCounter.new
        ActiveSupport::Notifications.subscribed(counter, "sql.active_record") do
          result = _assert_nothing_raised_or_warn("assert_queries_count", &block)
          queries = include_schema ? counter.log_all : counter.log
          if count
            assert_equal count, queries.size, "#{queries.size} instead of #{count} queries were executed. Queries: #{queries.join("\n\n")}"
          else
            assert_operator queries.size, :>=, 1, "1 or more queries expected, but none were executed.#{queries.empty? ? '' : "\nQueries:\n#{queries.join("\n")}"}"
          end
          result
        end
      end

assert_queries_count

Related methods