File: channel_spec.feature

package info (click to toggle)
ruby-rspec-rails 7.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,796 kB
  • sloc: ruby: 11,068; sh: 198; makefile: 6
file content (215 lines) | stat: -rw-r--r-- 6,729 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
Feature: Channel specs

  Channel specs are marked by `type: :channel` or if you have set
  `config.infer_spec_type_from_file_location!` by placing them in `spec/channels`.

  A channel spec is a thin wrapper for an `ActionCable::Channel::TestCase`, and includes all
  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 testing is available
    And a file named "app/channels/chat_channel.rb" with:
      """ruby
      class ChatChannel < ApplicationCable::Channel
        def subscribed
          reject unless params[:room_id].present?
        end

        def speak(data)
          ActionCable.server.broadcast(
            "chat_#{params[:room_id]}", text: data['message']
          )
        end

        def echo(data)
          data.delete("action")
          transmit data
        end
      end
      """

  Scenario: A simple passing example
    Given a file named "spec/channels/chat_channel_spec.rb" with:
      """ruby
      require "rails_helper"

      RSpec.describe ChatChannel, type: :channel do
        it "successfully subscribes" do
          subscribe room_id: 42
          expect(subscription).to be_confirmed
        end
      end
      """
    When I run `rspec spec/channels/chat_channel_spec.rb`
    Then the example should pass

  Scenario: Verifying that a subscription is rejected
    Given a file named "spec/channels/chat_channel_spec.rb" with:
      """ruby
      require "rails_helper"

      RSpec.describe ChatChannel, type: :channel do
        it "rejects subscription" do
          subscribe room_id: nil
          expect(subscription).to be_rejected
        end
      end
      """
    When I run `rspec spec/channels/chat_channel_spec.rb`
    Then the example should pass

  Scenario: Performing actions and checking transmissions
    Given a file named "spec/channels/chat_channel_spec.rb" with:
      """ruby
      require "rails_helper"

      RSpec.describe ChatChannel, type: :channel do
        it "successfully subscribes" do
          subscribe room_id: 42

          perform :echo, foo: 'bar'
          expect(transmissions.last).to eq('foo' => 'bar')
        end
      end
      """
    When I run `rspec spec/channels/chat_channel_spec.rb`
    Then the example should pass

  Scenario: A successful connection with url params
    Given a file named "app/channels/application_cable/connection.rb" with:
      """ruby
      class ApplicationCable::Connection < ActionCable::Connection::Base
        identified_by :user_id

        def connect
          self.user_id = request.params[:user_id]
          reject_unauthorized_connection unless user_id.present?
        end
      end
      """
    And 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: A successful connection with cookies
    Given a file named "app/channels/application_cable/connection.rb" with:
      """ruby
      class ApplicationCable::Connection < ActionCable::Connection::Base
        identified_by :user_id

        def connect
          self.user_id = cookies.signed[:user_id]
          reject_unauthorized_connection unless user_id.present?
        end
      end
      """
    And a file named "spec/channels/connection_spec.rb" with:
      """ruby
      require "rails_helper"

      RSpec.describe ApplicationCable::Connection, type: :channel do
        it "successfully connects" do
          cookies.signed[:user_id] = "324"

          connect "/cable"
          expect(connection.user_id).to eq "324"
        end
      end
      """
    When I run `rspec spec/channels/connection_spec.rb`
    Then the example should pass

  Scenario: A successful connection with headers
    Given a file named "app/channels/application_cable/connection.rb" with:
      """ruby
      class ApplicationCable::Connection < ActionCable::Connection::Base
        identified_by :user_id

        def connect
          self.user_id = request.headers["x-user-id"]
          reject_unauthorized_connection unless user_id.present?
        end
      end
      """
    And 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: A rejected connection
    Given a file named "app/channels/application_cable/connection.rb" with:
      """ruby
      class ApplicationCable::Connection < ActionCable::Connection::Base
        identified_by :user_id

        def connect
          self.user_id = request.params[:user_id]
          reject_unauthorized_connection unless user_id.present?
        end
      end
      """
    And 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?user_id=" }.to have_rejected_connection
        end
      end
      """
    When I run `rspec spec/channels/connection_spec.rb`
    Then the example should pass

  Scenario: Disconnect a connection
    Given a file named "app/channels/application_cable/connection.rb" with:
      """ruby
      class ApplicationCable::Connection < ActionCable::Connection::Base
        identified_by :user_id

        def connect
          self.user_id = request.params[:user_id]
          reject_unauthorized_connection unless user_id.present?
        end

        def disconnect
          $stdout.puts "User #{user_id} disconnected"
        end
      end
      """
    And 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