onlyoffice_testrail_wrapper 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19634fbfe2b46911fd5e1f2cb47fd4d832bb0daea5ef9696ee1b8af9c3437b6e
-  data.tar.gz: 3fb395f8bf1ae4f6358de89f79c2fa84aab9841981c7708c3e1c2238606683cc
+  metadata.gz: 52534448b28a8c38d7f7089d063f17cc06129cf8d1b0c404fedc68f327a7251c
+  data.tar.gz: c1a1b6b8f5d96aaadac8cb0fb748380b6ce9c349fcb61d16457719b6c3e36307
 SHA512:
-  metadata.gz: a4adc0fea2c094fa440e75af45428e11d3c5e719ebe2b0bf1448fc827ae26d70dcac81ac6bbc0b70941a2bc2ac647415f711efa2b02648d294167261863d9960
-  data.tar.gz: b84ee3c105b0266d153dd095f27303af39620d75342018c71eaab625d10d533496628e0b9801ecfb9589b5b680cdb5a82253764162cbe34390c38ec2603fc823
+  metadata.gz: 185e5eb0f882db675dbba8cc1ee5b54eac489b4e0b9f4a5043819c7c24921342be1260b78a5d3c36d47915f2b408fd8d46d4b9ce60841b2a2ef512305735c977
+  data.tar.gz: f6b90d93b5faaa7215981f5b5011078f64684eddbb8d8cf3f478ab7114eac1cf2a46eaed85c2d3721f69c1eb16db19fda7c0543743893ae27e12470753b5c94a

data/lib/onlyoffice_testrail_wrapper/helpers/rspec_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'onlyoffice_file_helper'
+
 module OnlyofficeTestrailWrapper
   # Methods to some rspec methods
   module RspecHelper

data/lib/onlyoffice_testrail_wrapper/helpers/ruby_helper.rb

@@ -3,6 +3,8 @@
 module OnlyofficeTestrailWrapper
   # Methods to work with ruby
   module RubyHelper
+    # Check if current process run in debug mode
+    # @return [Boolean] true if in debug mode, false otherwise
     def debug?
       ENV['RUBYLIB'].to_s.include?('ruby-debug')
     end

data/lib/onlyoffice_testrail_wrapper/helpers/string_helper.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 module OnlyofficeTestrailWrapper
+  # Helper for working with strings
   class StringHelper
     class << self
+      # Check if string is have spaces in begin or end and remove them
+      # @param [String] string to check
+      # @return [String] string without spaces in begin or end
       def warnstrip!(string)
         warn "Beginning or end of string has spaces! In: #{string}" unless string == string.strip
         string.strip

data/lib/onlyoffice_testrail_wrapper/mock/rspec_example_mock.rb

@@ -5,8 +5,13 @@ module OnlyofficeTestrailWrapper
   class RspecExceptionMock
     attr_accessor :backtrace
 
-    def initialize
-      @backtrace = %w[TestBackTraceLine1 TestBackTraceLine2]
+    def initialize(backtrace = %w[TestBackTraceLine1 TestBackTraceLine2])
+      @backtrace = backtrace
+    end
+
+    # @return [String] string version of exception
+    def to_s
+      @backtrace
     end
   end
 
@@ -31,7 +36,7 @@ module OnlyofficeTestrailWrapper
     def initialize(description: 'MockDescription',
                    exception: RspecExceptionMock.new)
       @exception = exception
-      @metadata = { execution_result: RspecExceptionResultMock.new }
+      @metadata = { execution_result: RspecExceptionResultMock.new, absolute_file_path: __FILE__ }
       @pending = false
       @description = description
       @section = ''

data/lib/onlyoffice_testrail_wrapper/testrail/requests_helper.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Module for working with requests
+  module RequestsHelper
+    # Send request to Testrail
+    # @param [URI] uri uri to send request
+    # @param [Net::HTTP::Get, Net::HTTP::Post] request request to send
+    # @return [Net::HTTPResponse] response from Testrail
+    def 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')
+      @connection ||= Net::HTTP.start(uri.host, uri.port, use_ssl: is_ssl)
+      @connection.start unless @connection.started?
+      attempts = 0
+      begin
+        response = @connection.request(request)
+      rescue Timeout::Error
+        attempts += 1
+        retry if attempts < 3
+        raise 'Timeout error after 3 attempts'
+      end
+      response
+    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
+end

