action-cable-testing 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 49ea4d058ad808b422aee252af3404f7ffc19b09
-  data.tar.gz: fc2a1ab66b7d9dbbcb34a8c59d51f614fe715e8e
+SHA256:
+  metadata.gz: f485ca6094981aea2459acc0a1334d79855b20180fd7866e4bbb073d97d9d75a
+  data.tar.gz: a350c77463c57478ada51df21acdeab8a4ef4621abe7dad12a07347a3820c4f3
 SHA512:
-  metadata.gz: 6457b2c9afabf9c6e758a5cbe1cad993c7585734dec33bfed1a96e4d606dcc415e507cefc3d0e6fc7acbcca877edd4d558798919ef2f700846c40d7185faecd7
-  data.tar.gz: 9cc75eb56ad1f4b6f30540e5d3b523be3ab6278604bbc97325e1b3d1d84024dbd72ea9e7feb0894732b134c4832a4040c2c76843d6d14d4e690ae244c91d2b81
+  metadata.gz: 166cd3cfd3481b90e4d67d3c1b2348010e399e762d5278e198de9d3b254babac01287ddfa288c0aa8c7ebd1402e538e2c34bc83a5ebda4214f3105c6288d84c5
+  data.tar.gz: a3065fa172d0a0777dc057c68b17e5b12d1b89a4c105b9566b8a44cca3d37db713242982f9d1d9d465a5088b758fdf1b393bd0845f819dbeacac92109d1a8aa1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## master
+
+## 0.3.0
+
+- Add connection unit-testing utilities. ([@palkan][])
+
+  See https://github.com/palkan/action-cable-testing/pull/6
+
 ## 0.2.0
 
 - Update minitest's `assert_broadcast_on` and `assert_broadcasts` matchers to support a record as an argument. ([@thesmartnik][])

data/README.md

@@ -156,6 +156,43 @@ class ChatChannelTest < ActionCable::Channel::TestCase
 end
 ```
 
+### Connection Testing
+
+Connection unit tests are written as follows:
+1. First, one uses the `connect` method to simulate connection.
+2. Then, one asserts whether the current state is as expected (e.g. identifiers).
+
+For example:
+
+```ruby
+module ApplicationCable
+  class ConnectionTest < ActionCable::Connection::TestCase
+    def test_connects_with_cookies
+      # Simulate a connection
+      connect cookies: { user_id: users[:john].id }
+
+      # Asserts that the connection identifier is correct
+      assert_equal "John", connection.user.name
+  end
+
+  def test_does_not_connect_without_user
+    assert_reject_connection do
+      connect
+    end
+  end
+end
+```
+
+You can also provide additional information about underlying HTTP request:
+
+```ruby
+def test_connect_with_headers_and_query_string
+  connect "/cable?user_id=1", headers: { "X-API-TOKEN" => 'secret-my' }
+
+  assert_equal connection.user_id, "1"
+end
+```
+
 ### RSpec Usage
 
 First, you need to have [rspec-rails](https://github.com/rspec/rspec-rails) installed.
@@ -227,6 +264,23 @@ RSpec.describe ChatChannel, type: :channel do
 end
 ```
 
+And, of course, connections:
+
+```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
+
+  it "rejects connection" do
+    expect { connect "/cable" }.to have_rejected_connection
+  end
+end
+```
+
 #### Shared contexts to switch between adapters
 
 Sometimes you may want to use _real_ Action Cable adapter instead of the test one (for example, in Capybara-like tests).

data/lib/action_cable/channel/test_case.rb

@@ -38,6 +38,10 @@ module ActionCable
       def streams
         @_streams ||= []
       end
+
+      # Make periodic timers no-op
+      def start_periodic_timers; end
+      alias stop_periodic_timers start_periodic_timers
     end
 
     class ConnectionStub
@@ -80,7 +84,7 @@ module ActionCable
     #       assert subscription.confirmed?
     #
     #       # Asserts that the channel subscribes connection to a stream
-    #       assert "chat_1", streams.last
+    #       assert_equal "chat_1", streams.last
     #     end
     #
     #     def test_does_not_subscribe_without_room_number
@@ -137,6 +141,7 @@ module ActionCable
 
         include ActiveSupport::Testing::ConstantLookup
         include ActionCable::TestHelper
+        include ActionCable::Connection::TestCase::Behavior
 
         CHANNEL_IDENTIFIER = "test_stub"
 
@@ -191,6 +196,7 @@ module ActionCable
 
         # 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 +215,6 @@ module ActionCable
           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)

data/lib/action_cable/connection/test_case.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+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
+  module Connection
+    class NonInferrableConnectionError < ::StandardError
+      def initialize(name)
+        super "Unable to determine the connection to test from #{name}. " +
+          "You'll need to specify it using tests YourConnection in your " +
+          "test case definition."
+      end
+    end
+
+    module Assertions
+      # Asserts that the connection is rejected (via +reject_unauthorized_connection+).
+      #
+      #   # Asserts that connection without user_id fails
+      #   assert_reject_connection { connect cookies: { user_id: '' } }
+      def assert_reject_connection(&block)
+        res =
+          begin
+            block.call
+            false
+          rescue ActionCable::Connection::Authorization::UnauthorizedError
+            true
+          end
+
+        assert res, "Expected to reject connection but no rejection were made"
+      end
+    end
+
+    class TestRequest < ActionDispatch::TestRequest
+      attr_reader :cookie_jar
+
+      module CookiesStub
+        # Stub signed cookies, we don't need to test encryption here
+        def signed
+          self
+        end
+      end
+
+      def cookie_jar=(val)
+        @cookie_jar = val.tap do |h|
+          h.singleton_class.include(CookiesStub)
+        end
+      end
+    end
+
+    module TestConnection
+      attr_reader :logger, :request
+
+      def initialize(path, cookies, headers)
+        @logger = ActiveSupport::TaggedLogging.new ActiveSupport::Logger.new(StringIO.new)
+
+        uri = URI.parse(path)
+        env = {
+          "QUERY_STRING" => uri.query,
+          "PATH_INFO" => uri.path
+        }.merge(build_headers(headers))
+
+        @request = TestRequest.create(env)
+        @request.cookie_jar = cookies.with_indifferent_access
+      end
+
+      def build_headers(headers)
+        headers.each_with_object({}) do |(k, v), obj|
+          k = k.upcase
+          k.tr!("-", "_")
+          obj["HTTP_#{k}"] = v
+        end
+      end
+    end
+
+    # Superclass for Action Cable connection unit tests.
+    #
+    # == Basic example
+    #
+    # Unit tests are written as follows:
+    # 1. First, one uses the +connect+ method to simulate connection.
+    # 2. Then, one asserts whether the current state is as expected (e.g. identifiers).
+    #
+    # For example:
+    #
+    #   module ApplicationCable
+    #     class ConnectionTest < ActionCable::Connection::TestCase
+    #       def test_connects_with_cookies
+    #         # Simulate a connection
+    #         connect cookies: { user_id: users[:john].id }
+    #
+    #         # Asserts that the connection identifier is correct
+    #         assert_equal "John", connection.user.name
+    #     end
+    #
+    #     def test_does_not_connect_without_user
+    #       assert_reject_connection do
+    #         connect
+    #       end
+    #     end
+    #   end
+    #
+    # You can also provide additional information about underlying HTTP request:
+    #   def test_connect_with_headers_and_query_string
+    #     connect "/cable?user_id=1", headers: { "X-API-TOKEN" => 'secret-my' }
+    #
+    #     assert_equal connection.user_id, "1"
+    #   end
+    #
+    # == Connection is automatically inferred
+    #
+    # ActionCable::Connection::TestCase will automatically infer the connection under test
+    # from the test class name. If the channel cannot be inferred from the test
+    # class name, you can explicitly set it with +tests+.
+    #
+    #   class ConnectionTest < ActionCable::Connection::TestCase
+    #     tests ApplicationCable::Connection
+    #   end
+    #
+    class TestCase < ActiveSupport::TestCase
+      module Behavior
+        extend ActiveSupport::Concern
+
+        include ActiveSupport::Testing::ConstantLookup
+        include Assertions
+
+        included do
+          class_attribute :_connection_class
+
+          attr_reader :connection
+
+          ActiveSupport.run_load_hooks(:action_cable_connection_test_case, self)
+        end
+
+        module ClassMethods
+          def tests(connection)
+            case connection
+            when String, Symbol
+              self._connection_class = connection.to_s.camelize.constantize
+            when Module
+              self._connection_class = connection
+            else
+              raise NonInferrableConnectionError.new(connection)
+            end
+          end
+
+          def connection_class
+            if connection = self._connection_class
+              connection
+            else
+              tests determine_default_connection(name)
+            end
+          end
+
+          def determine_default_connection(name)
+            connection = determine_constant_from_test_name(name) do |constant|
+              Class === constant && constant < ActionCable::Connection::Base
+            end
+            raise NonInferrableConnectionError.new(name) if connection.nil?
+            connection
+          end
+        end
+
+        # Performs connection attempt (i.e. calls #connect method).
+        #
+        # 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(TestConnection)
+          connection.send(:initialize, path, cookies, headers)
+          connection.connect if connection.respond_to?(:connect)
+
+          # Only set instance variable if connected successfully
+          @connection = connection
+        end
+
+        # Disconnect the connection under test (i.e. calls #disconnect)
+        def disconnect
+          raise "Must be connected!" if connection.nil?
+
+          connection.disconnect if connection.respond_to?(:disconnect)
+          @connection = nil
+        end
+      end
+
+      include Behavior
+    end
+  end
+end

data/lib/action_cable/testing.rb

@@ -14,6 +14,12 @@ module ActionCable
     end
   end
 
+  module Connection
+    eager_autoload do
+      autoload :TestCase
+    end
+  end
+
   module SubscriptionAdapter
     autoload :Test
   end

data/lib/action_cable/testing/version.rb

@@ -2,6 +2,6 @@
 
 module ActionCable
   module Testing
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/rspec/rails/example/channel_example_group.rb

@@ -27,6 +27,17 @@ if defined?(ActionCable)
           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

data/lib/rspec/rails/matchers/action_cable.rb

@@ -7,7 +7,7 @@ module RSpec
       #
       # @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 @@ module RSpec
             raise ArgumentError, error_msg
           end
         end
-        # rubocop: enable Style/ClassLength
+        # rubocop: enable Metrics/ClassLength
       end
 
       # @api public

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action-cable-testing
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable
@@ -148,6 +148,7 @@ files:
 - README.md
 - lib/action-cable-testing.rb
 - lib/action_cable/channel/test_case.rb
+- lib/action_cable/connection/test_case.rb
 - lib/action_cable/subscription_adapter/test.rb
 - lib/action_cable/test_case.rb
 - lib/action_cable/test_helper.rb
@@ -182,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Testing utils for Action Cable