instance method `assert_queries_count`

Ruby on Rails 8.0.4

Since v7.2.3

Available in: v7.2.3 v8.0.4 v8.1.2

Compare with:

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

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 }

If the :include_schema option is provided, any queries (including schema related) are counted.

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

Parameters

count opt = nil
include_schema key = false
block block

Source

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

        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

Defined in activerecord/lib/active_record/testing/query_assertions.rb line 18 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::Assertions::QueryAssertions

Signature

Parameters