jira-cucumber 0.0.3.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35be64cd78d0556884a4a257c1ef3870da4ce2c7
+  data.tar.gz: 7b1341624824f068b1f07f0e1aab1ac685b0e93a
+SHA512:
+  metadata.gz: ce9fd857c1f2cff154c6a1f3fdce913256fce2083e86e5aecbbeac9bd46ee499e8548c2604f75e5dc66290c9a5d668144f0a7a1ac13f9f64b8dd3f8ef95d7760
+  data.tar.gz: d08111830ca513f39971ff314bb6becb73b01051fe51ba02614062cfadb5c49b133af25a92ab5351dc3dcd764c0f2ac729daa59a7214dcb9d2e67255e21193d9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 1.9.3
+  - 1.8.7
+
+# whitelist
+branches:
+  only:
+    - master
+
+notifications:
+  email:
+    - calebtom87@gmail.com

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+#gem 'cucumber', :git => 'git://github.com/calebTomlinson/cucumber.git', :branch => 'examples_tags'
+
+# Specify your gem's dependencies in jira-cucumber.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Caleb Tomlinson
+
+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 @@
+# JiraFormatter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jira-cucumber'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jira-cucumber
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new do |t|
+  
+end

data/features/README

@@ -0,0 +1 @@
+This Cucumber framework is not functional for testing. It is invoked by the rspec tests for integration testing.

data/features/basic_functionality.feature

@@ -0,0 +1,7 @@
+@feature_tag
+Feature: The formatter doesn't croak
+  
+  @scenario_tag_1
+  Scenario: A simple scenario
+
+    Given a passing step with a <parameter>

data/features/everything.feature

@@ -0,0 +1,37 @@
+@feature-tag
+Feature: A complicated feature
+  
+  @basic-scenario-tag
+  @second-basic-scenario-tag
+  Scenario: passing scenario
+    
+    Given a passing step with a parameter
+    Then it passes
+    
+  @failing-basic
+  Scenario: failing scenario
+    
+    Given a passing step with a parameter
+    Then it fails
+    
+  @outline-tag
+  Scenario Outline: An outline
+
+    Given I set a resource <resource>
+    Given a passing step with a <param>
+    Then it <pass_or_fail>
+    
+    @scenarios-section-tag
+    Scenarios: some scenarios
+    | param     | pass_or_fail | resource |
+    | parameter | passes       | value_a  |
+    | parameter | fails        | value_a  |
+    | missing   | irrelevant   | value_a  |
+
+    @examples-section-tag
+    Examples: some examples... because we like having two syntaxes
+      | param     | pass_or_fail | resource |
+      | parameter | passes       | value_b  |
+      | parameter | fails        | value_b  |
+      | missing   | irrelevant   | value_b  |
+    

data/features/step_definitions/steps.rb

@@ -0,0 +1,15 @@
+Given /^a passing step with a <parameter>$/ do
+  x=1
+end
+Given(/^a passing step with a parameter$/) do
+  x=1
+end
+Then(/^it passes$/) do
+  x=1
+end
+Then(/^it fails$/) do
+  raise StandardError
+end
+Given(/^I set a resource (.*)$/) do |resource|
+  $resource = resource
+end

data/jira-cucumber.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jira_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jira-cucumber"
+  spec.version       = JiraFormatter::VERSION
+  spec.authors       = ["Caleb Tomlinson"]
+  spec.email         = ["ctomlinson@opentable.com"]
+  spec.description   = %q{Jira reporting for cucumber tests}
+  spec.summary       = %q{Jira reporting for cucumber tests}
+  spec.homepage      = ""
+  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"
+  spec.add_runtime_dependency 'jiralicious'
+  
+  spec.platform      = Gem::Platform::RUBY
+  #spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'rspec', '> 2.0'
+  spec.add_development_dependency 'vcr', '2.5.0'
+end

data/lib/jira-cucumber.rb

@@ -0,0 +1 @@
+require 'jira_formatter/formatter'

data/lib/jira_formatter/formatter.rb

