standard_automation_library 0.2.1.pre.temp

data/lib/standard_automation_library/api_clients/jira.rb

@@ -0,0 +1,326 @@
+require 'jira-ruby'
+require 'set'
+
+# Wrapper around the jira-ruby gem https://github.com/sumoheavy/jira-ruby
+class Jira
+  def initialize(username, api_key, site: 'https://jira.autodesk.com', is_dry_run: false)
+    options = {
+      site: site,
+      username: username,
+      password: api_key,
+      context_path: '',
+      auth_type: :basic
+    }
+    @client = JIRA::Client.new(options)
+    @is_dry_run = is_dry_run
+  end
+
+  attr_accessor :client
+
+  # Get a JiraIssue representing the supplied issue key
+  # Will be nil if the issue does not exist or the credentials are wrong.
+  def issue(issue_key)
+    issue = @client.Issue.find(issue_key)
+    JiraIssue.new(@client, issue, is_dry_run: @is_dry_run)
+  rescue JIRA::HTTPError => e
+    puts "Error getting Jira issue: #{e.response}"
+    nil
+  rescue StandardError => e
+    puts "Error getting Jira project keys: #{e}"
+    nil
+  end
+
+  # Get a JiraProject representing the supplied project key
+  # Will be nil if the project does not exist or the credentials are wrong.
+  def project(project_key)
+    project = @client.Project.find(project_key)
+    JiraProject.new(@client, project, is_dry_run: @is_dry_run)
+  rescue JIRA::HTTPError => e
+    puts "Error getting Jira project: #{e.response}"
+    nil
+  rescue StandardError => e
+    puts "Error getting Jira project keys: #{e}"
+    nil
+  end
+
+  def all_project_keys
+    Set.new(@client.Project.all.map(&:key))
+  rescue JIRA::HTTPError => e
+    puts "Error getting Jira project keys: #{e.response}"
+    Set.new
+  rescue StandardError => e
+    puts "Error getting Jira project keys: #{e}"
+    Set.new
+  end
+
+  # https://github.com/sumoheavy/jira-ruby/blob/master/example.rb
+  def all_unverified_tickets(fix_version, platform = nil)
+    jql = all_unverified_tickets_jql(fix_version, platform)
+    # Specify a hardcoded key for local testing purposes
+    # jql = 'key = SCMP-4638'
+    @client.Issue.jql(
+      jql,
+      # rubocop:disable Naming/VariableNumber
+      fields: %i[key assignee summary reporter customfield_11882], # customfield_11882 = 'QA Owner'
+      # rubocop:enable Naming/VariableNumber
+      max_results: 50 # More than 50 tickets points to a programming or process problem. Let's avoid the spam
+    )
+  end
+
+  # The JQL is inspired by the QA Kanbans for iOS & Android
+  # https://jira.autodesk.com/secure/RapidBoard.jspa?rapidView=12177
+  # https://jira.autodesk.com/secure/RapidBoard.jspa?rapidView=12175
+  def all_unverified_tickets_jql(fix_version, platform = nil)
+    product_family = '("Product Family" in (PlanGrid, "Autodesk Build", "ACC Platform") OR "Product Family" = EMPTY)'
+    fix_version = "fixVersion = #{fix_version}"
+    verified_statuses = [
+      'Closed',
+      'Done',
+      "Won't Do",
+      'Ready for Launch',
+      'Live',
+      'Signed off',
+      'Resolved',
+      'Ready For Prod',
+      'Ready for staging',
+      'In staging',
+      'In prod',
+      'Ready for Engineering',
+      'Remediation done',
+      'Waiting for Deployment',
+      'Waiting for Deploy',
+      'Awaiting Deployment',
+      'Ready for Deploy'
+    ]
+                        .map { |status| "\"#{status}\"" }
+                        .join(', ')
+    unverified = "status not in (#{verified_statuses})"
+    jql = "#{product_family} AND #{fix_version} AND #{unverified}"
+
+    # 	Common Mobile is added independent of the platform in case of platform specification
+    jql += " AND Platform IN ('Common Mobile', '#{platform}')" if platform
+
+    puts "JQL: #{jql}"
+    jql
+  end
+
+  def unverified_ticket_comment(assignee, fix_version, release_date)
+    assignee_at_mention = "[~#{assignee.name}]"
+    "Hello #{assignee_at_mention}, the #{fix_version} RC is currently being verified with a scheduled " \
+      "release date of #{release_date}. This ticket is not yet verified and will block the release. Please " \
+      'complete and verify the ticket if it is part of the release. If the functionality is behind a feature ' \
+  end
+
+  def comment_on_all_unverified_tickets_for_version(fix_version, release_date)
+    unverified_tickets = all_unverified_tickets(fix_version)
+    if @is_dry_run
+      puts "Would have commented on the following #{unverified_tickets.size} unverified tickets:"
+      unverified_tickets.each do |issue|
+        ticket_url = "https://jira.autodesk.com/browse/#{issue.key}\n"
+        comment = unverified_ticket_comment(issue.assignee, fix_version, release_date)
+        puts ticket_url
+        puts comment
+      end
+    else
+      puts "Commenting on the following #{unverified_tickets.size} unverified tickets:"
+      unverified_tickets.each do |issue|
+        ticket_url = "https://jira.autodesk.com/browse/#{issue.key}\n"
+        comment = unverified_ticket_comment(issue.assignee, fix_version, release_date)
+        puts ticket_url
+        puts comment
+        issue.comments.build.save(body: comment)
+      end
+    end
+  end
+end
+
+# Wrapper around the jira-ruby gem's issue api. Represents a set of issue related convenience methods.
+# Object represents the state of the issue at the time of the object's creation.
+class JiraIssue
+  CREATEMETA_V2_ENDPOINT = '/issue/createmeta/'.freeze
+
+  def initialize(client, issue, is_dry_run: false)
+    @client = client
+    @issue = issue
+    @is_dry_run = is_dry_run
+  end
+
+  def api_issue
+    @issue
+  end
+
+  def key
+    @issue.key
+  end
+
+  def status
+    @issue.fields['status']['name']
+  end
+
+  def project_key
+    @issue.project.key
+  end
+
+  def fix_versions
+    @issue.fields['fixVersions'].map { |fix_version| fix_version['name'] }
+  end
+
+  # Returns a boolean indicating success of comment addition
+  def add_comment(comment_text)
+    if @is_dry_run
+      puts "Would have added comment '#{comment_text}' to issue '#{key}'"
+      true
+    else
+      @issue.comments.build.save(body: comment_text)
+    end
+  end
+
+  def contains_comment?(comment_text)
+    @issue.comments.each do |comment|
+      return true if comment.body.include?(comment_text)
+    end
+    false
+  end
+
+  def fix_version?(specific_version = nil)
+    if specific_version
+      !fix_versions.find { |fix_version| fix_version == specific_version }.nil?
+    else
+      !fix_versions.empty?
+    end
+  end
+
+  # Returns a boolean indicating success of fix version addition
+  def add_fix_version(fix_version)
+    if @is_dry_run
+      puts "Would have added fix version: #{fix_version} to issue #{key}"
+      true
+    else
+      begin
+        @issue.save!(update: { fixVersions: [add: { name: fix_version }] })
+        @issue.fetch(true)
+        true
+      rescue JIRA::HTTPError => e
+        puts "Error adding fix version to issue #{key}: #{e.response}"
+        false
+      end
+    end
+  end
+
+  # Get the value of the custom field if the field exists and it has a value. Nil otherwise.
+  def custom_field_data(field_name)
+    field_array = metadata_field_array
+    field_index = custom_field_index(field_array, field_name)
+
+    return unless field_index
+
+    @issue.fields[metadata_field_array[field_index]['fieldId']]
+  end
+
+  # Set the custom field for the issue to the given value.
+  # Will return true if successful or throw an error explaining why the given
+  # value cannot be set. Only supports 'array' and 'option' type fields.
+  def update_custom_field(field_name, value)
+    field_array = metadata_field_array
+    field_index = custom_field_index(field_array, field_name)
+
+    raise "Cannot modify '#{field_name}' field for JIRA issue #{@issue.key}. No such field exists." unless field_index
+
+    platform_not_allowed = field_array[field_index]['allowedValues'].find do |allowed_value|
+      allowed_value['value'] == value
+    end.nil?
+    if platform_not_allowed
+      raise "Cannot modify '#{field_name}' field for JIRA issue #{@issue.key}. " \
+            "Supplied value '#{value}' is not an allowed value."
+    end
+
+    if @is_dry_run
+      puts "Would have updated issue '#{key}' with #{field_name}: #{value}"
+      true
+    else
+      schema_type = field_array[field_index]['schema']['type']
+      operation = :set
+      operation = :add if schema_type == 'array'
+      puts "Operation #{operation}, Value: #{value}"
+      @issue.save(update: { field_array[field_index]['fieldId'] => [operation => { value: value }] })
+    end
+  end
+
+  # Workaround for https://confluence.atlassian.com/jiracore/createmeta-rest-endpoint-to-be-removed-975040986.html
+  # Which is not supported by the jira-ruby gem yet.
+  def metadata_field_array
+    params = {
+      maxResults: 100,
+      expand: 'projects.issuetypes.fields'
+    }
+    project_key = @issue.project.key
+    issue_type_id = @issue.issuetype.id
+    endpoint_path = "#{CREATEMETA_V2_ENDPOINT}#{project_key}/issuetypes/#{issue_type_id}"
+    query_params = JIRA::Base.hash_to_query_string(params)
+    create_meta_url = "#{@client.options[:rest_base_path]}#{endpoint_path}?#{query_params}"
+
+    response = @client.get(create_meta_url)
+    json = JIRA::Base.parse_json(response.body)
+    fields = json['values']
+
+    raise "JIRA metadata not found for project #{project_key} and issuetype #{@issue.issuetype.name}." unless fields
+
+    fields
+  end
+
+  def custom_field_index(field_array, field_name)
+    # Assume there's only 1 field with the given name. If not then there's a much bigger problem.
+    field_array.find_index { |dict| dict['name'] == field_name }
+  end
+end
+
+# Wrapper around the jira-ruby gem's project api. Represents a set of project related convenience methods.
+# Object represents the state of the project at the time of the object's creation.
+class JiraProject
+  def initialize(client, project, is_dry_run: false)
+    @client = client
+    @project = project
+    @is_dry_run = is_dry_run
+  end
+
+  def api_project
+    @project
+  end
+
+  def fix_version?(specific_version = nil)
+    if specific_version
+      !@project.versions.find { |fix_version| fix_version.name == specific_version }.nil?
+    else
+      !@project.versions.empty?
+    end
+  end
+
+  def key
+    @project.key
+  end
+
+  def style
+    @project.style
+  rescue StandardError
+    # JIRA instances that do not have a concept of project style will throw an error
+    nil
+  end
+
+  # Requires that the api_key have admin privileges for the project.
+  # Returns a boolean indicating the success of the version creation.
+  def add_fix_version(fix_version)
+    if @is_dry_run
+      puts "Would have created fix version: #{fix_version} in project: #{key}"
+      true
+    else
+      begin
+        @client.Version.build.save!(name: fix_version, projectId: @project.id)
+        @project.fetch(true)
+        true
+      rescue JIRA::HTTPError => e
+        puts "Error adding fix version to project: #{e.response}"
+        false
+      end
+    end
+  end
+end

