cukerail 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2766250f6ab930d87a486fe29cf12d953a96ac28
+  data.tar.gz: 2163570c2c5f60002ac0de36b55ffbabbb2fa653
+SHA512:
+  metadata.gz: 4782fa57ad5d3d403cf07f0697a66f5e99976cee441c71ccbbc444bceb7b447467faed37e19265cc71dfc5b49ef3718b5d824fd393e006ce944c1da7f0668890
+  data.tar.gz: 0aeb164dac7a5013690d62a31b5430646e4894b06565ea224be7bdbae51669e55879197c013c69148ec5af00f4d0d44885e056ce21777eec82ee4be6b3f2e843

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cukerail.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 John Small
+
+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 @@
+# Cukerail
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cukerail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cukerail
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cukerail/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# # Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec
+

data/cukerail.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cukerail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cukerail"
+  spec.version       = Cukerail::VERSION
+  spec.authors       = ["John Small"]
+  spec.email         = ["john.small@bbc.com"]
+  spec.summary       = %q{Integrates Cucumber and Testrail from Gurock Software}
+  spec.description   = %q{Allows you to sync your Testrail testcases from feature files and send test results into Testrail testruns}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake","~>10.4"
+  spec.add_development_dependency "rspec","~>3.2"
+  spec.add_development_dependency "pry","~>0.10"
+  spec.add_development_dependency "geminabox","~>0.12"
+end

data/lib/cukerail/version.rb

@@ -0,0 +1,3 @@
+module Cukerail
+  VERSION = "0.0.2"
+end

data/lib/cukerail.rb