data/lib/onlyoffice_testrail_wrapper/testrail.rb

@@ -7,6 +7,7 @@ require 'net/http'
 require 'json'
 require 'yaml'
 require_relative 'testrail_project'
+require_relative 'testrail/requests_helper'
 
 module OnlyofficeTestrailWrapper
   # Main class for working with testrail
@@ -20,7 +21,8 @@ module OnlyofficeTestrailWrapper
   #  current_test.add_result(Testrail2::TEST_RESULT_OK, 'description','version')
   #  incomplete_test = test_run_from_api.get_incomplete_tests()
   # end1
-  class Testrail2
+  class Testrail2 < TestrailApiObject
+    extend RequestsHelper
     # @return [String] address of testrail
     @testrail_url = nil
     # @return [String] login for admin user
@@ -28,13 +30,6 @@ module OnlyofficeTestrailWrapper
     # @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
@@ -43,12 +38,12 @@ module OnlyofficeTestrailWrapper
       attr_writer :admin_pass
 
       # @return [String] default config location
-      CONFIG_LOCATION = "#{Dir.home}/.gem-onlyoffice_testrail_wrapper/config.yml"
+      CONFIG_LOCATION = "#{Dir.home}/.gem-onlyoffice_testrail_wrapper/config.yml".freeze
 
       def read_keys
-        @testrail_url = ENV['TESTRAIL_URL']
-        @admin_user = ENV['TESTRAIL_USER']
-        @admin_pass = ENV['TESTRAIL_PASSWORD']
+        @testrail_url = ENV.fetch('TESTRAIL_URL', 'http://unknown.url')
+        @admin_user = ENV.fetch('TESTRAIL_USER', nil)
+        @admin_pass = ENV.fetch('TESTRAIL_PASSWORD', nil)
         return unless @admin_user.nil? && @admin_pass.nil?
 
         begin
@@ -62,12 +57,12 @@ module OnlyofficeTestrailWrapper
       end
 
       def admin_user
-        read_keys
+        read_keys unless @admin_user
         @admin_user
       end
 
       def admin_pass
-        read_keys
+        read_keys unless @admin_pass
         @admin_pass
       end
 
@@ -75,30 +70,6 @@ module OnlyofficeTestrailWrapper
         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
@@ -115,19 +86,22 @@ module OnlyofficeTestrailWrapper
     end
 
     # Get all projects on testrail
-    # @return [Array, ProjectTestrail] array of projects
+    # @return [Array<TestrailProject>] array of projects data
     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 = []
+      Testrail2.http_get('index.php?/api/v2/get_projects').each do |project|
+        projects << TestrailProject.new.init_from_hash(project)
+      end
       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)
+      new_project = TestrailProject.new.init_from_hash(Testrail2.http_post('index.php?/api/v2/add_project',
+                                                                           name: StringHelper.warnstrip!(name.to_s),
+                                                                           announcement: announcement,
+                                                                           show_announcement: show_announcement))
       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.instance_variable_set(:@testrail, self)
       new_project
     end
 
@@ -142,15 +116,22 @@ module OnlyofficeTestrailWrapper
     # 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)
+      project = TestrailProject.new.init_from_hash(Testrail2.http_get("index.php?/api/v2/get_project/#{id}"))
       OnlyofficeLoggerHelper.log("Initialized project: #{project.name}")
-      project.instance_variable_set('@testrail', self)
+      project.instance_variable_set(:@testrail, self)
       project
     end
 
+    # Get Testrail project by it's name
+    # @param [String] name name of project
+    # @return [TestrailProject, nil] project with this name or nil if not found
     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)])
+      projects = get_projects
+      project_name = StringHelper.warnstrip!(name.to_s)
+      project = projects.find { |current_project| current_project.name == project_name }
+      return nil unless project
+
+      project
     end
 
     # Check if Testrail connection is available
