onlyoffice_testrail_wrapper 0.1.0

data/lib/onlyoffice_testrail_wrapper/testrail_helper/testrail_helper_rspec_metadata.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Module for working with rspec metadata
+  module TestrailHelperRspecMetadata
+    # @return [String] version of tested app
+    def version
+      return @version if @version
+      return @plan.name if @plan&.name
+
+      'Unknown'
+    end
+
+    # @return [String] example execution time in seconds
+    def example_time_in_seconds(example)
+      execution_time = (Time.now - example.metadata[:execution_result].started_at).to_i
+      execution_time = 1 if execution_time.zero? # Testrail cannot receive 0 as elapsed time
+      "#{execution_time}s"
+    end
+
+    # Fill default values for custom fields
+    # @param [RSpec::Core::Example] example with metadata
+    # @return [Hash] custom fields
+    def init_custom_fields(example)
+      custom_fields = {}
+      # TODO: Fix dependencies from other project
+      return custom_fields if defined?(AppManager).nil?
+
+      custom_fields[:elapsed] = example_time_in_seconds(example)
+      custom_fields[:version] = version
+      custom_fields[:custom_host] = SystemHelper.hostname
+      custom_fields[:custom_screenshot_link] = screenshot_link if example.exception
+      custom_fields
+    end
+
+    # @return [String] link to screenshot
+    # empty string if not supported
+    def screenshot_link
+      return AppManager.create_screenshots if AppManager.respond_to?(:create_screenshots)
+
+      ''
+    end
+
+    def parse_pending_comment(pending_message)
+      return [:pending, 'There is problem with initialization of @bugzilla_helper', nil] if @bugzilla_helper.nil?
+
+      bug_id = @bugzilla_helper.bug_id_from_string(pending_message)
+      return [:pending, pending_message] if bug_id.nil?
+
+      bug_status = @bugzilla_helper.bug_status(bug_id)
+      status = bug_status.include?('VERIFIED') ? :failed : :pending
+      [status, "#{pending_message}\nBug has status: #{bug_status}, test was failed", bug_id]
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_helper/testrail_status_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  module TestrailStatusHelper
+    # check the statuses is exist
+    # @param [Array] status with symbols
+    def check_status_exist(status)
+      status = [status] unless status.is_a?(Array)
+      status.each do |current_status|
+        unless current_status.is_a?(Symbol)
+          raise "Founded status '#{current_status}' is a '#{current_status.class}'! " \
+                'All statuses must be symbols'
+        end
+        raise 'One or some statuses is not found. Pls, check it' unless TestrailResult::RESULT_STATUSES.key?(current_status)
+      end
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_milestone.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  class TestrailMilestone
+    attr_accessor :id, :name, :description, :is_completed
+
+    def initialize(name = '', description = '', is_completed = false, id = nil)
+      @id = id.to_i
+      @name = name
+      @description = description
+      @is_completed = is_completed
+    end
+
+    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)
+    end
+
+    def delete
+      Testrail2.http_post "index.php?/api/v2/delete_milestone/#{@id}", {}
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_plan.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative 'testrail_plan_entry'
+
+module OnlyofficeTestrailWrapper
+  class TestrailPlan
+    # @return [Integer] Id of test plan
+    attr_accessor :id
+    # @return [String] test run name
+    attr_accessor :name
+    # @return [Integer] Id of project
+    attr_accessor :project_id
+    # @return [String] test plan description
+    attr_accessor :description
+    # @return [Array] test plan entries(Suites)
+    attr_accessor :entries
+    # @return [Integer] milestone id
+    attr_accessor :milestone_id
+    # @return [True, False] Completed this test plan or not
+    attr_accessor :is_completed
+    # @return [String] url to current test plan
+    attr_reader :url
+
+    def initialize(name = '', entries = [], description = '', milestone_id = nil, id = nil)
+      @name = name
+      @entries = entries
+      @description = description
+      @milestone_id = milestone_id
+      @id = id
+    end
+
+    def add_entry(name, suite_id, include_all = true, case_ids = [], assigned_to = nil)
+      entry = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_plan_entry/#{@id}", suite_id: suite_id, name: StringHelper.warnstrip!(name.to_s),
+                                                                                                                include_all: include_all, case_ids: case_ids, assigned_to: assigned_to), TestrailPlanEntry)
+      OnlyofficeLoggerHelper.log "Added plan entry: #{name.to_s.strip}"
+      entry.runs.each_with_index { |run, index| entry.runs[index] = HashHelper.parse_to_class_variable(run, TestrailRun) }
+      entry
+    end
+
+    def delete_entry(entry_id)
+      Testrail2.http_post "index.php?/api/v2/delete_plan_entry/#{@id}/#{entry_id}", {}
+    end
+
+    def delete
+      Testrail2.http_post "index.php?/api/v2/delete_plan/#{@id}", {}
+      OnlyofficeLoggerHelper.log "Deleted plan: #{@name}"
+      nil
+    end
+
+    def tests_results
+      run_results = {}
+      @entries.each do |current_entrie|
+        current_entrie.runs.each do |current_run|
+          current_run.pull_tests_results
+          run_results.merge!(current_run.name => current_run.test_results)
+        end
+      end
+      run_results
+    end
+
+    # Get run from plan
+    # @param run_name [String] run to find
+    # @return TestrailRun
+    def run(run_name)
+      @entries.each do |entry|
+        run = entry.runs.first
+        return run if run.name == run_name
+      end
+      nil
+    end
+
+    # Get all runs in current plan
+    # @return [Array, TestrailRuns]
+    def runs
+      runs = []
+      @entries.each do |entry|
+        runs << entry.runs.first
+      end
+      runs
+    end
+
+    # Generate array of durations of runs
+    # @return [Array] array of durations, sorted by descrease
+    def plan_durations
+      durations_hash = {}
+      runs.each do |current_run|
+        durations_hash[current_run.name] = current_run.duration
+      end
+      durations_hash.sort_by { |_, time| time }.reverse
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_plan_entry.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  class TestrailPlanEntry
+    attr_accessor :suite_id, :name, :assigned_to, :include_all, :case_ids, :runs
+
+    def initialize(params = {})
+      @suite_id = params.fetch(:suite_id, nil)
+      @name = params.fetch(:name, '')
+      @include_all = params.fetch(:include_all, true)
+      @case_ids = params.fetch(:case_ids, [])
+      @assigned_to = params.fetch(:assigned_to, nil)
+      @runs = params.fetch(:runs, [])
+    end
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_project.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+require_relative 'testrail_suite'
+require_relative 'testrail_run'
+require_relative 'testrail_plan'
+require_relative 'testrail_milestone'
+require_relative 'testrail_project/testrail_project_plan_helper'
+
+module OnlyofficeTestrailWrapper
+  # @author Roman.Zagudaev
+  # Class for working with Test Projects
+  class TestrailProject
+    include TestrailProjectPlanHelper
+    # @return [Integer] Id of project
+    attr_accessor :id
+    # @return [String] Name of project
+    attr_accessor :name
+    # @return [String] announcement string
+    attr_accessor :announcement
+    # @return [true, false] is show announcement option enabled
+    attr_accessor :show_announcement
+    # @return [true, false] is project completed
+    attr_accessor :is_completed
+    # @return [String] Date, when test completed
+    attr_accessor :completed_on
+    # @return [String] url to project
+    attr_accessor :url
+    # @return [Array<String>] name of suites
+    attr_accessor :suites_names
+    # @return [Array<String>] name of runs
+    attr_accessor :runs_names
+    # @return [Array<String>] name of planes
+    attr_accessor :plans_names
+    # @return [Array<String>] name of milestones
+    attr_accessor :milestones_names
+
+    # Default constructor
+    # @param id [id] id of project, default = nil
+    # @param name  [String] name of project, default = nil
+    # @param announcement [String] announcement of project, default = nil
+    # @param is_completed [true, false] is project completed, default = nil
+    # @return [TestRunTestRail] new Test run
+    def initialize(name = '', announcement = nil, show_announcement = true, is_completed = false, id = nil)
+      @id = id.to_i
+      @name = name
+      @announcement = announcement
+      @show_announcement = show_announcement
+      @is_completed = is_completed
+      @suites_names = {}
+      @runs_names = {}
+      @plans_names = {}
+      @milestones_names = {}
+    end
+
+    def update(is_completed = false, name = @name, announcement = @announcement, show_announcement = @show_announcement)
+      @testrail.projects_names.delete[@name]
+      @testrail.projects_names[StringHelper.warnstrip!(name.to_s)] = @id
+      updated_project = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_project/#{@id}", name: name, announcement: announcement,
+                                                                                                                          show_announcement: show_announcement, is_completed: is_completed), TestrailProject)
+      OnlyofficeLoggerHelper.log "Updated project: #{updated_project.name}"
+      updated_project
+    end
+
+    def delete
+      Testrail2.http_post "index.php?/api/v2/delete_project/#{@id}", {}
+      OnlyofficeLoggerHelper.log "Deleted project: #{@name}"
+      @testrail.projects_names.delete @name
+    end
+
+    # region: SUITE
+
+    def suite(name_or_id)
+      case name_or_id.class.to_s
+      when 'Fixnum'
+        get_suite_by_id name_or_id
+      when 'String'
+        init_suite_by_name name_or_id
+      else
+        raise 'Wrong argument. Must be name [String] or id [Integer]'
+      end
+    end
+
+    # Get all test runs of project
+    # @return [Array, TestrailSuite] array with runs
+    def get_suites
+      suites = Testrail2.http_get("index.php?/api/v2/get_suites/#{@id}")
+      @suites_names = HashHelper.get_hash_from_array_with_two_parameters(suites, 'name', 'id') if @suites_names.empty?
+      suites
+    end
+
+    # Get Test Suite by it's name
+    # @param [String] name name of test suite
+    # @return [TestrailSuite] test suite
+    def get_suite_by_name(name)
+      get_suites if @suites_names.empty?
+      @suites_names[StringHelper.warnstrip!(name)].nil? ? nil : get_suite_by_id(@suites_names[name])
+    end
+
+    def get_suite_by_id(id)
+      suite = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_suite/#{id}"), TestrailSuite)
+      suite.instance_variable_set('@project', self)
+      OnlyofficeLoggerHelper.log("Initialized suite: #{suite.name}")
+      suite
+    end
+
+    # Init suite by it's name
+    # @param [String] name name of suit
+    # @return [TestrailSuite] suite with this name
+    def init_suite_by_name(name)
+      found_suite = get_suite_by_name name
+      found_suite.nil? ? create_new_suite(name) : found_suite
+    end
+
+    # Create new test suite in project
+    # @param [String] name name of suite
+    # @param [String] description description of suite (default = nil)
+    # @return [TestrailSuite] created suite
+    def create_new_suite(name, description = '')
+      new_suite = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_suite/#{@id}", name: StringHelper.warnstrip!(name), description: description), TestrailSuite)
+      new_suite.instance_variable_set('@project', self)
+      OnlyofficeLoggerHelper.log "Created new suite: #{new_suite.name}"
+      @suites_names[new_suite.name] = new_suite.id
+      new_suite
+    end
+
+    # endregion
+
+    # region: RUN
+
+    def test_run(name_or_id)
+      case name_or_id.class.to_s
+      when 'Fixnum'
+        get_run_by_id name_or_id
+      when 'String'
+        init_run_by_name name_or_id
+      else
+        raise 'Wrong argument. Must be name [String] or id [Integer]'
+      end
+    end
+
+    # Get all test runs of project
+    # @return [Array, TestRunTestrail] array of test runs
+    def get_runs(filters = {})
+      get_url = "index.php?/api/v2/get_runs/#{@id}"
+      filters.each { |key, value| get_url += "&#{key}=#{value}" }
+      runs = Testrail2.http_get(get_url)
+      @runs_names = HashHelper.get_hash_from_array_with_two_parameters(runs, 'name', 'id') if @runs_names.empty?
+      runs
+    end
+
+    # Get Test Run by it's name
+    # @param [String] name name of test run
+    # @return [TestRunTestRail] test run
+    def get_run_by_name(name)
+      get_runs if @runs_names.empty?
+      @runs_names[StringHelper.warnstrip!(name)].nil? ? nil : get_run_by_id(@runs_names[name])
+    end
+
+    def get_run_by_id(id)
+      run = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_run/#{id}"), TestrailRun)
+      OnlyofficeLoggerHelper.log("Initialized run: #{run.name}")
+      run.instance_variable_set('@project', self)
+      run
+    end
+
+    def init_run_by_name(name, suite_id = nil)
+      found_run = get_run_by_name name
+      suite_id = get_suite_by_name(name).id if suite_id.nil?
+      found_run.nil? ? create_new_run(name, suite_id) : found_run
+    end
+
+    def create_new_run(name, suite_id, description = '')
+      new_run = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_run/#{@id}", name: StringHelper.warnstrip!(name), description: description, suite_id: suite_id), TestrailRun)
+      OnlyofficeLoggerHelper.log "Created new run: #{new_run.name}"
+      new_run.instance_variable_set('@project', self)
+      @runs_names[new_run.name] = new_run.id
+      new_run
+    end
+
+    # endregion
+
+    # region: MILESTONE
+
+    def milestone(name_or_id)
+      case name_or_id.class.to_s
+      when 'Fixnum'
+        get_milestone_by_id name_or_id
+      when 'String'
+        init_milestone_by_name name_or_id
+      else
+        raise 'Wrong argument. Must be name [String] or id [Integer]'
+      end
+    end
+
+    def init_milestone_by_name(name)
+      found_milestone = get_milestone_by_name name
+      found_milestone.nil? ? create_new_milestone(name) : found_milestone
+    end
+
+    def get_milestone_by_id(id)
+      milestone = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_milestone/#{id}"), TestrailMilestone)
+      OnlyofficeLoggerHelper.log("Initialized milestone: #{milestone.name}")
+      milestone
+    end
+
+    def get_milestone_by_name(name)
+      get_milestones if @milestones_names.empty?
+      @milestones_names[StringHelper.warnstrip!(name.to_s)].nil? ? nil : get_milestone_by_id(@milestones_names[name])
+    end
+
+    def get_milestones
+      milestones = Testrail2.http_get("index.php?/api/v2/get_milestones/#{@id}")
+      @milestones_names = HashHelper.get_hash_from_array_with_two_parameters(milestones, 'name', 'id') if @milestones_names.empty?
+      milestones
+    end
+
+    # @param [String] name of milestone
+    # @param [String] description of milestone
+    def create_new_milestone(name, description = '')
+      new_milestone = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_milestone/#{@id}", :name => StringHelper.warnstrip!(name.to_s), description => description), TestrailMilestone)
+      OnlyofficeLoggerHelper.log "Created new milestone: #{new_milestone.name}"
+      new_milestone
+    end
+
+    # endregion
+  end
+end

