itriagetestrail 1.0.36

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d3fb08d0333d280c30606a5cd177b439f668a94a8683bf0099c47dac4b563cc
+  data.tar.gz: 9dd89450a238a488c46783754df2ca4c312301e2e9dd807b31d30f01b80430e7
+SHA512:
+  metadata.gz: 64729b306598a415b93d91869a57d0be086772f39fe235159be11b17ea3e88c48186189207fe125ab0d93d9d9640db9de0da1817a829e210de94c89c4e41ce6d
+  data.tar.gz: ed2d5d73ea6c95e07d56f0b8355e0ec73b9d09420c083517e92f7500efa10f9971bc1822c96daf8d8b94834f272b393d33c986659251151bcfeacfe2d99e2db9

data/lib/itriagetestrail.rb

@@ -0,0 +1,254 @@
+# frozen_string_literal: true
+
+require_relative 'itriagetestrail/version'
+require_relative 'itriagetestrail/testrail_binding'
+
+require_relative 'itriagetestrail/pool'
+require_relative 'itriagetestrail/testrail_objects/milestones'
+require_relative 'itriagetestrail/testrail_objects/projects'
+require_relative 'itriagetestrail/testrail_objects/sections'
+require_relative 'itriagetestrail/testrail_objects/suites'
+require_relative 'itriagetestrail/testrail_objects/test_cases'
+require_relative 'itriagetestrail/testrail_objects/test_plans'
+require_relative 'itriagetestrail/testrail_objects/test_results'
+require_relative 'itriagetestrail/testrail_objects/test_runs'
+
+require 'tzinfo'
+
+module Itriagetestrail
+  class TestRailInterface
+    include Projects
+    include Suites
+    include Milestones
+    include Sections
+    include TestCases
+    include TestPlans
+    include TestRuns
+    include TestResults
+
+    attr_accessor :client
+    attr_accessor :sections
+    attr_accessor :test_cases
+    attr_accessor :test_case_ids
+    attr_accessor :run_id
+    attr_accessor :execute
+    attr_accessor :pool
+    attr_accessor :batch_size
+    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 testrail_online
+      # This is the very first call to TestRail
+      make_connection
+      projects
+      if @client.response_code == '200' || @client.response_code.nil?
+        true
+      else
+        puts "**** TESTRAIL IS OFFLINE for maintenance or other reason with status code #{@client.response_code}"
+        false
+      end
+    end
+
+    def _execute
+      @execute = if @testrail_config[:user].nil? || @testrail_config[:user].empty?
+                   false
+                 else
+                   testrail_online
+                 end
+    end
+
+    def initialize
+      @setup = false
+      config
+
+      if File.exist?(run_tempfile_name)
+        @run_id = File.read(run_tempfile_name)
+        @plan_id = File.read(plan_tempfile_name)
+        @shared_run = true
+      else
+        @run_id = 0
+        @plan_id = 0
+      end
+
+      @milestone_name = normalize_milestone
+      @jenkins_build = @testrail_config[:jenkinsBuild]
+      @app_version = @testrail_config[:appVersion]
+      @suite_name = @testrail_config[:suiteName]
+
+      _time_zone
+
+      _execute
+
+      clear_results
+      @submitted = { results: [] }
+
+      @external_results = { results: [] }
+      @batch_size = @testrail_config[:batch_size] || 0
+    end
+
+    def clear_results
+      @results = { results: [] }
+    end
+
+    def config
+      time_zone = if ENV['TZINFO_TIME_ZONE'].nil? || ENV['TZINFO_TIME_ZONE'].empty?
+                    'America/Denver'
+                  else
+                    ENV['TZINFO_TIME_ZONE']
+                  end
+
+      @testrail_config = {
+        site: ENV['TESTRAIL_SITE'],
+        user: ENV['TESTRAIL_USER'],
+        password: ENV['TESTRAIL_PASSWORD'],
+        tzinfoTimeZone: time_zone,
+        projectId: ENV['TESTRAIL_PROJECT_ID'],
+        milestone: ENV['TESTRAIL_MILESTONE'],
+        projectName: ENV['APP_NAME'],
+        suiteName: ENV['TESTRAIL_SUITE_NAME'],
+        run_id: ENV['TESTRAIL_RUN_ID'],
+        report_skips: ENV['TESTRAIL_REPORT_SKIPS'],
+        close_run: ENV['TESTRAIL_CLOSE_RUN'],
+        close_run_delay: ENV['TESTRAIL_CLOSE_RUN_DELAY'],
+        origin: ENV['GIT_BRANCH'],
+        jenkinsBuild: ENV['BUILD_NUMBER'],
+        appVersion: nil,
+        config: { ios: ENV['IOS_VERSION'],
+                  android: ENV['ANDROID_VERSION'],
+                  androidDevice: ENV['DEVICE_NAME'],
+                  browser: ENV['BROWSER_NAME'], # Jenkins: SELENIUM_BROWSER
+                  platform: ENV['PLATFORM'], # Jenkins: SELENIUM_PLATFORM
+                  browserVersion: ENV['BROWSER_VERSION'] } # Jenkins: SELENIUM_VERSION
+      }
+    end
+
+    # These are generic, hardcoded tag translations that map to test ids in TestRail
+    def tag_ids(tag_names = [])
+      tag_ids = []
+      tag_names.each do |tag_name|
+        case tag_name
+        when '@wip'
+          tag_ids << 1
+        when '@flaky'
+          tag_ids << 2
+        when '@broken'
+          tag_ids << 3
+        when '@missingTheSauce'
+          tag_ids << 4
+        end
+      end
+      tag_ids
+    end
+
+    def setup?
+      @setup
+    end
+
+    def setup
+      return false if setup?
+      return false unless execute
+
+      @results = { results: [] }
+      @submitted = { results: [] }
+
+      @external_results = { results: [] }
+      @batch_size = @testrail_config[:batch_size] || 0
+
+      initialize_variables
+
+      @milestone_id = fetch_milestone(@milestone_name)
+
+      reset_milestone(@milestone_name)
+
+      #Supports tagging
+      @testrail_case_fields = @client.send_get('get_case_fields')
+      @pool = Pool.new(1)
+      @setup = true
+    end
+    
+    def create_run_id 
+      # TODO: Look into configuration_ids to add a plan
+      add_testrail_run if @run_id.to_i.zero?
+    end
+
+    def initialize_variables
+      make_connection
+      # Set the project id
+      set_project
+      # Get the test rail suites
+      testrail_suites
+      # Get the test rail sections
+      testrail_sections
+      # Get the test rail ids
+      testrail_ids
+      # Populate configurations
+      configurations
+    end
+
+    def run_tempfile_name
+      "./tmp/#{@testrail_config[:jenkinsBuild]}_testrail_run_id"
+    end
+
+    def plan_tempfile_name
+      "./tmp/#{@testrail_config[:jenkinsBuild]}_testrail_plan_id"
+    end
+
+    def make_connection
+      @client = TestRail::APIClient.new(@testrail_config[:site])
+      @client.user = @testrail_config[:user]
+      @client.password = @testrail_config[:password]
+    end
+
+    def close_run?
+      # do not close a run if a run id was supplied.  other test suites related to the job will need it.
+      close_run = false
+      if @testrail_config[:close_run] == 'true' && (@testrail_config[:run_id].nil? || @testrail_config[:run_id].empty?)
+        close_run = true
+      end
+      close_run
+    end
+
+    # This method is only used publicly
+    def delete_temp_files
+      File.delete(run_tempfile_name) if File.exist?(run_tempfile_name)
+      File.delete(plan_tempfile_name) if File.exist?(plan_tempfile_name)
+    end
+
+    # This method is only used publicly
+    def initialize_temp_files
+      Dir.mkdir('./tmp') unless File.exist?('./tmp')
+      File.write(run_tempfile_name, @run_id)
+      File.write(plan_tempfile_name, @plan_id)
+
+      @shared_run = true
+    end
+
+    def close_run(run_id = @run_id, message = '')
+      # A delay is recommended to prevent an HTTP 400 race condition where final results are still
+      # being populated in the TESTRAIL DB while a close_run has been requested.
+
+      close_run_delay = @testrail_config[:close_run_delay] || 5
+      sleep close_run_delay.to_i
+      @client.send_post("update_run/#{run_id}",
+                        include_all: false, case_ids: existing_cases_from_run(run_id),
+                        description: 'Timestamp: ' + @time_zone.now.strftime('%m/%d/%Y %I:%M %p') +
+                            "\nBranch: #{@testrail_config[:origin]}" + "\n#{message}")
+
+      @client.send_post("close_run/#{run_id}", {})
+    end
+
+    def shutdown(message = '')
+      @pool.shutdown
+
+      close_run(message) if close_run?
+    end
+  end
+end

