mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Add Action Cable test case and test helper
This commit is contained in:
parent
f7dd2d67d6
commit
c11ca09962
5 changed files with 255 additions and 0 deletions
|
@ -51,4 +51,6 @@ module ActionCable
|
||||||
autoload :Channel
|
autoload :Channel
|
||||||
autoload :RemoteConnections
|
autoload :RemoteConnections
|
||||||
autoload :SubscriptionAdapter
|
autoload :SubscriptionAdapter
|
||||||
|
autoload :TestHelper
|
||||||
|
autoload :TestCase
|
||||||
end
|
end
|
||||||
|
|
11
actioncable/lib/action_cable/test_case.rb
Normal file
11
actioncable/lib/action_cable/test_case.rb
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
require "active_support/test_case"
|
||||||
|
|
||||||
|
module ActionCable
|
||||||
|
class TestCase < ActiveSupport::TestCase
|
||||||
|
include ActionCable::TestHelper
|
||||||
|
|
||||||
|
ActiveSupport.run_load_hooks(:action_cable_test_case, self)
|
||||||
|
end
|
||||||
|
end
|
132
actioncable/lib/action_cable/test_helper.rb
Normal file
132
actioncable/lib/action_cable/test_helper.rb
Normal file
|
@ -0,0 +1,132 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
module ActionCable
|
||||||
|
# Provides helper methods for testing Action Cable broadcasting
|
||||||
|
module TestHelper
|
||||||
|
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
|
||||||
|
|
||||||
|
def after_teardown # :nodoc:
|
||||||
|
super
|
||||||
|
ActionCable.server.instance_variable_set(:@pubsub, @old_pubsub_adapter)
|
||||||
|
end
|
||||||
|
|
||||||
|
# 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
|
||||||
|
#
|
||||||
|
def assert_broadcasts(stream, number)
|
||||||
|
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
|
||||||
|
|
||||||
|
# Asserts that no messages have been sent to the stream.
|
||||||
|
#
|
||||||
|
# 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
|
||||||
|
#
|
||||||
|
def assert_no_broadcasts(stream, &block)
|
||||||
|
assert_broadcasts stream, 0, &block
|
||||||
|
end
|
||||||
|
|
||||||
|
# Asserts that the specified message has been sent to the stream.
|
||||||
|
#
|
||||||
|
# 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
|
||||||
|
#
|
||||||
|
def assert_broadcast_on(stream, data)
|
||||||
|
# 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))
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
def pubsub_adapter # :nodoc:
|
||||||
|
ActionCable.server.pubsub
|
||||||
|
end
|
||||||
|
|
||||||
|
delegate :broadcasts, :clear_messages, to: :pubsub_adapter
|
||||||
|
|
||||||
|
private
|
||||||
|
def broadcasts_size(channel) # :nodoc:
|
||||||
|
broadcasts(channel).size
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
|
@ -15,6 +15,10 @@ end
|
||||||
# Require all the stubs and models
|
# Require all the stubs and models
|
||||||
Dir[File.expand_path("stubs/*.rb", __dir__)].each { |file| require file }
|
Dir[File.expand_path("stubs/*.rb", __dir__)].each { |file| require file }
|
||||||
|
|
||||||
|
# Set test adapter and logger
|
||||||
|
ActionCable.server.config.cable = { "adapter" => "test" }
|
||||||
|
ActionCable.server.config.logger = Logger.new(StringIO.new).tap { |l| l.level = Logger::UNKNOWN }
|
||||||
|
|
||||||
class ActionCable::TestCase < ActiveSupport::TestCase
|
class ActionCable::TestCase < ActiveSupport::TestCase
|
||||||
include ActiveSupport::Testing::MethodCallAssertions
|
include ActiveSupport::Testing::MethodCallAssertions
|
||||||
|
|
||||||
|
|
106
actioncable/test/test_helper_test.rb
Normal file
106
actioncable/test/test_helper_test.rb
Normal file
|
@ -0,0 +1,106 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class BroadcastChannel < ActionCable::Channel::Base
|
||||||
|
end
|
||||||
|
|
||||||
|
class TransmissionsTest < ActionCable::TestCase
|
||||||
|
def test_assert_broadcasts
|
||||||
|
assert_nothing_raised do
|
||||||
|
assert_broadcasts("test", 1) do
|
||||||
|
ActionCable.server.broadcast "test", "message"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_assert_broadcasts_with_no_block
|
||||||
|
assert_nothing_raised do
|
||||||
|
ActionCable.server.broadcast "test", "message"
|
||||||
|
assert_broadcasts "test", 1
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_nothing_raised do
|
||||||
|
ActionCable.server.broadcast "test", "message 2"
|
||||||
|
ActionCable.server.broadcast "test", "message 3"
|
||||||
|
assert_broadcasts "test", 3
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_assert_no_broadcasts_with_no_block
|
||||||
|
assert_nothing_raised do
|
||||||
|
assert_no_broadcasts "test"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_assert_no_broadcasts
|
||||||
|
assert_nothing_raised do
|
||||||
|
assert_no_broadcasts("test") do
|
||||||
|
ActionCable.server.broadcast "test2", "message"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_assert_broadcasts_message_too_few_sent
|
||||||
|
ActionCable.server.broadcast "test", "hello"
|
||||||
|
error = assert_raises Minitest::Assertion do
|
||||||
|
assert_broadcasts("test", 2) do
|
||||||
|
ActionCable.server.broadcast "test", "world"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_match(/2 .* but 1/, error.message)
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_assert_broadcasts_message_too_many_sent
|
||||||
|
error = assert_raises Minitest::Assertion do
|
||||||
|
assert_broadcasts("test", 1) do
|
||||||
|
ActionCable.server.broadcast "test", "hello"
|
||||||
|
ActionCable.server.broadcast "test", "world"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_match(/1 .* but 2/, error.message)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class TransmitedDataTest < ActionCable::TestCase
|
||||||
|
include ActionCable::TestHelper
|
||||||
|
|
||||||
|
def test_assert_broadcast_on
|
||||||
|
assert_nothing_raised do
|
||||||
|
assert_broadcast_on("test", "message") do
|
||||||
|
ActionCable.server.broadcast "test", "message"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_assert_broadcast_on_with_hash
|
||||||
|
assert_nothing_raised do
|
||||||
|
assert_broadcast_on("test", text: "hello") do
|
||||||
|
ActionCable.server.broadcast "test", text: "hello"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_assert_broadcast_on_with_no_block
|
||||||
|
assert_nothing_raised do
|
||||||
|
ActionCable.server.broadcast "test", "hello"
|
||||||
|
assert_broadcast_on "test", "hello"
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_nothing_raised do
|
||||||
|
ActionCable.server.broadcast "test", "world"
|
||||||
|
assert_broadcast_on "test", "world"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_assert_broadcast_on_message
|
||||||
|
ActionCable.server.broadcast "test", "hello"
|
||||||
|
error = assert_raises Minitest::Assertion do
|
||||||
|
assert_broadcast_on("test", "world")
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_match(/No messages sent/, error.message)
|
||||||
|
end
|
||||||
|
end
|
Loading…
Reference in a new issue