@@ -161,27 +142,5 @@ module OnlyofficeTestrailWrapper
     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_api_object.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Base class for all Testrail API objects
+  class TestrailApiObject
+    # Fill object data from hash with data
+    # @param [Hash] hash with data
+    # @return
+    def init_from_hash(hash)
+      hash.each { |key, value| instance_variable_set(:"@#{key}", value) }
+      self
+    end
+
+    # Generate hash wih pars of name:id
+    # @param [Array<Hash>] array of raw data
+    # @param [String, Symbol] name_key how name key is called in hash
+    # @return [Hash] result hash data
+    def name_id_pairs(array, name_key = 'name')
+      raise 'First argument must be Array!' unless array.is_a?(Array)
+
+      result_hash = {}
+      array.reverse_each { |element| result_hash[element[name_key]] = element['id'] }
+      result_hash
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_case.rb

@@ -3,7 +3,7 @@
 module OnlyofficeTestrailWrapper
   # @author Roman.Zagudaev
   # Class for description of test case
-  class TestrailCase
+  class TestrailCase < TestrailApiObject
     # @return [Integer] Id of test case
     attr_accessor :id
     # @return [String] title of test case
@@ -25,6 +25,7 @@ module OnlyofficeTestrailWrapper
     # @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)
+      super()
       @id = id
       @title = title
       @type_id = type_id
@@ -35,8 +36,11 @@ module OnlyofficeTestrailWrapper
     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)
+      TestrailCase.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/update_case/#{@id}",
+                                                          title: title,
+                                                          type_id: type_id,
+                                                          priority_id: priority_id,
+                                                          custom_steps: custom_steps))
     end
 
     def delete
@@ -47,13 +51,15 @@ module OnlyofficeTestrailWrapper
 
     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.each_with_index { |test_case, index| case_results[index] = TestrailResult.new.init_from_hash(test_case) }
       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)
+      response = TestrailResult.new.init_from_hash(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)))
       OnlyofficeLoggerHelper.log "Set test case result: #{result}. URL: #{Testrail2.get_testrail_address}index.php?/tests/view/#{response.test_id}", output_colors[result]
       response
     end

data/lib/onlyoffice_testrail_wrapper/testrail_helper/example_failed_got_expected_exception.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Class for exception then result contains `got` and `expected`
+  class ExampleFailedGotExpectedException
+    def initialize(example)
+      @example = example
+    end
+
+    # @return [Symbol] result of this exception
+    def result
+      :failed
+    end
+
+    # @return [String] comment for this exception
+    def comment
+      return @comment if @comment
+
+      failed_line = RspecHelper.find_failed_line(@example)
+      @comment = "\n#{@example.exception
+                              .to_s
+                              .gsub('got:', "got:\n")
+                              .gsub('expected:', "expected:\n")}\nIn line:\n#{failed_line}"
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_helper/example_lpv_exception.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Class for example with LPV exception
+  class ExampleLPVException
+    def initialize(example)
+      @example = example
+    end
+
+    # @return [Symbol] result of this exception
+    def result
+      :lpv
+    end
+
+    # @return [String] comment for this exception
+    def comment
+      "\n#{@example.exception}"
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_helper/example_service_unavailable_exception.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Class for example with exception `Service Unavailable`
+  class ExampleServiceUnavailableException
+    def initialize(example)
+      @example = example
+    end
+
+    # @return [Symbol] result of this exception
+    def result
+      :service_unavailable
+    end
+
+    # @return [String] comment for this exception
+    def comment
+      "\n#{@example.exception}"
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_helper.rb

@@ -2,7 +2,9 @@
 
 require 'onlyoffice_bugzilla_helper'
 require_relative 'testrail_helper/testrail_helper_rspec_metadata'
-require_relative 'testrail_helper/testrail_status_helper'
+require_relative 'testrail_helper/example_failed_got_expected_exception'
+require_relative 'testrail_helper/example_lpv_exception'
+require_relative 'testrail_helper/example_service_unavailable_exception'
 require_relative 'testrail'
 require_relative 'helpers/ruby_helper'
 require_relative 'helpers/system_helper'
