itriagetestrail 1.0.36

data/lib/itriagetestrail/testrail_objects/test_cases.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module TestCases
+    # TestRail Cases
+    def testrail_ids
+      case @suite_mode
+      when 2, 3
+        @test_cases = @client.send_get("get_cases/#{@project_id}&suite_id=#{@suite_id}&type_id=3")
+      else
+        @test_cases = @client.send_get("get_cases/#{@project_id}&type_id=3")
+      end
+
+      @test_case_ids = []
+
+      @test_cases.each { |test_case| @test_case_ids << test_case['id'] }
+    end
+
+    def testrail_test_case_id(external_id)
+      res = -1
+      @test_cases.each do |test_case|
+        res = test_case['id'] if test_case['custom_external_case_id'] == external_id
+      end
+      res
+    end
+
+    def associate_result(external_id)
+      test_case_id = testrail_test_case_id(external_id)
+      # store the test case id with the local result
+      @results[:results].each do |result|
+        next unless result[:external_id] == external_id
+        @external_results[:results] << { case_id: test_case_id,
+                                         status_id: result['status_id'],
+                                         comment: result['comment'] }
+      end
+    end
+
+    # add the test case if it doesn't exist
+    def add_testrail_test_case(scenario_title, external_id, scenario_steps, section_id)
+      body = {
+        title: scenario_title,
+        custom_external_case_id: external_id,
+        custom_steps: scenario_steps,
+        type_id: 3
+      }
+
+      @client.send_post("add_case/#{section_id}", body)
+
+      # refresh test case ids
+      testrail_ids
+    end
+
+    def app_version_label
+      if @app_version.nil? || @app_version.empty?
+        ''
+      else
+        "App Version:#{@app_version}"
+      end
+    end
+
+    def jenkins_build_label
+      if @jenkins_build .nil? || @jenkins_build.empty?
+        ''
+      else
+        " Jenkins Build:#{@jenkins_build}"
+      end
+    end
+
+    def time_zone_label
+      ' (' + @time_zone.now.strftime('%-I:%M %p') + ')'
+    end
+
+    def test_name
+      ci_label = "#{app_version_label}#{jenkins_build_label}"
+
+      if ci_label.dup.strip.empty?
+        'Regression' + time_zone_label
+      else
+        ci_label + time_zone_label
+      end
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/test_plans.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module TestPlans
+    def configuration_group(name)
+      res = {}
+      @configurations.each do |config|
+        res = config if config['name'] == name
+      end
+      res
+    end
+
+    def config_id(name, value)
+      res = {}
+      configuration = configuration_group(name)
+
+      return nil if configuration.empty?
+      configuration['configs'].each do |config|
+        res = config['id'] if config['name'] == value
+      end
+      res
+    end
+
+    def configurations
+      @configurations = @client.send_get("get_configs/#{@project_id}")
+    end
+
+    def configuration_ids
+      @configuration_ids = []
+
+      # evaluate @testrail_comfig
+      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!
+
+      @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,
+        description: '',
+        milestone_id: @milestone_id
+      }
+
+      @plan = @client.send_post("add_plan/#{@project_id}", body)
+      # TODO: replace debugging
+      puts @plan.inspect
+
+      @plan_id = @plan['id']
+      # TODO: replace debugging
+      puts @plan_id.inspect
+    end
+
+    def add_plan_entry
+      # TODO: refactor redundant assignments of @suite_id
+      @suite_id = testrail_suite_id(@suite_name)
+      body = {
+        suite_id: @suite_id,
+        # TODO: replace hardcoded name
+        name: 'replace this with config description',
+        include_all: true,
+        # TODO: replace hardcoded config
+        config_ids: configuration_ids,
+        runs: [
+          {
+            include_all: true,
+            config_ids: configuration_ids
+          }
+        ]
+      }
+
+      @plan_entry = @client.send_post("add_plan_entry/#{@plan_id}", body)
+      # TODO: replace debugging
+      puts @plan_entry.inspect
+      @run_id = @plan_entry['runs'][0]['id']
+      # TODO: replace debugging
+      puts @run_id.inspect
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/test_results.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module TestResults
+    def send_results_to_testrail
+      return if @results[:results].empty?
+      # copy what is in the results
+      @submitted[:results] << @results[:results]
+
+      begin
+        send = { results: @results[:results] }
+        @client.send_post("add_results_for_cases/#{@run_id}", send)
+        clear_results
+      rescue StandardError => e
+        raise e
+      end
+    end
+
+    # In implementations where there is not an at_exit, parallel test threads can store results
+    # of tests from the completed test class into a batch file, so final processing sends all results
+    # at the very end of the job while avoiding rate limiting issues.
+    def store_results_to_batch_file
+      return if @results[:results].empty?
+      entry = {runId: @run_id, results: @results[:results]}
+
+      Dir.mkdir('./tmp') unless File.exist?('./tmp')
+      file = File.open("./tmp/batch", 'a')
+      file.write("#{entry}\n")
+      file.close
+
+      # keep track of what is submitted
+      @submitted[:results] << @results[:results]
+
+      # clear the buffer for next class
+      @results[:results] = []
+    end
+
+    # Use this method to read bulk records of results stored in the temp file, and send entire set as a
+    # post execution batch.
+    def send_batch_results_to_testrail
+      content = read_batch_file
+      begin
+        send = { results: content[:results] }
+        @client.send_post("add_results_for_cases/#{content[:runId]}", send)
+        clear_results
+      rescue StandardError => e
+        raise e
+      end
+    end
+
+    def read_batch_file
+      return unless File.exist?('./tmp/batch')
+      run_id = nil
+      results = []
+      File.open("./tmp/batch").each do |line|
+        content = eval(line)
+        unless run_id
+          run_id = content[:runId]
+        end
+          content[:results].each { |result| results << result }
+      end
+      {runId: run_id, results: results}
+    end
+
+    def update_test_suite(scenario_title, external_id, scenario_steps)
+      feature = external_id.split(';')[0].split('#')[0]
+
+      # if the testrail case does not exist, update cases
+      if testrail_test_case_id(external_id) == -1
+
+        section_id = testrail_section_id(feature)
+
+        # if the testrail section does not exist, update sections
+        section_id = add_testrail_section(feature) if section_id == -1
+
+        add_testrail_test_case(scenario_title, external_id, scenario_steps, section_id)
+        sleep 1
+
+        # Update Test Run
+        extend_testrail_run
+      end
+      # store the case id associated with the external_id
+      associate_result(external_id)
+    end
+
+    # Called during after_teardown, this saves the result of the test method or scenario
+    # into local memory for later processing
+    def store_result(scenario_title, external_id, scenario_steps, status_id, comment)
+      update_test_suite scenario_title, external_id, scenario_steps
+
+      case_id = testrail_test_case_id(external_id)
+      @results[:results] << {
+        case_id: case_id,
+        scenario_title: scenario_title,
+        external_id: external_id,
+        scenario_steps: scenario_steps,
+        status_id: status_id,
+        comment: comment,
+        custom_branch_name: @testrail_config[:origin]
+      }
+
+      # Pull Tag IDs
+      unless @scenario_tags.nil?
+
+        # https://github.com/cucumber/cucumber-ruby/blob/master/lib/cucumber/runtime.rb
+        # Test has to actually run in order to populate testrail.
+
+        testrail_tag_object = @testrail_case_fields.select { |field| field['system_name'] == 'custom_tags'}[0]
+        testrail_tag_items = testrail_tag_object['configs'][0]['options']['items'].split("\n")
+        scenario_tag_ids = []
+        @scenario_tags.each do |scenario_tag|
+          testrail_tag_items.each do | tag_item |
+            system_tag = tag_item.split(',')
+            if scenario_tag == system_tag[1]
+              scenario_tag_ids << system_tag[0].to_i
+            end
+          end
+        end
+
+        current_case = @test_cases.select { |item| item['id'] == case_id }[0]
+
+        testrail_case_tag_ids = current_case['custom_tags']
+        testrail_case_steps = current_case['custom_steps']
+
+        if testrail_case_tag_ids == scenario_tag_ids || testrail_case_steps == @scenario_steps
+          @client.send_post("update_case/#{case_id}", { 'custom_tags': scenario_tag_ids, 'custom_steps': @scenario_steps})
+        end
+      end
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/test_runs.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module TestRuns
+    def extend_testrail_run
+      # Reset test scope to include all cases
+      body = { include_all: true }
+      @client.send_post("update_run/#{@run_id}", body)
+    end
+
+    def existing_cases_from_description
+      # Grabs from testrail run description
+      run = @client.send_get("get_run/#{@run_id}")
+      @description = run['description']
+      @description.nil? ? [] : @description.split(',')
+    end
+
+    def existing_cases_from_run(run_id = @run_id)
+      allowed_statuses = %i[1 2 4 5]
+      allowed_statuses << 6 if @testrail_config[:report_skips] == 'true'
+      tests = @client.send_get("get_tests/#{run_id}&status_id=#{allowed_statuses.compact.join(',')}") || []
+
+      cases = []
+
+      tests.each do |test|
+        cases << test['case_id']
+      end
+      cases
+    end
+
+    # open a test run to submit test results
+    def add_testrail_run
+      body = {
+        name: test_name,
+        description: '',
+        include_all: true,
+        milestone_id: @milestone_id
+      }
+
+      unless @testrail_config[:include_all] == 'true'
+        body[:include_all] = false
+        body[:case_ids] = @test_case_ids
+      end
+
+      case @suite_mode
+      when 2, 3
+        body[:suite_id] = @suite_id
+      end
+      res = @client.send_post("add_run/#{@project_id}", body)
+      @run_id = res['id']
+    end
+  end
+end

