bilgerat 0.2.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    bilgerat (0.2.1)
+      cucumber (>= 1.0.0)
+      hipchat (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    columnize (0.3.6)
+    cucumber (1.3.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.3)
+    debugger (1.2.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.5)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.7)
+    diff-lcs (1.2.4)
+    ffi (1.9.0)
+    gherkin (2.12.0)
+      multi_json (~> 1.3)
+    hipchat (0.7.0)
+      httparty
+      httparty
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.5)
+  bilgerat!
+  debugger

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Medidata Solutions Worldwide
+
+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,42 @@
+bilgerat
+========
+
+Bilgerat is a [cucumber](http://cukes.info/) output formatter that sends messages about failing scenarios to [HipChat](https://www.hipchat.com/) rooms.
+
+
+usage
+-----
+
+In your Gemfile:
+
+```ruby
+    gem 'bilgerat',            git: 'git@github.com:mdsol/bilgerat.git'
+```
+
+On the command line:
+
+```
+cucumber --format Bilgerat --out na --format pretty
+```
+
+
+configuration
+-----
+You must supply a configuration file that contains credentials to use the HipChat API.  By default Bilgerat looks for this file is config/hipchat.yml.  You can override this location by setting the HIPCHAT_CONFIG_PATH environment variable.
+
+The configuration file contains settings per context.  You should set all configuration items in the default context.  You can override these settings for other contexts.  Use the BILGERAT_CONTEXT environment variable to choose the context.
+
+For example our CI server runs cucumber scenarios in parallel for the first round, then reruns failing scenarios in the final round.  Our config file looks like this:
+
+```
+default:
+  user: 'Bilge Rat #{TEST_ENV_NUMBER}'
+  auth_token: 'goes here'
+  room: 'test room'
+  error_color: 'red'
+first_round:
+  error_color: 'purple'
+final_round:
+  user: 'Final Bilge Rat'
+```
+

data/bilgerat.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = "bilgerat"
+  s.version = '0.2.1'
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version     = '>= 1.9.3'
+  s.authors = ["Joseph Shraibman"]
+  s.email = ["jshraibman@mdsol.com"]
+  s.homepage = "https://github.com/mdsol/bilgerat"
+  s.summary = "Cucumber output formatter that sends failure messages to Hipchat"
+
+  s.add_dependency "cucumber", ">= 1.0.0"
+  s.add_dependency 'hipchat', '~> 0.7.0'
+
+  s.add_development_dependency 'aruba', '~> 0.5'
+  s.add_development_dependency 'debugger'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+ end

data/features/error_handling.feature

@@ -0,0 +1,21 @@
+Feature: Error handling
+
+  @announce-stderr
+  Scenario: Undefined steps work
+    And a file named "features/scenario_with_unmatched_step_def.feature" with:
+    """
+      Feature: Outline
+
+        @tagtag
+        Scenario: blah blah
+          Given this passes
+      """
+    And a file named "features/step_definitions/steps.rb" with:
+    """
+      Given /^this passes$/ do
+      end
+      Given /^this passes$/ do
+      end
+      """
+    When I run bilgerat with: `cucumber --format Bilgerat --out na --format pretty`
+    Then there should be a hipchat post matching /.*Ambiguous match of "this passes".*/

data/features/outlines/main.feature

@@ -0,0 +1,30 @@
+Feature: Scenario outlines
+
+  Background:
+    Given a standard Cucumber project directory structure
+
+  Scenario: Full information is only printed for the first example
+    And a file named "features/scenario_with_failing_examples.feature" with:
+    """
+      Feature: Outline
+
+        @tagtag
+        Scenario Outline: blah blah
+          Given this <fails or passes>
+          Examples:
+            | fails or passes |
+            | passes     |
+            | fails     |
+            | fails   |
+      """
+    And a file named "features/step_definitions/steps.rb" with:
+    """
+      Given /^this (fails|passes)$/ do |str|
+        str.should == 'passes'
+      end
+      """
+    When I run bilgerat with: `cucumber --format Bilgerat --out na --format pretty`
+    Then there should be a hipchat post matching /.*@tagtag.*Example #2 failed.*/
+    And there should not be a hipchat post matching /@tagtag.*Example #3 failed.*/
+    And there should be a hipchat post matching /.*Example #3 failed.*/
+

data/features/step_definitions/bilgerat_steps.rb

@@ -0,0 +1,34 @@
+def debug_file_name
+  '/tmp/tempfile.xml'
+end
+
+When /^I run bilgerat with: `(.*)`$/ do |cmd|
+  step %Q{I run `env DEBUG_BILGERAT=#{debug_file_name} #{cmd}`}
+end
+
+When /^I clear hipchat posts$/ do
+  File.delete(debug_file_name) if File.exists?(debug_file_name)
+end
+
+Before do
+  step 'I clear hipchat posts'
+end
+
+# For debugging
+Then /^I print the hipchat posts$/ do
+  puts File.read(debug_file_name)
+end
+
+Then /^there should (not )?be a hipchat post matching \/(.*)\/$/ do |should_not, pattern|
+  file_text = nil
+  File.open(debug_file_name, 'r') do |file|
+    file_text = file.read
+  end
+  re = Regexp.new("<HIPPOST>#{pattern}</HIPPOST>", Regexp::MULTILINE)
+
+  if should_not
+    file_text.should_not match(re)
+  else
+    file_text.should match(re)
+  end
+end

data/features/step_definitions/cucumber_steps.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+# Copied from the cucumber project
+
+Given /^I am in (.*)$/ do |example_dir_relative_path|
+  @current_dir = fixtures_dir(example_dir_relative_path)
+end
+
+Given /^a standard Cucumber project directory structure$/ do
+  @current_dir = `mktemp -d cuc.XXXXXX`.strip
+  #puts "created cuc dir #{@current_dir}"
+  in_current_dir do
+    FileUtils.rm_rf 'features' if File.directory?('features')
+    FileUtils.mkdir_p 'features/support'
+    FileUtils.mkdir 'features/step_definitions'
+  end
+end

data/features/support/base.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'aruba/cucumber'
+
+After do
+  FileUtils.rm_rf @current_dir if @current_dir && File.directory?(@current_dir)
+end

data/hipchat.yml.sample

@@ -0,0 +1,5 @@
+default:
+  user: 'Bilge Rat #{TEST_ENV_NUMBER}'
+  auth_token: 'goes here'
+  room: 'test room'
+  error_color: 'red'

data/lib/bilgerat.rb

@@ -0,0 +1,269 @@
+# encoding: utf-8
+
+# Based on https://github.com/cucumber/cucumber/blob/master/lib/cucumber/formatter/pretty.rb and the other cucumber
+# built in formatters.
+# There was no handy api so I had to reverse engineer
+
+class Bilgerat
+
+  def initialize(step_mother, path_or_io, options)
+  end
+
+
+  def before_background(background)
+    @background_failed = nil
+    reset_scenario_info
+    @in_background = background
+  end
+
+  def after_background(background)
+    @in_background = nil
+    @background_tags = @tags
+    @tags = nil
+  end
+
+  def tag_name(tag)
+    (@tags ||= []) << tag
+  end
+
+  def scenario_name(keyword, name, file_colon_line, source_indent)
+    reset_scenario_info
+    @current_scenario_info = {keyword: keyword, name: name, file_colon_line: file_colon_line, tags: @tags}
+    @tags = nil
+  end
+
+  def after_table_row(table_row)
+    return unless @in_examples and Cucumber::Ast::OutlineTable::ExampleRow === table_row
+    @example_num += 1  if !@header_row
+    if table_row.exception
+      hipchat_exception(table_row.exception)
+    elsif !@header_row && table_row.failed?
+      hipchat_exception('<failure had no exception>')
+    end
+    @header_row = false
+  end
+
+  def before_examples(*args)
+    @in_examples = true
+    @header_row = true
+  end
+
+  def after_examples(*args)
+    @in_examples = false
+  end
+
+  def exception(exception, status)
+    hipchat_exception(exception)
+  end
+
+  # file_colon_line is new in cucumber 1.2.0.  Give it default of nil to be reverse compatible
+  def step_name(keyword, step_match, status, source_indent, background, file_colon_line=nil)
+    @current_failed_step_info = nil
+    #TODO: detect if we are running in strict mode somehow, and if so also send a message when status == :pending
+    if status == :failed
+      @current_failed_step_info = {step_match: step_match, file_colon_line: file_colon_line, status: status}
+    end
+  end
+
+  private
+
+  # send failure report to hipchat
+  def hipchat_exception(exception)
+    # If the background fails only send one message the first time
+    return if @background_failed
+
+    # If this is a failing scenario output includes:
+    # 1a) file & line number for scenario
+    # 1b) all tags, including those declared on the feature
+    # 1c) scenario name
+    # 2) failing step
+    # 3) The exception
+
+    # If this is a failing example, then output includes:
+    # 1) For the first failing example in an outline the same as above, omitted for the subsequent examples
+    # 2) "Example #X failed:"
+    # 3) the exception
+
+    # If this was a failing background step:
+    # 1a) file & line number for background
+    # 1b) "Background step failed:"
+    # 2) failing step
+    # 3) the exception
+
+    sb = ''
+
+    # part 1
+    unless @had_failing_example
+      if @current_scenario_info
+        sb << "# #{ @current_scenario_info[:file_colon_line] }\n"
+        all_tags = (@background_tags || []) + (@current_scenario_info[:tags] || [])
+        sb << all_tags.join(' ') + "\n"  if all_tags.size > 0
+        sb << "#{ @current_scenario_info[:keyword]}: #{ @current_scenario_info[:name]}\n"
+      elsif @in_background
+        sb << "# #{ @in_background.file_colon_line }\nBackground step failed:\n"
+        @background_failed = true
+      else
+        sb = 'error: no scenario info'
+      end
+    end
+
+    # part2
+    if @current_failed_step_info # Failing scenario or background, not example
+      sb << "#{ current_step_match_to_str } # "
+      fcl = @current_failed_step_info[:file_colon_line]  # line in the feature file, may be nil
+      sb << fcl << ' → ' if fcl
+      sb << @current_failed_step_info[:step_match].file_colon_line << "\n"
+    elsif @example_num
+      @had_failing_example = true
+      sb << "Example ##{@example_num} failed:\n"
+    end
+
+    adapter.hip_post( "#{ sb }#{ build_exception_detail(exception) }", color: :error )
+  end
+
+  # Convert the step match (saved from step_name(), above into a string for outputting.
+  def current_step_match_to_str
+    current_step_match = @current_failed_step_info[:step_match]
+    # current_step_match might be a StepMatch or a NoStepMatch.  If a NoStepMatch we must pass in dummy argument to format_args
+    args = current_step_match.is_a?(Cucumber::NoStepMatch)? [nil] : []
+    current_step_match.format_args(*args)
+  end
+
+  def adapter
+    HipchatAdapter
+  end
+
+  # Based on cucumber code
+  def build_exception_detail(exception)
+    return exception if exception.is_a? String
+    backtrace = Array.new
+
+    message = exception.message
+    if defined?(RAILS_ROOT) && message.include?('Exception caught')
+      matches = message.match(/Showing <i>(.+)<\/i>(?:.+) #(\d+)/)
+      backtrace += ["#{RAILS_ROOT}/#{matches[1]}:#{matches[2]}"] if matches
+      matches = message.match(/<code>([^(\/)]+)<\//m)
+      message = matches ? matches[1] : ""
+    end
+
+    unless exception.instance_of?(RuntimeError)
+      message = "#{message} (#{exception.class})"
+    end
+
+    message << "\n" << backtrace.join("\n")
+  end
+
+  def reset_scenario_info
+    @current_failed_step_info = @current_scenario_info = @example_num = @had_failing_example = nil
+    @example_num = 0
+  end
+
+end
+
+# In theory in the future there might be different adapters that can plug in to the output formatter, but for now
+# there is just this one.
+class HipchatAdapter
+
+  class << self
+    DEFAULTS = {
+        :message_format => 'text',
+        :notify => '1'
+    }.freeze
+
+
+    # Send a message to a HipChat room
+    # TODO: fork a thread so we don't block tests while we wait for the network. Also on the puts calls because on at
+    # least one occasion a call blocked and locked up cucumber.
+    def hip_post(message, options = {})
+      if ENV['DEBUG_BILGERAT']
+        unless @debug_file
+          @debug_file = File.open(ENV['DEBUG_BILGERAT'], 'w')
+          @debug_file.puts "<debugfile>"
+          at_exit { @debug_file.puts "</debugfile>" }
+        end
+        @debug_file.puts "<HIPPOST>#{ message }</HIPPOST>"
+      end
+
+      return unless configured?
+
+      def option(sym)
+        return options[sym] if options.keys.include?(sym)
+        DEFAULTS[sym]
+      end
+
+      # Replace the 'error' color with a real color
+      options[:color] = error_color if options[:color] == :error
+
+      begin
+        client[config['room']].send(username, message, DEFAULTS.merge(options))
+        #puts "sent msg to hipchat"
+      rescue  => ex
+        STDERR.puts "Caught #{ex.class}; disabling hipchat notification"
+        @configured = false
+      end
+    end
+
+    # Config hash, from yml file
+
+    private
+
+    def error_color
+      @error_color ||= config['error_color'] || 'red'
+    end
+
+    # Returns something that looks like a hash.  It returns values from the raw bash by first looking under the
+    # current context, then under 'default'
+    def config
+      config_file = ENV['HIPCHAT_CONFIG_PATH'] || 'config/hipchat.yml'
+      return nil unless File.exists?(config_file)
+
+
+      @config ||= Class.new do
+        @raw_config_yaml = YAML.load_file(config_file)
+
+        @context = ENV['BILGERAT_CONTEXT'] if ENV['BILGERAT_CONTEXT'] && ENV['BILGERAT_CONTEXT'].length > 0
+
+        def self.[](sym)
+          sym = sym.to_s
+          if @context
+            hash = @raw_config_yaml[@context]
+            return hash[sym] if hash && hash.keys.include?(sym)
+          end
+          @raw_config_yaml['default'][sym]
+        end
+      end
+    end
+
+    # Are we configured to send messages to HipChat?  If not just drop messages.
+    def configured?
+      if @configured.nil?
+        @configured = !!(config && config['room'] && config['auth_token'])
+      else
+        @configured
+      end
+    end
+
+    def client
+      require 'hipchat'
+      @client ||= HipChat::Client.new(config['auth_token'])
+    end
+
+    # The username as we want it to appear in the HipChat room.
+    def username
+      @username ||= begin
+        env_var = config['user']
+        case env_var
+          when nil then
+            'Bilge Rat'
+          when Regexp.compile('#{TEST_ENV_NUMBER}') then
+            test_env_number = ENV['TEST_ENV_NUMBER']
+            test_env_number = '1' if test_env_number == ''
+            env_var.gsub('#{TEST_ENV_NUMBER}', test_env_number || '')
+          else
+            env_var
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: bilgerat
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Joseph Shraibman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jshraibman@mdsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bilgerat.gemspec
+- features/error_handling.feature
+- features/outlines/main.feature
+- features/step_definitions/bilgerat_steps.rb
+- features/step_definitions/cucumber_steps.rb
+- features/support/base.rb
+- hipchat.yml.sample
+- lib/bilgerat.rb
+homepage: https://github.com/mdsol/bilgerat
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cucumber output formatter that sends failure messages to Hipchat
+test_files:
+- features/error_handling.feature
+- features/outlines/main.feature
+- features/step_definitions/bilgerat_steps.rb
+- features/step_definitions/cucumber_steps.rb
+- features/support/base.rb
+has_rdoc: