jirametrics 2.4 → 2.30

data/lib/jirametrics/issue_collection.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class IssueCollection < Array
+  attr_reader :hidden
+
+  def self.[] *issues
+    collection = new
+    issues.each { |i| collection << i }
+    collection
+  end
+
+  def initialize
+    super
+    @hidden = []
+  end
+
+  def reject! &block
+    select(&block).each do |issue|
+      @hidden << issue
+    end
+    super
+  end
+
+  def find_by_key key:, include_hidden: false
+    block = ->(issue) { issue.key == key }
+    issue = find(&block)
+    issue = hidden.find(&block) if issue.nil? && include_hidden
+    issue
+  end
+  def clone
+    raise 'baboom'
+  end
+end

data/lib/jirametrics/issue_printer.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+class IssuePrinter
+  def initialize issue
+    @issue = issue
+  end
+
+  def to_s
+    issue = @issue
+    result = +''
+    result << "#{issue.key} (#{issue.type}): #{issue.compact_text issue.summary, max: 200}\n"
+
+    assignee = issue.raw['fields']['assignee']
+    result << "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n" unless assignee.nil?
+
+    issue.raw['fields']['issuelinks']&.each do |link|
+      result << "  [link] #{link['type']['outward']} #{link['outwardIssue']['key']}\n" if link['outwardIssue']
+      result << "  [link] #{link['type']['inward']} #{link['inwardIssue']['key']}\n" if link['inwardIssue']
+    end
+
+    history = [] # time, type, detail
+
+    if issue.board.cycletime
+      started_at, stopped_at = issue.started_stopped_times
+      history << [started_at, nil, 'vvvv Started here vvvv', true] if started_at
+      history << [stopped_at, nil, '^^^^ Finished here ^^^^', true] if stopped_at
+    else
+      result << "  Unable to determine start/end times as board #{issue.board.id} has no cycletime specified\n"
+    end
+
+    issue.discarded_change_times&.each do |time|
+      history << [time, nil, '^^^^ Changes discarded ^^^^', true]
+    end
+
+    (issue.changes + (issue.discarded_changes || [])).each do |change|
+      history << [change.time, change.field, create_change_message(change: change, issue: issue), change.artificial?]
+    end
+
+    result << "  History:\n"
+    type_width = history.collect { |_time, type, _detail, _artificial| type&.length || 0 }.max
+    sort_history!(history)
+    history.each do |time, type, detail, _artificial|
+      type = type.nil? ? '-' * type_width : type.rjust(type_width)
+      result << "    #{time.strftime '%Y-%m-%d %H:%M:%S %z'} [#{type}] #{detail}\n"
+    end
+
+    result
+  end
+
+  def create_change_message change:, issue:
+    value, old_value = format_change_values(change: change, issue: issue)
+
+    message = +''
+    message << "#{old_value} -> " unless old_value.nil? || old_value.empty?
+    message << value
+    if change.artificial?
+      message << ' (Artificial entry)'
+    else
+      message << " (Author: #{change.author})"
+    end
+    message
+  end
+
+  def format_change_values change:, issue:
+    if change.status?
+      value = "#{change.value.inspect}:#{change.value_id.inspect}"
+      old_value = change.old_value ? "#{change.old_value.inspect}:#{change.old_value_id.inspect}" : nil
+    elsif change.sprint?
+      added = change.value_id - change.old_value_id
+      removed = change.old_value_id - change.value_id
+      value = "#{change.value.inspect} #{change.value_id}"
+      value << " (added: #{added})" unless added.empty?
+      value << " (removed: #{removed})" unless removed.empty?
+      old_value = nil
+    else
+      value = issue.compact_text(change.value).inspect
+      old_value = change.old_value ? issue.compact_text(change.old_value).inspect : nil
+    end
+    [value, old_value]
+  end
+
+  def sort_history! history
+    history.sort! do |a, b|
+      if a[0] == b[0]
+        if a[1].nil?
+          1
+        elsif b[1].nil?
+          -1
+        else
+          a[1] <=> b[1]
+        end
+      else
+        a[0] <=> b[0]
+      end
+    end
+  end
+end

data/lib/jirametrics/jira_gateway.rb

@@ -3,31 +3,95 @@
 require 'cgi'
 require 'json'
 require 'English'
+require 'open3'
 
 class JiraGateway
-  attr_accessor :ignore_ssl_errors, :jira_url
+  attr_accessor :ignore_ssl_errors
+  attr_reader :jira_url, :settings, :file_system
 
-  def initialize file_system:
+  RETRYABLE_EXIT_CODES = [7, 28, 35, 56].freeze
+  MAX_RETRIES = 3
+  RETRY_DELAY_SECONDS = 5
+
+  def initialize file_system:, jira_config:, settings:
     @file_system = file_system
