itriagetestrail 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f35d2994320ffa218fcd8ab70a15b9b97e23b07a
-  data.tar.gz: 7448966bf55811e48f275701d95f6bdbefc7e1c1
+  metadata.gz: 10cdea2dd4ae8d6f5dbd2cbe96e9083d90b556aa
+  data.tar.gz: 8a6bf7878edd7504570caafbf707f6f2ae49720b
 SHA512:
-  metadata.gz: a4242607687c8b7d51d025810e66fc7a9cf67f9b8dc84d4f8b7504a53ebcbef9d9aae8dc1b78f4a0378a5d6ebf10c33f127867c2f61f7a9204991636f91dc42d
-  data.tar.gz: 70e37c17bee8cb1f4ba95ac4d28d0eb13c8177e04a20b17f242dc49b4f71947b2177f7d2a6d3e5060bbe390cf79371ef1353d67d5e80332e05cb65aba58d9997
+  metadata.gz: 18fc8c673d326c649658fd91a87424131100fef5373f4b740a8698dc43207664be64701c0acf26bbdcdc111e2a4b4fb9623d199ecf3496dbd932886cd231200e
+  data.tar.gz: d33b1178702724ba819ecc293a85e86687550b470a43307b3d140d01aa62665e3fc7d2b9501de97334b63ed5c5b38d494e9bf6fc81f3d0b5efd56b5eab4c3e2d

data/lib/itriagetestrail.rb

@@ -37,6 +37,22 @@ module Itriagetestrail
     attr_reader :results
     attr_reader :external_results
 
+    def _time_zone
+      @time_zone = if @testrail_config[:tzinfoTimeZone].nil? || @testrail_config[:tzinfoTimeZone].empty?
+                     TZInfo::Timezone.get('UTC')
+                   else
+                     TZInfo::Timezone.get(@testrail_config[:tzinfoTimeZone])
+                   end
+    end
+
+    def _execute
+      @execute = if @testrail_config[:user].nil? || @testrail_config[:user].empty?
+                   false
+                 else
+                   true
+                 end
+    end
+
     def initialize
       @setup = false
       config
@@ -55,17 +71,9 @@ module Itriagetestrail
       @app_version = @testrail_config[:appVersion]
       @suite_name = @testrail_config[:suiteName]
 
-      @time_zone = if @testrail_config[:tzinfoTimeZone].nil? || @testrail_config[:tzinfoTimeZone].empty?
-                     TZInfo::Timezone.get('UTC')
-                   else
-                     TZInfo::Timezone.get(@testrail_config[:tzinfoTimeZone])
-                   end
+      _time_zone
 
-      @execute = if @testrail_config[:user].nil? || @testrail_config[:user].empty?
-                   false
-                 else
-                   true
-                 end
+      _execute
 
       clear_results
       @submitted = { results: [] }
@@ -146,12 +154,8 @@ module Itriagetestrail
 
       reset_milestone(@milestone_name)
 
-      if !configuration_ids.empty? && false # disable configurations for now
-        add_testrail_plan if @plan_id == 0
-        add_plan_entry if @run_id == 0
-      else
-        add_testrail_run if @run_id == 0
-      end
+      # TODO: Look into configuration_ids to add a plan
+      add_testrail_run if @run_id.zero?
 
       @pool = Pool.new(1)
 

data/lib/itriagetestrail/framework_bindings/trcucumber13.rb

@@ -3,27 +3,32 @@
 require 'itriagetestrail'
 module Itriagetestrail
   class TRCucumber13 < TestRailInterface