data/lib/onlyoffice_testrail_wrapper/testrail_project/testrail_project_plan_helper.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module OnlyofficeTestrailWrapper
+  # Mehtods to help working with Plan in Project
+  module TestrailProjectPlanHelper
+    def plan(name_or_id)
+      case name_or_id.class.to_s
+      when 'Fixnum'
+        get_plan_by_id name_or_id
+      when 'String'
+        init_plan_by_name name_or_id
+      else
+        raise 'Wrong argument. Must be name [String] or id [Integer]'
+      end
+    end
+
+    def init_plan_by_name(name)
+      found_plan = get_plan_by_name name
+      found_plan.nil? ? create_new_plan(name) : found_plan
+    end
+
+    def get_plan_by_id(id)
+      plan = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_plan/#{id}"), TestrailPlan)
+      OnlyofficeLoggerHelper.log("Initialized plan: #{plan.name}")
+      plan.entries.each_with_index do |test_entry, index|
+        entry = HashHelper.parse_to_class_variable(test_entry, TestrailPlanEntry)
+        entry.runs.each_with_index { |run, i| entry.runs[i] = HashHelper.parse_to_class_variable(run, TestrailRun) }
+        plan.entries[index] = entry
+      end
+      plan.instance_variable_set '@project', self
+      plan
+    end
+
+    def get_plan_by_name(name)
+      get_plans if @plans_names.empty?
+      @plans_names[StringHelper.warnstrip!(name.to_s)].nil? ? nil : get_plan_by_id(@plans_names[name])
+    end
+
+    # Get list of all TestPlans
+    # @param filters [Hash] filter conditions
+    # @return [Array, TestrailPlan] test plans
+    def get_plans(filters = {})
+      get_url = "index.php?/api/v2/get_plans/#{@id}"
+      filters.each { |key, value| get_url += "&#{key}=#{value}" }
+      plans = Testrail2.http_get(get_url)
+      @plans_names = HashHelper.get_hash_from_array_with_two_parameters(plans, 'name', 'id') if @plans_names.empty?
+      plans
+    end
+
+    # @param [String] name of test plan
+    # @param [String] description
+    # @param [Integer] milestone_id
+    def create_new_plan(name, entries = [], description = '', milestone_id = nil)
+      new_plan = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_plan/#{@id}", name: StringHelper.warnstrip!(name), description: description,
+                                                                                                             milestone_id: milestone_id, entries: entries), TestrailPlan)
+      OnlyofficeLoggerHelper.log "Created new plan: #{new_plan.name}"
+      new_plan.entries.each_with_index do |entry, i|
+        new_plan.entries[i] = HashHelper.parse_to_class_variable(entry, TestrailPlanEntry)
+        new_plan.entries[i].runs.each_with_index { |run, j| new_plan.entries[i].runs[j] = HashHelper.parse_to_class_variable(run, TestrailRun) }
+      end
+      @plans_names[new_plan.name] = new_plan.id
+      new_plan
+    end
+  end
+end