cukerail 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 982bc5b8489480f18b05ec0ba879f387b8ba32ce
-  data.tar.gz: ec916a3a62fa3fcf304ccc8b952a3b50e7480ab1
+  metadata.gz: 4d5e94039d69eaeda30dcd54079c8a6a32e54405
+  data.tar.gz: 5de856db7882e048d153b3363d4416747e7c399d
 SHA512:
-  metadata.gz: 2b00406acf979ee5add3bf25deda6979457ab5bf59e5efedbcfc62eed9cba303a6b4b6041768877630c28ba0adbb62268d5eca61401f21fa654067e80f6624c9
-  data.tar.gz: 5048aa64d6f6544c199a39768375201bc5d97c12ddf09d78816cfc753d504524f6dde6eba5769659a8981ddf86e35bf0348ca0b58d3dae877f9786e1a06c9e24
+  metadata.gz: 8cee48c1ec2d56dc332dccd445fde07232d67a7a9c419fce54f4e241e2e2ee0cb42f58b07883cb966bfd211be9ddbdeb26c30c959fe402db1da9534f7df1a77d
+  data.tar.gz: 8981b323ad57e7d668c304f9433f45ecb474ebf9ef11e7eab0a19b933c61bfbf8b5c500899f6128feba6c9bdccfe53d7b19479ae39f8f4e0f7697cee3133b531

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
-
+import './lib/tasks/cukerail.rake'
 # Default directory to look in is `/specs`
 # # Run with `rake spec`
 RSpec::Core::RakeTask.new(:spec) do |task|

data/lib/cukerail/version.rb

@@ -1,3 +1,3 @@
 module Cukerail
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/json_sender.rb

