cucumber-pro 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aba26207747344dda383814db4114cb91cee6d20
-  data.tar.gz: f809da648aed73a7eca530eb31391c02343b00e4
+  metadata.gz: 4c1ea22ade2589bfaba0ea2b8b452133995630c9
+  data.tar.gz: 31a0837902dfacd353adf063083d2a5c6d9d1681
 SHA512:
-  metadata.gz: f246995c5281209a5cd2340ab3a3f3fec7cbfbc1f79cdd9d3f80769cf186e782d3677c9b360401a7d92f8a1648dab7ae1a96c6e4bb691895fadf5971b7972523
-  data.tar.gz: 349ae812ab5017bb077a5f378370498323b7a68119bb7349025a5a4009770277f131039c8b93a645dd5e56e75521221138e467e0c4d6b2e542454d54eab05d7e
+  metadata.gz: 3ba8796ca612b363c444fb9308687d6dfdcc66e0620eb2d197e9461dacec93bb019cb2a5d13d9621d62753ac70113bc09b66183a02d528d4bc71e22c02b2a401
+  data.tar.gz: 4f3a0bf99cdd27ac75142da244443a1f5378b03e36cf66be3a2fed14db919d82d4fa5110635600b2a85d749bd0c79a74f8db810fd3503cd8b863dfcf7d197149

data/Rakefile

@@ -25,7 +25,7 @@ desc 'Run repeated tests to check for async bugs'
 task :soak, :repetitions do |task, args|
   reps = args[:repetitions] || 10
   results = reps.to_i.times.map do
-    `cucumber`
+    `rspec > tmp/test.log`
     print $? == 0 ? '.' : 'x'
     $?
   end

data/TODO.md

@@ -1,7 +1,7 @@
 - Unit tests for Messaging
   - Handle cases where some messages sent are not ack'd with a timeout
   - Handle cases where some messages sent come back with an error
-  - e.g. upgrade your client error
+    - e.g. upgrade your client error
 - Allow configuration of git remote
 - Build against Cucumber 2.0 and 1.3.x
 - SVN support

data/lib/cucumber/pro.rb

@@ -1,6 +1,7 @@
 require 'logger'
 require 'cucumber/pro/formatter'
 require 'cucumber/pro/web_socket/session'
+require 'cucumber/pro/errors'
 
 module Cucumber
   module Pro
@@ -8,7 +9,7 @@ module Cucumber
     class << self
       def new(runtime, output, options)
         create_logger(output)
-        session = WebSocket::Session.new(url, logger)
+        session = WebSocket::Session.new(url, logger, timeout: config.timeout)
         Formatter.new(session)
       end
 
@@ -41,31 +42,18 @@ module Cucumber
     end
 
     class Config
-      attr_accessor :url, :logger, :token
+      attr_accessor :url, :logger, :token, :timeout
     end
 
     # Default config
     configure do |config|
-      config.url    = ENV['CUCUMBER_PRO_URL'] || 'wss://results.cucumber.pro/ws'
-      config.token  = ENV['CUCUMBER_PRO_TOKEN']
-      ENV['cucumber_pro_log_path'].tap do |path|
-        config.logger = Logger.new(path) if path
+      config.url     = ENV['CUCUMBER_PRO_URL'] || 'wss://results.cucumber.pro/ws'
+      config.token   = ENV['CUCUMBER_PRO_TOKEN']
+      config.timeout = 5
+      if file = ENV['CUCUMBER_PRO_LOG_FILE']
+        config.logger = Logger.new(file)
       end
     end
 
-    module Error
-      AccessDenied = Class.new(StandardError) {
-        def initialize
-          super "Access denied."
-        end
-      }
-
-      MissingToken = Class.new(StandardError) {
-        def initialize
-          super "Missing access token. Please visit https://app.cucumber.pro/api-token for instructions."
-        end
-      }
-    end
-
   end
 end

data/lib/cucumber/pro/errors.rb

@@ -0,0 +1,25 @@
+module Cucumber
+  module Pro
+
+    module Error
+      AccessDenied = Class.new(StandardError) {
+        def initialize
+          super "Access denied."
+        end
+      }
+
+      MissingToken = Class.new(StandardError) {
+        def initialize
+          super "Missing access token. Please visit https://app.cucumber.pro/my/profile for instructions."
+        end
+      }
+
+      Timeout = Class.new(StandardError) {
+        def initialize
+          super "Timed out waiting for a reply from the Cucumber Pro server."
+        end
+      }
+    end
+
+  end
+end

data/lib/cucumber/pro/version

@@ -1 +1 @@
-0.0.11
+0.0.12

data/lib/cucumber/pro/web_socket/session.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'faye/websocket'
 require 'eventmachine'
+require 'cucumber/pro/errors'
 
 module Cucumber
   module Pro
@@ -8,7 +9,7 @@ module Cucumber
 
       class Session
 
-        def initialize(url, logger)
+        def initialize(url, logger, options)
           @url, @logger = url, logger
           create_socket = -> worker {
             ws = Faye::WebSocket::Client.new(@url, nil, ping: 15)
@@ -19,7 +20,7 @@ module Cucumber
             ws
           }
           @queue = Queue.new
-          @socket = Worker.new(create_socket, logger, self)
+          @socket = Worker.new(create_socket, logger, self, options)
         end
 
         def send(message)
@@ -49,8 +50,9 @@ module Cucumber
 
       class Worker
 
-        def initialize(create_socket, logger, error_handler)
+        def initialize(create_socket, logger, error_handler, options = {})
           @create_socket, @logger, @error_handler = create_socket, logger, error_handler
+          @timeout = options.fetch(:timeout) { raise ArgumentError("Please specify timeout") }
           @q = Queue.new
           @em = Thread.new { start_client }
           @ack_count = 0
@@ -59,8 +61,9 @@ module Cucumber
         def close
           @q << -> {
             if @ack_count == 0
-              @ws.close
+              close_websocket
             else
+              ensure_close_timer_started
               EM.next_tick { close }
             end
           }
@@ -81,7 +84,25 @@ module Cucumber
 
         private
 
-        attr_reader :logger, :error_handler, :next_task
+        attr_reader :logger, :error_handler, :next_task, :timeout
+
+        def ensure_close_timer_started
+          return if @close_timer
+          logger.debug [:ws, :set_close_timeout, timeout]
+          @close_timer = EM.add_timer(timeout) { handle_close_timeout }
+        end
+
+        def handle_close_timeout
+          logger.debug [:ws, :handle_close_timeout]
+          return unless @ws
+          error_handler.error Error::Timeout.new
+          close_websocket
+        end
+
+        def close_websocket
+          logger.debug [:ws, :close_socket]
+          @ws.close
+        end
 
         def start_client
           EM.run do

data/spec/cucumber/pro/web_socket/worker_spec.rb

@@ -1,79 +1,103 @@
 require 'cucumber/pro/web_socket/session'
 require 'logger'
 
-module Cucumber::Pro::WebSocket
+module Cucumber::Pro
+  module WebSocket
+
+    describe Worker do
+      let(:good_data) { double('good data') }
+      let(:error_handler) { double('error handler') }
+      let(:logger) { Logger.new(ENV['CUCUMBER_PRO_LOG_PATH'] || STDOUT) }
+      let!(:socket) { SpySocket.new }
+      let(:worker) { Worker.new(self.method(:create_fake_socket), logger, error_handler, timeout: 0.5) }
+
+      before { logger.level = Logger::DEBUG }
+
+      it "closes once all messages have been acknowledged (but not before)" do
+        worker.send(good_data)
+        worker.close
+        eventually do
+          socket.data.last.should == good_data
+        end
+        eventually do
+          expect( worker ).to_not be_closed
+        end
+        socket.send_ack
+        eventually do
+          expect( worker ).to be_closed
+        end
+      end
 
-  describe Worker do
-    let(:good_data) { double('good data') }
-    let(:logger) { Logger.new(STDOUT) }
-    let(:socket) { FakeSocket.new }
-    let(:worker) { Worker.new(self.method(:create_fake_socket), logger, logger) }
+      it "throws an error and closes if all messages are not acknowledged within a timeout period" do
+        expect( error_handler ).to receive(:error).with(Error::Timeout.new)
+        worker.send(good_data)
+        worker.close
+        eventually do
+          expect( worker ).to be_closed
+        end
+      end
 
-    before { logger.level = Logger::DEBUG }
+      it "throws an error if the server responds with an error"
 
-    it "closes once all messages have been acknowledged (but not before)" do
-      worker.send(good_data)
-      worker.close
-      eventually do
-        socket.data.last.should == good_data
-      end
-      eventually do
-        expect( worker ).to_not be_closed
-      end
-      socket.send_ack
-      eventually do
-        expect( worker ).to be_closed
+      def create_fake_socket(worker)
+        socket.worker = worker
+        EM.next_tick {
+          worker.method(:on_open).call(double('ws event'))
+        }
+        socket
       end
-    end
 
-    def create_fake_socket(worker)
-      socket.worker = worker
-      EM.next_tick {
-        worker.method(:on_open).call(double('ws event'))
-      }
-      socket
-    end
 
+      class SpySocket
+        include RSpec::Mocks::ExampleMethods
 
-    class FakeSocket
-      include RSpec::Mocks::ExampleMethods
+        attr_accessor :worker
+        attr_reader :data
 
-      attr_accessor :worker
-      attr_reader :data
+        def initialize
+          @q = Queue.new
+        end
 
-      def initialize
-        @data = []
-      end
+        def close
+          worker.method(:on_close).call(ws_event(1000))
+        end
 
-      def close
-        worker.method(:on_close).call(ws_event(1000))
-      end
+        def send(data)
+          @q << data
+          self
+        end
 
-      def send(data)
-        @data << data
-      end
+        def send_ack
+          event = ws_event(1000, { 'type' => 'metadata_saved' })
+          worker.method(:on_message).call(event)
+        end
 
-      def send_ack
-        event = ws_event(1000, { 'type' => 'metadata_saved' })
-        worker.method(:on_message).call(event)
-      end
+        def data
+          @data ||= []
+          while !@q.empty?
+            @data << @q.pop
+          end
+          @data
+        end
+
+        private
 
-      private
+        def ws_event(code, data = {})
+          double('ws event', code: 1000, data: data)
+        end
 
-      def ws_event(code, data = {})
-        double('ws event', code: 1000, data: data)
       end
-    end
 
-    require 'anticipate'
-    include Anticipate
-    def eventually(&block)
-      result = nil
-      sleeping(0.1).seconds.between_tries.failing_after(30).tries do
-        result = block.call
+      require 'anticipate'
+      include Anticipate
+      def eventually(&block)
+        result = nil
+        sleeping(0.1).seconds.between_tries.failing_after(50).tries do
+          result = block.call
+        end
+        result
       end
-      result
     end
-  end
 
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-pro
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Matt Wynne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -158,6 +158,7 @@ files:
 - features/support/fake_results_service.rb
 - features/support/world.rb
 - lib/cucumber/pro.rb
+- lib/cucumber/pro/errors.rb
 - lib/cucumber/pro/formatter.rb
 - lib/cucumber/pro/info.rb
 - lib/cucumber/pro/scm/working_copy.rb
@@ -190,7 +191,7 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: cucumber-pro-0.0.11
+summary: cucumber-pro-0.0.12
 test_files:
 - features/publish_results.feature
 - features/security.feature