instance method `assert_broadcasts`

Ruby on Rails 8.1.2

Since v6.0.6

Available in: v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

assert_broadcasts(stream, number, &block)

Asserts that the number of broadcasted messages to the stream matches the given number.

def test_broadcasts
  assert_broadcasts 'messages', 0
  ActionCable.server.broadcast 'messages', { text: 'hello' }
  assert_broadcasts 'messages', 1
  ActionCable.server.broadcast 'messages', { text: 'world' }
  assert_broadcasts 'messages', 2
end

If a block is passed, that block should cause the specified number of messages to be broadcasted.

def test_broadcasts_again
  assert_broadcasts('messages', 1) do
    ActionCable.server.broadcast 'messages', { text: 'hello' }
  end

  assert_broadcasts('messages', 2) do
    ActionCable.server.broadcast 'messages', { text: 'hi' }
    ActionCable.server.broadcast 'messages', { text: 'how are you?' }
  end
end

Parameters

stream req
number req
block block

Source

# File actioncable/lib/action_cable/test_helper.rb, line 48
    def assert_broadcasts(stream, number, &block)
      if block_given?
        new_messages = new_broadcasts_from(broadcasts(stream), stream, "assert_broadcasts", &block)

        actual_count = new_messages.size
        assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
      else
        actual_count = broadcasts(stream).size
        assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
      end
    end

Defined in actioncable/lib/action_cable/test_helper.rb line 48 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionCable::TestHelper

Signature

Parameters