cucumber-pro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 360d700355a6242a32b3bc1158413bb28631b78f
+  data.tar.gz: 62714230f4f2b5705019573dc6e1e6c0a73efd01
+SHA512:
+  metadata.gz: e774893274297e0d247c25ef63d2781c9f30be102feb663a96c9591f923ce52f11228944b5957f8bbd82dae382c710d42a6b95be8c114f2ad9fb8170d787f117
+  data.tar.gz: dcad02c537dba40d9ebce9f6c5b1238896bc7f1a36edf656573abd87511f8d997f3f65d541c2a06dcb7220215f358b76a474e4c204a92eaab0e1418821971a12

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2013 Cucumber Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# Cucumber Pro Client Gem
+
+This gem provides a formatter for Cucumber that publishes results to 
+the [Cucumber Pro](https://cucumber.pro) web service.
+
+## Usage
+
+Add the following line to your gemfile:
+
+```
+gem 'cucumber-pro'
+```
+
+Now run Cucumber using the `Cucumber::Pro` formatter:
+
+```
+CUCUMBER_PRO_TOKEN=<your auth token> cucumber -f Cucumber::Pro -f pretty
+```
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Run tests'
+task default: :cucumber
+
+ENV['cucumber_pro_log_path'] = File.dirname(__FILE__) + '/tmp/test.log'
+
+task :cucumber do
+  sh 'cucumber'
+end
+
+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`
+    print $? == 0 ? '.' : 'x'
+    $?
+  end
+  num_failed = results.count { |r| r != 0 }
+  fail "#{num_failed}/#{reps} failed" if num_failed > 0
+end

data/TODO.md

@@ -0,0 +1,4 @@
+- Scenario for when the token is invalid
+- Gemspec etc
+- Better (more unique) run ID
+

data/cucumber-pro.gemspec

@@ -0,0 +1,34 @@
+# -*- 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.authors     = ["Matt Wynne"]
+  s.description = "Client library for publishing results to the Cucumber Pro service"
+  s.summary     = "cucumber-pro-#{s.version}"
+  s.email       = "hello@cucumber.pro"
+  s.homepage    = "https://cucumber.pro"
+  s.platform    = Gem::Platform::RUBY
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 1.9.3"
+
+  s.add_dependency 'grit'
+  s.add_dependency 'faye-websocket'
+
+  s.add_development_dependency 'bundler', '>= 1.3.5'
+  s.add_development_dependency 'rake',    '>= 0.9.2'
+  s.add_development_dependency 'rspec',   '>= 2.14.1'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'thin'
+  s.add_development_dependency 'rack'
+  s.add_development_dependency 'anticipate'
+
+  s.rubygems_version = ">= 1.6.1"
+  s.files            = `git ls-files`.split("\n").reject {|path| path =~ /\.gitignore$/ }
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+end

data/features/publish_results.feature

@@ -0,0 +1,49 @@
+@announce
+Feature: Publish results
+
+  Scenario: A couple of scenarios
+    Given a git repo
+    And a feature "features/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given passing
+
+        Scenario:
+          Given failing
+      """
+    When I run `cucumber -f Cucumber::Pro -o /dev/null -f pretty`
+    Then the results service should receive a header
+    And the results service should receive these test-step results:
+      | status | path                  | location |
+      | passed | features/test.feature | 3        |
+      | failed | features/test.feature | 6        |
+    And the results service should receive these test-case results:
+      | status | path                  | location |
+      | passed | features/test.feature | 2        |
+      | failed | features/test.feature | 5        |
+
+  Scenario: A scenario outline
+
+    Note that we don't specify how step results will be published. This is because it's hard to get
+    a location for steps when a scenario outline executes.
+
+    Given a git repo
+    And a feature "features/test.feature" with:
+      """
+      Feature:
+        Scenario Outline:
+          Given <result>
+
+          Examples:
+          | result  |
+          | passing |
+          | failing |
+      """
+    When I run `cucumber -f Cucumber::Pro -o /dev/null -f pretty`
+    Then the results service should receive a header
+    And the results service should receive these test-case results:
+      | status | path                  | location |
+      | passed | features/test.feature | 7        |
+      | failed | features/test.feature | 8        |
+

data/features/step_definitions/steps.rb

@@ -0,0 +1,53 @@
+Before do
+  write_file 'features/step_definitions/steps.rb', <<-END
+Given(/pass/) { }
+Given(/fail/) { fail }
+  END
+end
+
+After do
+  terminate_processes!
+end
+
+Given(/^a git repo$/) do
+  run_simple "git init"
+  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"
+end
+
+Given(/^a feature "(.*?)" with:$/) do |path, content|
+  write_file path, content
+end
+
+Then(/^the results service should receive a header$/) do
+  eventually do
+    results_service.messages.length.should > 0
+  end
+  results_service.messages.first['repo_url'].should == repo_url
+end
+
+Then(/^the results service should receive these ([\w\-]+) results:$/) do |type, results|
+  expected_results = results.hashes
+  actual_results = eventually {
+    results = results_service.messages.select { |msg| msg['mime_type'] =~ /#{type}/ }
+    expect( results.length ).to eq expected_results.length
+    results
+  }
+  expected_statuses = expected_results.map { |result| [result['status'], result['path'], result['location'].to_i ] }
+  actual_statuses = actual_results.map { |result| [result['body']['status'], result['path'], result['location']] }
+  expect( actual_statuses ).to eq expected_statuses
+end
+
+require 'anticipate'
+module Eventually
+  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
+World(Eventually)

data/features/support/aruba.rb

@@ -0,0 +1,11 @@
+require 'aruba/cucumber'
+
+Before do
+  # ensure Cucumber's Ruby process can require the plugin as though it were a gem
+  path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+  set_env 'RUBYLIB', path
+end
+
+Before do
+  @aruba_timeout_seconds = 5
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+$logger = Logger.new(ENV['cucumber_pro_log_path'] || STDOUT)
+$logger.debug '--- starting tests ---'

data/features/support/fake_results_service.rb

@@ -0,0 +1,98 @@
+require 'faye/websocket'
+require 'json'
+
+module FakeResultsService
+  PORT = 5000
+  VALID_TOKEN = 'valid-cucumber-pro-token'
+
+  class << self
+    def messages
+      @messages ||= []
+    end
+
+    def reset
+      @messages = nil
+    end
+
+    def logger
+      $logger
+    end
+  end
+
+  logger = self.logger
+
+  SocketApp = lambda do |env|
+    logger.debug [:server, :starting]
+    ws = Faye::WebSocket.new(env)
+
+    ws.on :open do |event|
+      logger.debug [:server, :open]
+    end
+
+    ws.on :message do |event|
+      logger.debug [:server, :message, event.data]
+      FakeResultsService.messages << JSON.parse(event.data)
+      ws.send 'ok'
+    end
+
+    ws.on :close do |event|
+      logger.debug [:server, :close]
+    end
+
+    # Return async Rack response
+    ws.rack_response
+  end
+
+  class Security
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      params = request.params
+      return [401, [], {}] unless params['token'] == VALID_TOKEN
+      @app.call(env)
+    end
+  end
+
+  require 'thin'
+  require 'rack'
+  require 'eventmachine'
+  Faye::WebSocket.load_adapter 'thin'
+  Thin::Logging.logger = logger
+  $em = Thread.new do
+    begin
+      EM.run do
+        thin = Rack::Handler.get('thin')
+        app = Security.new(SocketApp)
+        thin.run app, :Port => PORT
+        trap("INT") { exit }
+      end
+    rescue => exception
+      logger.fatal(exception)
+      $stderr.puts exception, exception.backtrace
+      exit 1
+    end
+  end
+
+  loop until EM.reactor_running?
+end
+
+if !respond_to?(:Before)
+  # Standalone (manual test) mode
+  $em.join
+else
+  # Cucumber mode
+  Before { FakeResultsService.reset }
+  After { FakeResultsService.logger.debug [:server, :messages, FakeResultsService.messages] }
+  Before do
+    write_file 'features/step_definitions/cucumber_pro.rb', <<-END
+require 'cucumber/pro'
+Cucumber::Pro.configure do |c|
+  c.url = 'ws://localhost:#{FakeResultsService::PORT}'
+  c.token = "#{FakeResultsService::VALID_TOKEN}"
+end
+    END
+  end
+end

data/features/support/world.rb

@@ -0,0 +1,9 @@
+World Module.new {
+  def repo_url
+    "git@github.com:cucumber-ltd/cucumber-pro-test"
+  end
+
+  def results_service
+    FakeResultsService
+  end
+}

data/lib/cucumber/pro.rb

@@ -0,0 +1,40 @@
+require 'logger'
+require 'cucumber/pro/formatter'
+require 'cucumber/pro/web_socket_session'
+
+module Cucumber
+  module Pro
+
+    class << self
+      def new(*)
+        url = config.url + "?token=#{config.token}"
+        session = WebSocketSession.new(url, config.logger)
+        Formatter.new(session)
+      end
+
+      def configure
+        yield config
+      end
+
+      private
+
+      def config
+        @config ||= Config.new
+      end
+    end
+
+    class Config
+      attr_accessor :url, :logger, :token
+    end
+
+    # Default config
+    configure do |config|
+      config.url    = 'ws://metarepo.cucumber.pro/ws'
+      config.logger = Logger.new(ENV['cucumber_pro_log_path'] || STDOUT)
+      config.token  = ENV['CUCUMBER_PRO_TOKEN']
+    end
+
+  end
+end
+
+

data/lib/cucumber/pro/formatter.rb

@@ -0,0 +1,88 @@
+require 'cucumber/pro/scm'
+
+module Cucumber
+  module Pro
+
+    class Formatter
+      def initialize(session)
+        @session = session
+        send_header
+      end
+
+      def before_feature(feature)
+        @path = feature.file # we need this because table_row doens't have a file_colon_line
+      end
+
+      def before_step_result(*args)
+        keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line = *args
+        path, line = *file_colon_line.split(':')
+        send_step_result(path, line, status)
+      end
+
+      def after_feature_element(feature_element)
+        return if Cucumber::Ast::ScenarioOutline === feature_element
+        scenario = feature_element
+        path, line = *scenario.file_colon_line.split(':')
+        send_test_case_result(path, line, scenario.status)
+      end
+
+      def before_examples(*args)
+        @header_row = true
+        @in_examples = true
+      end
+
+      def after_examples(*args)
+        @in_examples = false
+      end
+
+      def after_table_row(table_row)
+        return unless @in_examples and Cucumber::Ast::OutlineTable::ExampleRow === table_row
+        if @header_row
+          @header_row = false
+          return
+        end
+        send_test_case_result(@path, table_row.line, table_row.status)
+      end
+
+      def after_features(*args)
+        @session.close
+      end
+
+      private
+
+      def send_header
+        scm = Scm::Repo.find
+        @session.send({
+          repo_url: scm.remote,
+          branch: scm.branch,
+          rev: scm.rev,
+          group: get_run_id
+        })
+      end
+
+      def send_step_result(path, line, status)
+        @session.send({
+          path: path,
+          location: line.to_i,
+          mime_type: 'application/vnd.cucumber.test-step-result+json',
+          body: { status: status }
+        })
+      end
+
+      def send_test_case_result(path, line, status)
+        @session.send({
+          path: path,
+          location: line.to_i,
+          mime_type: 'application/vnd.cucumber.test-case-result+json',
+          body: { status: status }
+        })
+      end
+
+      def get_run_id
+        Time.now.to_i
+      end
+
+    end
+
+  end
+end

data/lib/cucumber/pro/scm.rb

@@ -0,0 +1,38 @@
+module Cucumber
+  module Pro
+
+    module Scm
+
+      require 'grit'
+      class Repo
+
+        NoGitRepoFound = Class.new(StandardError)
+
+        def self.find(path = Dir.pwd)
+          if Dir.entries(path).include? '.git'
+            new(path)
+          else
+            raise NoGitRepoFound if path == '/'
+            find File.expand_path(path + '/..')
+          end
+        end
+
+        def initialize(path)
+          @repo = Grit::Repo.new(path)
+        end
+
+        def remote
+          @repo.config['remote.origin.url']
+        end
+
+        def branch
+          @repo.head.name
+        end
+
+        def rev
+          @repo.head.commit.id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/pro/version.rb

@@ -0,0 +1,9 @@
+module Cucumber
+  module Pro
+    class Version
+      def self.to_s
+        "0.0.1"
+      end
+    end
+  end
+end

data/lib/cucumber/pro/web_socket_session.rb

@@ -0,0 +1,111 @@
+require 'json'
+require 'faye/websocket'
+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
+      end
+
+      def send(message)
+        logger.debug [:session, :send, message]
+        queue.push(SendMessage.new(message))
+      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
+      end
+
+      private
+
+      attr_reader :logger, :queue
+
+      def start
+        @em = Thread.new do
+          begin
+            EM.run { start_ws_client }
+          rescue => exception
+            logger.fatal exception
+            @ws_error = exception
+          end
+        end
+      end
+
+      def start_ws_client
+        logger.debug [:ws, :start]
+        ws = Faye::WebSocket::Client.new(@url)
+
+        ws.on(:open) do
+          logger.debug [:ws, :open]
+          process_queue(ws)
+        end
+
+        ws.on(:error) do
+          logger.error [:ws, :error]
+        end
+
+        ws.on(:message) do |event|
+          logger.debug [:ws, :message, event.data]
+        end
+
+        ws.on(:close) do |event|
+          logger.debug [:ws, :close]
+          @ws_error = Error::AccessDenied.new
+          ws = nil
+          EM.stop_event_loop
+        end
+        self
+      end
+
+      def process_queue(ws)
+        process_next_message(ws)
+        EM.next_tick do
+          process_queue(ws)
+        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
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-pro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Wynne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-15 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: anticipate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client library for publishing results to the Cucumber Pro service
+email: hello@cucumber.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- cucumber-pro.gemspec
+- features/publish_results.feature
+- features/step_definitions/steps.rb
+- features/support/aruba.rb
+- features/support/env.rb
+- features/support/fake_results_service.rb
+- features/support/world.rb
+- lib/cucumber/pro.rb
+- lib/cucumber/pro/formatter.rb
+- lib/cucumber/pro/scm.rb
+- lib/cucumber/pro/version.rb
+- lib/cucumber/pro/web_socket_session.rb
+homepage: https://cucumber.pro
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: cucumber-pro-0.0.1
+test_files:
+- features/publish_results.feature
+- features/step_definitions/steps.rb
+- features/support/aruba.rb
+- features/support/env.rb
+- features/support/fake_results_service.rb
+- features/support/world.rb
+has_rdoc: