jirametrics 2.31 → 3.1

data/lib/jirametrics/issue_collection.rb

@@ -27,6 +27,7 @@ class IssueCollection < Array
     issue = hidden.find(&block) if issue.nil? && include_hidden
     issue
   end
+
   def clone
     raise 'baboom'
   end

data/lib/jirametrics/issue_printer.rb

@@ -6,45 +6,82 @@ class IssuePrinter
   end
 
   def to_s
-    issue = @issue
     result = +''
-    result << "#{issue.key} (#{issue.type}): #{issue.compact_text issue.summary, max: 200}\n"
+    result << header_line
+    result << assignee_line
+    result << links_section
+    result << history_section
+    result
+  end
+
+  def header_line
+    "#{@issue.key} (#{@issue.type}): #{@issue.compact_text @issue.summary, max: 200}\n"
+  end
 
-    assignee = issue.raw['fields']['assignee']
-    result << "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n" unless assignee.nil?
+  def assignee_line
+    assignee = @issue.raw['fields']['assignee']
+    return '' if assignee.nil?
 
-    issue.raw['fields']['issuelinks']&.each do |link|
+    "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n"
+  end
+
+  def links_section
+    result = +''
+    @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
+    result
+  end
 
-    history = [] # time, type, detail
+  def history_section
+    result = +''
+    result << cycletime_warning
+    result << "  History:\n"
+    result << render_history(build_history)
+    result
+  end
 
-    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
+  def cycletime_warning
+    return '' if @issue.board.cycletime
+
+    "  Unable to determine start/end times as board #{@issue.board.id} has no cycletime specified\n"
+  end
+
+  # Each history entry is [time, type, detail, artificial?].
+  def build_history
+    start_stop_entries + discarded_change_entries + change_entries
+  end
+
+  def start_stop_entries
+    return [] unless @issue.board.cycletime
+
+    started_at, stopped_at = @issue.started_stopped_times
+    entries = []
+    entries << [started_at, nil, 'vvvv Started here vvvv', true] if started_at
+    entries << [stopped_at, nil, '^^^^ Finished here ^^^^', true] if stopped_at
+    entries
+  end
 
-    issue.discarded_change_times&.each do |time|
-      history << [time, nil, '^^^^ Changes discarded ^^^^', true]
+  def discarded_change_entries
+    (@issue.discarded_change_times || []).map do |time|
+      [time, nil, '^^^^ Changes discarded ^^^^', true]
     end
+  end
 
-    (issue.changes + (issue.discarded_changes || [])).each do |change|
-      history << [change.time, change.field, create_change_message(change: change, issue: issue), change.artificial?]
+  def change_entries
+    (@issue.changes + (@issue.discarded_changes || [])).map do |change|
+      [change.time, change.field, create_change_message(change: change, issue: @issue), change.artificial?]
     end
+  end
 
-    result << "  History:\n"
+  def render_history history
     type_width = history.collect { |_time, type, _detail, _artificial| type&.length || 0 }.max
     sort_history!(history)
-    history.each do |time, type, detail, _artificial|
+    history.map 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
+      "    #{time.strftime '%Y-%m-%d %H:%M:%S %z'} [#{type}] #{detail}\n"
+    end.join
   end
 
   def create_change_message change:, issue:

data/lib/jirametrics/jira_gateway.rb

@@ -43,7 +43,7 @@ class JiraGateway
         return parse_response(command: command, result: stdout)
       end
 
-      if RETRYABLE_EXIT_CODES.include?(status.exitstatus) && retries < MAX_RETRIES && !stderr.include?('503')
+      if retryable?(status: status, stderr: stderr, retries: retries)
         retries += 1
         @file_system.log "Transient network error (exit #{status.exitstatus}), retrying in " \
                          "#{RETRY_DELAY_SECONDS}s (attempt #{retries}/#{MAX_RETRIES})..."
@@ -51,20 +51,40 @@ class JiraGateway
         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
