onlyoffice_testrail_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7cdb9209303106828ac8d2628bdfbd6243b0b66cbf9e57f8d1c3d506a29d0af
+  data.tar.gz: 54ad089da3f905190dc4b33784fbfc665faa725d865f0b28d77f034e4766b08e
+SHA512:
+  metadata.gz: 86813255438a058617f52e431bd1465fe1a2aba8397dc62cd41efc51fc270c22c271a3c0e6a8c59645540896b8842eab77ce53a3614048f7d7f4da9016615ce1
+  data.tar.gz: e198cc8aa5f2b5c537ee36ff4e30c03ebb262a0485f7852d12f4ef333ce3f751e9046df74a1a842221f9e5b17358afc55ef2ea73f92d64099dbdf368e8655072

data/lib/onlyoffice_testrail_wrapper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'onlyoffice_logger_helper'
+require_relative 'onlyoffice_testrail_wrapper/rspec_extension'
+require_relative 'onlyoffice_testrail_wrapper/testrail_helper'
+require_relative 'onlyoffice_testrail_wrapper/mock/rspec_example_mock'
+require_relative 'onlyoffice_testrail_wrapper/helpers/hash_helper'
+require_relative 'onlyoffice_testrail_wrapper/helpers/rspec_helper'
+require_relative 'onlyoffice_testrail_wrapper/helpers/string_helper'
+require_relative 'onlyoffice_testrail_wrapper/testrail_tools/testrail_tools'

data/lib/onlyoffice_testrail_wrapper/helpers/hash_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  class HashHelper
+    class << self
+      def get_hash_from_array_with_two_parameters(array, key_parameter, value_parameter)
+        raise 'First argument must be Array!' unless array.is_a?(Array)
+
+        result_hash = {}
+        array.reverse_each { |element| result_hash[element[key_parameter]] = element[value_parameter] }
+        result_hash
+      end
+
+      def parse_to_class_variable(hash, class_name)
+        object = class_name.new
+        hash.each { |key, value| object.instance_variable_set("@#{key}", value) }
+        object
+      end
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/helpers/rspec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Methods to some rspec methods
+  module RspecHelper
+    # This method is based on
+    # https://github.com/rspec/rspec-core/blob/v3.3.0/lib/rspec/core/formatters/exception_presenter.rb#L130
+    # It extracted exact line of code from failed exception
+    # @param [RSpec::Core::Example] example
+    # @return [String] line value
+    def self.find_failed_line(example)
+      example_path = example.metadata[:absolute_file_path].downcase
+      dirty_line = example.exception.backtrace.find do |line|
+        next unless (line_path = line[/(.+?):(\d+)(|:\d+)/, 1])
+
+        File.expand_path(line_path).casecmp(example_path).zero?
+      end
+      line_number = dirty_line[/:\d*:/].delete(':').to_i
+      OnlyofficeFileHelper::FileHelper.read_array_from_file(example.metadata[:absolute_file_path])[line_number - 1]
+    rescue StandardError => e
+      "Cannot find failed line because of exception: #{e}"
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/helpers/ruby_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Methods to work with ruby
+  module RubyHelper
+    def debug?
+      ENV['RUBYLIB'].to_s.include?('ruby-debug')
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/helpers/string_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  class StringHelper
+    class << self
+      def warnstrip!(string)
+        warn "Beginning or end of string has spaces! In: #{string}" unless string == string.strip
+        string.strip
+      end
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/helpers/system_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'socket'
+
+module OnlyofficeTestrailWrapper
+  # Stuff for working with OS
+  class SystemHelper
+    class << self
+      # @return [String] name of current host
+      def hostname
+        name = Socket.gethostname
+        OnlyofficeLoggerHelper.log("hostname is: #{name}")
+        name
+      end
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/mock/rspec_example_mock.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Mock Rspec example exception
+  class RspecExceptionMock
+    attr_accessor :backtrace
+
+    def initialize
+      @backtrace = %w[TestBackTraceLine1 TestBackTraceLine2]
+    end
+  end
+
+  # Class for mocking rspec result metadata
+  class RspecExceptionResultMock
+    attr_accessor :started_at
+  end
+
+  # Mock Rspec example
+  class RspecExampleMock
+    # @return [Object] object exception
+    attr_accessor :exception
+    # @return [Object] backtrace object
+    attr_accessor :backtrace
+    # @return [Hash] metadata
+    attr_accessor :metadata
+    # @return [True, False] is test pending
+    attr_accessor :pending
+    # @return [String] description of spec
+    attr_accessor :description
+
+    def initialize(description: 'MockDescription',
+                   exception: RspecExceptionMock.new)
+      @exception = exception
+      @metadata = { execution_result: RspecExceptionResultMock.new }
+      @pending = false
+      @description = description
+      @section = ''
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/name.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Module for storing gem name
+  module Name
+    # @return [String] gem name
+    STRING = 'onlyoffice_testrail_wrapper'
+  end
+end