+    load_jira_config(jira_config)
+    @settings = settings
+    @ignore_ssl_errors = settings['ignore_ssl_errors']
+  end
+
+  def post_request relative_url:, payload:
+    command = make_curl_command url: "#{@jira_url}#{relative_url}", method: 'POST'
+    exec_and_parse_response command: command, stdin_data: payload
+  end
+
+  def exec_and_parse_response command:, stdin_data:
+    log_entry = "  #{command.gsub(/\s+/, ' ')}"
+    log_entry = sanitize_message log_entry
+    @file_system.log log_entry
+
+    retries = 0
+    loop do
+      stdout, stderr, status = capture3(command, stdin_data: stdin_data)
+
+      if status.success?
+        @file_system.log "Returned (stderr): #{stderr.inspect}" unless stderr == ''
+        raise 'no response from curl on stdout' if stdout == ''
+        return parse_response(command: command, result: stdout)
+      end
+
+      if RETRYABLE_EXIT_CODES.include?(status.exitstatus) && retries < MAX_RETRIES
+        retries += 1
+        @file_system.log "Transient network error (exit #{status.exitstatus}), retrying in #{RETRY_DELAY_SECONDS}s (attempt #{retries}/#{MAX_RETRIES})..."
+        sleep_between_retries
+        next
+      end
+
+      @file_system.error "Failed call with exit status #{status.exitstatus}!"
+      @file_system.error "Returned (stdout): #{stdout.inspect}"
+      @file_system.error "Returned (stderr): #{stderr.inspect}"
+      if stderr.include?('401')
+        raise 'The request was not authorized. Verify that your authentication token hasn\'t expired'
+      end
+      raise "Failed call with exit status #{status.exitstatus}. " \
+        "See #{@file_system.logfile_name} for details"
+    end
+  end
+
+  def capture3 command, stdin_data:
+    # In it's own method so we can mock it out in tests
+    Open3.capture3(command, stdin_data: stdin_data)
+  end
+
+  def sleep_between_retries
+    # In its own method so we can mock it out in tests
+    sleep RETRY_DELAY_SECONDS
   end
 
   def call_url relative_url:
     command = make_curl_command url: "#{@jira_url}#{relative_url}"
-    result = call_command command
-    JSON.parse result
-  rescue => e # rubocop:disable Style/RescueStandardError
-    puts "Error #{e.inspect} when parsing result: #{result.inspect}"
+    exec_and_parse_response command: command, stdin_data: nil
+  end
+
+  def parse_response command:, result:
+    begin
+      json = JSON.parse(result)
+    rescue # rubocop:disable Style/RescueStandardError
+      message = "Unable to parse results from #{sanitize_message(command)}"
+      @file_system.error message, more: result
+      raise message
+    end
+
+    raise "Download failed with: #{JSON.pretty_generate(json)}" unless json_successful?(json)
+
+    json
   end
 
-  def call_command command
-    @file_system.log "  #{command.gsub(/\s+/, ' ')}"
-    result = `#{command}`
-    @file_system.log result unless $CHILD_STATUS.success?
-    return result if $CHILD_STATUS.success?
+  def sanitize_message message
+    token = @jira_api_token || @jira_personal_access_token
+    return message unless token # cookie based authentication
 
-    @file_system.log "Failed call with exit status #{$CHILD_STATUS.exitstatus}."
-    raise "Failed call with exit status #{$CHILD_STATUS.exitstatus}. " \
-      "See #{@file_system.logfile_name} for details"
+    message.gsub(token, '[API_TOKEN]')
   end
 
   def load_jira_config jira_config
@@ -47,7 +111,7 @@ class JiraGateway
     @cookies = (jira_config['cookies'] || []).collect { |key, value| "#{key}=#{value}" }.join(';')
   end
 
-  def make_curl_command url:
+  def make_curl_command url:, method: 'GET'
     command = +''
     command << 'curl'
     command << ' -L' # follow redirects
@@ -56,9 +120,25 @@ class JiraGateway
     command << " --cookie #{@cookies.inspect}" unless @cookies.empty?
     command << " --user #{@jira_email}:#{@jira_api_token}" if @jira_api_token
     command << " -H \"Authorization: Bearer #{@jira_personal_access_token}\"" if @jira_personal_access_token
-    command << ' --request GET'
+    command << " --request #{method}"
+    if method == 'POST'
+      command << ' --data @-'
+      command << ' --header "Content-Type: application/json"'
+    end
     command << ' --header "Accept: application/json"'
+    command << ' --show-error --fail' # Better diagnostics when the server returns an error
     command << " --url \"#{url}\""
     command
   end
+
+  def json_successful? json
+    return false if json.is_a?(Hash) && (json['error'] || json['errorMessages'] || json['errorMessage'])
+    return false if json.is_a?(Array) && json.first == 'errorMessage'
+
+    true
+  end
+
+  def cloud?
+    @jira_url.downcase.end_with? '.atlassian.net'
+  end
 end