itriagetestrail 1.0.36

data/lib/itriagetestrail/testrail_binding.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+#
+# TestRail API binding for Ruby (API v2, available since TestRail 3.0)
+#
+# 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 = ''
+    @response_code = nil
+
+    attr_accessor :user
+    attr_accessor :password
+    attr_reader :response_code
+
+    def initialize(base_url)
+      valid_regex = %r{/\/$/}
+      base_url += '/' unless valid_regex.match(base_url)
+      @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).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. get_case/1)
+    #
+    def send_get(uri)
+      res = read_cache(uri)
+      res || _send_request('GET', uri, nil, true)
+    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)
+    #
+    def send_post(uri, data)
+      _send_request('POST', uri, data)
+    end
+
+    private
+
+    def make_connection(url)
+      conn = Net::HTTP.new(url.host, url.port)
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      conn
+    end
+
+    def _parse_result(response)
+      if response.body && !response.body.empty?
+        JSON.parse(response.body)
+      else
+        {}
+      end
+    end
+
+    def _error_check(response, result)
+      return if response.code == '200'
+      error = if !result.nil? && result.key?('error')
+                '"' + result['error'] + '"'
+              else
+                'No additional error message received'
+              end
+      raise APIError, format('TestRail API returned HTTP %<response_code>s\n%<error>s',
+                             response_code: response.code, error: error)
+    end
+
+    def _send_request(method, uri, data, write_cache = false)
+      url = URI.parse(@url + uri)
+      if method == 'POST'
+        request = Net::HTTP::Post.new(url.path + '?' + url.query)
+        request.body = JSON.dump(data)
+      else
+        request = Net::HTTP::Get.new(url.path + '?' + url.query)
+      end
+      request.basic_auth(@user, @password)
+      request.add_field('Content-Type', 'application/json')
+
+      conn = make_connection(url)
+
+      retry_count = 0
+      while retry_count < 10
+        response = conn.request(request)
+        @response_code = response.code
+        if @response_code == '429'
+          write_http_status_to_file('testrail_429s', url)
+          sleep(response.header['retry-after'].to_i)
+        elsif @response_code == '500'
+          puts response.to_s
+          # this might require different handling for 500 'Deadlock found when
+          # trying to get lock; try restarting transaction'
+          sleep(2)
+        else
+          write_http_status_to_file('testrail_200s', url)
+          break
+        end
+        retry_count += 1
+      end
+
+      result = _parse_result(response)
+
+      _error_check(response, result)
+
+      if write_cache
+        cache_to_file(uri, result)
+      end
+
+      result
+    end
+
+    # This method is only used publicly
+    def write_http_status_to_file(filename, endpoint)
+      Dir.mkdir('./tmp') unless File.exist?('./tmp')
+      file = File.open("./tmp/#{filename}", 'a')
+      file.write("#{Time.now},#{endpoint}\n")
+      file.close
+    end
+
+    def cache_to_file(url, content)
+      payload = {'response' => content}
+      Dir.mkdir('./tmp') unless File.exist?('./tmp')
+      filename = sanitize_filename(url)
+      file = File.open("./tmp/#{filename}", 'w')
+      file.write(payload.to_json)
+      file.close
+    end
+
+    def read_cache(url)
+      filename = sanitize_filename(url)
+      return unless File.exist?("./tmp/#{filename}")
+      file = File.open("./tmp/#{filename}", 'r')
+      content = JSON.parse(file.read)
+      file.close
+      content[:response]
+    end
+
+    def sanitize_filename(filename)
+      # Split the name when finding a period which is preceded by some
+      # character, and is followed by some character other than a period,
+      # if there is no following period that is followed by something
+      # other than a period (yeah, confusing, I know)
+      fn = filename.split /(?<=.)\.(?=[^.])(?!.*\.[^.])/m
+
+      # We now have one or two parts (depending on whether we could find
+      # a suitable period). For each of these parts, replace any unwanted
+      # sequence of characters with an underscore
+      fn.map! { |s| s.gsub /[^a-z0-9\-]+/i, '_' }
+
+      # Finally, join the parts with a period and return the result
+      return fn.join '.'
+    end
+  end
+
+  class APIError < StandardError
+  end
+end

