cucumber-rapid7 0.0.1.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 905198412fc25706ec71608451bbe265e9cf6cb8
+  data.tar.gz: 829fc1c439736c6f9fa9a235458dbfb84880fd7f
+SHA512:
+  metadata.gz: b54567750084877b42d95c3fb67298b8422b6b81f23976d2ad010fdcb6a0d0e12a04ddac5135f335401243173fa5f584be1168917579a566db6897750ef7f172
+  data.tar.gz: ec8f08ac7ab2fd11fef82223aa675fb202621f9b1e7b1c03c51dc9def1427aa215392e79ebb4ccb00eaa952e626df3369d101b11e944036adc4a2fc64ab0a792

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Erran Carey <erran_carey@rapid7.com>
+
+MIT License
+
+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,29 @@
+# Cucumber::Rapid7
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cucumber-rapid7'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cucumber-rapid7
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/cucumber-rapid7.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cucumber/rapid7/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cucumber-rapid7'
+  spec.version       = Cucumber::Rapid7::VERSION
+  spec.authors       = ['Erran Carey']
+  spec.email         = ['erran_carey@rapid7.com']
+  spec.description   = %q{Cucumber extensions used at Rapid7}
+  spec.summary       = %q{Cucumber extensions for Rapid7}
+  spec.homepage      = 'https://github.com/ecarey-r7/cucumber-rapid7'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/cucumber/rapid7/auxiliary.rb

@@ -0,0 +1,54 @@
+require 'cucumber/ast/outline_table/example_row'
+require 'cucumber/ast/scenario'
+require 'cucumber/term/ansicolor'
+
+module Cucumber
+  module Rapid7
+    module Auxiliary
+      def find_scenario_name(scenario_or_outline)
+        case scenario_or_outline
+        when Cucumber::Ast::Scenario
+          scenario_or_outline.name
+        when Cucumber::Ast::OutlineTable::ExampleRow
+          scenario_or_outline.scenario_outline.name
+        end
+      end
+
+      def find_file_colon_line(scenario_or_outline)
+        case scenario_or_outline
+        when Cucumber::Ast::Scenario
+          scenario_or_outline.file_colon_line
+        when Cucumber::Ast::OutlineTable::ExampleRow
+          scenario_or_outline.scenario_outline.file_colon_line
+        end
+      end
+
+      def example_row_from_scenario(scenario)
+        if scenario.is_a? Cucumber::Ast::OutlineTable::ExampleRow
+            example_row = [
+              scenario.name.split('|').map { |column| column.cyan }.join(' | '.reset),
+              ' |'.reset
+            ].flatten.join.sub('| ', '')
+        end
+
+        if example_row && ENV['CI']
+          Cucumber::Term::ANSIColor.uncolored(example_row)
+        elsif example_row
+          example_row
+        end
+      end
+
+      def skip_tag_error(scenario_name, common_tags, example_row = false)
+        skip_error = [
+          ' Skipping'.cyan,
+          %("#{scenario_name}").bold.cyan,
+          'due to having the following auto-skip tags:'.cyan,
+          common_tags.to_s.bold.cyan
+        ].join(' ')
+
+        skip_error << ' |'.reset if example_row
+        ENV['CI'] ? Cucumber::Term::ANSIColor.uncolored(skip_error) : skip_error
+      end
+    end
+  end
+end

data/lib/cucumber/rapid7/formatter/html_postponed.rb

@@ -0,0 +1,34 @@
+require 'cucumber/formatter/html'
+
+class HtmlPostponed < Cucumber::Formatter::Html
+  def after_features(features)
+    @builder << '</div>' # Close the previous <div>
+    @skip_tags = ENV['CUCUMBER_SKIP_TAGS'].split(',')
+    @file_colon_lines = []
+
+    @builder << '<div class="cucumber">'
+      @builder << '<div class="feature">'
+        @builder << '<h2>'
+          @builder << 'Postponed tests (using $CUCUMBER_SKIP_TAGS)'
+        @builder << '</h2>'
+        @builder << '<span class="tag">'
+          @skip_tags.each { |tag| @builder << tag }
+        @builder << '</span>'
+        @builder << '<ol>'
+          features.each do |feature|
+            if (@skip_tags & feature.source_tag_names).any?
+              unless @file_colon_lines.include? feature.file_colon_line
+                @builder << '<li>'
+                @builder << feature.file_colon_line
+                @builder << '</li>'
+              end
+            end
+          end
+        @builder << '</ol>'
+      @builder << '</div>'
+    @builder << '</div>'
+
+    @builder << '<div>'
+    super # Give the HTML formatter control
+  end
+end

data/lib/cucumber/rapid7/formatter/jira_metrics.rb

@@ -0,0 +1,29 @@
+require 'cucumber/formatter/pretty'
+require 'cucumber/jira'
+
+# This formatter is a WIP that will eventually gather information from JIRA
+# based on JIRA themes and Gherkin tags and add the information into cucumber
+# reports.
+#
+# @author Erran Carey <erran_carey@rapid7.com>
+# @api private
+class JiraMetrics < Cucumber::Formatter::Pretty
+  def initialize(runtime, path_or_io, options)
+    super
+
+    jira_client = Cucumber::Jira::Soap.new(ENV['JIRA_ENDPOINT'])
+    jira_client.login(ENV['JIRA_USER'], ENV['JIRA_PASSWORD'], true)
+    @jira_issues = jira_client.search :project => ENV['JIRA_PROJECT_KEY'], :themes => ENV['JIRA_THEMES'].to_s.split(/,\s*/, '')
+  end
+
+  def before_feature(feature)
+    super
+
+    tags = feature.source_tags.map { |tag| tag.name.sub(/^@/, '') }
+    jira_tags = tags.grep(/^COSMO-\d+/)
+
+    issues = @jira_issues.find_all { |issue| jira_tags.include?(issue[:key]) }
+
+    puts issues
+  end
+end

data/lib/cucumber/rapid7/formatter/notification_center.rb

@@ -0,0 +1,135 @@
+require 'cucumber/formatter/duration'
+require 'cucumber/formatter/io'
+require 'terminal-notifier'
+
+# A Cucumber formatter that notifies a user through Mac OS X's notification
+# center when the cucumber tests have finished running.
+#
+# @note This formatter was originally written by Jon Frisby (@MrJoy)
+#   https://github.com/MrJoy/cucumber-nc
+# @note This formatter incorporates patches from ipwnstuff/cucumber-nc
+#   (ipwnstuff => Erran Carey)
+# @author John Frisby <jfrisby@mrjoy.com>
+# @author Erran Carey <erran_carey@rapid7.com>
+# @api private
+class NotificationCenterFormatter
+  include Cucumber::Formatter::Duration
+  include Cucumber::Formatter::Io
+
+  attr_reader :step_mother
+  def initialize(step_mother, path_or_io, options)
+    @step_mother, @options = step_mother, options
+  end
+
+  def after_features(features)
+    print_summary(features)
+  end
+
+  def before_feature(feature); end
+  def comment_line(comment_line); end
+  def after_tags(tags); end
+  def tag_name(tag_name); end
+  def feature_name(keyword, name); end
+  def before_feature_element(feature_element); end
+  def after_feature_element(feature_element); end
+  def before_background(background); end
+  def after_background(background); end
+  def background_name(keyword, name, file_colon_line, source_indent); end
+  def before_examples_array(examples_array); end
+  def examples_name(keyword, name); end
+  def before_outline_table(outline_table); end
+  def after_outline_table(outline_table); end
+  def scenario_name(keyword, name, file_colon_line, source_indent); end
+  def before_step(step); end
+  def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line); end
+  def step_name(keyword, step_match, status, source_indent, background, file_colon_line); end
+  def doc_string(string); end
+  def exception(exception, status); end
+  def before_multiline_arg(multiline_arg); end
+  def after_multiline_arg(multiline_arg); end
+  def before_table_row(table_row); end
+  def after_table_row(table_row); end
+  def after_table_cell(cell); end
+  def table_cell_value(value, status); end
+
+  private
+
+  def pluralize(num, str)
+    (num == 1) ? str : "#{str}s"
+  end
+
+  def summary_line(features)
+    scenarios = step_mother.scenarios.count
+    scenarios_failed = step_mother.scenarios(:failed).count
+    scenarios_undefined = step_mother.scenarios(:undefined).count
+    scenarios_pending = step_mother.scenarios(:pending).count
+    scenarios_passing = step_mother.scenarios(:passed).count
+
+    steps = step_mother.steps.count
+    steps_failed = step_mother.steps(:failed).count
+    steps_skipped = step_mother.steps(:skipped).count
+    steps_undefined = step_mother.steps(:undefined).count
+    steps_pending = step_mother.steps(:pending).count
+    steps_passing = step_mother.steps(:passed).count
+
+    counts = []
+    counts << "#{scenarios_undefined} undefined" if scenarios_undefined > 0
+    counts << "#{scenarios_pending} pending" if scenarios_pending > 0
+    counts << "#{scenarios_failed} failed" if scenarios_failed > 0
+    counts << "#{scenarios_passing} passed" if scenarios_passing > 0
+
+    # 5 scenarios (1 undefined, 3 pending, 1 passed)
+    case counts.count
+    when 4
+      summary = "#{scenarios} #{pluralize(scenarios, "scenario")} (#{counts[0]}, #{counts[1]}, #{counts[2]},\n#{counts[3]})\n"
+    else
+      summary = "#{scenarios} #{pluralize(scenarios, "scenario")} (#{counts.join(', ')})\n"
+    end
+
+    counts = []
+    counts << "#{steps_undefined} undefined" if steps_undefined > 0
+    counts << "#{steps_skipped} skipped" if steps_skipped > 0
+    counts << "#{steps_pending} pending" if steps_pending > 0
+    counts << "#{steps_failed} failed" if steps_failed > 0
+    counts << "#{steps_passing} passed" if steps_passing > 0
+
+    # 35 steps (23 skipped, 1 undefined, 3 pending, 8 passed)
+    case counts.count
+    when 4
+      summary << "#{steps} #{pluralize(steps, "step")} (#{counts[0]}, #{counts[1]}, #{counts[2]},\n#{counts[3]})"
+    when 5
+      summary << "#{steps} #{pluralize(steps, "step")} (#{counts[0]}, #{counts[1]}, #{counts[2]},\n#{counts[3]}, #{counts[4]})"
+    else
+      summary << "#{steps} #{pluralize(steps, "step")} (#{ counts.join(', ') })"
+    end
+
+    summary
+  end
+
+  def print_summary(features)
+    body = []
+    body << summary_line(features)
+
+    # 0m0.024s
+    body << "#{ format_duration(features.duration) }"
+
+    name = File.basename(File.expand_path('.'))
+
+    title = unless step_mother.scenarios(:failed).empty?
+      "\u26D4 #{ name }: #{ step_mother.scenarios(:failed).count } failed #{ pluralize(step_mother.scenarios(:failed).count, 'scenario') }"
+    else
+      "\u2705 #{ name }: Success"
+    end
+
+    say title, body.join("\n")
+  end
+
+  def say(title, body)
+    if TerminalNotifier.available?
+      TerminalNotifier.notify body, :title => title, :sender => 'com.apple.Terminal'
+    else
+      puts "\e[1;39;49m#{title}\e[0m"
+      puts body
+    end
+  end
+end

data/lib/cucumber/rapid7/hooks/capybara.rb

@@ -0,0 +1,25 @@
+require 'capybara'
+
+# Alias :selenium to :firefox
+Capybara.register_driver :firefox do |app|
+  Capybara.drivers[:selenium]
+end
+
+# If a scenario is tagged as @ui and more than one capybara driver this hook
+# will pick it up and run it in each browser
+Around '@ui' do |scenario, block|
+  tags = scenario.source_tag_names.map do |tag|
+    tag.sub(/^@/, '').to_sym
+  end
+
+  common_drivers = tags & Capybara.drivers.keys
+
+  if common_drivers.count <= 1
+    Capybara.current_driver = common_drivers.first unless common_drivers.empty?
+    block.call
+  else
+    common_drivers.each do |driver|
+      Capybara.using_driver(driver, &block)
+    end
+  end
+end

data/lib/cucumber/rapid7/hooks/capybara_register_drivers.rb

@@ -0,0 +1,25 @@
+require 'capybara'
+
+# Takes each value in a comma separated list and registers it as a
+# Capybara driver
+ENV['CAPYBARA_DRIVERS'].split(/,\s*/).map(&:to_sym).each do |driver|
+  case driver
+  when :poltergeist
+    require 'capybara/poltergeist'
+
+    file_name = ENV['PHANTOMJS_LOG_FILE'] || 'phantomjs.log'
+    Capybara.register_driver :poltergeist do |app|
+      options = {
+        # By default Javascript errors will be reraised in Ruby
+        # :js_errors => false,
+        :phantomjs_options => %w[--ignore-ssl-errors=yes],
+        :phantomjs_logger  => File.open(file_name, 'a+')
+      }
+      Capybara::Poltergeist::Driver.new(app, options)
+    end
+  else
+    Capybara.register_driver driver do |app|
+      Capybara::Selenium::Driver.new(app, :browser => driver)
+    end
+  end
+end

data/lib/cucumber/rapid7/hooks/postponed.rb

@@ -0,0 +1,35 @@
+require 'cucumber/rapid7/auxiliary'
+
+# OPTIMIZE: Include helper methods on a global scope, so that they can be used in around hooks
+include Cucumber::Rapid7::Auxiliary
+
+Around do |scenario, block|
+  scenario_name = find_scenario_name(scenario)
+  source_tags = scenario.source_tag_names
+  common_tags = source_tags & ENV['CUCUMBER_SKIP_TAGS'].to_s.split(/,/)
+  example_row = scenario.is_a?(Cucumber::Ast::OutlineTable::ExampleRow)
+
+  if common_tags.any? && scenario_name.eql?(@last_scenario_name)
+    # TODO: Would this always an example row? If not should scenario names be unique?
+    if example_row
+      $stdout.print example_row_from_scenario(scenario)
+    end
+  elsif common_tags.any?
+    file_name = ENV['CUCUMBER_RERUN_FILE'] || 'rerun.txt'
+
+    File.open(file_name, 'w+') do |rerun_file|
+      rerun_file << " #{find_file_colon_line(scenario)}"
+    end
+
+    $stdout.puts skip_tag_error(scenario_name, common_tags, example_row)
+
+    if example_row
+      # "\s"*6 => six space chars
+      $stdout.print "\s"*6, '|', example_row_from_scenario(scenario)
+    end
+  else
+    block.call
+  end
+
+  @last_scenario_name = scenario_name
+end

data/lib/cucumber/rapid7/hooks/ui.rb

@@ -0,0 +1,8 @@
+After '@ui', '@wip' do |scenario|
+  scenario_name = find_scenario_name(scenario)
+
+  unless ENV['CI']
+    $stdout.puts "\a\nPaused on '#{scenario_name}'. Press enter/return to continue to the next test."
+    $stdin.gets
+  end
+end

data/lib/cucumber/rapid7/version.rb

@@ -0,0 +1,5 @@
+module Cucumber
+  module Rapid7
+    VERSION = '0.0.1.beta.1'
+  end
+end

data/lib/cucumber/rapid7.rb

@@ -0,0 +1,6 @@
+require 'cucumber/rapid7/version'
+
+module Cucumber
+  module Rapid7
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-rapid7
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta.1
+platform: ruby
+authors:
+- Erran Carey
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: Cucumber extensions used at Rapid7
+email:
+- erran_carey@rapid7.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- cucumber-rapid7.gemspec
+- lib/cucumber/rapid7.rb
+- lib/cucumber/rapid7/auxiliary.rb
+- lib/cucumber/rapid7/formatter/html_postponed.rb
+- lib/cucumber/rapid7/formatter/jira_metrics.rb
+- lib/cucumber/rapid7/formatter/notification_center.rb
+- lib/cucumber/rapid7/hooks/capybara.rb
+- lib/cucumber/rapid7/hooks/capybara_register_drivers.rb
+- lib/cucumber/rapid7/hooks/postponed.rb
+- lib/cucumber/rapid7/hooks/ui.rb
+- lib/cucumber/rapid7/version.rb
+homepage: https://github.com/ecarey-r7/cucumber-rapid7
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Cucumber extensions for Rapid7
+test_files: []