@@ -0,0 +1,67 @@
+require "jira_formatter/version"
+require 'jira_formatter/jira_interface'
+
+module JiraFormatter
+  #responds to the cucumber formatter methods and parses the relevant information
+  #only class to talk to cucumber libs!
+  class Formatter
+    #gets called by cucumber to initialize reporting
+    def initialize(step_mother, io, options)
+      @step_mother, @io, @options = step_mother, io, options
+    end
+    
+    #gets called by cucumber after all features have completed
+    #this is the starting point of all reporting
+    def after_features(*args)
+      @scenarios = failed_and_passed
+      JiraInterface.new.report(formatted_scenarios)
+    end
+    
+    private
+    
+    def failed_and_passed
+      failures = @step_mother.scenarios(:failed).select { |s|
+        s.is_a?(Cucumber::Ast::Scenario) || s.is_a?(Cucumber::Ast::OutlineTable::ExampleRow) }
+      passes = @failures = @step_mother.scenarios(:passed).select { |s| s.is_a?(Cucumber::Ast::Scenario) || s.is_a?(Cucumber::Ast::OutlineTable::ExampleRow) }
+      return failures + passes
+    end
+
+    def formatted_scenarios
+      @scenarios.map do |scenario|
+        properties = Hash.new()
+        properties[:run_time] = Time.new()
+        properties[:tags] = scenario.source_tag_names
+        properties[:status] = scenario.status
+        properties[:domain] = determine_domain(scenario)
+        if properties[:status] == :failed
+          
+        end
+
+        if scenario.class == Cucumber::Ast::Scenario
+          properties.merge build_from_scenario(scenario)
+        elsif scenario.class == Cucumber::Ast::OutlineTable::ExampleRow
+          properties.merge build_from_example_row(scenario)
+        end
+      end
+    end
+
+    def determine_domain(scenario)
+
+    end
+
+    def build_from_scenario(scenario)
+      {
+          :feature => scenario.feature.name,
+          :scenario => scenario.name
+      }
+    end
+
+    def build_from_example_row(example_row)
+      {
+          :feature => example_row.scenario_outline.feature.name,
+          :scenario => example_row.scenario_outline.name,
+          :row => example_row.name
+      }
+    end    
+  end
+end

data/lib/jira_formatter/issue.rb

@@ -0,0 +1,61 @@
+module JiraFormatter
+  class Issue
+    
+    def initialize(scenario)
+      @hash = scenario
+      search_results = search_for_existing_issue
+      if search_results.num_results == 0
+        build_issue
+      else
+        load_issue(search_results)
+      end
+      update_issue
+    end
+    
+    private
+    
+    def summary
+      "#{@hash[:feature]} | #{@hash[:scenario]} | #{@hash[:row]}"
+    end
+    
+    def search_for_existing_issue
+      search_string = "project = #{JiraConfiguration.instance.project['id']} AND summary ~ '#{summary}'" 
+      Jiralicious.search(search_string)
+    end
+    
+    def build_issue
+      @jissue = Jiralicious::Issue.new
+      @jissue.fields.set_id("project", JiraConfiguration.instance.project['id'])
+      @jissue.fields.set("summary", summary)
+      @jissue.fields.set_id("issuetype", JiraConfiguration.instance.default_issue_type['id'])
+      @jissue.save!
+    end
+    
+    def load_issue(search_results)
+      @jissue = Jiralicious::Issue.find(search_results.issues[0].jira_key)
+    end
+    
+    def update_issue
+      @jissue.fields.set('labels', @hash[:tags])
+      @jissue.save
+      transition_issue
+      add_comments
+    end
+    
+    def status
+      @jissue.fields.fields_current['status']['id'].to_i
+    end
+    
+    def transition_issue
+      transition = JiraConfiguration.instance.transitions[status][@hash[:status].to_s]
+      if transition
+        Jiralicious::Issue.transition("#{@jissue.jira_self}/transitions", {"transition" => "#{transition}"})
+      end
+    end
+    
+    def add_comments
+      comment = "Test #{@hash[:status]} on #{@hash[:run_time]}\nBuild: http://teamcity/viewLog.html?buildId=#{ENV['teamcity.build.id']}"
+      @jissue.comments.add comment
+    end
+  end
+end

data/lib/jira_formatter/jira_configuration.rb

@@ -0,0 +1,30 @@
+require 'singleton'
+
+module JiraFormatter
+  class JiraConfiguration
+    include Singleton
+    
+    attr_accessor :project, :default_issue_type, :transitions
+    
+    def configure
+      Jiralicious.load_yml('jiralicious.yml')
+      load_yml('jiralicious.yml')
+    end
+    
+    private
+
+    #TODO: add dynamic attribute accessors
+    #yanked straight from the jiralicious method of the same name.
+    def load_yml(yml_file)
+      if File.exist?(yml_file)
+        yml_cfg = OpenStruct.new(YAML.load_file(yml_file))
+        yml_cfg.jira_properties.each do |k, v|
+          instance_variable_set("@#{k}", v)
+        end
+      else
+        raise StandardError, "unable to find yml config file"
+      end
+    end
+    
+  end
+end

