itriagetestrail 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60a7641e7255058ed13e18ca80a789133c7e5eba
-  data.tar.gz: 1311492cd1cd2f59dc9cfe20a303d126b5c15430
+  metadata.gz: 2cf1256452b3bb7d41e2eaa822e7139af10acf1e
+  data.tar.gz: b9864514855c3cdaba1d96d518f3da7fad81479c
 SHA512:
-  metadata.gz: 3a261214a074fd3f997371f7824e1767439cd81c237f28286326644ccee5e0bb630c50b872b9282cbe1419bb46221be0ec820ba32a38c82f0130cdcdc9e0d3b0
-  data.tar.gz: 256e30f116140fc04f1c02d98d1642e7667e79f6a4c6bebdc8a5644af81df80001a1178073d893e61e0d0c8e80f40967f1644712ac9062c9b74a84bb7fa51047
+  metadata.gz: 27c259fd9132e190b92559fa4959e15b135c8ef6562ea83f2c56669701f21420a842f8001c20338a8c661c67eacb232a6f9ac9f02d8c39c9a9f96f6e6f836a60
+  data.tar.gz: e5d82b254b2d99305d1c92696c55c169d7aaf8af2e67438f92e1e7e8e42c5404d20aff9891fd162da4f4731060564419101e2455628c4272cabcb8934d30a80b

data/lib/itriagetestrail/testrail_objects/milestones.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'tzinfo'
+
+module Itriagetestrail
+  module Milestones
+
+    # 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
+      else
+        @testrail_config[:milestone]
+      end
+    end
+
+    # returns timestamp for begining of first day of current quarter
+    def milestone_period_start
+      time_zone = TZInfo::Timezone.get('America/Denver')
+      current_year = time_zone.now.year
+      month = time_zone.now.mon
+
+      # determine which quarter we are in
+      if month <= 3
+        time_zone.utc_to_local(Time.utc(current_year, 1, 1))
+      elsif month <= 6
+        time_zone.utc_to_local(Time.utc(current_year, 4, 1))
+      elsif month <= 9
+        time_zone.utc_to_local(Time.utc(current_year, 7, 1))
+      else
+        time_zone.utc_to_local(Time.utc(current_year, 10, 1))
+      end
+    end
+
+    # determine the due date (end of quarter) for a new milestone being added
+    def milestone_due_date
+      time_zone = TZInfo::Timezone.get('America/Denver')
+      current_year = time_zone.now.year
+      month = time_zone.now.mon
+
+      # determine which quarter we are in
+      if month <= 3
+        Time.utc(current_year, 3, 31).strftime('%s')
+      elsif month <= 6
+        Time.utc(current_year, 6, 30).strftime('%s')
+      elsif month <= 9
+        Time.utc(current_year, 9, 30).strftime('%s')
+      else
+        Time.new(current_year, 12, 31).strftime('%s')
+      end
+    end
+
+    # returns the id for a requested milestone by name, or creates one if the milestone does not exist
+    def fetch_milestone(requested_milestone_name)
+      milestones = @client.send_get("get_milestones/#{@project_id}")
+      res = -1
+      milestones.each do |milestone|
+        res = milestone['id'] if milestone['name'] == requested_milestone_name
+      end
+
+      if res == -1
+        # We need to add the milestone to TestRail
+
+        body = {
+          name: requested_milestone_name,
+          due_on: milestone_due_date
+        }
+
+        res = @client.send_post("add_milestone/#{@project_id}", body)['id']
+      end
+      res
+    end
+
+    # return a standardized name for a milestone to be archived
+    def milestone_archive_name(milestone_name, date)
+      year = date.year
+      month = date.mon
+
+      if month <= 3
+        "#{milestone_name} #{year}-Q1"
+      elsif month <= 6
+        "#{milestone_name} #{year}-Q2"
+      elsif month <= 9
+        "#{milestone_name} #{year}-Q3"
+      else
+        "#{milestone_name} #{year}-Q4"
+      end
+    end
+
+    # return all the runs associated with an existing milestone
+    def milestone_runs(milestone_name)
+      # use the matching milestone id for project
+      milestone_id = fetch_milestone(milestone_name)
+
+      # fetch all test runs associated with the milestone id for project
+      @client.send_get("get_runs/#{@project_id}&milestone_id=#{milestone_id}&is_completed=1") || []
+    end
+
+    # testrail call to rename a milestone (for archiving)
+    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']
+    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)
+      if runs.size > 0
+        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
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/projects.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'itriagetestrail/version'
+require 'itriagetestrail/testrail_binding'
+require 'itriagetestrail/pool'
+require 'tzinfo'
+
+module Itriagetestrail
+  module Projects
+    # populate projects instance variable with all projects objects in the testrail site
+    def projects
+      @projects ||= @client.send_get('get_projects')
+    end
+
+    def project_by_name(name)
+      res = -1
+      projects.each do |project|
+        res = project if project['name'] == name
+      end
+      res
+    end
+
+    # return the project object for a given project id
+    def project_by_id(id)
+      res = -1
+      projects.each do |project|
+        res = project if project['id'] == id.to_i
+      end
+      res
+    end
+
+    # set the project_id by a requested project from config/environment variable
+    def set_project
+      requested_id = @testrail_config[:projectId]
+      case requested_id
+      when nil, ''
+        # a project id was not provided, fetch it from TestRail by project name
+        res = project_by_name(@testrail_config[:projectName])
+        if res == -1
+          @execute = false
+          return
+        end
+        @project_id = res['id']
+        @suite_mode = res['suite_mode']
+      else
+        # use the requested project id
+        @project_id = requested_id
+        @suite_mode = project_by_id(@project_id)['suite_mode']
+      end
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/sections.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module Sections
+    # TestRail Sections
+    def testrail_sections
+      case @suite_mode
+      when 2,3
+        @suite_id = testrail_suite_id(@suite_name)
+        @sections = @client.send_get("get_sections/#{@project_id}&suite_id=#{@suite_id}")
+      else
+        @sections = @client.send_get("get_sections/#{@project_id}")
+      end
+    end
+
+    def testrail_section_id(section_title)
+      res = -1
+      @sections.each do |section|
+        res = section['id'] if section['name'] == section_title
+      end
+      res
+    end
+
+    def add_testrail_section(section_title)
+      if @suite_name
+        body = {
+            name: section_title,
+            suite_id: testrail_suite_id(@suite_name)
+        }
+      else
+        body = {
+            name: section_title
+        }
+      end
+
+      res = @client.send_post("add_section/#{@project_id}", body)
+
+      testrail_section = res['id']
+
+      # re-establish sections
+      testrail_sections
+
+      testrail_section
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/suites.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module Suites
+    # TestRail Suites
+    def testrail_suites
+      case @suite_mode
+      when 2,3
+        @suites = @client.send_get("get_suites/#{@project_id}")
+      end
+    end
+
+    def testrail_suite_id(suite_name)
+      res = -1
+      @suites.each do |suite|
+        res = suite['id'] if suite['name'] == suite_name
+      end
+      res
+    end
+
+    def add_testrail_suite(suite_name)
+      body = { name: suite_name }
+      res = @client.send_post("add_suite/#{@project_id}", body)
+      testrail_suite = res['id']
+
+      #re-establish suites
+      testrail_suites
+
+      testrail_suite
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/test_cases.rb