+    def scenario_title_and_external_id(scenario)
+      if scenario.class.to_s == 'Cucumber::Ast::OutlineTable::ExampleRow'
+        scenario_cell_id = []
+        scenario.name.split('|')[1..50].each { |cell| scenario_cell_id << cell.gsub(/[\| "]/, '') }
+        @scenario_title = "#{scenario.scenario_outline.title}, Example: #{scenario_cell_id}"
+        @external_id = "#{scenario.scenario_outline.feature.name};#{@scenario_title}"[0, 249]
+        @scenario_steps = scenario.scenario_outline.raw_steps.select { 'name' }.collect(&:name).join("\n")
+      else
+        #    identifiers: scenario.feature.name, scenario.name
+        @external_id = "#{scenario.feature.title};#{scenario.title}"
+        @scenario_title = scenario.title
+        @scenario_steps = scenario.steps.select { 'name' }.collect(&:name).join("\n")
+      end
+    end
+
     def record_result(scenario)
       return if execute == false
       begin
-        if scenario.class.to_s == 'Cucumber::Ast::OutlineTable::ExampleRow'
-          scenario_cell_id = []
-          scenario.name.split('|')[1..50].each { |cell| scenario_cell_id << cell.gsub(/[\| "]/, '') }
-          @scenario_title = "#{scenario.scenario_outline.title}, Example: #{scenario_cell_id}"
-          @external_id = "#{scenario.scenario_outline.feature.name};#{@scenario_title}"[0, 249]
-          @scenario_steps = scenario.scenario_outline.raw_steps.select { 'name' }.collect(&:name).join("\n")
-        else
-          #    identifiers: scenario.feature.name, scenario.name
-          @external_id = "#{scenario.feature.title};#{scenario.title}"
-          @scenario_title = scenario.title
-          @scenario_steps = scenario.steps.select { 'name' }.collect(&:name).join("\n")
-        end
+        scenario_title_and_external_id(scenario)
 
         if scenario.passed?
           store_result(@scenario_title, @external_id, @scenario_steps, 1, '')
         else
           store_result(@scenario_title, @external_id, @scenario_steps,
-                       (ENV['RERUN'] ? 5 : 4).to_s.to_i, "#{scenario.exception.class}\n#{scenario.exception}\n#{scenario.exception.backtrace}")
+                       (ENV['RERUN'] ? 5 : 4).to_s.to_i, "#{scenario.exception.class}\n" \
+                       "#{scenario.exception}\n#{scenario.exception.backtrace}")
         end
       rescue StandardError => exception
         puts "TESTRAIL ENCOUNTERED AN ERROR: #{exception}\n #{@external_id} \n\n"
@@ -31,11 +36,10 @@ module Itriagetestrail
     end
 
     def shutdown
-      if execute
-        sleep 3 # testrail service rate limit precaution
-        send_results_to_testrail
-        super
-      end
+      break unless execute
+      sleep 3 # testrail service rate limit precaution
+      send_results_to_testrail
+      super
     end
   end
 end

data/lib/itriagetestrail/framework_bindings/trcucumber20.rb

@@ -3,17 +3,21 @@
 require 'itriagetestrail'
 module Itriagetestrail
   class TRCucumber20 < TestRailInterface
+    def scenario_title_and_external_id(scenario)
+      if scenario.class.to_s == 'Cucumber::RunningTestCase::ScenarioOutlineExample'
+        scenario.cell_values.each { |cell| cell.gsub!(/\s+/, '') }
+        @scenario_title = "#{scenario.name.match(/\b.*Example/)}: #{scenario.cell_values}"
+        @external_id = "#{scenario.feature.short_name}\;#{@scenario_title}"[0, 249]
+      else
+        @external_id = "#{scenario.feature.short_name}\;#{scenario.name}"
+        @scenario_title = scenario.name
+      end
+    end
+
     def record_result(scenario)
       return if execute == false
       begin
-        if scenario.class.to_s == 'Cucumber::RunningTestCase::ScenarioOutlineExample'
-          scenario.cell_values.each { |cell| cell.gsub!(/\s+/, '') }
-          @scenario_title = "#{scenario.name.match(/\b.*Example/)}: #{scenario.cell_values}"
-          @external_id = "#{scenario.feature.short_name}\;#{@scenario_title}"[0, 249]
-        else
-          @external_id = "#{scenario.feature.short_name}\;#{scenario.name}"
-          @scenario_title = scenario.name
-        end
+        scenario_title_and_external_id(scenario)
 
         @scenario_steps = scenario.test_steps.select { 'name' }.collect(&:name).join("\n")
 
@@ -21,7 +25,8 @@ module Itriagetestrail
           store_result(@scenario_title, @external_id, @scenario_steps, 1, '')
         else
           store_result(@scenario_title, @external_id, @scenario_steps,
-                       (ENV['RERUN'] ? 5 : 4).to_s.to_i, "#{scenario.exception.class}\n#{scenario.exception}\n#{scenario.exception.backtrace}")
+                       (ENV['RERUN'] ? 5 : 4).to_s.to_i, "#{scenario.exception.class}\n" \
+                       "#{scenario.exception}\n#{scenario.exception.backtrace}")
         end
       rescue StandardError => exception
         puts "TESTRAIL ENCOUNTERED AN ERROR: #{exception}\n #{@external_id} \n\n"
@@ -29,11 +34,10 @@ module Itriagetestrail
     end
 
     def shutdown
-      if execute
-        sleep 3 # testrail service rate limit precaution
-        send_results_to_testrail
-        super
-      end
+      break unless execute
+      sleep 3 # testrail service rate limit precaution
+      send_results_to_testrail
+      super
     end
   end
 end

data/lib/itriagetestrail/framework_bindings/trcucumber30.rb

@@ -3,27 +3,30 @@
 require 'itriagetestrail'
 module Itriagetestrail
   class TRCucumber30 < TestRailInterface
+    def scenario_title_and_external_id(scenario)
+      if scenario.class.to_s == 'Cucumber::RunningTestCase::ScenarioOutlineExample'
+        # Remove spaces within cells to match our Cucumber 1.3 implementation
+        scenario.cell_values.each { |cell| cell.gsub!(/\s+/, '') }
+        @scenario_title = "#{scenario.name.match(/\b.*Example/)}: #{scenario.cell_values}"
+        @external_id = "#{scenario.feature.short_name}\;#{@scenario_title}"[0, 249]
+      else
+        @external_id = "#{scenario.feature.short_name}\;#{scenario.name}"
+        @scenario_title = scenario.name
+      end
+    end
+
     def record_result(scenario)
       return if execute == false
       begin
-        if scenario.class.to_s == 'Cucumber::RunningTestCase::ScenarioOutlineExample'
-
-          # Remove spaces within cells to match our Cucumber 1.3 implementation
-          scenario.cell_values.each { |cell| cell.gsub!(/\s+/, '') }
-          @scenario_title = "#{scenario.name.match(/\b.*Example/)}: #{scenario.cell_values}"
-          @external_id = "#{scenario.feature.short_name}\;#{@scenario_title}"[0, 249]
-        else
-          @external_id = "#{scenario.feature.short_name}\;#{scenario.name}"
-          @scenario_title = scenario.name
-        end
-
+        scenario_title_and_external_id(scenario)
         @scenario_steps = scenario.test_steps.collect(&:text).join("\n")
 
         if scenario.passed?
           store_result(@scenario_title, @external_id, @scenario_steps, 1, '')
         else
           store_result(@scenario_title, @external_id, @scenario_steps,
-                       (ENV['RERUN'] ? 5 : 4).to_s.to_i, "#{scenario.exception.class}\n#{scenario.exception}\n#{scenario.exception.backtrace}")
+                       (ENV['RERUN'] ? 5 : 4).to_s.to_i, "#{scenario.exception.class}" \
+                       "\n#{scenario.exception}\n#{scenario.exception.backtrace}")
         end
       rescue StandardError => exception
         puts "TESTRAIL ENCOUNTERED AN ERROR: #{exception}\n #{@external_id} \n\n"
@@ -31,11 +34,10 @@ module Itriagetestrail
     end
 
     def shutdown
-      if execute
-        sleep 3 # testrail service rate limit precaution
-        send_results_to_testrail
-        super
-      end
+      break unless execute
+      sleep 3 # testrail service rate limit precaution
+      send_results_to_testrail
+      super
     end
   end
 end

data/lib/itriagetestrail/framework_bindings/trminitest.rb

@@ -20,11 +20,10 @@ module Itriagetestrail
     end
 
     def shutdown
-      if execute
-        sleep 3 # testrail service rate limit precaution
-        send_results_to_testrail
-        super
-      end
+      break unless execute
+      sleep 3 # testrail service rate limit precaution
+      send_results_to_testrail
+      super
     end
   end
 end

data/lib/itriagetestrail/testrail_binding.rb

@@ -74,7 +74,24 @@ module TestRail
       conn
     end
 
-    private
+    def _parse_result(response)
+      if response.body && !response.body.empty?
+        JSON.parse(response.body)
+      else
+        {}
+      end
+    end
+
+    def _error_check(response, result)
+      break if response.code == '200'
+      error = if result&.key?('error')
+                '"' + result['error'] + '"'
+              else
+                'No additional error message received'
+              end
+      raise APIError, format('TestRail API returned HTTP %<response_code>s\n%<error>s',
+                             response_code: response.code, error: error)
+    end
 
     def _send_request(method, uri, data)
       url = URI.parse(@url + uri)
@@ -97,7 +114,8 @@ module TestRail
           sleep(response.header['retry-after'].to_i)
         elsif response.code == '500'
           puts response.to_s
-          # this might require different handling for 500 'Deadlock found when trying to get lock; try restarting transaction'
+          # this might require different handling for 500 'Deadlock found when
+          # trying to get lock; try restarting transaction'
           sleep(2)
         else
           break
@@ -105,20 +123,9 @@ module TestRail
         retry_count += 1
       end
 
-      result = if response.body && !response.body.empty?
-                 JSON.parse(response.body)
-               else
-                 {}
-               end
-
-      if response.code != '200'
-        error = if result&.key?('error')
-                  '"' + result['error'] + '"'
-                else
-                  'No additional error message received'
-                end
-        raise APIError, format('TestRail API returned HTTP %s (%s)', response.code, error)
-      end
+      result = _parse_result(response)
+
+      _error_check(response, result)
 
       result
     end

data/lib/itriagetestrail/testrail_objects/milestones.rb

@@ -4,24 +4,28 @@ require 'tzinfo'
 
 module Itriagetestrail
   module Milestones
+    def normalize_origin
+      case @testrail_config[:origin]
+      when 'prd', 'production', 'origin/production'
+        'Production'
+      when 'stg', 'staging', 'origin/staging'
+        'Staging'
+      when 'dev', 'development', 'origin/development'
+        'Development'
+      when 'local', ''
+        'Local'
+      when 'master', 'origin/master'
+        'Master'
+      else
+        'Dev Branch'
+      end
+    end
+
     # Establish the milestone name based on origin passed in,
     # usually origin represents a branch or environment
     def normalize_milestone
       if @testrail_config[:milestone].nil? || @testrail_config[:milestone].empty?
-        case @testrail_config[:origin]
-        when 'prd', 'production', 'origin/production'
-          'Production'
-        when 'stg', 'staging', 'origin/staging'
-          'Staging'
-        when 'dev', 'development', 'origin/development'
-          'Development'
-        when 'local', ''
-          'Local'
-        when 'master', 'origin/master'
-          'Master'
-        else
-          'Dev Branch'
-        end
+        normalize_origin
       else
         @testrail_config[:milestone]
       end
@@ -113,19 +117,19 @@ module Itriagetestrail
     def rename_milestone(id, new_name)
       # TODO: rename milestone with previous_milestone
       body = { name: new_name }
-      res = @client.send_post("update_milestone/#{id}", body)['id']
+      @client.send_post("update_milestone/#{id}", body)['id']
     end
 
     # this archives a milestone at the turn of a quarter and creates a new one in its place
     def reset_milestone(milestone_name)
       runs = milestone_runs(milestone_name)
-      unless runs.empty?
-        last_run_time = Time.at(runs.last['completed_on'])
-        if last_run_time < milestone_period_start
-          rename_milestone(@milestone_id, milestone_archive_name(milestone_name, last_run_time))
-          @milestone_id = fetch_milestone(@milestone_name)
-        end
-      end
+      break if runs.empty?
+      last_run_time = Time.at(runs.last['completed_on'])
+
+      # if last run time is smaller than period start, do below
+      break unless last_run_time < milestone_period_start
+      rename_milestone(@milestone_id, milestone_archive_name(milestone_name, last_run_time))
+      @milestone_id = fetch_milestone(@milestone_name)
     end
   end
 end

data/lib/itriagetestrail/testrail_objects/test_cases.rb

@@ -51,13 +51,19 @@ module Itriagetestrail
     end
 
     def app_version_label
-      ''
-      "App Version:#{@app_version}" unless @app_version.nil? || @app_version == ''
+      if @app_version.nil? || @app_version == ''
+        ''
+      else
+        "App Version:#{@app_version}"
+      end
     end
 
     def jenkins_build_label
-      ''
-      " Jenkins Build:#{@jenkins_build}" unless @jenkins_build .nil? || @jenkins_build == ''
+      if @jenkins_build .nil? || @jenkins_build == ''
+        ''
+      else
+        " Jenkins Build:#{@jenkins_build}"
+      end
     end
 
     def time_zone_label

data/lib/itriagetestrail/testrail_objects/test_plans.rb

@@ -29,12 +29,12 @@ module Itriagetestrail
       @configuration_ids = []
 
       # evaluate @testrail_comfig
-      @configuration_ids << config_id('Browser', @testrail_config[:config][:browser]) unless @testrail_config[:config][:browser].nil?
-      @configuration_ids << config_id('Browser Version', @testrail_config[:config][:browserVersion]) unless @testrail_config[:config][:browserVersion].nil?
-      @configuration_ids << config_id('Platform', @testrail_config[:config][:platform]) unless @testrail_config[:config][:platform].nil?
-      @configuration_ids << config_id('Android Version', @testrail_config[:config][:android]) unless @testrail_config[:config][:android].nil?
-      @configuration_ids << config_id('Android Device', @testrail_config[:config][:androidDevice]) unless @testrail_config[:config][:androidDevice].nil?
-      @configuration_ids << config_id('IOS Version', @testrail_config[:config][:ios]) unless @testrail_config[:config][:ios].nil?
+      append_configuration_ids('Browser', @testrail_config[:config][:browser])
+      append_configuration_ids('Browser Version', @testrail_config[:config][:browserVersion])
+      append_configuration_ids('Platform', @testrail_config[:config][:platform])
+      append_configuration_ids('Android Version', @testrail_config[:config][:android])
+      append_configuration_ids('Android Device', @testrail_config[:config][:androidDevice])
+      append_configuration_ids('IOS Version', @testrail_config[:config][:ios])
 
       # remove the nils
       @configuration_ids.compact!
@@ -42,6 +42,10 @@ module Itriagetestrail
       @configuration_ids
     end
 
+    def append_configuration_ids(topic, configuration)
+      @configuration_ids << config_id(topic, configuration) unless configuration.nil?
+    end
+
     def add_testrail_plan
       body = {
         name: test_name,

data/lib/itriagetestrail/testrail_objects/test_results.rb

@@ -9,7 +9,7 @@ module Itriagetestrail
 
       begin
         send = { results: @results[:results] }
-        res = @client.send_post("add_results_for_cases/#{@run_id}", send)
+        @client.send_post("add_results_for_cases/#{@run_id}", send)
         clear_results
       rescue StandardError => e
         raise e

data/lib/itriagetestrail/testrail_objects/test_runs.rb

@@ -35,7 +35,7 @@ module Itriagetestrail
         milestone_id: @milestone_id
       }
 
-      unless @testrail_config[:include_all] || true
+      unless @testrail_config[:include_all] == 'true'
         body[:include_all] = false
         body[:case_ids] = @test_case_ids
       end

data/lib/itriagetestrail/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Itriagetestrail
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: itriagetestrail
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - a801069