data/lib/jira_formatter/jira_interface.rb

@@ -0,0 +1,22 @@
+require 'jiralicious'
+require 'jira_formatter/issue'
+require 'jira_formatter/jira_configuration'
+
+module JiraFormatter
+  class JiraInterface
+    
+    def initialize
+      JiraConfiguration.instance.configure
+    end
+    
+    def report(scenarios)
+      scenarios.each do |scenario|
+        begin
+          issue = Issue.new(scenario)
+        rescue => e
+          puts "jira reporting failed for #{scenario}\n#{e.message}\n#{e.backtrace}"
+        end
+      end
+    end
+  end
+end

data/lib/jira_formatter/version.rb

@@ -0,0 +1,3 @@
+module JiraFormatter
+    VERSION = "0.0.3.pre1"
+end

data/spec/formatter/formatter_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'jira_formatter/formatter'
+
+describe 'JiraFormatter::Formatter' do
+  describe '#after_features' do
+    before :each do
+      @step_mother = Cucumber::Runtime.new()
+      @io = StringIO.new()
+      @formatter = JiraFormatter::Formatter.new(@step_mother, @io, {})
+
+      stub_const('Reporter', Class.new())
+      @reporter = mock('Reporter')      
+    end
+    
+    it 'passes the scenarios to the reporter' do
+      @formatter.should_receive(:failed_and_passed).and_return([1,2,3,1,2,3])
+      Reporter.should_receive(:new).with([1,2,3,1,2,3]).and_return(@reporter)
+      @reporter.should_receive(:report)
+      
+      @formatter.after_features()
+    end
+  end
+end

data/spec/formatter/reporter_spec.rb

@@ -0,0 +1,12 @@
+require 'spec/spec_helper'
+require 'jira_formatter/jira_interface'
+
+#find a way to get a scenario in there for me to work with...
+
+describe 'Reporter' do
+  describe '#report' do
+    it 'just calls 3 functions' do
+       
+    end
+  end
+end

data/spec/integration/integration_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'jira-cucumber'
+
+describe JiraFormatter do   
+  it 'runs without error' do
+    run_feature('everything')
+  end
+  
+  context 'feature exists in jira in the failing state' do
+    context 'the run passes' do             
+      it 'moves the feature to passed' do
+        
+      end
+      
+      it 'adds a comment' do
+        
+      end
+    end
+    context 'the run fails' do
+      it 'does not move the issue' do
+        
+      end
+      it 'adds a comment' do
+        
+      end      
+    end
+  end
+  context 'feature exists in jira in the passing state' do
+    context 'the run passes' do
+      it 'does not move the issue' do
+
+      end
+
+      it 'adds a comment' do
+
+      end
+    end
+    context 'the run fails' do
+      it 'moves the issue to passing' do
+
+      end
+      it 'adds a comment' do
+
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'cucumber/cli/main'
+
+def run_feature(feature_name)  
+  Cucumber::Cli::Main.execute(["features/#{feature_name}.feature", '--format', 'JiraFormatter::Formatter'])
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: jira-cucumber
+version: !ruby/object:Gem::Version
+  version: 0.0.3.pre1
+platform: ruby
+authors:
+- Caleb Tomlinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: jiralicious
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+description: Jira reporting for cucumber tests
+email:
+- ctomlinson@opentable.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/README
+- features/basic_functionality.feature
+- features/everything.feature
+- features/step_definitions/steps.rb
+- jira-cucumber.gemspec
+- lib/jira-cucumber.rb
+- lib/jira_formatter/formatter.rb
+- lib/jira_formatter/issue.rb
+- lib/jira_formatter/jira_configuration.rb
+- lib/jira_formatter/jira_interface.rb
+- lib/jira_formatter/version.rb
+- spec/formatter/formatter_spec.rb
+- spec/formatter/reporter_spec.rb
+- spec/integration/integration_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Jira reporting for cucumber tests
+test_files:
+- features/README
+- features/basic_functionality.feature
+- features/everything.feature
+- features/step_definitions/steps.rb
+- spec/formatter/formatter_spec.rb
+- spec/formatter/reporter_spec.rb
+- spec/integration/integration_spec.rb
+- spec/spec_helper.rb
+has_rdoc: