cucumber-pro 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c90f1ff93aa0791fcc5726992f81678704506523
-  data.tar.gz: 4db71bb9349a648e404e787a4f808af24764b9c1
+  metadata.gz: 130928ede57f9a40d1b22d0e66f3ed254d614aeb
+  data.tar.gz: 00dd538d850dee73f4d8a2caf58858845942274c
 SHA512:
-  metadata.gz: 52b7ef6e162dc95d32a8b48b8e3b2d67c82da83a48da92667b926d8478d9db2588a4d609e71c1f6b8f74fc3cda3de582141ed8d42882df329f0fd4b38ae10065
-  data.tar.gz: 66d5412d15be33487e3a4cd163d70d1f9c2666dfda7074e1fac89dc86113d5d4f8d8bea66c3868b665ab24cb1eda6eb3a4b5dc6bf4fcdfe1834e0e8df249c610
+  metadata.gz: 52da99dc9bfd36bf1369d4f0e4069258bdfc4accde72781f6b63b555d2a239faa4472567eec372c5ece35a8ffd844e9705b513aee222734da7f6a9436c942687
+  data.tar.gz: 76a252ee7416ea06cac3c42743e9ec8b848b2952c788cd85ee0e804739813e887eca56905e2c06b336c19e1809dfff5bd5bd15043ddf9e0d73fcfcea5efb2465

data/.rspec

@@ -0,0 +1 @@
+--color --order random

data/Rakefile

@@ -3,7 +3,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 desc 'Run tests'
-task default: :cucumber
+task default: [:rspec, :cucumber]
 
 ENV['cucumber_pro_log_path'] = File.dirname(__FILE__) + '/tmp/test.log'
 
@@ -11,6 +11,10 @@ task :cucumber do
   sh 'cucumber'
 end
 
+task :rspec do
+  sh 'rspec'
+end
+
 desc 'Run repeated tests to check for async bugs'
 task :soak, :repetitions do |task, args|
   reps = args[:repetitions] || 10

data/TODO.md

@@ -1,9 +1,5 @@
-- Scenario for when the token is invalid
-- Scenario for when branch is invalid
-  - Branch has a * in it
-- Better (more unique) run ID - use a UUID
-- Log to Cucumber's IO instead of STDOUT by default
 - Unit tests for Messaging
   - Handle cases where some messages sent are not ack'd
   - Handle cases where some messages sent come back with an error
+- Allow configuration of remote
 

data/lib/cucumber/pro.rb

@@ -1,14 +1,14 @@
 require 'logger'
 require 'cucumber/pro/formatter'
-require 'cucumber/pro/web_socket_session'
+require 'cucumber/pro/web_socket/session'
 require 'cucumber/pro/version'
 
 module Cucumber
   module Pro
 
     class << self
-      def new(*)
-        session = WebSocketSession.new(url, config.logger)
+      def new(runtime, output, options)
+        session = WebSocket::Session.new(url, logger(output))
         Formatter.new(session)
       end
 
@@ -26,6 +26,10 @@ module Cucumber
         token = config.token || raise(Error::MissingToken.new)
         config.url + "?token=#{token}"
       end
+
+      def logger(output)
+        config.logger || Logger.new(output)
+      end
     end
 
     class Config
@@ -35,7 +39,6 @@ module Cucumber
     # Default config
     configure do |config|
       config.url    = 'wss://results.cucumber.pro/ws'
-      config.logger = Logger.new(ENV['cucumber_pro_log_path'] || STDOUT)
       config.token  = ENV['CUCUMBER_PRO_TOKEN']
     end
 

data/lib/cucumber/pro/formatter.rb

@@ -1,4 +1,5 @@
 require 'cucumber/pro/scm'
+require 'securerandom'
 
 module Cucumber
   module Pro
@@ -79,7 +80,7 @@ module Cucumber
       end
 
       def get_run_id
-        Time.now.to_i
+        SecureRandom.hex 
       end
 
     end

data/lib/cucumber/pro/scm.rb

@@ -9,33 +9,40 @@ module Cucumber
 
         def self.find(path = Dir.pwd)
           if Dir.entries(path).include? '.git'
-            new(path)
+            GitRepo.new(path)
           else
             raise NoGitRepoFound if path == '/'
             find File.expand_path(path + '/..')
           end
         end
 
+      end
+
+      class GitRepo
+
         def initialize(path)
           @path = path
         end
 
         def remote
-          cmd('git config --get remote.origin.url')
+          cmd('git config --get remote.origin.url').last
         end
 
         def branch
-          cmd("git branch --contains #{rev}")
+          branch = cmd("git branch --contains #{rev}").
+            reject { |b| /^\* \(detached from \w+\)/.match b }.
+            first.
+            gsub(/^\* /, '')
         end
 
         def rev