@@ -0,0 +1,64 @@
+# 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|
+        if test_case['custom_external_case_id'] == external_id
+          res = test_case['id']
+        end
+      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 test_name
+      label = ''
+      label += "App Version:#{@app_version}" unless @app_version.nil? || @app_version == ''
+      label += " Jenkins Build:#{@jenkins_build}" unless @jenkins_build .nil? || @jenkins_build == ''
+      label.strip!
+      label = 'Regression' if label == ''
+      label + ' (' + @time_zone.now.strftime('%-I:%M %p') + ')'
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/test_plans.rb

@@ -0,0 +1,92 @@
+# 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
+      @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?
+
+      # remove the nils
+      @configuration_ids.compact!
+
+      @configuration_ids
+    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,52 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module TestResults
+    def send_results_to_testrail
+      return unless @results[:results].size != 0
+      # copy what is in the results
+      @submitted[:results] << @results[:results]
+
+      begin
+        send = { results: @results[:results] }
+        res = @client.send_post("add_results_for_cases/#{@run_id}", send)
+        clear_results
+      rescue StandardError => e
+        raise e
+      end
+    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
+      end
+      # store the case id associated with the external_id
+      associate_result(external_id)
+    end
+
+    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]
+      }
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/test_runs.rb

@@ -0,0 +1,54 @@
+# 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)
+
+      tests = @client.send_get("get_tests/#{run_id}&status_id=1,2,4,5") || []
+
+      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

@@ -1,3 +1,3 @@
 module Itriagetestrail
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: itriagetestrail
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - a801069
@@ -93,6 +93,14 @@ files:
 - 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: []