File: shared_examples.rb

package info (click to toggle)
ruby-em-websocket 0.5.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 416 kB
  • sloc: ruby: 3,137; makefile: 5
file content (265 lines) | stat: -rw-r--r-- 5,993 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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# encoding: UTF-8

# These tests are run against all draft versions
#
shared_examples_for "a websocket server" do
  it "should expose the protocol version" do
    em {
      start_server { |ws|
        ws.onopen { |handshake|
          handshake.protocol_version.should == version
          done
        }
      }

      start_client
    }
  end

  it "should expose the origin header" do
    em {
      start_server { |ws|
        ws.onopen { |handshake|
          handshake.origin.should == 'http://example.com'
          done
        }
      }

      start_client
    }
  end

  it "should expose the remote IP address" do
    em {
      start_server { |ws|
        ws.onopen {
          ws.remote_ip.should == "127.0.0.1"
          done
        }
      }

      start_client
    }
  end

  it "should send messages successfully" do
    em {
      start_server { |ws|
        ws.onmessage { |message|
          message.should == "hello server"
          done
        }
      }

      start_client { |client|
        client.onopen {
          client.send("hello server")
        }
      }
    }
  end

  it "should allow connection to be closed with valid close code" do
    em {
      start_server { |ws|
        ws.onopen {
          ws.close(4004, "Bye bye")
          done
        }
      }

      start_client
      # TODO: Use a real client which understands how to respond to closing
      # handshakes, sending the handshake currently untested
    }
  end

  it "should raise error if if invalid close code is used" do
    em {
      start_server { |ws|
        ws.onopen {
          lambda {
            ws.close(2000)
          }.should raise_error("Application code may only use codes from 1000, 3000-4999")
          done
        }
      }

      start_client
    }
  end

  it "should call onclose with was_clean set to false if connection closed without closing handshake by server" do
    em {
      start_server { |ws|
        ws.onopen {
          # Close tcp connection (no close handshake)
          ws.close_connection
        }
        ws.onclose { |event|
          event.should == {:code => 1006, :was_clean => false}
          done
        }
      }
      start_client
    }
  end

  it "should call onclose with was_clean set to false if connection closed without closing handshake by client" do
    em {
      start_server { |ws|
        ws.onclose { |event|
          event.should == {:code => 1006, :was_clean => false}
          done
        }
      }
      start_client { |client|
        client.onopen {
          # Close tcp connection (no close handshake)
          client.close_connection
        }
      }
    }
  end

  it "should call onerror if an application error raised in onopen" do
    em {
      start_server { |ws|
        ws.onopen {
          raise "application error"
        }

        ws.onerror { |e|
          e.message.should == "application error"
          done
        }
      }

      start_client
    }
  end

  it "should call onerror if an application error raised in onmessage" do
    em {
      start_server { |server|
        server.onmessage {
          raise "application error"
        }

        server.onerror { |e|
          e.message.should == "application error"
          done
        }
      }

      start_client { |client|
        client.onopen {
          client.send('a message')
        }
      }
    }
  end

  it "should call onerror in an application error raised in onclose" do
    em {
      start_server { |server|
        server.onclose {
          raise "application error"
        }

        server.onerror { |e|
          e.message.should == "application error"
          done
        }
      }

      start_client { |client|
        client.onopen {
          EM.add_timer(0.1) {
            client.close_connection
          }
        }
      }
    }
  end

  it "should close the connection when a too long frame is sent" do
    em {
      start_server { |server|
        server.max_frame_size = 20

        server.onerror { |e|
          # 3: Error should be reported to server
          e.class.should == EventMachine::WebSocket::WSMessageTooBigError
          e.message.should =~ /Frame length too long/
        }
      }

      start_client { |client|
        client.onopen {
          EM.next_tick {
            client.send("This message is longer than 20 characters")
          }

        }

        client.onmessage { |msg|
          # 4: This is actually the close message. Really need to use a real
          # WebSocket client in these tests...
          done
        }

        client.onclose {
          # 4: Drafts 75 & 76 don't send a close message, they just close the
          # connection
          done
        }
      }
    }
  end

  # Only run these tests on ruby 1.9
  if "a".respond_to?(:force_encoding)
    it "should raise error if you try to send non utf8 text data to ws" do
      em {
        start_server { |server|
          server.onopen {
            # Create a string which claims to be UTF-8 but which is not
            s = "ê" # utf-8 string
            s.encode!("ISO-8859-1")
            s.force_encoding("UTF-8")
            s.valid_encoding?.should == false # now invalid utf8

            # Send non utf8 encoded data
            server.send(s)
          }
          server.onerror { |error|
            error.class.should == EventMachine::WebSocket::WebSocketError
            error.message.should == "Data sent to WebSocket must be valid UTF-8 but was UTF-8 (valid: false)"
            done
          }
        }

        start_client { }
      }
    end

    it "should not change the encoding of strings sent to send [antiregression]" do
      em {
        start_server { |server|
          server.onopen {
            s = "example string"
            s.force_encoding("UTF-8")

            server.send(s)

            s.encoding.should == Encoding.find("UTF-8")
            done
          }
        }

        start_client { }
      }
    end
  end
end