cucumber-pro 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ee55b4be0adcf54b3d932966fd38e9d90792584
-  data.tar.gz: 2119b85e2b613e454dac33f9e9e581df13e487d9
+  metadata.gz: c90f1ff93aa0791fcc5726992f81678704506523
+  data.tar.gz: 4db71bb9349a648e404e787a4f808af24764b9c1
 SHA512:
-  metadata.gz: 57951a1256a93d2e272503aa7f1765eddae8db60ef473274331688c919d9657c18853c22d3de5fd5cd470796194032adf20396e47f0e8beac772c93772664e6b
-  data.tar.gz: 7c943932f07f9a00237bdb5ff9027cf0825a35ac774e4c9d7c4f3fca31381b98d11b746b32ac29d0155e4d18097cb33b96eaab709f25ccee09f85c9be1637ab3
+  metadata.gz: 52b7ef6e162dc95d32a8b48b8e3b2d67c82da83a48da92667b926d8478d9db2588a4d609e71c1f6b8f74fc3cda3de582141ed8d42882df329f0fd4b38ae10065
+  data.tar.gz: 66d5412d15be33487e3a4cd163d70d1f9c2666dfda7074e1fac89dc86113d5d4f8d8bea66c3868b665ab24cb1eda6eb3a4b5dc6bf4fcdfe1834e0e8df249c610

data/TODO.md

@@ -1,4 +1,9 @@
 - Scenario for when the token is invalid
-- Gemspec etc
-- Better (more unique) run ID
+- 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
 

data/cucumber-pro.gemspec

@@ -1,10 +1,9 @@
 # -*- encoding: utf-8 -*-
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "cucumber/pro/version"
 
 Gem::Specification.new do |s|
   s.name        = 'cucumber-pro'
-  s.version     = Cucumber::Pro::Version
+  s.version     = File.read(File.expand_path("../lib/cucumber/pro/version", __FILE__))
   s.authors     = ["Matt Wynne"]
   s.description = "Client library for publishing results to the Cucumber Pro service"
   s.summary     = "cucumber-pro-#{s.version}"
@@ -14,8 +13,7 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.required_ruby_version = ">= 1.9.3"
 
-  s.add_dependency 'grit'
-  s.add_dependency 'faye-websocket'
+  s.add_dependency 'faye-websocket', '~> 0.7'
 
   s.add_development_dependency 'bundler', '>= 1.3.5'
   s.add_development_dependency 'rake',    '>= 0.9.2'

data/features/publish_results.feature

@@ -1,6 +1,11 @@
 @announce
 Feature: Publish results
 
+  Background:
+    Given I set the environment variables to:
+      | variable           | value       |
+      | CUCUMBER_PRO_TOKEN | valid-token |
+
   Scenario: A couple of scenarios
     Given a git repo
     And a feature "features/test.feature" with:
@@ -22,6 +27,7 @@ Feature: Publish results
       | status | path                  | location |
       | passed | features/test.feature | 2        |
       | failed | features/test.feature | 5        |
+    And the stderr should not contain anything
 
   Scenario: A scenario outline
 

data/features/security.feature

@@ -0,0 +1,27 @@
+@announce
+Feature: Security
+
+  Scenario: Bad access token
+    Given a git repo
+    And a feature "features/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given passing
+      """
+    When I set the environment variables to:
+      | variable           | value         |
+      | CUCUMBER_PRO_TOKEN | invalid-token |
+    And I run `cucumber -f Cucumber::Pro -o /dev/null -f pretty`
+    And the stderr should contain "Access denied"
+
+  Scenario: No access token
+    Given a git repo
+    And a feature "features/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given passing
+      """
+    When I run `cucumber -f Cucumber::Pro -o /dev/null -f pretty`
+    And the stderr should contain "Missing access token"

data/features/step_definitions/steps.rb

@@ -11,6 +11,8 @@ end
 
 Given(/^a git repo$/) 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 remote add origin #{repo_url}"
   run_simple "git config --get remote.origin.url"

data/features/support/fake_results_service.rb

@@ -3,7 +3,7 @@ require 'json'
 
 module FakeResultsService
   PORT = 5000
-  VALID_TOKEN = 'valid-cucumber-pro-token'
+  VALID_TOKEN = 'valid-token'
 
   class << self
     def messages
@@ -91,7 +91,6 @@ else
 require 'cucumber/pro'
 Cucumber::Pro.configure do |c|
   c.url = 'ws://localhost:#{FakeResultsService::PORT}'
-  c.token = "#{FakeResultsService::VALID_TOKEN}"
 end
     END
   end

data/lib/cucumber/pro.rb

@@ -1,13 +1,13 @@
 require 'logger'
 require 'cucumber/pro/formatter'
 require 'cucumber/pro/web_socket_session'
+require 'cucumber/pro/version'
 
 module Cucumber
   module Pro
 
     class << self
       def new(*)