@@ -0,0 +1,171 @@
+require_relative "cukerail/version"
+require_relative "cukerail/testrail"
+require 'json' unless JSON 
+module Cukerail
+  class JsonSender
+    attr_reader :testrail_api_client,:results
+    def initialize(json_file)
+      if %w(BASE_URL USER PASSWORD).map{|e| ENV["TESTRAIL_#{e}"]}.any?{|e| e=='' || !e}
+        raise 'You need to setup Testrail environment parameters see https://bbcworldwide.atlassian.net/wiki/display/BAR/Installing+and+Running+Cukerail' 
+      end
+      @testrail_api_client = TestRail::APIClient.new(ENV['TESTRAIL_BASE_URL'],ENV['TESTRAIL_USER'],ENV['TESTRAIL_PASSWORD'])
+      @results = JSON.parse(File.read(json_file)).select{|f| f['tags']}
+    end
+
+    def each_feature
+      results.each do |feature|
+        scenarios = feature['elements'].reject{|e| e['keyword']=='Background'}.select{|e| e['type'] == 'scenario'}
+        project_id,suite_id,sub_section_id,background_steps = extract_top_level_data(feature)
+        yield scenarios,project_id,suite_id,sub_section_id,background_steps
+      end
+    end
+
+
+    def get_id(scenario,background_steps,project_id,suite_id,sub_section_id)
+      title = get_name(scenario)
+      found_case = testrail_api_client.send_get("get_cases/#{project_id}&suite_id=#{suite_id}").select{|c| c['title'] == title}.first
+      if found_case
+        result= found_case['id']
+      else
+        result = create_new_case(scenario,background_steps,project_id,suite_id,sub_section_id)['id']
+      end
+      return result
+    end
+
+    def extract_top_level_data(feature)
+      project_id = feature['tags'].select{|j| j['name']=~/project_\d+/}.map{|j| /project_(\d+)/.match(j['name'])[1].to_i}.first
+      suite_id = feature['tags'].select{|j| j['name']=~/suite_\d+/}.map{|j| /suite_(\d+)/.match(j['name'])[1].to_i}.first
+      sub_section_id = feature['tags'].select{|j| j['name']=~/sub_section_\d+/}.map{|j| /sub_section_(\d+)/.match(j['name'])[1].to_i}.first
+      background=feature['elements'].select{|e| e['keyword']=='Background'}.first
+      background_steps = background['steps'].map{|s| s['keyword']+s['name']}.join("\n")
+      return project_id,suite_id,sub_section_id,background_steps
+    end
+
+    def get_name(scenario)
+      base_name = scenario['name']
+      outline_number_str = scenario['id'].split(';').select{|e| e =~/^\d+$/}.first
+      if outline_number_str
+        outline_number = (outline_number_str.to_i) -1
+      end
+      tags= [scenario['tags']].flatten.compact
+      requirement = tags.select{|t| t['name'] =~/@req/}.map{|t| /@req_(\w+)/.match(t['name'])[1]}.first unless tags.empty?
+      [requirement, base_name, outline_number].join(' ').strip
+    end
+
+    def create_new_case(scenario,background_steps,project_id,suite_id,sub_section_id)
+      data = prepare_data(scenario,background_steps)
+      testrail_api_client.send_post("add_case/#{sub_section_id || suite_id}", data)
+    end
+
+    def send_steps(scenario,background_steps,testcase_id)
+      data = prepare_data(scenario,background_steps)
+      testrail_api_client.send_post("update_case/#{testcase_id}",data)
+    end
+
+    def prepare_data(scenario,background_steps)
+      steps = background_steps + "\n" + scenario['steps'].map{|s| s['keyword']+s['name']}.join("\n")
+      is_manual = scenario['tags'].any?{|tag| tag['name'] =~/manual/} if scenario['tags']
+      data = {'title'=>get_name(scenario),
+              'type_id'=>(is_manual ? 7 : 1 ),
+              'custom_steps'=>steps,
+              'refs'=>defects(scenario)
+      }
+    end
+
+    def defects(scenario)
+      if scenario['tags']
+        scenario['tags'].select{|t| t['name'] =~/@jira_/}.map{|t| /jira_(\w+-\w+)/.match(t['name'])}.join(' ')
+      end
+    end
+
+    def send_result(scenario,id,testrun)
+      error_line = scenario['steps'].select{|s| s['result']['status'] != 'passed'}.first 
+      if error_line
+        puts error_line['result']
+        testrail_status = case error_line['result']['status']
+                          when 'failed'
+                            {id:5,comment: 'failed'}
+                          when 'undefined'
+                            {id:7,comment: 'undefined step'}
+                          when  'pending'
+                            {id:6,comment: 'pending step'}
+                          when  'skipped'
+                            {id:5,comment: 'failed in before hook'}
+                          end
+        error_result = error_line['error_message']
+        failure_message = <<-FAILURE
+        Error message: #{testrail_status[:comment]} #{error_result}
+        Step: #{error_line['keyword']} #{error_line['name']}
+        Location: #{error_line['match']['location']}
+        FAILURE
+      else
+        testrail_status = {id:1,comment: 'passed'}
+        failure_message = nil
+      end
+      report_on_result =  {status_id:testrail_status[:id],comment:failure_message,defects:defects(scenario)}
+      begin
+        testrail_api_client.send_post("add_result_for_case/#{testrun}/#{id}",report_on_result)
+      rescue => e
+        if e.message =~ /No \(active\) test found for the run\/case combination/
+          add_case_to_test_run(id,testrun)
+          retry
+        else
+          puts "#{e.message} testrun=#{testrun} test case id=#{id}"
+        end
+      end
+    end
+
+    def get_run(run_id)
+      testrail_api_client.send_get("get_run/#{run_id}")
+    end
+
+    def get_tests_in_a_run(run_id)
+      testrail_api_client.send_get("get_tests/#{run_id}")
+    end
+
+    def update_run(testrun,case_ids)
+      begin
+        testrail_api_client.send_post("update_run/#{testrun}",case_ids)
+      rescue => e
+        puts "#{e.message} testrun=#{testrun} test case ids=#{case_ids}"
+      end
+    end
+
+    def remove_case_from_test_run(testcase,testrun)
+      testcase_id = get_id(testcase)
+      run = get_run(testrun)
+      unless run['include_all']
+        case_ids = get_tests_in_a_run(testrun).map{|h| h['case_id']} - [testcase_id]
+        update_run(testrun,{'case_ids'=>case_ids})
+      end
+    end
+
+    def add_case_to_test_run(testcase_id,testrun)
+      run = get_run(testrun)
+      unless run['include_all']
+        case_ids = get_tests_in_a_run(testrun).map{|h| h['case_id']} + [testcase_id]
+        update_run(testrun,{'case_ids'=>case_ids})
+      end
+    end
+
+    def remove_all_except_these_cases_from_testrun(testcases,testrun)
+      run = get_run(testrun)
+      unless run['include_all']
+        case_ids = get_tests_in_a_run(testrun).map{|h| h['case_id']} & testcases
+        update_run(testrun,{'case_ids'=>case_ids})
+      end
+    end
+
+    def remove_all_except_these_cases_from_suite(testcases,project_id,suite_id)
+      puts '=== testcases === '
+      puts testcases
+      existing_cases = testrail_api_client.send_get("get_cases/#{project_id}&suite_id=#{suite_id}").map{|m| m['id']}
+      puts '===== existing_cases === '
+      puts existing_cases
+      (existing_cases - testcases).each do |case_to_remove|
+        puts "case_to_remove #{case_to_remove}"
+        testrail_api_client.send_post("delete_case/#{case_to_remove}",nil)
+      end
+    end
+  end
+end

