tms-cli 0.0.pre.beta

data/lib/testrail/testcase.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Testcase
+    module_function
+    
+    @@cases = {}
+    @@tc_ids = {}
+    @@test_results = []
+
+    def validate_testcase(client, section_id, test_title, test_status, refs_from_report, tr_version, error_comment)
+      # find case with the same title
+      # update existing case if found the same title 
+      # and create new case if no case have the same title 
+      tc = @@cases.find { |case_object| case_object['title'] == test_title }
+      if !tc.nil?
+        tc_refs = tc['refs'].nil? ? '' : tc['refs'].to_s
+        put_existing_tc_id(tc, test_status, section_id, error_comment)
+
+        # update tc refs if previous refs is different or empty
+        if validate_update_reference(refs_from_report, tc_refs) || tc_refs.eql?('')
+          update_test_refs(client, tc['id'], refs_from_report)
+        end
+      else
+        put_new_tc_id(client, section_id, test_title, test_status, error_comment, refs_from_report)
+      end
+    end
+
+    # this method will directly update test case when ref available in report file
+    def validate_testcase_bdd(client, section_id, test_id, refs_from_report, tr_version)
+      tc = get_tc_by_test_id(client, test_id)
+      tc_refs = tc['refs'].nil? ? '' : tc['refs'].to_s
+      if validate_update_reference(refs_from_report, tc_refs) || tc_refs.empty?
+        update_test_refs(client, tc['case_id'], refs_from_report)
+      end
+    end
+
+    def put_existing_tc_id(tc, test_status, section_id, error_comment)
+      tc_arr = []
+      tmp_hash = {}
+
+      tc_arr = @@tc_ids[section_id] unless @@tc_ids[section_id].nil?
+      tc_arr.push(tc['id'])
+      @@tc_ids[section_id] = tc_arr
+      tmp_hash['case_id'] = tc['id']
+      tmp_hash['status_id'] = test_status
+      tmp_hash['comment'] = error_comment
+
+      @@test_results.push(tmp_hash) unless @@test_results.include? tmp_hash
+    end
+
+    def update_test_refs(client, tc_id, refs)
+      payload = { refs: refs.to_s }
+      client.send_post("update_case/#{tc_id}", payload)
+    end
+
+    def create_testcase(client, section_id, test_title, refs)
+      begin
+        payload = { title: test_title.to_s, refs: refs.to_s, template_id: 1 }
+        client.send_post("add_case/#{section_id}", payload)
+      rescue TestRail::APIError => e
+        puts "Error occurred while creating test case with title: '#{test_title}'"
+        puts "Error message: #{e.message}"
+      end
+    end
+
+    def put_new_tc_id(client, section_id, test_title, test_status, error_comment, refs)
+      tc_arr = []
+      response = create_testcase(client, section_id, test_title, refs)
+      @@cases.push(response)
+      tc_id = response['id']
+      tc_arr = @@tc_ids[section_id] unless @@test_results.empty?
+
+      tc_arr.push(tc_id)
+      @@tc_ids[section_id] = tc_arr
+
+      tmp_hash = {}
+
+      tmp_hash['case_id'] = tc_id
+      tmp_hash['status_id'] = test_status
+      tmp_hash['comment'] = error_comment
+      @@test_results.push(tmp_hash) unless @@test_results.include? tmp_hash
+    end
+
+    def get_cases(client, project_id, suite_id, section_id, offset = 0)
+      # handle cases more than 250 entries
+      offset = 0
+      cases = []
+
+      loop do 
+        get_cases = client.send_get("get_cases/#{project_id}&suite_id=#{suite_id}&section_id=#{section_id}&offset=#{offset}")
+        cases.push get_cases['cases']
+        offset += 250
+        break if get_cases['_links']['next'].nil?
+      end
+      cases = cases.flatten
+
+      return cases
+    end
+
+    def get_status_id(status)
+      case status
+      when 'passed' then 1
+      when 'todo' then 2
+      when 'skipped' then 4
+      when 'failed' then 5
+      when 'pending' then 6
+      else abort('Invalid status on report json')
+      end
+    end
+
+    def validate_update_reference(refs_from_report, tc_refs)
+      refs_eql = false
+      unless tc_refs.nil? || refs_from_report.nil?
+        tc_refs.split(',').each do |tc_ref|
+          refs_from_report.split(',').each do |ref|
+            if tc_ref.eql?(ref)
+              refs_eql = true
+              break
+            end
+          end
+        end
+      end
+      refs_eql
+    end
+
+    def test_ids
+      @@tc_ids
+    end
+
+    def test_results
+      @@test_results
+    end
+
+    def validate_refs(refs)
+      refs.include?('-') && 
+        refs.split('-').size.eql?(2) && 
+        (refs.split('-')[1] =~ /[^0-9]/).nil?
+    end
+
+    # This method will get case id by test id
+    # @param client testrail
+    # @param test_id is existing test run
+    def get_tc_by_test_id(client, test_id)
+      client.send_get("get_test/#{test_id}")
+    end
+
+    # This method will get case id by test id
+    # @param client testrail
+    # @param suite_id is the id of the suite
+    def delete_cases_from_suite(client, suite_id, case_ids)
+      payload = { case_ids: case_ids }
+      client.send_post("delete_cases/#{suite_id}&soft=1", payload)
+    end
+
+    def add_case(client, section_id, refs, title, label, bdd)
+      puts "Create test case: #{title}"
+      begin
+        payload = {
+          title: title,
+          refs: refs,
+          custom_label_id: label,
+          template_id: 4,
+          custom_testrail_bdd_scenario:[{content: bdd}]
+        }
+        client.send_post("add_case/#{section_id}", payload)
+      rescue TestRail::APIError => e
+        puts "Error occurred while creating test case with title: '#{test_title}'"
+        puts "Error message: #{e.message}"
+      end
+    end
+
+    # This method will set reference into '' on test case
+    # @param client testrail
+    # @param test case id
+    def update_case(client, tc_id, refs, title, label, bdd)
+      puts "Update test case: #{title}"
+      begin
+      payload = {
+          title: title,
+          refs: refs,
+          custom_label_id: label,
+          custom_testrail_bdd_scenario:[{content: bdd}]
+        }
+        client.send_post("update_case/#{tc_id}", payload)
+      rescue TestRail::APIError => e
+        puts "Error occurred while creating test case with title: '#{title}'"
+        puts "Error message: #{e.message}"
+      end
+    end
+  end
+end

data/lib/testrail/testplan.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require_relative './dataprep'
+require_relative './projects'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Testplan
+    module_function
+
+    include Dataprep
+    include Projects
+
+    # Returns an existing test plan
+    # @param client testrail
+    # @param plan id
+    def get_plan(client, plan_id)
+      client.send_get("get_plan/#{plan_id}")
+    end
+
+    # Returns all list existing test plans and handle plans more than 250
+    # @param client testrail
+    # @param project_id
+    def get_plans(client, project_id, filter = '')
+      offset = 0
+      plans = []
+
+      puts "Retrieving test plans from project id #{project_id} ..."
+
+      loop do
+        get_plans = client.send_get("get_plans/#{project_id}&#{filter}&offset=#{offset}&is_completed=0")
+        plans.push get_plans['plans']
+        offset += 250
+        break if get_plans['_links']['next'].nil?
+      end
+
+      plans = plans.flatten
+      return plans
+    end
+
+    # Creates a new test plan
+    # @param client testrail
+    # @param project id
+    # @param payload object
+    def create_testplan(client, project_id, payload)
+      client.send_post("add_plan/#{project_id}", payload)
+    end
+
+    # Adds one or more new test runs to a test plan
+    # @param client testrail
+    # @param plan id
+    # @param suite id
+    # @param array of test runs
+    def add_plan_entry(client, plan_id, suite_id, runs)
+      payload = {
+        suite_id: suite_id,
+        include_all: false,
+        entries: runs
+      }
+      puts payload
+      client.send_post("add_plan_entry/#{plan_id}", payload)
+    end
+
+    # Close the active test plan in the testrail project
+    # @param client testrail
+    # @param plan id
+    def close_test_plan(client, plan_id)
+      client.send_post("close_plan/#{plan_id}", {})
+    end
+
+    # Closes test plans created before a specified number of months ago.
+    #
+    # This method closes test plans that were created before the specified number
+    # of months ago for all projects. It iterates through the projects, retrieves
+    # the test plans that meet the criteria, and then closes each test run.
+    #
+    # @param client [DataprepClient] The Dataprep client instance.
+    # @param month [Integer] The number of months ago to consider for closing test plans.
+    def close_test_plan_months_before(client, month)
+      filter = "created_before=#{month}&created_by=1"
+      Projects.get_list_project_ids(client).each do |project_id|
+        get_plans(client, project_id, filter).each do |run_detail|
+          plan_id = run_detail['id']
+          created_on = run_detail['created_on']
+          close_test_plan(client, plan_id)
+          puts "Close Testrail Plan ID: #{plan_id} with started on date: #{created_on}"
+        end
+      end
+    end
+  end
+end

data/lib/testrail/testrail.rb

@@ -0,0 +1,136 @@
+#
+# TestRail API binding for Java (API v2, available since TestRail 3.0)
+#  Updated for TestRail 5.7
+#
+# Learn more:
+#
+# http://docs.gurock.com/testrail-api2/start
+# http://docs.gurock.com/testrail-api2/accessing
+#
+# Copyright Gurock Software GmbH. See license.md for details.
+#
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module TestRail
+  class APIClient
+    @url = ''
+    @user = ''
+    @password = ''
+    @openTimeout = 360
+    @readTimeout = 360
+
+    attr_accessor :user, :password
+
+    def initialize(base_url)
+      base_url += '/' unless base_url.match(%r{/$})
+      @url = base_url + 'index.php?/api/v2/'
+    end
+
+    #
+    # Send Get
+    #
+    # Issues a GET request (read) against the API and returns the result
+    # (as Ruby hash).
+    # If 'get_attachment/{id}' is successful, returns the data parameter
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. get_case/1)
+    # data                When using get_attachment/{id}, this should be
+    #                     the file path (including filename) where the
+    #                     attachment should be saved
+    #
+    def send_get(uri, data = nil)
+      _send_request('GET', uri, data)
+    end
+
+    #
+    # Send POST
+    #
+    # Issues a POST request (write) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. add_case/1)
+    # data                The data to submit as part of the request (as
+    #                     Ruby hash, strings must be UTF-8 encoded)
+    #                     If adding an attachment, should be the path
+    #                     to the file
+    #
+    def send_post(uri, data)
+      _send_request('POST', uri, data)
+    end
+
+    private
+
+    def _send_request(method, uri, data)
+      url = URI.parse(@url + uri)
+      if method == 'POST'
+        request = Net::HTTP::Post.new(url.path + '?' + url.query, :open_timeout => @openTimeout)
+        if uri.start_with?('add_attachment') || uri.start_with?('add_bdd')
+          # SOURCE: https://yukimotopress.github.io/http
+          boundary = 'TestRailAPIAttachmentBoundary'
+          post_body = []
+          post_body << "--#{boundary}\r\n"
+          post_body << "Content-Disposition: form-data; name=\"attachment\"; filename=\"#{File.basename(data)}\"\r\n"
+          post_body << "\r\n"
+          post_body << File.open(data, 'rb') { |io| io.read }
+          post_body << "\r\n--#{boundary}--\r\n"
+
+          request.body = post_body.join
+          request['Content-Type'] = "multipart/form-data; boundary=#{boundary}"
+        else
+          request['Content-Type'] = 'application/json'
+          request.body = JSON.dump(data)
+        end
+      else
+        request = Net::HTTP::Get.new(url.path + '?' + url.query, :open_timeout => @openTimeout, :read_timeout => @readTimeout)
+        request['Content-Type'] = 'application/json'
+      end
+      request.basic_auth(@user, @password)
+
+      conn = Net::HTTP.new(url.host, url.port)
+      conn.open_timeout = @openTimeout
+      conn.read_timeout = @readTimeout
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      response = conn.request(request)
+
+      if response.body && !response.body.empty? && (response.code == '200')
+        if uri.start_with?('get_attachment/')
+          File.open(data, 'w') { |file| file.write(response.body) }
+          result = data
+        elsif uri.start_with?('get_bdd/')
+          result = response.body
+        else
+          result = JSON.parse(response.body)
+        end
+      else
+        result = {}
+      end
+    
+      if response.code != '200'
+        error = if result && result.key?('error')
+                  '"' + result['error'] + '"'
+                else
+                  'No additional error message received'
+                end
+        raise APIError, format('TestRail API returned HTTP %s (%s)', response.code, response.body, error)
+      end
+
+      result
+    end
+  end
+
+  class APIError < StandardError
+  end
+end