-        url = config.url + "?token=#{config.token}"
         session = WebSocketSession.new(url, config.logger)
         Formatter.new(session)
       end
@@ -21,6 +21,11 @@ module Cucumber
       def config
         @config ||= Config.new
       end
+
+      def url
+        token = config.token || raise(Error::MissingToken.new)
+        config.url + "?token=#{token}"
+      end
     end
 
     class Config
@@ -34,6 +39,20 @@ module Cucumber
       config.token  = ENV['CUCUMBER_PRO_TOKEN']
     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/scm.rb

@@ -3,7 +3,6 @@ module Cucumber
 
     module Scm
 
-      require 'grit'
       class Repo
 
         NoGitRepoFound = Class.new(StandardError)
@@ -18,19 +17,25 @@ module Cucumber
         end
 
         def initialize(path)
-          @repo = Grit::Repo.new(path)
+          @path = path
         end
 
         def remote
-          @repo.config['remote.origin.url']
+          cmd('git config --get remote.origin.url')
         end
 
         def branch
-          @repo.head.name
+          cmd("git branch --contains #{rev}")
         end
 
         def rev
-          @repo.head.commit.id
+          cmd("git rev-parse HEAD")
+        end
+
+        private
+
+        def cmd(cmd)
+          Dir.chdir(@path) { `#{cmd}` }.strip
         end
       end
     end

data/lib/cucumber/pro/version

@@ -0,0 +1 @@
+0.0.4

data/lib/cucumber/pro/web_socket_session.rb

@@ -4,106 +4,118 @@ require 'eventmachine'
 
 module Cucumber
   module Pro
-    module Error
-      AccessDenied = Class.new(StandardError) {
-        def initialize
-          super "Access denied."
-        end
-      }
-    end
-
     class WebSocketSession
 
-
-      class SendMessage
-        def initialize(data)
-          @data = data
-        end
-
-        def send_to(ws)
-          ws.send(@data.to_json)
-        end
-      end
-
-      class Close
-        def send_to(ws)
-          ws.close
-        end
-      end
-
       def initialize(url, logger)
         @url, @logger = url, logger
         @queue = Queue.new
-        start
+        @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(SendMessage.new(message))
+        queue.push -> { socket.send(message.to_json) }
+        self
       end
 
       def close
         logger.debug [:session, :close]
-        queue.push(Close.new)
-        @em.join
-        if @ws_error
-          puts "Cucumber Pro failed to send results: #{@ws_error}"
-        end
+        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
+      attr_reader :logger, :queue, :socket
 
-      def start
-        @em = Thread.new do
-          begin
-            EM.run { start_ws_client }
-          rescue => exception
-            logger.fatal exception
-            @ws_error = exception
-          end
+      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
-      end
 
-      def start_ws_client
-        logger.debug [:ws, :start]
-        ws = Faye::WebSocket::Client.new(@url)
+        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
 
-        ws.on(:open) do
+        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_queue(ws)
+          process_tasks
+          self
         end
 
-        ws.on(:error) do
+        def on_error(event)
           logger.error [:ws, :error]
+          self
         end
 
-        ws.on(:message) do |event|
+        def on_message(event)
           logger.debug [:ws, :message, event.data]
+          self
         end
 
-        ws.on(:close) do |event|
+        def on_close(event)
           logger.debug [:ws, :close]
-          @ws_error = Error::AccessDenied.new
-          ws = nil
+          if access_denied?(event)
+            raise Error::AccessDenied.new 
+          end
+          @ws = nil
           EM.stop_event_loop
+          self
         end
-        self
-      end
 
-      def process_queue(ws)
-        process_next_message(ws)
-        EM.next_tick do
-          process_queue(ws)
+        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
 
-      def process_next_message(ws)
-        return if queue.empty?
-        message = queue.pop
-        message.send_to(ws)
-        logger.debug [:ws, :send, message]
       end
 
     end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-pro
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Matt Wynne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-05-18 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: grit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +149,7 @@ files:
 - TODO.md
 - cucumber-pro.gemspec
 - features/publish_results.feature
+- features/security.feature
 - features/step_definitions/steps.rb
 - features/support/aruba.rb
 - features/support/env.rb
@@ -171,8 +158,10 @@ files:
 - lib/cucumber/pro.rb
 - lib/cucumber/pro/formatter.rb
 - lib/cucumber/pro/scm.rb
+- lib/cucumber/pro/version
 - lib/cucumber/pro/version.rb
 - lib/cucumber/pro/web_socket_session.rb
+- tmp/.gitkeep
 homepage: https://cucumber.pro
 licenses:
 - MIT
@@ -197,9 +186,10 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: cucumber-pro-0.0.2
+summary: cucumber-pro-0.0.4
 test_files:
 - features/publish_results.feature
+- features/security.feature
 - features/step_definitions/steps.rb
 - features/support/aruba.rb
 - features/support/env.rb