data/lib/tasks/cukerail.rake

@@ -0,0 +1,71 @@
+require_relative '../json_sender'
+desc 'load a json results file into a test suite'
+task :load_to_suite do
+  raise 'You must have JSON=filename on the command line' unless ENV['JSON']
+  json_sender =Cukerail::JsonSender.new(ENV['JSON'])
+  features = json_sender.results
+  #only work with feature files that have tags set up
+  features.select{|f| f['tags']}.each do | feature |
+    # project_id = feature['tags'].select{|j| j['name']=~/project_\d+/}.map{|j| /project_(\d+)/.match(j['name'])[1].to_i}.first
+    # suite_id = feature['tags'].select{|j| j['name']=~/suite_\d+/}.map{|j| /suite_(\d+)/.match(j['name'])[1].to_i}.first
+    # sub_section_id = feature['tags'].select{|j| j['name']=~/sub_section_\d+/}.map{|j| /sub_section_(\d+)/.match(j['name'])[1].to_i}.first
+    # background=feature['elements'].select{|e| e['keyword']=='Background'}.first
+    # background_steps = background['steps'].map{|s| s['keyword']+s['name']}.join("\n")
+    project_id,suite_id,sub_section_id,background_steps = json_sender.extract_top_level_data(feature)
+    feature['elements'].reject{|e| e['keyword']=='Background'}.select{|e| e['type'] == 'scenario'}.each do | scenario |
+      testcase_id = json_sender.get_id(scenario,background_steps,project_id,suite_id,sub_section_id) if scenario['type'] == 'scenario'
+      puts "testcase_id = #{testcase_id}"
+      json_sender.send_steps(scenario,background_steps,testcase_id)
+    end
+  end
+end
+
+desc 'load a json results file into a test run'
+task :load_to_test_run do
+  raise 'You must have TESTRUN=testrun_number on the command line' unless ENV['TESTRUN']
+  json_sender =Cukerail::JsonSender.new(ENV['JSON'])
+  #only work with feature files that have tags set up
+  json_sender.each_feature do | scenarios,project_id,suite_id,sub_section_id,background_steps |
+    scenarios.each do | scenario |
+    testcase_id = json_sender.get_id(scenario,background_steps,project_id,suite_id,sub_section_id)
+    puts "scenario_id #{scenario['id']} testcase_id = #{testcase_id}"
+    json_sender.send_steps(scenario,background_steps,testcase_id)
+    json_sender.send_result(scenario,testcase_id,ENV['TESTRUN'])
+  end
+  end
+end
+
+desc "remove cases from a test run that are aren't in the json results"
+task :remove_from_test_run do
+  raise 'You must have TESTRUN=testrun_number on the command line' unless ENV['TESTRUN']
+  raise 'You must have JSON=filename on the command line' unless ENV['JSON']
+  json_sender =Cukerail::JsonSender.new(ENV['JSON'])
+  testcase_ids = []
+  json_sender.each_feature do | scenarios,project_id,suite_id,sub_section_id,background_steps |
+    scenarios.each do | scenario |
+    testcase_ids << json_sender.get_id(scenario,background_steps,project_id,suite_id,sub_section_id)
+  end  
+  end  
+  json_sender.remove_all_except_these_cases_from_testrun(testcase_ids,ENV['TESTRUN'])
+end
+
+desc "match test run cases to json results file"
+task match_to_test_run: [:remove_from_test_run,:load_to_test_run] do 
+end
+
+desc "remove cases from a test suite that aren't in the json results"
+task :remove_from_test_suite do
+  raise 'You must have JSON=filename on the command line' unless ENV['JSON']
+  json_sender =Cukerail::JsonSender.new(ENV['JSON'])
+  testcase_ids = []
+  ex_project_id = 0
+  ex_suite_id = 0
+  json_sender.each_feature do | scenarios,project_id,suite_id,sub_section_id,background_steps |
+    ex_project_id = project_id
+    ex_suite_id = suite_id
+    scenarios.each do | scenario |
+      testcase_ids << json_sender.get_id(scenario,background_steps,project_id,suite_id,sub_section_id)
+    end  
+  end  
+  json_sender.remove_all_except_these_cases_from_suite(testcase_ids,ex_project_id,ex_suite_id)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cukerail
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - John Small
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,8 @@ files:
 - lib/cukerail.rb
 - lib/cukerail/testrail.rb
 - lib/cukerail/version.rb
+- lib/json_sender.rb
+- lib/tasks/cukerail.rake
 - spec/cukerail_spec.rb
 - spec/spec_helper.rb
 homepage: ''