@@ -0,0 +1,137 @@
+require "cukerail/version"
+require "testrail"
+module Cukerail
+  class Sender
+    attr_reader :conn
+    def initialize(runtime, io, options)
+      @conn = TestRail::APIClient.new(ENV['TESTRAIL_BASE_URL'],ENV['TESTRAIL_USER'],ENV['TESTRAIL_PASSWORD'])
+    end
+
+    def after_test_case(test_case,result)
+      feature = test_case.feature
+      #      ap feature.methods - Object.methods
+      #      ap feature.tags
+      @id = get_id(test_case)
+      raise 'No id found' unless @id
+      send_steps(test_case,@id)
+      send_result(test_case,result,@id,ENV['TESTRUN']) if ENV['TESTRUN']
+    end
+
+    def tag_name(tag_name)
+      @scenario_tags << tag_name
+    end
+
+    def step_name(keyword, step_match, status, source_indent, background, file_colon_line)
+      step_name = step_match.format_args(lambda{|param| "*#{param}*"})
+      @test_steps << "#{keyword}#{step_name}"
+    end
+
+    def after_test_step(step,result)
+      unless result.passed?
+        # only the first non-passed step
+        @failed_step[:step]   ||= step
+        @failed_step[:result] ||= result
+      end
+    end
+
+    def before_test_case(*args)
+      @test_steps =[]
+      @scenario_tags = []
+      @failed_step = {}
+    end
+
+    def get_id(test_case)
+      #      ap test_case.methods - Object.methods
+      tagged_id = test_case.tags.select{|tag| tag.name =~/testcase/}.first
+      tags = test_case.tags + test_case.feature.tags
+      project_id = /\d+/.match(tags.select{|tag| tag.name =~/project/}.first.name)[0] 
+      suite_id = /\d+/.match(tags.select{|tag| tag.name =~/suite/}.first.name)[0] 
+      title = extract_title(test_case)
+      found_case = @conn.send_get("get_cases/#{project_id}&suite_id=#{suite_id}").select{|c| c['title'] == title}.first
+      if found_case
+        result= found_case['id']
+      else
+        sub_section_id = /\d+/.match(tags.select{|tag| tag.name =~/sub_section/}.first.name)[0] 
+        result = create_new_case(project_id,suite_id,sub_section_id,test_case)['id']
+      end
+      return result
+    end
+
+    def update_source_file(scenario, external_reference)
+      #this could be done on one line with sed. But the format is different on Mac OS and GNU Linux version and it definitely won't work on a Windows machine
+      path = scenario.file
+      lines = IO.readlines(scenario.file)
+      lines[scenario.line-2].gsub!(/ @testcase_\d*/," @testcase_#{external_reference}") 
+      lines[scenario.line-2].gsub!(/\n/," @testcase_#{external_reference}") unless lines[scenario.line-2] =~ /testcase/ 
+      temp_file = Tempfile.new('foo')
+      begin
+        File.open(path, 'r') do |file|
+          lines.each do |line|
+            temp_file.puts line
+          end
+        end
+        temp_file.close
+        FileUtils.mv(temp_file.path, path)
+      ensure
+        temp_file.close
+        temp_file.unlink
+      end
+    end
+
+    def send_steps(test_case,id)
+      steps_as_string = test_case.test_steps.map{|step| step.source.last}.select{|step| step.is_a?(Cucumber::Core::Ast::Step)}.map do | step |
+        g = step.gherkin_statement
+        str = g.keyword+g.name
+        g.rows.each do | row |
+          str += "\n| #{row.cells.join(' | ')} |"
+        end if g.rows
+        str
+      end.join("\n")
+      is_manual = test_case.tags.any?{|tag| tag.name =~/manual/}
+      data = {'title'=>extract_title(test_case),'type_id'=>(is_manual ? 7 : 1 ),'custom_steps'=>steps_as_string}
+      @conn.send_post("update_case/#{id}",data)
+    end
+
+    def create_new_case(project_id,suite_id,sub_section_id,test_case)
+      is_manual = test_case.tags.any?{|tag| tag.name =~/manual/}
+      steps_as_string = test_case.test_steps.map{|step| step.source.last}.select{|step| step.is_a?(Cucumber::Core::Ast::Step)}.map{|step| "#{step.keyword}#{step.name}"}.join("\n")
+      data = {'title'=>extract_title(test_case),'type_id'=>(is_manual ? 7 : 1 ),'custom_steps'=>steps_as_string}
+      @conn.send_post("add_case/#{sub_section_id || suite_id}", data)
+    end
+
+    def send_result(test_case,result,id,testrun)
+      testrail_status = case 
+                        when result.passed?
+                          {id:1,comment: 'passed'}
+                        when result.failed?
+                          {id:5,comment: 'failed'}
+                        when result.undefined?
+                          {id:7,comment: 'undefined step'}
+                        when result.pending?
+                          {id:6,comment: 'pending step'}
+                        end
+      unless result.passed?
+        failure_message = <<-FAILURE
+        Error message: #{testrail_status[:comment]} #{result.exception.message}
+        Step: #{@failed_step[:step].source.last.keyword}#{@failed_step[:step].source.last.name}
+        Location: #{@failed_step[:step].source.last.file_colon_line}
+        FAILURE
+      else
+        failure_message = nil
+      end
+      defects = test_case.tags.select{|tag| tag.name =~/jira_/}.map{|ticket| /STORE-\d+/.match(ticket.name)[0]}.join(" ")
+      report_on_result =  {status_id:testrail_status[:id],comment:failure_message,defects:defects}
+      @conn.send_post("add_result_for_case/#{testrun}/#{id}",report_on_result)
+    end
+    def extract_title(test_case)
+      if test_case.source.last.is_a?(Cucumber::Core::Ast::ExamplesTable::Row)
+        title  = test_case.source.select{|s| s.is_a?(Cucumber::Core::Ast::ScenarioOutline)}.first.title
+        title += " "+test_case.source.last.send(:data).map{|key,value| "#{key}=#{value}"}.join(', ')
+      else
+        title = test_case.source.last.title
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: cukerail
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John Small
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Allows you to sync your Testrail testcases from feature files and send
+  test results into Testrail testruns
+email:
+- john.small@bbc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cukerail.gemspec
+- lib/cukerail.rb
+- lib/cukerail/version.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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Integrates Cucumber and Testrail from Gurock Software
+test_files: []