-          cmd("git rev-parse HEAD")
+          cmd("git rev-parse HEAD").last
         end
 
         private
 
         def cmd(cmd)
-          Dir.chdir(@path) { `#{cmd}` }.strip
+          Dir.chdir(@path) { `#{cmd}` }.lines.map &:strip
         end
       end
     end

data/lib/cucumber/pro/version

@@ -1 +1 @@
-0.0.4
+0.0.6

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

@@ -0,0 +1,139 @@
+require 'json'
+require 'faye/websocket'
+require 'eventmachine'
+
+module Cucumber
+  module Pro
+    module WebSocket
+
+      class Session
+
+        def initialize(url, logger)
+          @url, @logger = url, logger
+          create_socket = -> worker {
+            ws = Faye::WebSocket::Client.new(@url)
+            ws.on :open,    &worker.method(:on_open)
+            ws.on :error,   &worker.method(:on_error)
+            ws.on :message, &worker.method(:on_message)
+            ws.on :close,   &worker.method(:on_close)
+            ws
+          }
+          @queue = Queue.new
+          @socket = Worker.new(create_socket, logger, self)
+        end
+
+        def send(message)
+          logger.debug [:session, :send, message]
+          socket.send(message.to_json)
+          self
+        end
+
+        def close
+          logger.debug [:session, :close]
+          socket.close
+          loop until socket.closed?
+          self
+        end
+
+        def error(exception)
+          logger.fatal exception
+          $stderr.puts "Cucumber Pro failed to send results: #{exception}"
+          $stderr.puts exception.backtrace.join("\n")
+          self
+        end
+
+        private
+
+        attr_reader :logger, :queue, :socket
+      end
+
+      class Worker
+
+        def initialize(create_socket, logger, error_handler)
+          @create_socket, @logger, @error_handler = create_socket, logger, error_handler
+          @q = Queue.new
+          @em = Thread.new { start_client }
+          @ack_count = 0
+        end
+
+        def close
+          @q << -> {
+            if @ack_count == 0
+              @ws.close
+            else
+              EM.next_tick { close }
+            end
+          }
+          self
+        end
+
+        def send(data)
+          @q << -> {
+            @ws.send data
+            @ack_count += 1
+          }
+          self
+        end
+
+        def closed?
+          !@em.alive?
+        end
+
+        private
+
+        attr_reader :logger, :error_handler, :next_task
+
+        def start_client
+          EM.run do
+            logger.debug [:ws, :start]
+            @ws = @create_socket.call(self)
+          end
+          self
+        rescue => exception
+          error_handler.error exception
+        end
+
+        def on_open(event)
+          logger.debug [:ws, :open]
+          process_tasks
+          self
+        end
+
+        def on_error(event)
+          logger.error [:ws, :error]
+          self
+        end
+
+        def on_message(event)
+          logger.debug [:ws, :message, event.data]
+          @ack_count -= 1
+          self
+        end
+
+        def on_close(event)
+          logger.debug [:ws, :close]
+          if access_denied?(event)
+            raise Error::AccessDenied.new 
+          end
+          @ws = nil
+          EM.stop_event_loop
+          self
+        end
+
+        def process_tasks
+          @q.pop.call if !@q.empty?
+          EM.next_tick { process_tasks }
+          self
+        end
+
+        def access_denied?(event)
+          event.code == 1002 && 
+            event.reason == \
+            "Error during WebSocket handshake: Unexpected response code: 401"
+        end
+
+      end
+
+    end
+  end
+end

data/spec/cucumber/pro/scm/git_repo_spec.rb

@@ -0,0 +1,40 @@
+require 'cucumber/pro/scm'
+require 'aruba/api'
+
+module Cucumber
+  module Pro
+    module Scm
+      describe GitRepo do
+        include Aruba::Api
+        before do
+          clean_current_dir
+        end
+
+        it "figures out the name of the branch, even on CI" do
+          in_current_dir do
+            run_simple "git init"
+            run_simple "git config user.email \"test@test.com\""
+            run_simple "git config user.name \"Test user\""
+            run_simple "git commit --allow-empty -m 'Initial commit'"
+            run_simple "git rev-parse HEAD"
+            rev = all_stdout.split("\n").last
+            run_simple "git checkout #{rev}"
+            repo = Repo.find(current_dir)
+            expect( repo.branch ).to eq "master"
+          end
+        end
+
+        it "figures out the name of the branch when that's what's checked out" do
+          in_current_dir do
+            run_simple "git init"
+            run_simple "git config user.email \"test@test.com\""
+            run_simple "git config user.name \"Test user\""
+            run_simple "git commit --allow-empty -m 'Initial commit'"
+            repo = Repo.find(current_dir)
+            expect( repo.branch ).to eq "master"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+require 'cucumber/pro/web_socket/session'
+require 'logger'
+
+module Cucumber::Pro::WebSocket
+
+  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) }
+
+    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
+
+    def create_fake_socket(worker)
+      socket.worker = worker
+      EM.next_tick {
+        worker.method(:on_open).call(double('ws event'))
+      }
+      socket
+    end
+
+
+    class FakeSocket
+      include RSpec::Mocks::ExampleMethods
+
+      attr_accessor :worker
+      attr_reader :data
+
+      def initialize
+        @data = []
+      end
+
+      def close
+        worker.method(:on_close).call(ws_event(1000))
+      end
+
+      def send(data)
+        @data << data
+      end
+
+      def send_ack
+        event = ws_event(1000, { 'type' => 'metadata_saved' })
+        worker.method(:on_message).call(event)
+      end
+
+      private
+
+      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
+      end
+      result
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-pro
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Matt Wynne
@@ -142,6 +142,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
@@ -160,7 +161,9 @@ files:
 - lib/cucumber/pro/scm.rb
 - lib/cucumber/pro/version
 - lib/cucumber/pro/version.rb
-- lib/cucumber/pro/web_socket_session.rb
+- lib/cucumber/pro/web_socket/session.rb
+- spec/cucumber/pro/scm/git_repo_spec.rb
+- spec/cucumber/pro/web_socket/worker_spec.rb
 - tmp/.gitkeep
 homepage: https://cucumber.pro
 licenses:
@@ -186,7 +189,7 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: cucumber-pro-0.0.4
+summary: cucumber-pro-0.0.6
 test_files:
 - features/publish_results.feature
 - features/security.feature
@@ -195,4 +198,6 @@ test_files:
 - features/support/env.rb
 - features/support/fake_results_service.rb
 - features/support/world.rb
+- spec/cucumber/pro/scm/git_repo_spec.rb
+- spec/cucumber/pro/web_socket/worker_spec.rb
 has_rdoc: 

data/lib/cucumber/pro/web_socket_session.rb

@@ -1,123 +0,0 @@
-require 'json'
-require 'faye/websocket'
-require 'eventmachine'
-
-module Cucumber
-  module Pro
-    class WebSocketSession
-
-      def initialize(url, logger)
-        @url, @logger = url, logger
-        @queue = Queue.new
-        @socket = SocketWorker.new(url, logger, self) do
-          queue.pop.call if !queue.empty?
-        end
-      end
-
-      def send(message)
-        logger.debug [:session, :send, message]
-        queue.push -> { socket.send(message.to_json) }
-        self
-      end
-
-      def close
-        logger.debug [:session, :close]
-        queue.push -> { socket.close }
-        loop until socket.closed?
-        self
-      end
-
-      def error(exception)
-        logger.fatal exception
-        $stderr.puts "Cucumber Pro failed to send results: #{exception}"
-        $stderr.puts exception.backtrace.join("\n")
-        self
-      end
-
-      private
-
-      attr_reader :logger, :queue, :socket
-
-      class SocketWorker
-
-        def initialize(url, logger, error_handler, &next_task)
-          @url, @logger, @error_handler = url, logger, error_handler
-          @next_task = next_task
-          @em = Thread.new { start_client }
-        end
-
-        def close
-          @ws.close
-          self
-        end
-
-        def send(data)
-          @ws.send data
-          self
-        end
-
-        def closed?
-          !@em.alive?
-        end
-
-        private
-
-        attr_reader :logger, :error_handler, :next_task
-
-        def start_client
-          EM.run do
-            logger.debug [:ws, :start]
-            @ws = Faye::WebSocket::Client.new(@url)
-            @ws.on :open,    &self.method(:on_open)
-            @ws.on :error,   &self.method(:on_error)
-            @ws.on :message, &self.method(:on_message)
-            @ws.on :close,   &self.method(:on_close)
-          end
-          self
-        rescue => exception
-          error_handler.error exception
-        end
-
-        def on_open(event)
-          logger.debug [:ws, :open]
-          process_tasks
-          self
-        end
-
-        def on_error(event)
-          logger.error [:ws, :error]
-          self
-        end
-
-        def on_message(event)
-          logger.debug [:ws, :message, event.data]
-          self
-        end
-
-        def on_close(event)
-          logger.debug [:ws, :close]
-          if access_denied?(event)
-            raise Error::AccessDenied.new 
-          end
-          @ws = nil
-          EM.stop_event_loop
-          self
-        end
-
-        def process_tasks
-          next_task.call
-          EM.next_tick { process_tasks }
-          self
-        end
-
-        def access_denied?(event)
-          event.code == 1002 && 
-            event.reason == \
-            "Error during WebSocket handshake: Unexpected response code: 401"
-        end
-
-      end
-
-    end
-  end
-end