data/lib/itriagetestrail/framework_bindings/trcucumber13.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+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
+      @scenario_tags = scenario.source_tag_names
+    end
+
+    def record_result(scenario)
+      return if execute == false
+      begin
+        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}")
+        end
+      rescue StandardError => exception
+        puts "TESTRAIL ENCOUNTERED AN ERROR: #{exception}\n #{@external_id} \n\n"
+      end
+    end
+
+    def shutdown
+      return unless execute
+      sleep 3 # testrail service rate limit precaution
+      send_results_to_testrail
+      super
+    end
+  end
+end

data/lib/itriagetestrail/framework_bindings/trcucumber20.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+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
+      @scenario_tags = scenario.source_tag_names
+    end
+
+    def record_result(scenario)
+      return if execute == false
+      begin
+        scenario_title_and_external_id(scenario)
+
+        @scenario_steps = scenario.test_steps.select { 'name' }.collect(&:name).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}")
+        end
+      rescue StandardError => exception
+        puts "TESTRAIL ENCOUNTERED AN ERROR: #{exception}\n #{@external_id} \n\n"
+      end
+    end
+
+    def shutdown
+      return unless execute
+      sleep 3 # testrail service rate limit precaution
+      send_results_to_testrail
+      super
+    end
+  end
+end

data/lib/itriagetestrail/framework_bindings/trcucumber30.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+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
+      @scenario_tags = scenario.source_tag_names
+    end
+
+    def record_result(scenario)
+      return if execute == false
+      begin
+        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}")
+        end
+      rescue StandardError => exception
+        puts "TESTRAIL ENCOUNTERED AN ERROR: #{exception}\n #{@external_id} \n\n"
+      end
+    end
+
+    def shutdown
+      return unless execute
+      sleep 3 # testrail service rate limit precaution
+      send_results_to_testrail
+      super
+    end
+  end
+end