data/lib/onlyoffice_testrail_wrapper/rspec_extension.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Core
+    # Override for Rspec Example class
+    class Example
+      def add_custom_exception(comment)
+        e = Exception.exception(comment)
+        e.set_backtrace('')
+        @exception = e
+      end
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+# @author Roman.Zagudaev
+# lib for working with http queries
+
+require 'net/http'
+require 'json'
+require 'yaml'
+require_relative 'testrail_project'
+
+module OnlyofficeTestrailWrapper
+  # Main class for working with testrail
+  # dvd_copy = Project.init_project_by_name('AVS Disc Creator')
+  # compete_test_suit= dvd_copy.init_suite_by_name('Complete Test Suite')
+  # test_run_from_api = compete_test_suit.start_test_run('TestRunName', "Simple description")
+  # incompleted_test = test_run_from_api.get_incomplete_tests()
+  # while(incomplete_test.length > 0)
+  #  current_test = incomplete_test.sample
+  #  p current_test.title
+  #  current_test.add_result(Testrail2::TEST_RESULT_OK, 'description','version')
+  #  incomplete_test = test_run_from_api.get_incomplete_tests()
+  # end1
+  class Testrail2
+    # @return [String] address of testrail
+    @testrail_url = nil
+    # @return [String] login for admin user
+    @admin_user = nil
+    # @return [String] password for admin user
+    @admin_pass = nil
+
+    # @return [Hash] project information
+    attr_accessor :projects_names
+
+    def initialize
+      @projects_names = {}
+    end
+
+    class << self
+      attr_accessor :testrail_url
+      # Attribute to write admin_user
+      attr_writer :admin_user
+      # Attribute to write admin_pass
+      attr_writer :admin_pass
+
+      # @return [String] default config location
+      CONFIG_LOCATION = "#{Dir.home}/.gem-onlyoffice_testrail_wrapper/config.yml"
+
+      def read_keys
+        @testrail_url = ENV['TESTRAIL_URL']
+        @admin_user = ENV['TESTRAIL_USER']
+        @admin_pass = ENV['TESTRAIL_PASSWORD']
+        return unless @admin_user.nil? && @admin_pass.nil?
+
+        begin
+          yaml = YAML.load_file(CONFIG_LOCATION)
+          @testrail_url = yaml['url']
+          @admin_user = yaml['user']
+          @admin_pass = yaml['password']
+        rescue Errno::ENOENT
+          raise Errno::ENOENT, "No user of passwords found in #{CONFIG_LOCATION}. Please create correct config"
+        end
+      end
+
+      def admin_user
+        read_keys
+        @admin_user
+      end
+
+      def admin_pass
+        read_keys
+        @admin_pass
+      end
+
+      def get_testrail_address
+        read_keys unless testrail_url
+        testrail_url
+      end
+
+      # Perform http get on address
+      # @param [String] request_url to perform http get
+      # @return [Hash] Json with result data in hash form
+      def http_get(request_url)
+        uri = URI get_testrail_address + request_url
+        request = Net::HTTP::Get.new uri.request_uri
+        response = send_request(uri, request)
+        JSON.parse response.body
+      end
+
+      # Perform http post on address
+      # @param [String] request_url to perform http get
+      # @param [Hash] data_hash headers to add to post query
+      # @return [Hash] Json with result data in hash form
+      def http_post(request_url, data_hash)
+        uri = URI get_testrail_address + request_url
+        request = Net::HTTP::Post.new uri.request_uri
+        request.body = data_hash.to_json
+        response = send_request(uri, request)
+        return if response.body == ''
+
+        JSON.parse response.body
+      end
+    end
+
+    # region PROJECT
+
+    def project(name_or_id)
+      case name_or_id.class.to_s
+      when 'Fixnum'
+        get_project_by_id name_or_id
+      when 'String'
+        init_project_by_name name_or_id
+      else
+        raise 'Wrong argument. Must be name [String] or id [Integer]'
+      end
+    end
+
+    # Get all projects on testrail
+    # @return [Array, ProjectTestrail] array of projects
+    def get_projects
+      projects = Testrail2.http_get 'index.php?/api/v2/get_projects'
+      @projects_names = HashHelper.get_hash_from_array_with_two_parameters(projects, 'name', 'id') if @projects_names.empty?
+      projects
+    end
+
+    def create_new_project(name, announcement = '', show_announcement = true)
+      new_project = HashHelper.parse_to_class_variable(Testrail2.http_post('index.php?/api/v2/add_project', name: StringHelper.warnstrip!(name.to_s), announcement: announcement,
+                                                                                                            show_announcement: show_announcement), TestrailProject)
+      OnlyofficeLoggerHelper.log "Created new project: #{new_project.name}"
+      new_project.instance_variable_set('@testrail', self)
+      @projects_names[new_project.name] = new_project.id
+      new_project
+    end
+
+    # Initialize project by it's name
+    # @param [String] name name of project
+    # @return [TestrailProject] project with this name
+    def init_project_by_name(name)
+      found_project = get_project_by_name name
+      found_project.nil? ? create_new_project(name) : found_project
+    end
+
+    # Get all projects on testrail
+    # @return [Array, ProjectTestrail] array of projects
+    def get_project_by_id(id)
+      project = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_project/#{id}"), TestrailProject)
+      OnlyofficeLoggerHelper.log("Initialized project: #{project.name}")
+      project.instance_variable_set('@testrail', self)
+      project
+    end
+
+    def get_project_by_name(name)
+      get_projects if @projects_names.empty?
+      @projects_names[StringHelper.warnstrip!(name.to_s)].nil? ? nil : get_project_by_id(@projects_names[StringHelper.warnstrip!(name.to_s)])
+    end
+
+    # Check if Testrail connection is available
+    # @return [True, False] result of test connection
+    def available?
+      get_projects
+      true
+    rescue StandardError
+      false
+    end
+
+    # endregion
+
+    def self.send_request(uri, request)
+      request.basic_auth admin_user, admin_pass
+      request.delete 'content-type'
+      request.add_field 'content-type', 'application/json'
+      is_ssl = (uri.scheme == 'https')
+      Net::HTTP.start(uri.host, uri.port, use_ssl: is_ssl) do |http|
+        attempts = 0
+        begin
+          response = http.request(request)
+        rescue Timeout::Error
+          attempts += 1
+          retry if attempts < 3
+          raise 'Timeout error after 3 attempts'
+        rescue StandardError => e
+          raise e
+        end
+        return response
+      end
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_case.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # @author Roman.Zagudaev
+  # Class for description of test case
+  class TestrailCase
+    # @return [Integer] Id of test case
+    attr_accessor :id
+    # @return [String] title of test case
+    attr_accessor :title
+    # @return [Integer] type id of test case
+    attr_accessor :type_id
+    # @return [Integer] priority id of test case
+    attr_accessor :priority_id
+    # @return [String] Steps of test case
+    attr_accessor :custom_steps
+    # @return [String] Estimated test time
+    attr_accessor :estimate
+
+    # Default constructor
+    # @param [String] title name of test case, default = nil
+    # @param [Integer] type_id type id of test case, default = 3
+    # @param [Integer] priority_id priority id of test case, default = 4
+    # @param [String] custom_steps Steps of test case
+    # @param [Integer] id Id of test case
+    # @return [TestCaseTestrail] new test case
+    def initialize(title = nil, type_id = 3, priority_id = 4, custom_steps = nil, id = nil)
+      @id = id
+      @title = title
+      @type_id = type_id
+      @priority_id = priority_id
+      @custom_steps = custom_steps
+    end
+
+    def update(title = @title, type_id = @type_id, priority_id = @priority_id, custom_steps = @custom_steps)
+      @section.cases_names.delete @title
+      @section.cases_names[StringHelper.warnstrip!(title.to_s)] = @id
+      HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_case/#{@id}", title: title, type_id: type_id,
+                                                                                                     priority_id: priority_id, custom_steps: custom_steps), TestrailCase)
+    end
+
+    def delete
+      @section.cases_names.delete @title
+      OnlyofficeLoggerHelper.log "Deleted test case: #{@title}"
+      Testrail2.http_post "index.php?/api/v2/delete_case/#{@id}", {}
+    end
+
+    def get_results(run_id)
+      case_results = Testrail2.http_get "index.php?/api/v2/get_results_for_case/#{run_id}/#{@id}"
+      case_results.each_with_index { |test_case, index| case_results[index] = HashHelper.parse_to_class_variable(test_case, TestrailResult) }
+      case_results
+    end
+
+    def add_result(run_id, result, comment = '', custom_fields = {}, version = '')
+      response = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_result_for_case/#{run_id}/#{@id}", { status_id: TestrailResult::RESULT_STATUSES[result],
+                                                                                                                                    comment: comment, version: version }.merge(custom_fields)), TestrailResult)
+      OnlyofficeLoggerHelper.log "Set test case result: #{result}. URL: #{Testrail2.get_testrail_address}index.php?/tests/view/#{response.test_id}", output_colors[result]
+      response
+    end
+
+    private
+
+    def output_colors
+      { failed: 45, pending: 43, passed: 42, passed_2: 46, aborted: 41, blocked: 44 }
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_helper.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'onlyoffice_bugzilla_helper'
+require_relative 'testrail_helper/testrail_helper_rspec_metadata'
+require_relative 'testrail_helper/testrail_status_helper'
+require_relative 'testrail'
+require_relative 'helpers/ruby_helper'
+require_relative 'helpers/system_helper'
+
+module OnlyofficeTestrailWrapper
+  # Class with help methods with testrail
+  class TestrailHelper
+    include RubyHelper
+    include TestrailHelperRspecMetadata
+    include TestrailStatusHelper
+    attr_reader :project, :plan, :suite, :run
+    attr_accessor :add_all_suites, :ignore_parameters, :suites_to_add, :search_plan_by_substring, :in_debug, :version
+
+    def initialize(project_name, suite_name = nil, plan_name = nil, run_name = nil)
+      @in_debug = debug?
+      begin
+        @bugzilla_helper = OnlyofficeBugzillaHelper::BugzillaHelper.new
+      rescue Errno::ENOENT
+        @bugzilla_helper = nil
+      end
+      if @in_debug
+        OnlyofficeLoggerHelper.log 'Do not initialize Testrail, because spec run in debug'
+        @run = TestrailRun.new
+        return
+      end
+      OnlyofficeLoggerHelper.log 'Begin initializing Testrail...'
+      @suites_to_add = []
+      @add_all_suites = true
+      @search_plan_by_substring = false
+      yield(self) if block_given?
+      @project = Testrail2.new.project project_name.to_s.dup
+      if plan_name
+        @plan = @project.get_plan_by_name(search_plan_by_substring ? get_plan_name_by_substring(plan_name.to_s) : plan_name.to_s)
+        @plan ||= @project.create_new_plan(plan_name, suites_to_add_hash(@add_all_suites ? all_suites_names : @suites_to_add))
+      end
+      return if suite_name.nil?
+
+      @suite = @project.suite suite_name.to_s
+      if @plan
+        init_run_in_plan(suite_name.to_s)
+      else
+        @run = @project.init_run_by_name(run_name ? run_name.to_s : suite_name.to_s, @suite.id)
+      end
+      raise "Plan '#{@plan.name}' is completed! Cannot add results. See #{@plan.url}" if !@plan.nil? && @plan.is_completed
+
+      OnlyofficeLoggerHelper.log 'Initializing complete!'
+    end
+
+    def add_cases_to_suite(cases, section_name = 'All Test Cases')
+      if @in_debug
+        OnlyofficeLoggerHelper.log 'Do not add test result, because spec run in debug '
+        return
+      end
+      OnlyofficeLoggerHelper.log "Begin scanning #{@suite.name} suite for new cases" unless cases.is_a?(Array)
+      section = @suite.section section_name.to_s
+      existing_cases = section.get_cases.map { |test_case| test_case['title'] }
+      cases.each { |case_name| section.create_new_case case_name.to_s unless existing_cases.include?(case_name) }
+      OnlyofficeLoggerHelper.log 'Suite scanning complete!'
+      @suite = @project.get_suite_by_id @suite.id
+    end
+
+    def add_result_to_test_case(example, comment = '', section_name = 'All Test Cases')
+      if @in_debug
+        OnlyofficeLoggerHelper.log 'Do not add test result, because spec run in debug '
+        return
+      end
+      exception = example.exception
+      custom_fields = init_custom_fields(example)
+      if @ignore_parameters && (ignored_hash = ignore_case?(example.metadata))
+        comment += "\nTest ignored by #{ignored_hash}"
+        result = :blocked
+      elsif example.pending
+        result, comment, bug_id = parse_pending_comment(example.execution_result.pending_message)
+        if example.exception.to_s == 'Expected example to fail since it is pending, but it passed.'
+          result = :failed
+          comment = "Test passed! #{comment}"
+        end
+        custom_fields[:defects] = bug_id.to_s
+        example.add_custom_exception(comment) if result == :failed
+        result = :lpv if comment.downcase.include?('limited program version')
+      elsif exception.to_s.include?('got:') || exception.to_s.include?('expected:')
+        result = :failed
+        failed_line = RspecHelper.find_failed_line(example)
+        comment += "\n#{exception.to_s.gsub('got:', "got:\n").gsub('expected:', "expected:\n")}\nIn line:\n#{failed_line}"
+      elsif exception.to_s.include?('to return') || exception.to_s.include?('expected')
+        result = :failed
+        comment += "\n#{exception.to_s.gsub('to return ', "to return:\n").gsub(', got ', "\ngot:\n")}"
+      elsif exception.to_s.include?('Service Unavailable')
+        result = :service_unavailable
+        comment += "\n#{exception}"
+      elsif exception.to_s.include?('Limited program version')
+        result = :lpv
+        comment += "\n#{exception}"
+      elsif exception.nil?
+        result = if @last_case == example.description
+                   :passed_2
+                 elsif custom_fields.key?(:custom_js_error)
+                   :js_error
+                 else
+                   :passed
+                 end
+        comment += "\nOk"
+      else
+        result = :aborted
+        comment += "\n#{exception}"
+        custom_fields[:custom_autotest_error_line] = exception.backtrace.join("\n") unless exception.backtrace.nil?
+      end
+      @last_case = example.description
+      @suite.section(section_name).case(example.description).add_result @run.id, result, comment, custom_fields
+    end
+
+    def add_result_by_case_name(name, result, comment = 'ok', section_name = 'All Test Cases')
+      @suite.section(section_name).case(name.to_s).add_result(@run.id, result, comment)
+    end
+
+    def get_incomplete_tests
+      @run.get_tests.map { |test| test['title'] if test['status_id'] == 3 || test['status_id'] == 4 }.compact
+    end
+
+    # @param [Array] result. Example: [:retest, :passed]
+    def get_tests_by_result(result)
+      check_status_exist(result)
+      result = [result] unless result.is_a?(Array)
+      @run.get_tests.map { |test| test['title'] if result.include?(TestrailResult::RESULT_STATUSES.key(test['status_id'])) }.compact
+    end
+
+    def delete_plan(plan_name)
+      @project.plan(get_plan_name_by_substring(plan_name.to_s)).delete
+    end
+
+    def mark_rest_environment_dependencies(supported_test_list, status_to_mark = :lpv)
+      get_incomplete_tests.each do |current_test|
+        add_result_by_case_name(current_test, status_to_mark, 'Not supported on this test environment') unless supported_test_list.include?(current_test)
+      end
+    end
+
+    private
+
+    def init_run_in_plan(run_name)
+      @plan.entries.each { |entry| @run = entry.runs.first if entry.name == run_name }
+      @run = @plan.add_entry(run_name, @suite.id).runs.first if @run.nil?
+      OnlyofficeLoggerHelper.log("Initialized run: #{@run.name}")
+    end
+
+    def get_plan_name_by_substring(string)
+      @project.get_plans.each { |plan| return plan['name'] if plan['name'].include?(string) }
+      string
+    end
+
+    def all_suites_names
+      @suites ? (return @suites) : @suites = []
+      @project.get_suites
+      @project.suites_names.each_key { |key| @suites << key }
+      @suites.sort!
+    end
+
+    def ignore_case?(example_metadata)
+      raise 'Ignore parameters must be Hash!!' unless @ignore_parameters.instance_of?(Hash)
+
+      @ignore_parameters.each { |key, value| return { key => value } if example_metadata[key] == value }
+      false
+    end
+
+    def suites_to_add_hash(suites_names)
+      suites_names.map { |suite| all_suites_names.include?(suite) ? { 'suite_id' => @project.suites_names[suite] } : { 'suite_id' => @project.create_new_suite(suite).id } }
+    end
+  end
+end