Specs for behaviour on un-ack'd close connections

Author: mloughran

spec/helper.rb

@@ -8,6 +8,9 @@
 require 'em-websocket'
 require 'em-websocket-client'
 
+require 'integration/shared_examples'
+require 'integration/gte_03_examples'
+
 RSpec.configure do |c|
   c.mock_with :rspec
 end
@@ -128,6 +131,12 @@ def close_connection
   end
 end
 
+def start_server(opts = {})
+  EM::WebSocket.run({:host => "0.0.0.0", :port => 12345}.merge(opts)) { |ws|
+    yield ws if block_given?
+  }
+end
+
 def format_request(r)
   data = "#{r[:method]} #{r[:path]} HTTP/1.1\r\n"
   header_lines = r[:headers].map { |k,v| "#{k}: #{v}" }

spec/integration/common_spec.rb

@@ -6,12 +6,6 @@
   include EM::SpecHelper
   default_timeout 1
 
-  def start_server
-    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws if block_given?
-    }
-  end
-
   it "should fail on non WebSocket requests" do
     em {
       EM.add_timer(0.1) do

spec/integration/draft03_spec.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'integration/shared_examples'
 
 describe "draft03" do
   include EM::SpecHelper
@@ -35,12 +34,6 @@
     }
   end
 
-  def start_server
-    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws if block_given?
-    }
-  end
-
   def start_client
     client = EM.connect('0.0.0.0', 12345, Draft03FakeWebSocketClient)
     client.send_data(format_request(@request))
@@ -52,6 +45,10 @@ def start_client
     let(:version) { 3 }
   end
 
+  it_behaves_like "a WebSocket server drafts 3 and above" do
+    let(:version) { 3 }
+  end
+
   # These examples are straight from the spec
   # http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-03#section-4.6
   describe "examples from the spec" do

spec/integration/draft05_spec.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'integration/shared_examples'
 
 describe "draft05" do
   include EM::SpecHelper
@@ -21,12 +20,6 @@
       }
     }
   end
-  
-  def start_server
-    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws if block_given?
-    }
-  end
 
   def start_client
     client = EM.connect('0.0.0.0', 12345, Draft05FakeWebSocketClient)
@@ -39,6 +32,10 @@ def start_client
     let(:version) { 5 }
   end
 
+  it_behaves_like "a WebSocket server drafts 3 and above" do
+    let(:version) { 5 }
+  end
+
   it "should report that close codes are not supported" do
     em {
       start_server { |ws|

spec/integration/draft06_spec.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'integration/shared_examples'
 
 describe "draft06" do
   include EM::SpecHelper
@@ -30,12 +29,6 @@
       }
     }
   end
-  
-  def start_server
-    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws if block_given?
-    }
-  end
 
   def start_client
     client = EM.connect('0.0.0.0', 12345, Draft05FakeWebSocketClient)
@@ -48,6 +41,10 @@ def start_client
     let(:version) { 6 }
   end
 
+  it_behaves_like "a WebSocket server drafts 3 and above" do
+    let(:version) { 6 }
+  end
+
   it "should open connection" do
     em {
       start_server { |server|

spec/integration/draft13_spec.rb

@@ -1,7 +1,6 @@
 # encoding: BINARY
 
 require 'helper'
-require 'integration/shared_examples'
 
 describe "draft13" do
   include EM::SpecHelper
@@ -33,12 +32,6 @@
     }
   end
 
-  def start_server
-    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws if block_given?
-    }
-  end
-
   def start_client
     client = EM.connect('0.0.0.0', 12345, Draft07FakeWebSocketClient)
     client.send_data(format_request(@request))
@@ -50,6 +43,10 @@ def start_client
     let(:version) { 13 }
   end
 
+  it_behaves_like "a WebSocket server drafts 3 and above" do
+    let(:version) { 13 }
+  end
+
   it "should send back the correct handshake response" do
     em {
       start_server

spec/integration/draft75_spec.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'integration/shared_examples'
 
 # These integration tests are older and use a different testing style to the 
 # integration tests for newer drafts. They use EM::HttpRequest which happens 
@@ -9,12 +8,6 @@
   include EM::SpecHelper
   default_timeout 1
 
-  def start_server
-    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws if block_given?
-    }
-  end
-
   def start_client
     client = Draft75WebSocketClient.new
     yield client if block_given?

spec/integration/draft76_spec.rb

@@ -1,7 +1,6 @@
 # encoding: BINARY
 
 require 'helper'
-require 'integration/shared_examples'
 
 describe "WebSocket server draft76" do
   include EM::SpecHelper
@@ -35,12 +34,6 @@
       :body => "8jKS\'y:G*Co,Wxa-"
     }
   end
-  
-  def start_server
-    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws if block_given?
-    }
-  end
 
   def start_client
     client = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)

spec/integration/gte_03_examples.rb

@@ -0,0 +1,42 @@
+shared_examples_for "a WebSocket server drafts 3 and above" do
+  it "should force close connections after a timeout if close handshake is not sent by the client" do
+    em {
+      server_onerror_fired = false
+      server_onclose_fired = false
+      client_got_close_handshake = false
+      
+      start_server(:close_timeout => 0.1) { |ws|
+        ws.onopen {
+          # 1: Send close handshake to client
+          EM.next_tick { ws.close(4999, "Close message") }
+        }
+        
+        ws.onerror { |e|
+          # 3: Client should receive onerror
+          e.class.should == EM::WebSocket::WSProtocolError
+          e.message.should == "Close handshake un-acked after 0.1s, closing tcp connection"
+          server_onerror_fired = true
+        }
+        
+        ws.onclose {
+          server_onclose_fired = true
+        }
+      }
+      start_client { |client|
+        client.onmessage { |msg|
+          # 2: Client does not respond to close handshake (the fake client 
+          # doesn't understand them at all hence this is in onmessage)
+          msg.should =~ /Close message/ if version >= 6
+          client_got_close_handshake = true
+        }
+        
+        client.onclose {
+          server_onerror_fired.should == true
+          server_onclose_fired.should == true
+          client_got_close_handshake.should == true
+          done
+        }
+      }
+    }
+  end
+end