Implement RSpec connection testing

features/channel_specs/channel_spec.feature

@@ -7,6 +7,9 @@ Feature: channel spec
  of the behavior and assertions that it provides, in addition to RSpec's own
  behavior and expectations.
 
+ It also includes helpers from ActionCable::Connection::TestCase to make it possible to
+ test connection behavior.
+
  Background:
  Given action cable is available
 
@@ -112,3 +115,77 @@ Feature: channel spec
  """
  When I run `rspec spec/channels/chat_channel_spec.rb`
  Then the example should pass
+
+ Scenario: successful connection with url params
+ Given a file named "spec/channels/connection_spec.rb" with:
+ """ruby
+ require "rails_helper"
+
+ RSpec.describe ApplicationCable::Connection, :type => :channel do
+ it "successfully connects" do
+ connect "/cable?user_id=323"
+ expect(connection.user_id).to eq "323"
+ end
+ end
+ """
+ When I run `rspec spec/channels/connection_spec.rb`
+ Then the example should pass
+
+ Scenario: successful connection with cookies
+ Given a file named "spec/channels/connection_spec.rb" with:
+ """ruby
+ require "rails_helper"
+
+ RSpec.describe ApplicationCable::Connection, :type => :channel do
+ it "successfully connects" do
+ connect "/cable", cookies: { user_id: "324" }
+ expect(connection.user_id).to eq "324"
+ end
+ end
+ """
+ When I run `rspec spec/channels/connection_spec.rb`
+ Then the example should pass
+
+ Scenario: successful connection with headers
+ Given a file named "spec/channels/connection_spec.rb" with:
+ """ruby
+ require "rails_helper"
+
+ RSpec.describe ApplicationCable::Connection, :type => :channel do
+ it "successfully connects" do
+ connect "/cable", headers: { "X-USER-ID" => "325" }
+ expect(connection.user_id).to eq "325"
+ end
+ end
+ """
+ When I run `rspec spec/channels/connection_spec.rb`
+ Then the example should pass
+
+ Scenario: rejected connection
+ Given a file named "spec/channels/connection_spec.rb" with:
+ """ruby
+ require "rails_helper"
+
+ RSpec.describe ApplicationCable::Connection, :type => :channel do
+ it "rejects connection" do
+ expect { connect "/cable" }.to have_rejected_connection
+ end
+ end
+ """
+ When I run `rspec spec/channels/connection_spec.rb`
+ Then the example should pass
+
+ Scenario: disconnect connection
+ Given a file named "spec/channels/connection_spec.rb" with:
+ """ruby
+ require "rails_helper"
+
+ RSpec.describe ApplicationCable::Connection, :type => :channel do
+ it "disconnects" do
+ connect "/cable?user_id=42"
+ expect { disconnect }.to output(/User 42 disconnected/).to_stdout
+ end
+ end
+ """
+ When I run `rspec spec/channels/connection_spec.rb`
+ Then the example should pass

lib/action_cable/channel/test_case.rb

@@ -137,6 +137,7 @@ module Behavior
 
  include ActiveSupport::Testing::ConstantLookup
  include ActionCable::TestHelper
+ include ActionCable::Connection::TestCase::Behavior
 
  CHANNEL_IDENTIFIER = "test_stub"
 
@@ -191,6 +192,7 @@ def stub_connection(identifiers = {})
 
  # Subsribe to the channel under test. Optionally pass subscription parameters as a Hash.
  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
@@ -209,10 +211,6 @@ def perform(action, data = {})
  subscription.perform_action(data.stringify_keys.merge("action" => action.to_s))
  end
 
- def connection # :nodoc:
- @connection ||= stub_connection
- end
-
  # Returns messages transmitted into channel
  def transmissions
  # Return only directly sent message (via #transmit)

lib/action_cable/connection/test_case.rb

@@ -3,6 +3,7 @@
 require "active_support"
 require "active_support/test_case"
 require "active_support/core_ext/hash/indifferent_access"
+require "action_dispatch"
 require "action_dispatch/testing/test_request"
 
 module ActionCable
@@ -50,7 +51,7 @@ def cookie_jar=(val)
  end
  end
 
- module ConnectionStub
+ module TestConnection
  attr_reader :logger, :request
 
  def initialize(path, cookies, headers)
@@ -168,7 +169,7 @@ def determine_default_connection(name)
  # Accepts request path as the first argument and cookies and headers as options.
  def connect(path = "/cable", cookies: {}, headers: {})
  connection = self.class.connection_class.allocate
- connection.singleton_class.include(ConnectionStub)
+ connection.singleton_class.include(TestConnection)
  connection.send(:initialize, path, cookies, headers)
  connection.connect if connection.respond_to?(:connect)
 

lib/rspec/rails/example/channel_example_group.rb

@@ -27,6 +27,17 @@ module ClassMethods
  def channel_class
  described_class
  end
+
+ # @private
+ def connection_class
+ raise "Described class is not a Connection class" unless
+ described_class <= ::ActionCable::Connection::Base
+ described_class
+ end
+ end
+
+ def have_rejected_connection
+ raise_error(::ActionCable::Connection::Authorization::UnauthorizedError)
  end
  end
  end

lib/rspec/rails/matchers/action_cable.rb

@@ -7,7 +7,7 @@ module Matchers
  #
  # @api private
  module ActionCable
- # rubocop: disable Style/ClassLength
+ # rubocop: disable Metrics/ClassLength
  # @private
  class HaveBroadcastedTo < RSpec::Matchers::BuiltIn::BaseMatcher
  def initialize(target, channel:)
@@ -167,7 +167,7 @@ def check_channel_presence
  raise ArgumentError, error_msg
  end
  end
- # rubocop: enable Style/ClassLength
+ # rubocop: enable Metrics/ClassLength
  end
 
  # @api public

spec/dummy/app/channels/application_cable/connection.rb

@@ -1,5 +1,23 @@
 module ApplicationCable
  class Connection < ActionCable::Connection::Base
  identified_by :user_id
+
+ def connect
+ self.user_id = verify_user
+ end
+
+ def disconnect
+ $stdout.puts "User #{user_id} disconnected"
+ end
+
+ private
+
+ def verify_user
+ user_id = request.params[:user_id] ||
+ request.headers["x-user-id"] ||
+ cookies.signed[:user_id]
+ reject_unauthorized_connection unless user_id.present?
+ user_id
+ end
  end
 end