Module: ActionCable::TestHelper

Included in:
Channel::TestCase::Behavior, TestCase
Defined in:
lib/action_cable/testing/test_helper.rb

Overview

Provides helper methods for testing Action Cable broadcasting

Constant Summary collapse

CHANNEL_NOT_FOUND = 
ArgumentError.new("Broadcasting channel can't be infered. Please, specify it with `:channel`")

Instance Method Summary collapse

Instance Method Details

#after_teardown ⇒ Object

:nodoc:



21
22
23
24
 
# File 'lib/action_cable/testing/test_helper.rb', line 21

def after_teardown # :nodoc:
  super
  ActionCable.server.instance_variable_set(:@pubsub, @old_pubsub_adapter)
end

#assert_broadcast_on(target, data, channel: nil) ⇒ Object

Asserts that the specified message has been sent to the channel.

def test_assert_transmited_message
  ActionCable.server.broadcast 'messages', text: 'hello'
  assert_broadcast_on('messages', text: 'hello')
end

If a block is passed, that block should cause a message with the specified data to be sent.

def test_assert_broadcast_on_again
  assert_broadcast_on('messages', text: 'hello') do
    ActionCable.server.broadcast 'messages', text: 'hello'
  end
end



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/action_cable/testing/test_helper.rb', line 105

def assert_broadcast_on(target, data, channel: nil)
  warn_deprecated_channel! unless channel.nil?

  # Encode to JSON and back–we want to use this value to compare
  # with decoded JSON.
  # Comparing JSON strings doesn't work due to the order if the keys.
  serialized_msg =
    ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data))
  stream = stream(target, channel)

  new_messages = broadcasts(stream)
  if block_given?
    old_messages = new_messages
    clear_messages(stream)

    yield
    new_messages = broadcasts(stream)
    clear_messages(stream)

    # Restore all sent messages
    (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(stream, m) }
  end

  message = new_messages.find { |msg| ActiveSupport::JSON.decode(msg) == serialized_msg }

  assert message, "No messages sent with #{data} to #{stream}"
end

#assert_broadcasts(target, number, channel: nil) ⇒ Object

Asserts that the number of broadcasted messages to the channel 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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/action_cable/testing/test_helper.rb', line 50

def assert_broadcasts(target, number, channel: nil)
  warn_deprecated_channel! unless channel.nil?

  stream = stream(target, channel)

  if block_given?
    original_count = broadcasts_size(stream)
    yield
    new_count = broadcasts_size(stream)
    assert_equal number, new_count - original_count, "#{number} broadcasts to #{stream} expected, but #{new_count - original_count} were sent"
  else
    actual_count = broadcasts_size(stream)
    assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
  end
end

#assert_no_broadcasts(target, &block) ⇒ Object

Asserts that no messages have been sent to the channel.

def test_no_broadcasts
  assert_no_broadcasts 'messages'
  ActionCable.server.broadcast 'messages', { text: 'hi' }
  assert_broadcasts 'messages', 1
end

If a block is passed, that block should not cause any message to be sent.

def test_broadcasts_again
  assert_no_broadcasts 'messages' do
    # No job messages should be sent from this block
  end
end

Note: This assertion is simply a shortcut for:

assert_broadcasts 'messages', 0, &block



86
87
88
 
# File 'lib/action_cable/testing/test_helper.rb', line 86

def assert_no_broadcasts(target, &block)
  assert_broadcasts target, 0, &block
end

#before_setup ⇒ Object

:nodoc:



11
12
13
14
15
16
17
18
19
 
# File 'lib/action_cable/testing/test_helper.rb', line 11

def before_setup # :nodoc:
  server = ActionCable.server
  test_adapter = ActionCable::SubscriptionAdapter::Test.new(server)

  @old_pubsub_adapter = server.pubsub

  server.instance_variable_set(:@pubsub, test_adapter)
  super
end

#pubsub_adapter ⇒ Object

:nodoc:



133
134
135
 
# File 'lib/action_cable/testing/test_helper.rb', line 133

def pubsub_adapter # :nodoc:
  ActionCable.server.pubsub
end