data/lib/itriagetestrail/version.rb

@@ -0,0 +1,3 @@
+module Itriagetestrail
+  VERSION = '1.0.36'.freeze
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: itriagetestrail
+version: !ruby/object:Gem::Version
+  version: 1.0.36
+platform: ruby
+authors:
+- a801069
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.56.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.56.0
+description: Plugin to export your cucumber tests in the Testrail
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/itriagetestrail.rb
+- lib/itriagetestrail/framework_bindings/trcucumber13.rb
+- lib/itriagetestrail/framework_bindings/trcucumber20.rb
+- lib/itriagetestrail/framework_bindings/trcucumber30.rb
+- lib/itriagetestrail/framework_bindings/trminitest.rb
+- lib/itriagetestrail/pool.rb
+- lib/itriagetestrail/testrail_binding.rb
+- lib/itriagetestrail/testrail_objects/milestones.rb
+- lib/itriagetestrail/testrail_objects/projects.rb
+- lib/itriagetestrail/testrail_objects/sections.rb
+- lib/itriagetestrail/testrail_objects/suites.rb
+- lib/itriagetestrail/testrail_objects/test_cases.rb
+- lib/itriagetestrail/testrail_objects/test_plans.rb
+- lib/itriagetestrail/testrail_objects/test_results.rb
+- lib/itriagetestrail/testrail_objects/test_runs.rb
+- lib/itriagetestrail/version.rb
+homepage: 
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Plugin to export your cucumber tests in the Testrail
+test_files: []