@@ -12,9 +14,8 @@ module OnlyofficeTestrailWrapper
   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
+    attr_accessor :add_all_suites, :suites_to_add, :in_debug, :version
 
     def initialize(project_name, suite_name = nil, plan_name = nil, run_name = nil)
       @in_debug = debug?
@@ -23,7 +24,7 @@ module OnlyofficeTestrailWrapper
       rescue Errno::ENOENT
         @bugzilla_helper = nil
       end
-      if @in_debug
+      if skip_testrail_connection?
         OnlyofficeLoggerHelper.log 'Do not initialize Testrail, because spec run in debug'
         @run = TestrailRun.new
         return
@@ -31,11 +32,10 @@ module OnlyofficeTestrailWrapper
       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.get_plan_by_name(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?
@@ -71,10 +71,7 @@ module OnlyofficeTestrailWrapper
       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
+      if 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
@@ -84,18 +81,20 @@ module OnlyofficeTestrailWrapper
         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}"
+        testrail_exception = ExampleFailedGotExpectedException.new(example)
+        result = testrail_exception.result
+        comment += testrail_exception.comment
       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}"
+        testrail_exception = ExampleServiceUnavailableException.new(example)
+        result = testrail_exception.result
+        comment += testrail_exception.comment
       elsif exception.to_s.include?('Limited program version')
-        result = :lpv
-        comment += "\n#{exception}"
+        testrail_exception = ExampleLPVException.new(exception)
+        result = testrail_exception.result
+        comment += testrail_exception.comment
       elsif exception.nil?
         result = if @last_case == example.description
                    :passed_2
@@ -114,29 +113,8 @@ module OnlyofficeTestrailWrapper
       @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
+      @run.get_tests.filter_map { |test| test['title'] if test['status_id'] == 3 || test['status_id'] == 4 }
     end
 
     private
@@ -147,11 +125,6 @@ module OnlyofficeTestrailWrapper
       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
@@ -159,15 +132,19 @@ module OnlyofficeTestrailWrapper
       @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
+
+    # Check if we should skip connecting to testrail
+    # In debug mode (except when `TESTRAIL_IN_DEBUG` env is set)
+    # we do not do that for easy debugging E2E tests
+    # @return [Boolean]
+    def skip_testrail_connection?
+      return false unless @in_debug
+      return false if ENV['TESTRAIL_IN_DEBUG']
+
+      true
+    end
   end
 end

data/lib/onlyoffice_testrail_wrapper/testrail_milestone.rb

@@ -1,21 +1,39 @@
 # frozen_string_literal: true
 
 module OnlyofficeTestrailWrapper
-  class TestrailMilestone
-    attr_accessor :id, :name, :description, :is_completed
+  # Class for describing milestone data
+  class TestrailMilestone < TestrailApiObject
+    # @return [Integer] id of milestone
+    attr_accessor :id
+    # @return [String] name of milestone
+    attr_accessor :name
+    # @return [String] description of milestone
+    attr_accessor :description
+    # @return [Boolean] is this milestone completed
+    attr_accessor :is_completed
 
     def initialize(name = '', description = '', is_completed = false, id = nil)
+      super()
       @id = id.to_i
       @name = name
       @description = description
       @is_completed = is_completed
     end
 
+    # Update current milestone
+    # @param [Boolean] is_completed is milestone should be completed
+    # @param [String] name new name of milestone
+    # @param [String] description new description of milestone
+    # @return [TestrailMilestone] updated milestone data
     def update(is_completed = false, name = @name, description = @description)
-      HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_milestone/#{@id}", name: name, description: description,
-                                                                                                          is_completed: is_completed), TestrailMilestone)
+      TestrailMilestone.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/update_milestone/#{@id}",
+                                                               name: name,
+                                                               description: description,
+                                                               is_completed: is_completed))
     end
 
+    # Delete current milestone
+    # @return [Hash] result of http request
     def delete
       Testrail2.http_post "index.php?/api/v2/delete_milestone/#{@id}", {}
     end