data/lib/testrail/testrun.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require_relative './dataprep'
+require_relative './projects'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Testrun
+    module_function
+
+    include Dataprep
+    include Projects
+
+    # This method will get test run id on current milestone
+    # @param client testrail
+    # @param project id
+    # @param suite id
+    # @param milestone id
+    # @param section id
+    # @param section name
+    # @param tcs id is list of test case to put on test run
+    # @param env
+    def testrun_id(client, project_id, suite_id, milestone_id, section_id, section_name, tc_ids, env, platform_name)
+      list_tc = tc_ids[section_id]
+      run_id = ''
+      env = env.eql?('') ? '' : "_#{env}"
+      if platform_name != ''
+        test_run_name = "Test_Run_#{section_name}#{env}_#{platform_name}"
+      else
+        test_run_name = "Test_Run_#{section_name}#{env}"
+      end
+  
+      is_run_name_avail = false
+
+      if !list_tc.nil?
+        response = client.send_get("get_runs/#{project_id}&milestone_id=#{milestone_id}")['runs']
+
+        if response.empty?
+          run_id = create_testrun(client, project_id, suite_id, milestone_id, list_tc, test_run_name)
+        else
+          response.each do |run|
+            next unless run['name'].eql? test_run_name
+
+            is_run_name_avail = true
+            run_id = update_testrun(client, run['id'], milestone_id, list_tc)
+            puts "TEST RUN ID : #{run_id}"
+            break
+          end
+
+          run_id = create_testrun(client, project_id, suite_id, milestone_id, list_tc, test_run_name) unless is_run_name_avail
+        end
+      else
+        abort('List test cases is empty')
+      end
+      run_id
+    end
+
+    # This method will get test run id on current milestone
+    # @param client testrail
+    # @param project id
+    # @param milestone id
+    def testrun_id_by_milestone(client, project_id, milestone_id)
+      client.send_get("get_runs/#{project_id}&milestone_id=#{milestone_id}")['runs']
+    end
+
+    # This method will get test run for a specific suite
+    # @param client testrail
+    # @param project id
+    # @param milestone id
+    # @param suite id
+    def testrun_id_by_suite(client, project_id, milestone_id, suite_id)
+      offset = 0
+      runs = []
+
+      loop do 
+        get_runs = client.send_get("get_runs/#{project_id}&milestone_id=#{milestone_id}&suite_id=#{suite_id}&offset=#{offset}&is_completed=0")
+        runs.push get_runs['runs']
+        offset += 250
+        break if get_runs['_links']['next'].nil?
+      end
+      runs = runs.flatten
+      return runs
+    end
+    
+    # This method will create test run
+    # @param client testrail
+    # @param project id
+    # @param suite id
+    # @param milestone id
+    # @param tcs id is list of test case to put on test run
+    # @param test_run_name
+    def create_testrun(client, project_id, suite_id, milestone_id = 0, list_tc, test_run_name)
+      payload = { suite_id: suite_id.to_i, name: test_run_name.to_s,
+                  case_ids: list_tc, include_all: false, milestone_id: milestone_id }
+      payload.delete(:milestone_id) if milestone_id.eql?(0)
+      client.send_post("add_run/#{project_id}", payload)['id']
+    end
+
+    # This method will update list of test case on existing test run
+    # @param client testrail
+    # @param test_run_id is existing test run
+    # @param milestone id
+    # @param tcs id is list of test case to put on test run
+    def update_testrun(client, test_run_id, milestone_id, list_tc)
+      payload = { case_ids: list_tc, include_all: false, milestone_id: milestone_id}
+      client.send_post("update_run/#{test_run_id}", payload)['id']
+    end
+
+    # This method will get all test result on test run
+    # @param client testrail
+    # @param test_run_id is existing test run
+    # @param offset is the number that sets the position response start from
+    # handle tests more than 250 entries
+    def test_ids(client, test_run_id, offset = 0)
+      offset = 0
+      tests = []
+
+      loop do 
+        get_tests = client.send_get("get_tests/#{test_run_id}&offset=#{offset}")
+        tests.push get_tests['tests']
+        offset += 250
+        break if get_tests['_links']['next'].nil?
+      end
+      tests = tests.flatten
+      return tests
+    end
+
+    # This method will get all test result on test run
+    # @param client testrail
+    # @param test_run_id is existing test run
+    def get_runs(client, project_id, filter = '')
+      offset = 0
+      runs = []
+
+      puts "Retrieving test runs from project id #{project_id} ..."
+
+      loop do 
+        get_runs = client.send_get("get_runs/#{project_id}&#{filter}&offset=#{offset}&is_completed=0")
+        runs.push get_runs['runs']
+        offset += 250
+        break if get_runs['_links']['next'].nil?
+      end
+      runs = runs.flatten
+      return runs
+    end
+
+    # This method will delete test run
+    # @param client testrail
+    # @param test run id
+    def delete_testrun(client, run_id)
+      client.send_post("delete_run/#{run_id}", {})
+    end
+
+    # This method will close test run
+    # @param client testrail
+    # @param test run id
+    def close_test_run(client, run_id)
+      client.send_post("close_run/#{run_id}", {})
+      puts "Close the Test Run with ID: #{run_id}"
+    end
+
+    # Closes test runs created before a specified number of months ago.
+    #
+    # This method closes test runs that were created before the specified number
+    # of months ago for all projects. It iterates through the projects, retrieves
+    # the test runs that meet the criteria, and then closes each test run.
+    #
+    # @param client [DataprepClient] The Dataprep client instance.
+    # @param month [Integer] The number of months ago to consider for closing test runs.
+    def close_test_run_months_before(client, month)
+      filter = "created_before=#{month}&created_by=1"
+      Projects.get_list_project_ids(client).each do |project_id|
+        get_runs(client, project_id, filter).each do |run_detail|
+          run_id = run_detail['id']
+          created_on = run_detail['created_on']
+          close_test_run(client, run_id)
+          puts "Close Testrail Run ID: #{run_id} with started on date: #{created_on}"
+        end
+      end
+    end
+  end
+end