-      if stderr.include?('503')
-        raise 'Jira returned 503 (Service Unavailable). This may be a temporary outage, or your ' \
-              'Jira account may have been deactivated due to inactivity. Check your Jira subscription ' \
-              'and try again later.'
-      end
-      raise "Failed call with exit status #{status.exitstatus}. " \
-        "See #{@file_system.logfile_name} for details"
+      raise_for_failure status: status, stdout: stdout, stderr: stderr
+    end
+  end
+
+  def retryable? status:, stderr:, retries:
+    RETRYABLE_EXIT_CODES.include?(status.exitstatus) && retries < MAX_RETRIES && !stderr.include?('503')
+  end
+
+  def raise_for_failure status:, stdout:, stderr:
+    @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
+    if stderr.include?('503')
+      raise 'Jira returned 503 (Service Unavailable). This may be a temporary outage, or your ' \
+            'Jira account may have been deactivated due to inactivity. Check your Jira subscription ' \
+            'and try again later.'
     end
+    raise "#{failure_summary(status: status, stderr: stderr)}. See #{@file_system.logfile_name} for details"
+  end
+
+  # Turn curl's opaque exit code into something self-describing: prefer the HTTP status Jira
+  # returned, then curl's own error text (e.g. "Could not resolve host"), falling back to the exit
+  # code only when neither is present.
+  def failure_summary status:, stderr:
+    http_status = stderr[/returned error: (\d{3})/, 1]
+    return "Jira returned HTTP #{http_status}" if http_status
+
+    curl_message = stderr[/curl: \(\d+\) (.+)/, 1]
+    return "Jira call failed: #{curl_message.strip}" if curl_message
+
+    "Failed call with exit status #{status.exitstatus}"
   end
 
   def capture3 command, stdin_data:
@@ -87,6 +107,21 @@ class JiraGateway
     exec_and_parse_response command: command, stdin_data: nil
   end
 
+  VerifyResult = Data.define(:ok, :url, :message)
+
+  # Confirm that our credentials actually authenticate against Jira. We deliberately hit /myself,
+  # which requires authentication on every Jira edition (anonymous callers get a 401). An endpoint
+  # that also answers anonymously would happily "succeed" with bad credentials, which defeats the
+  # whole point. Cloud speaks v3, Server/Data Center speaks v2. Returns a VerifyResult rather than
+  # raising so the caller can report on every configured connection and set its own exit status.
+  def verify_connection
+    json = call_url relative_url: "/rest/api/#{cloud? ? 3 : 2}/myself"
+    user = json['displayName'] || json['name'] || json['emailAddress'] || 'unknown user'
+    VerifyResult.new(ok: true, url: @jira_url, message: "Verified #{@jira_url} (authenticated as #{user})")
+  rescue StandardError => e
+    VerifyResult.new(ok: false, url: @jira_url, message: "Could not authenticate to #{@jira_url}: #{e.message}")
+  end
+
   def parse_response command:, result:
     begin
       json = JSON.parse(result)
@@ -115,14 +150,17 @@ class JiraGateway
     @jira_email = jira_config['email']
     @jira_api_token = jira_config['api_token']
     @jira_personal_access_token = jira_config['personal_access_token']
+    validate_jira_auth
 
+    @cookies = (jira_config['cookies'] || []).collect { |key, value| "#{key}=#{value}" }.join(';')
+  end
+
+  def validate_jira_auth
     raise 'When specifying an api-token, you must also specify email' if @jira_api_token && !@jira_email
 
-    if @jira_api_token && @jira_personal_access_token
-      raise "You can't specify both an api-token and a personal-access-token. They don't work together."
-    end
+    return unless @jira_api_token && @jira_personal_access_token
 
-    @cookies = (jira_config['cookies'] || []).collect { |key, value| "#{key}=#{value}" }.join(';')
+    raise "You can't specify both an api-token and a personal-access-token. They don't work together."
   end
 
   def make_curl_command url:, method: 'GET'