data/lib/itriagetestrail/framework_bindings/trminitest.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'itriagetestrail'
+module Itriagetestrail
+  class TRMiniTest < TestRailInterface
+    def record_result(test, failures)
+      return if execute == false
+      begin
+        @external_id = "#{test.class}##{test.name}"
+        if test.passed?
+          store_result(test.name, @external_id, '', 1, '')
+        elsif failures.inspect.include? 'Minitest::Skip'
+          store_result(test.name, @external_id, '', 6, failures.inspect)
+        else
+          store_result(test.name, @external_id, '', 5, failures.inspect)
+        end
+      rescue StandardError => exception
+        puts "TESTRAIL ENCOUNTERED AN ERROR: #{exception}\n #{@external_id} \n\n"
+      end
+    end
+
+    def shutdown
+      return unless execute
+      sleep 3 # testrail service rate limit precaution
+      send_results_to_testrail
+      super
+    end
+  end
+end

data/lib/itriagetestrail/pool.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class Pool
+  def initialize(size)
+    @size = size
+    @jobs = Queue.new
+
+    @pool = Array.new(@size) do |i|
+      Thread.new do
+        Thread.current[:id] = i
+
+        catch(:exit) do
+          loop do
+            job, args = @jobs.pop
+            job.call(*args)
+          end
+        end
+      end
+    end
+  end
+
+  def schedule(*args, &block)
+    @jobs << [block, args]
+  end
+
+  def shutdown
+    @size.times do
+      schedule { throw :exit }
+    end
+
+    @pool.map(&:join)
+  end
+end