data/lib/standard_automation_library/api_clients/pagerduty.rb

@@ -0,0 +1,101 @@
+require 'pager_duty-connection'
+
+require_relative '../util/datetime_helper'
+
+# Client for accessing PagerDuty
+class PagerDutyClient
+  def initialize(api_key)
+    @client = PagerDuty::Connection.new(api_key)
+  end
+
+  attr_reader :client
+
+  # Find out who is on duty for the given schedule id. This method defaults to
+  # who is on duty at the moment this function runs but it can be made to
+  # query for any time by passing in an optional Time argument. The cut off hour
+  # is the hour of the day in the specified time zone at which duty switches
+  # from one person to another.
+  #
+  # This method assumes that the schedule contains non contiguous time blocks
+  # that occur predictably and that though those time blocks do not fill up
+  # an entire day the person whose name is in the time block for that day is
+  # on duty for the entire 24 hour period starting at the cut off hour. This
+  # method also assumes that when duty changes from one person to another
+  # it does so in a predictable way.
+  def who_is_on_duty(schedule_id, cut_off_hour, time_zone: nil, time: nil)
+    time_at_hour = DateTimeHelper.time_at_hour(
+      cut_off_hour,
+      time_zone: time_zone,
+      date: time ? Date.parse(time.to_s) : Date.today
+    )
+
+    # TODO: consider refactor now that Sorbet has been removed from the codebase
+    # This implementation exists because the sorbet sig for in_time_zone requires a String, not a T.nilable(String)
+    if time
+      time_now = time
+    else
+      time_now = Time.now
+      time_now = time_now.in_time_zone(time_zone) if time_zone
+    end
+
+    if time_now < time_at_hour
+      start_time = time_at_hour - (24 * 3600)
+      end_time = time_at_hour
+    else
+      start_time = time_at_hour
+      end_time = time_at_hour + (24 * 3600)
+    end
+
+    return nil if (schedule_response = schedule(schedule_id, start_time, end_time, time_zone)).nil?
+
+    user_name_from_schedule_response(schedule_response)
+  end
+
+  # Find out who is on duty right now for the given schedule id.
+  # The schedule will either have a name associated with that specific time
+  # or there will be no one in which case this method will return nil.
+  def who_is_on_duty_now(schedule_id, time: Time.now)
+    schedule_response = schedule(schedule_id, time, time, nil)
+    user_name_from_schedule_response(schedule_response)
+  end
+
+  def user_name_from_schedule_response(schedule_response)
+    schedule_entries = schedule_response['schedule']['final_schedule']['rendered_schedule_entries']
+    return nil if schedule_entries.empty?
+
+    user_id = schedule_entries[0]['user']['id']
+    user_name(user_id)
+  end
+
+  def schedule(schedule_id, start_time, end_time, time_zone)
+    @client.get(
+      "schedules/#{schedule_id}",
+      query_params: {
+        since: start_time.to_s,
+        until: end_time.to_s,
+        time_zone: time_zone
+      }
+    )
+  rescue PagerDuty::Connection::FileNotFoundError
+    raise "No PagerDuty schedule found with schedule id #{schedule_id}"
+  rescue JSON::ParserError => e
+    raise "Error parsing PagerDuty API response: #{e.message}"
+  rescue StandardError => e
+    raise "Error fetching PagerDuty schedule data: #{e.message}"
+  end
+
+  def user_name(user_id)
+    user_response = @client.get("users/#{user_id}", {})
+    user_response['user']['name']
+  rescue PagerDuty::Connection::FileNotFoundError
+    raise "No PagerDuty user found with user id #{user_id}"
+  end
+
+  def schedule_id(schedule_name)
+    schedule_response = @client.get('schedules', query_params: { query: schedule_name })
+    schedules = schedule_response['schedules']
+    raise "No PagerDuty schedule found with name #{schedule_name}" if schedules.empty?
+
+    schedules[0]['id']
+  end
+end