data/lib/testrail/testsuite.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Testsuite
+    module_function
+
+    # This method will get suite id
+    # will create new test suite with name 'master' if there is no test suite
+    # @param client testrail
+    # @param project id
+    def testsuite_id(client, project_id, suite_name)
+      response = client.send_get("get_suites/#{project_id}")
+      if response == [] 
+        payload = { name: 'master', description: 'created by automation' }
+        client.send_post("add_suite/#{project_id}", payload)
+        client.send_get("get_suites/#{project_id}")
+      else
+        found_suites = response.select { |suites| suites['name']&.include?(suite_name) }
+
+        if found_suites.empty?
+          "Creating suites of #{suite_name}..."
+          payload = { name: 'master', description: 'created by automation' }
+          client.send_post("add_suite/#{project_id}", payload)
+        else
+          puts "Fetching suites of #{suite_name}..."
+          return found_suites
+        end
+      end
+    end
+
+    # Returns a list of test suites for a project.
+    # @param client testrail
+    # @param project id
+    def suites(client, project_id)
+      client.send_get("get_suites/#{project_id}")
+    end
+
+    # Returns an existing test suite
+    # @param client testrail
+    # @param suite id
+    def suite_id(client, suite_id)
+      client.send_get("get_suite/#{suite_id}")
+    end
+  end
+end