onlyoffice_testrail_wrapper 0.1.0

data/lib/onlyoffice_testrail_wrapper/testrail_result.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # @author Roman.Zagudaev
+  # Class for working with Test results
+  class TestrailResult
+    RESULT_STATUSES = { passed: 1, blocked: 2, untested: 3, retest: 4, failed: 5, passed_2: 6, work_for_me: 7,
+                        pending: 8, aborted: 9, js_error: 10, lpv: 11, service_unavailable: 12 }.freeze
+    # @return [Integer] Id of test result
+    attr_accessor :id
+    # @return [String] Title of test result
+    attr_accessor :title
+    # @return [Integer] Status id of result
+    attr_accessor :status_id
+    # @return [String] Comment of result
+    attr_accessor :comment
+    # @return [String] Version
+    attr_accessor :version
+    # @return [Integer] date of creation of result from begging of era
+    attr_accessor :created_on
+    attr_reader :test_id
+    # @return [String] error if any happened
+    attr_accessor :error
+
+    # Default constructor
+    # @param [Symbol] status status to set. Could be :passed, blocked, retest or :failed
+    # @param [String] comment Comment of result
+    # @param [String] version Version
+    # @return [TestResultTestRail] new Test result
+    def initialize(status = nil, comment = nil, version = nil)
+      @title = status.to_s
+      @status_id = RESULT_STATUSES[status]
+      @comment = comment
+      @version = version
+      @error = nil
+    end
+
+    # Add result of test result
+    # @param [Integer] status id of status to set
+    # @param [String] comment comment of result
+    # @param [String] version version of test program
+    # @return nothing
+    # def add_result(status, comment, version)
+    #  Testrail2.http_post(Testrail2.add_test_result(self.id), {:status_id => RESULT_STATUSES[status], :comment => comment, :version => version})
+    # end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_run.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative 'testrail_test'
+
+module OnlyofficeTestrailWrapper
+  # @author Roman.Zagudaev
+  # Class for working with TestRun in TestRail
+  class TestrailRun
+    # @return [String] Name of test Run
+    attr_accessor :name
+    # @return [Integer] Id of test run
+    attr_accessor :id
+    # @return [Integer] Id of test suite
+    attr_accessor :suite_id
+    # @return [Integer] Id of project
+    attr_accessor :project_id
+    # @return [String] Description of test run
+    attr_accessor :description
+    # @return [Integer] Id of milestone
+    attr_accessor :milestone_id
+    # @return [Integer] Id of user to thom test assigned
+    attr_accessor :assignedto_id
+    # @return [Bool] parameter of including all test cases
+    attr_accessor :include_all_cases
+    # @return [Integer] Count of failed tests
+    attr_accessor :failed_count
+    # @return [Integer] Count of untested tests
+    attr_accessor :untested_count
+    # @return [Integer] Count of retest tests
+    attr_accessor :retest_count
+    # @return [Integer] Count of passed tests
+    attr_accessor :passed_count
+    # @return [Array] case Id's to include to run
+    # attr_accessor :case_ids
+    # @return [String] url to current test run
+    attr_reader :url
+    attr_accessor :tests_names
+    # @return [Array] array of arrays of TestResults
+    attr_accessor :test_results
+
+    # Default constructor
+    # @param [Integer] id id of test, default = nil
+    # @param [String] name name of test run, default = nil
+    # @param [String] description description of test run
+    # @return [TestRunTestRail] new Test run
+    def initialize(name = '', description = '', suite_id = nil, id = nil)
+      @id = id
+      @name = name
+      @description = description
+      @suite_id = suite_id
+      @tests_names = {}
+      @test_results = []
+    end
+
+    # Get all incomplete test (With status 'Untested' or 'Rerun')
+    # @return [Array, TestCaseTestrail] array of test cases
+    def get_incomplete_tests
+      incomplete_tests = []
+      get_tests.each do |test|
+        incomplete_tests << test if test.status_id == TestrailResult::RESULT_STATUSES[:retest] ||
+                                    test.status_id == TestrailResult::RESULT_STATUSES[:untested]
+      end
+      incomplete_tests
+    end
+
+    def close
+      test_run = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/close_run/#{@id}", {}), TestrailRun)
+      OnlyofficeLoggerHelper.log "Closed run: #{@name}"
+      test_run
+    end
+
+    def test(name_or_id)
+      case name_or_id.class.to_s
+      when 'Fixnum', 'Integer'
+        get_test_by_id name_or_id
+      when 'String'
+        get_test_by_name name_or_id
+      else
+        raise 'Wrong argument. Must be name [String] or id [Integer]'
+      end
+    end
+
+    def get_test_by_id(id)
+      HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_test/#{id}"), TestrailTest)
+    end
+
+    # Get all tests
+    # @return [Array, TestCaseTestrail] array of test cases
+    def get_tests
+      tests = Testrail2.http_get "index.php?/api/v2/get_tests/#{@id}"
+      @tests_names = HashHelper.get_hash_from_array_with_two_parameters(tests, 'title', 'id') if @tests_names.empty?
+      tests
+    end
+
+    def get_test_by_name(name)
+      get_tests if @tests_names.empty?
+      @tests_names[StringHelper.warnstrip!(name.to_s.dup)].nil? ? nil : get_test_by_id(@tests_names[name])
+    end
+
+    def add_result_by_case_id(result, case_id, comment = '', version = '')
+      HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_result_for_case/#{@id}/#{case_id}",
+                                                             status_id: TestrailResult[result], comment: comment, version: version), TestrailResult)
+    end
+
+    def parent_suite
+      @suite = TestrailTest.http_get "index.php?/api/v2/get_suite/#{@suite_id}"
+    end
+
+    def update(name = @name, description = @description)
+      @project.runs_names.delete @name
+      @project.runs_names[StringHelper.warnstrip!(name.to_s)] = @id
+      updated_plan = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_run/#{@id}", name: name, description: description), TestrailRun)
+      OnlyofficeLoggerHelper.log "Updated run: #{updated_plan.name}"
+      updated_plan
+    end
+
+    def delete
+      @project.runs_names.delete name
+      Testrail2.http_post "index.php?/api/v2/delete_run/#{@id}", {}
+      OnlyofficeLoggerHelper.log "Deleted run: #{@name}"
+      nil
+    end
+
+    def pull_tests_results
+      @test_results = {}
+      all_tests = get_tests
+      all_tests.each do |current_test|
+        test_data = test(current_test['id'])
+        @test_results.merge!(test_data.title => test_data.get_results)
+      end
+      OnlyofficeLoggerHelper.log "Get test results for run: #{@name}"
+    end
+
+    # Calculate duration of all tests in current spec in hours
+    # @return [Float] duration of tests in hours
+    def duration
+      pull_tests_results
+      test_results_date_array = []
+      @test_results.each_value do |test_result_sets|
+        test_result_sets.each do |test_result|
+          test_results_date_array << test_result.created_on
+        end
+      end
+      ((test_results_date_array.max - test_results_date_array.min).to_f / (60 * 60)).round(2)
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_section.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative 'testrail_case'
+
+module OnlyofficeTestrailWrapper
+  # @author Roman.Zagudaev
+  # Class for description of test sections
+  class TestrailSection
+    # @return [Integer] Id of test section
+    attr_accessor :id
+    # @return [Integer] Id of parent test section
+    attr_accessor :parent_id
+    # @return [String] Name of test section
+    attr_accessor :name
+    # @return [Integer] Id of suite
+    attr_accessor :suite_id
+    # @return [Array, TestrailCase] cases inside section
+    attr_accessor :cases_names
+
+    # Default constructor
+    # @param [String] name name of test section, default = ""
+    # @param [Integer] id id of test section, default = nil
+    # @param [Integer] parent_id id of parent section, default = nil
+    # @param [Integer] suite_id id of test suite
+    # @return [TestSectionTestRail] new Test section
+    def initialize(name = '', parent_id = nil, suite_id = nil, id = nil)
+      @id = id
+      @name = name
+      @suite_id = suite_id
+      @parent_id = parent_id
+    end
+
+    def case(name_or_id)
+      case name_or_id.class.to_s
+      when 'Fixnum'
+        get_case_by_id name_or_id
+      when 'String'
+        if name_or_id.to_s.length > 250
+          OnlyofficeLoggerHelper.log("There is limit for testcase name for 250 symbols. '#{name_or_id}' too long. It will cut")
+          name_or_id = name_or_id.to_s[0..249]
+        end
+        init_case_by_name name_or_id
+      else
+        raise 'Wrong argument. Must be name [String] or id [Integer]'
+      end
+    end
+
+    def get_case_by_id(id)
+      test_case = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_case/#{id}"), TestrailCase)
+      test_case.instance_variable_set '@section', self
+      test_case
+    end
+
+    # Get all cases of section
+    # @return [Array, TestCaseTestrail] array of test cases
+    def get_cases
+      # raise 'Project id is not identified' if @project_id.nil?
+      cases = Testrail2.http_get("index.php?/api/v2/get_cases/#{@project_id}&suite_id=#{@suite_id}&section_id=#{@id}")
+      @cases_names = HashHelper.get_hash_from_array_with_two_parameters(cases, 'title', 'id') if @cases_names.nil?
+      cases
+    end
+
+    def get_case_by_name(name)
+      get_cases if @cases_names.nil?
+      corrected_case_name = StringHelper.warnstrip!(name.to_s)
+      return nil if @cases_names[corrected_case_name].nil?
+
+      get_case_by_id(@cases_names[corrected_case_name])
+    end
+
+    # Init case by it's name
+    # @param [String] name name of test case
+    # @return [TestrailCase] test case with this name
+    def init_case_by_name(name)
+      test_case = get_case_by_name name
+      test_case.nil? ? create_new_case(name) : test_case
+    end
+
+    # Add test case to current Section
+    # @param [String] title name of test case to add
+    # @param [Integer] type_id type of test case to add (Default = 3)
+    # @param [Integer] priority_id id of priority of case (Default = 4)
+    # @param [String] custom_steps steps to perform
+    # @return [TestCaseTestrail] created test case
+    def create_new_case(title, type_id = 3, priority_id = 4, custom_steps = '')
+      new_case = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_case/#{@id}", title: StringHelper.warnstrip!(title.to_s), type_id: type_id,
+                                                                                                             priority_id: priority_id, custom_steps: custom_steps), TestrailCase)
+      new_case.instance_variable_set('@section', self)
+      OnlyofficeLoggerHelper.log "Created new case: #{new_case.title}"
+      @cases_names[new_case.title] = new_case.id
+      new_case
+    end
+
+    def update(name = @name, parent_id = @parent_id)
+      @suite.sections_names.delete @name
+      @suite.sections_names[StringHelper.warnstrip!(name.to_s)] = @id
+      updated_section = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_section/#{@id}", name: name, parent_id: parent_id), TestrailSection)
+      OnlyofficeLoggerHelper.log "Updated section: #{updated_section.name}"
+      updated_section
+    end
+
+    def delete
+      @suite.sections_names.delete @name
+      Testrail2.http_post "index.php?/api/v2/delete_section/#{@id}", {}
+      OnlyofficeLoggerHelper.log "Deleted section: #{@name}"
+      nil
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_suite.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require_relative 'testrail_project'
+require_relative 'testrail_section'
+require_relative 'testrail_run'
+
+module OnlyofficeTestrailWrapper
+  # @author Roman.Zagudaev
+  # Class for description of test suites
+  class TestrailSuite
+    # @return [Integer] Id of test suite
+    attr_accessor :id
+    # @return [String] Name of test suite
+    attr_accessor :name
+    # @return [String]  description of test suite
+    attr_accessor :description
+    # @return [true, false] id of project of test suite
+    attr_accessor :project_id
+    # @return [Array] sections in suite
+    attr_accessor :sections_names
+    # @return [String] url to current suite
+    attr_reader :url
+
+    # Default constructor
+    # @param [Integer] id id of test suite, default = nil
+    # @param [String] name name of test suite, default = nil
+    # @param [String] description description of test suite, default = nil
+    # @param [Integer] project_id id of project of test suite
+    # @return [TestrailSuite] new Test suite
+    def initialize(name = nil, description = nil, project_id = nil, id = nil)
+      @id = id
+      @name = name
+      @description = description
+      @project_id = project_id
+    end
+
+    # Start test run from test suite
+    # @param [String] name name of started test run
+    # @param [String] description description of test run
+    # @return [TestRunTestRail] created test run
+    def start_test_run(name, description = '')
+      HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_run/#{@project_id}", name: StringHelper.warnstrip!(name.to_s), description: description, suite_id: @id), TestrailRun)
+    end
+
+    def section(name_or_id = 'All Test Cases')
+      case name_or_id.class.to_s
+      when 'Fixnum'
+        get_section_by_id name_or_id
+      when 'String'
+        init_section_by_name name_or_id
+      else
+        raise 'Wrong argument. Must be name [String] or id [Integer]'
+      end
+    end
+
+    # Create new section of test suite
+    # @param [String] name of test section to create
+    # @param [Integer] parent_section id of parent section, default = nil
+    def create_new_section(name, parent_section = nil)
+      parent_section = get_section_by_name(parent_section).id if parent_section.is_a?(String)
+      new_section = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_section/#{@project_id}", name: StringHelper.warnstrip!(name.to_s),
+                                                                                                                           parent_id: parent_section, suite_id: @id), TestrailSection)
+      OnlyofficeLoggerHelper.log "Created new section: #{new_section.name}"
+      @sections_names[new_section.name] = new_section.id
+      new_section.instance_variable_set '@project_id', @project_id
+      new_section.instance_variable_set '@suite', self
+      new_section
+    end
+
+    # Get all sections in test suite
+    # @return [Array, TestrailSuite] array with sections
+    def get_sections
+      sections = Testrail2.http_get("index.php?/api/v2/get_sections/#{@project_id}&suite_id=#{@id}")
+      @sections_names = HashHelper.get_hash_from_array_with_two_parameters(sections, 'name', 'id') if @sections_names.nil?
+      sections
+    end
+
+    def get_section_by_id(id)
+      section = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_section/#{id}"), TestrailSection)
+      section.instance_variable_set '@project_id', @project_id
+      section.instance_variable_set '@suite', self
+      section
+    end
+
+    def get_section_by_name(name)
+      get_sections if @sections_names.nil?
+      @sections_names[StringHelper.warnstrip!(name.to_s)].nil? ? nil : get_section_by_id(@sections_names[name])
+    end
+
+    # Init section by it's name
+    # @param [String] name name of section
+    # @return [TestrailSection] Section with this name
+    def init_section_by_name(name, parent_section = nil)
+      found_section = get_section_by_name name
+      found_section.nil? ? create_new_section(name, parent_section) : found_section
+    end
+
+    def delete
+      Testrail2.http_post "index.php?/api/v2/delete_suite/#{@id}", {}
+      OnlyofficeLoggerHelper.log "Deleted suite: #{@name}"
+      @project.suites_names.delete @name
+      nil
+    end
+
+    def update(name, description = nil)
+      @project.suites_names.delete @name
+      @project.suites_names[StringHelper.warnstrip!(name.to_s)] = @id
+      updated_suite = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_suite/#{@id}", name: name, description: description), TestrailSuite)
+      OnlyofficeLoggerHelper.log "Updated suite: #{updated_suite.name}"
+      updated_suite
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'testrail_result'
+
+module OnlyofficeTestrailWrapper
+  class TestrailTest
+    # @return [Integer] test id
+    attr_accessor :id
+    # @return [Integer] test run id
+    attr_accessor :run_id
+    # @return [Integer] status id
+    attr_accessor :status_id
+    # @return [Integer] case id
+    attr_accessor :case_id
+    # @return [String] test title
+    attr_accessor :title
+    # @return [Integer] assigned to id
+    attr_accessor :assignedto_id
+
+    def initialize(id = nil, run_id = nil, case_id = nil, title = '')
+      @id = id
+      @title = title
+      @case_id = case_id
+      @run_id = run_id
+    end
+
+    def get_results
+      @results.nil? ? @results = Testrail2.http_get("index.php?/api/v2/get_results/#{@id}") : (return @results)
+      @results.each_with_index { |result, index| @results[index] = HashHelper.parse_to_class_variable(result, TestrailResult) }
+      @results
+    end
+
+    def add_result(result, comment = '', version = '')
+      result = TestrailResult::RESULT_STATUSES[result] if result.is_a?(Symbol)
+      HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_result/#{@id}", status_id: result,
+                                                                                                    comment: comment, version: version), TestrailResult)
+      OnlyofficeLoggerHelper.log "Set test result: #{result}"
+    end
+  end
+end