Module: ActionCable::Channel::TestCase::Behavior

Extended by:
ActiveSupport::Concern
Includes:
TestHelper, ActiveSupport::Testing::ConstantLookup
Included in:
ActionCable::Channel::TestCase, RSpec::Rails::ChannelExampleGroup
Defined in:
lib/action_cable/testing/channel/test_case.rb

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

CHANNEL_IDENTIFIER = 
"test_stub"

Constants included from TestHelper

TestHelper::CHANNEL_NOT_FOUND

Instance Method Summary collapse

Methods included from TestHelper

#after_teardown, #assert_no_broadcasts, #before_setup, #pubsub_adapter

Instance Method Details

#assert_broadcast_on(stream_or_object, *args) ⇒ Object 



253
254
255
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 253

def assert_broadcast_on(stream_or_object, *args)
  super(broadcasting_for(stream_or_object), *args)
end

#assert_broadcasts(stream_or_object, *args) ⇒ Object

Enhance TestHelper assertions to handle non-String broadcastings



249
250
251
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 249

def assert_broadcasts(stream_or_object, *args)
  super(broadcasting_for(stream_or_object), *args)
end

#assert_has_stream(stream) ⇒ Object

Asserts that the specified stream has been started.

def test_assert_started_stream
  subscribe
  assert_has_stream 'messages'
end



275
276
277
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 275

def assert_has_stream(stream)
  assert subscription.streams.include?(stream), "Stream #{stream} has not been started"
end

#assert_has_stream_for(object) ⇒ Object

Asserts that the specified stream for a model has started.

def test_assert_started_stream_for
  subscribe id: 42
  assert_has_stream_for User.find(42)
end



286
287
288
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 286

def assert_has_stream_for(object)
  assert_has_stream(broadcasting_for(object))
end

#assert_no_streams ⇒ Object

Asserts that no streams have been started.

def test_assert_no_started_stream
  subscribe
  assert_no_streams
end



264
265
266
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 264

def assert_no_streams
  assert subscription.streams.empty?, "No streams started was expected, but #{subscription.streams.count} found"
end

#perform(action, data = {}) ⇒ Object

Perform action on a channel.

NOTE: Must be subscribed.



236
237
238
239
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 236

def perform(action, data = {})
  check_subscribed!
  subscription.perform_action(data.stringify_keys.merge("action" => action.to_s))
end

#stub_connection(identifiers = {}) ⇒ Object

Setup test connection with the specified identifiers:

class ApplicationCable < ActionCable::Connection::Base
  identified_by :user, :token
end

stub_connection(user: users[:john], token: 'my-secret-token')



210
211
212
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 210

def stub_connection(identifiers = {})
  @connection = ConnectionStub.new(identifiers)
end

#subscribe(params = {}) ⇒ Object

Subsribe to the channel under test. Optionally pass subscription parameters as a Hash.



215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 215

def subscribe(params = {})
  @connection ||= stub_connection
  # NOTE: Rails < 5.0.1 calls subscribe_to_channel during #initialize.
  #       We have to stub before it
  @subscription = self.class.channel_class.allocate
  @subscription.singleton_class.include(ChannelStub)
  @subscription.send(:initialize, connection, CHANNEL_IDENTIFIER, params.with_indifferent_access)
  # Call subscribe_to_channel if it's public (Rails 5.0.1+)
  @subscription.subscribe_to_channel if ActionCable.gem_version >= Gem::Version.new("5.0.1")
  @subscription
end

#transmissions ⇒ Object

Returns messages transmitted into channel



242
243
244
245
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 242

def transmissions
  # Return only directly sent message (via #transmit)
  connection.transmissions.map { |data| data["message"] }.compact
end

#unsubscribe ⇒ Object

Unsubscribe the subscription under test.



228
229
230
231
 
# File 'lib/action_cable/testing/channel/test_case.rb', line 228

def unsubscribe
  check_subscribed!
  subscription.unsubscribe_from_channel
end