data/lib/itriagetestrail/testrail_objects/milestones.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'tzinfo'
+
+module Itriagetestrail
+  module Milestones
+    def normalize_origin
+      case @testrail_config[:origin]
+      when 'prd', 'production', 'origin/production'
+        'Production'
+      when 'stg', 'staging', 'origin/staging'
+        'Staging'
+      when 'dev', 'development', 'origin/development'
+        'Development'
+      when 'local', ''
+        'Local'
+      when 'master', 'origin/master'
+        'Master'
+      else
+        'Dev Branch'
+      end
+    end
+
+    # Establish the milestone name based on origin passed in,
+    # usually origin represents a branch or environment
+    def normalize_milestone
+      if @testrail_config[:milestone].nil? || @testrail_config[:milestone].empty?
+        normalize_origin
+      else
+        @testrail_config[:milestone]
+      end
+    end
+
+    # returns timestamp for begining of first day of current quarter
+    def milestone_period_start
+      time_zone = TZInfo::Timezone.get('America/Denver')
+      current_year = time_zone.now.year
+      month = time_zone.now.mon
+
+      # determine which quarter we are in
+      if month <= 3
+        time_zone.utc_to_local(Time.utc(current_year, 1, 1))
+      elsif month <= 6
+        time_zone.utc_to_local(Time.utc(current_year, 4, 1))
+      elsif month <= 9
+        time_zone.utc_to_local(Time.utc(current_year, 7, 1))
+      else
+        time_zone.utc_to_local(Time.utc(current_year, 10, 1))
+      end
+    end
+
+    # determine the due date (end of quarter) for a new milestone being added
+    def milestone_due_date
+      time_zone = TZInfo::Timezone.get('America/Denver')
+      current_year = time_zone.now.year
+      month = time_zone.now.mon
+
+      # determine which quarter we are in
+      if month <= 3
+        Time.utc(current_year, 3, 31).strftime('%s')
+      elsif month <= 6
+        Time.utc(current_year, 6, 30).strftime('%s')
+      elsif month <= 9
+        Time.utc(current_year, 9, 30).strftime('%s')
+      else
+        Time.new(current_year, 12, 31).strftime('%s')
+      end
+    end
+
+    # returns the id for a requested milestone by name, or creates one if the milestone does not exist
+    def fetch_milestone(requested_milestone_name)
+      milestones = @client.send_get("get_milestones/#{@project_id}")
+      res = -1
+      milestones.each do |milestone|
+        res = milestone['id'] if milestone['name'] == requested_milestone_name
+      end
+
+      if res == -1
+        # We need to add the milestone to TestRail
+
+        body = {
+          name: requested_milestone_name,
+          due_on: milestone_due_date
+        }
+
+        res = @client.send_post("add_milestone/#{@project_id}", body)['id']
+      end
+      res
+    end
+
+    # return a standardized name for a milestone to be archived
+    def milestone_archive_name(milestone_name, date)
+      year = date.year
+      month = date.mon
+
+      if month <= 3
+        "#{milestone_name} #{year}-Q1"
+      elsif month <= 6
+        "#{milestone_name} #{year}-Q2"
+      elsif month <= 9
+        "#{milestone_name} #{year}-Q3"
+      else
+        "#{milestone_name} #{year}-Q4"
+      end
+    end
+
+    # return all the runs associated with an existing milestone
+    def milestone_runs(milestone_name)
+      # use the matching milestone id for project
+      milestone_id = fetch_milestone(milestone_name)
+
+      # fetch all test runs associated with the milestone id for project
+      @client.send_get("get_runs/#{@project_id}&milestone_id=#{milestone_id}&is_completed=1") || []
+    end
+
+    # testrail call to rename a milestone (for archiving)
+    def rename_milestone(id, new_name)
+      # TODO: rename milestone with previous_milestone
+      body = { name: new_name }
+      @client.send_post("update_milestone/#{id}", body)['id']
+    end
+
+    # this archives a milestone at the turn of a quarter and creates a new one in its place
+    def reset_milestone(milestone_name)
+      runs = milestone_runs(milestone_name)
+      return if runs.empty?
+      last_run_time = Time.at(runs.last['completed_on'])
+
+      # if last run time is smaller than period start, do below
+      return unless last_run_time < milestone_period_start
+      rename_milestone(@milestone_id, milestone_archive_name(milestone_name, last_run_time))
+      @milestone_id = fetch_milestone(@milestone_name)
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/projects.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'itriagetestrail/version'
+require 'itriagetestrail/testrail_binding'
+require 'itriagetestrail/pool'
+require 'tzinfo'
+
+module Itriagetestrail
+  module Projects
+    # populate projects instance variable with all projects objects in the testrail site
+    def projects
+      @projects ||= @client.send_get('get_projects')
+    end
+
+    def project_by_name(name)
+      res = -1
+      projects.each do |project|
+        res = project if project['name'] == name
+      end
+      res
+    end
+
+    # return the project object for a given project id
+    def project_by_id(id)
+      res = -1
+      projects.each do |project|
+        res = project if project['id'] == id.to_i
+      end
+      res
+    end
+
+    # set the project_id by a requested project from config/environment variable
+    def set_project
+      requested_id = @testrail_config[:projectId]
+      case requested_id
+      when nil, ''
+        # a project id was not provided, fetch it from TestRail by project name
+        res = project_by_name(@testrail_config[:projectName])
+        if res == -1
+          @execute = false
+          return
+        end
+        @project_id = res['id']
+        @suite_mode = res['suite_mode']
+      else
+        # use the requested project id
+        @project_id = requested_id
+        @suite_mode = project_by_id(@project_id)['suite_mode']
+      end
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/sections.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module Sections
+    # TestRail Sections
+    def testrail_sections
+      case @suite_mode
+      when 2, 3
+        @suite_id = testrail_suite_id(@suite_name)
+        @sections = @client.send_get("get_sections/#{@project_id}&suite_id=#{@suite_id}")
+      else
+        @sections = @client.send_get("get_sections/#{@project_id}")
+      end
+    end
+
+    def testrail_section_id(section_title)
+      res = -1
+      @sections.each do |section|
+        res = section['id'] if section['name'] == section_title
+      end
+      res
+    end
+
+    def add_testrail_section(section_title)
+      body = if @suite_name
+               {
+                 name: section_title,
+                 suite_id: testrail_suite_id(@suite_name)
+               }
+             else
+               {
+                 name: section_title
+               }
+             end
+
+      res = @client.send_post("add_section/#{@project_id}", body)
+
+      testrail_section = res['id']
+
+      # re-establish sections
+      testrail_sections
+
+      testrail_section
+    end
+  end
+end

data/lib/itriagetestrail/testrail_objects/suites.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Itriagetestrail
+  module Suites
+    # TestRail Suites
+    def testrail_suites
+      case @suite_mode
+      when 2, 3
+        @suites = @client.send_get("get_suites/#{@project_id}")
+      end
+    end
+
+    def testrail_suite_id(suite_name)
+      res = -1
+      @suites.each do |suite|
+        res = suite['id'] if suite['name'] == suite_name
+      end
+      res
+    end
+
+    def add_testrail_suite(suite_name)
+      body = { name: suite_name }
+      res = @client.send_post("add_suite/#{@project_id}", body)
+      testrail_suite = res['id']
+
+      # re-establish suites
+      testrail_suites
+
+      testrail_suite
+    end
+  end
+end