apadmi_grout 0.0.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16022940fafd296f9f52d02c001b1a78906bfe59e1d9a0c3f9c27968ca1d1386
-  data.tar.gz: efc3cc64e75a693b32307c1b58e85a5a23d155e450187a1ecd4612d1b017d838
+  metadata.gz: 9a8f0b024bb98a0372b85755e14bc753370328418273d6e0d07aba74f664bb9a
+  data.tar.gz: '04286d3e985378d78f1dec57c220f1a4a5ec35d90ccf4a407d3dde66f75f9a6d'
 SHA512:
-  metadata.gz: 2191857e5bfdfcf6fbca7c1b2fbb889f38ec1e198d4d149c51fa696d63eba6991ae948bd95bf057764c3d2a1528d01038d77b95a241ebf9154fb21d0f11253a6
-  data.tar.gz: 5dcb577071f78db6e03bc5c06da0a873493f2ac9bbd3c1ecc8ec6586ba50003558d5e843d676b548cf369b330b2197b2d27029032ac9b0eece90904316a03e52
+  metadata.gz: 2c9d6d5fce5da1ffaa1ab71a7f54e4bba85a3f4fda470b0613049a2169ca9466d180b655c3129561e9046fe3d0a4041b85c2cf25d70dfd8ac7f521b70a6d5113
+  data.tar.gz: 13b59090e27577e87f7a52ef9dbcc085db1af1b0575a20e98642669155b0652e0e91976a4943f027e33c25d325fe0aa205afa481d761b7a944f5aebf3bf4138a

data/CHANGELOG.md

@@ -1,7 +1,16 @@
-# Fastlane Plugin Changelog
+# Core Changelog
 
-## [Unreleased]
+## [1.2.0] - 2022-05-17
+* Filter out issues missing from git changelogs when finding tickets to move.
 
-## [0.1.0] - 2022-01-23
+## [1.1.0] - 2022-05-12
+* Support allowing tickets that aren't assigned to a sprint to be moved.
+* Created utilities for getting the git root and number of commits
 
-- Initial release
+## [1.0.0] - 2022-05-09 - Initial release
+
+* Various JIRA utilities to simplify JIRA interactions
+* Action for searching JIRA tickets
+* Action for transitioning JIRA tickets
+* Action for generating release notes
+* Action for extracting ticket keys from Git changelog

data/lib/apadmi/grout/di.rb

@@ -4,7 +4,7 @@ module Apadmi
   module Grout
     # Convenience class for initializing and accessing the various actions
     class DependencyInjector
-      attr_reader :move_jira_tickets_action, :find_tickets_to_move_action, :generate_release_notes_action, :issues_from_changelog_action
+      attr_reader :jira_wrapper, :move_jira_tickets_action, :find_tickets_to_move_action, :generate_release_notes_action, :issues_from_changelog_action
 
       # @param [String] username
       # @param [String] token
@@ -15,10 +15,11 @@ module Apadmi
       def initialize(username, token, base_url, context_path, project, logger)
         @jira_wrapper = Apadmi::Grout::JiraWrapper.new(username, token, base_url, context_path, project)
 
+        git_utils = Apadmi::Grout::GitUtils
         @move_jira_tickets_action = Apadmi::Grout::MoveJiraTicketsAction.new(@jira_wrapper, logger)
-        @find_tickets_to_move_action = Apadmi::Grout::FindTicketsToMoveAction.new(@jira_wrapper, logger)
-        @generate_release_notes_action = Apadmi::Grout::GenerateReleaseNotesAction.new(base_url)
         @issues_from_changelog_action = Apadmi::Grout::IssuesFromChangelogAction.new(@jira_wrapper, logger)
+        @find_tickets_to_move_action = Apadmi::Grout::FindTicketsToMoveAction.new(@jira_wrapper, git_utils, issues_from_changelog_action, logger)
+        @generate_release_notes_action = Apadmi::Grout::GenerateReleaseNotesAction.new(base_url)
       end
     end
   end

data/lib/apadmi/grout/jira/actions/find_tickets_to_move_action.rb

@@ -2,74 +2,113 @@
 
 module Apadmi
   module Grout
+    module PrStatus
+      MERGED = 1
+      UNMERGED_BUT_INCLUDED = 2
+      UN_INCLUDED = 3
+    end
+
+    # ATTENTION: Any changes to the logic here should be reflected in the docs (find-tickets.md)
+
     # Finds and returns a list of all the issues that are ready to be moved
     # Any tickets found that have the given status but *don't* appear ready to be moved will
     # be flagged.
     class FindTicketsToMoveAction
       # @param [Apadmi::Grout::JiraWrapper]
+      # @param [Apadmi::Grout::GitUtils]
+      # @param [Apadmi::Grout::IssuesFromChangelogAction]
       # @param [Apadmi::Grout::DefaultLogger] // or your own logger!
-      def initialize(jira_wrapper, logger)
+      def initialize(jira_wrapper, git_utils, issues_from_chnglg, logger)
         @jira_wrapper = jira_wrapper
+        @git_utils = git_utils
+        @issues_from_changelog_action = issues_from_chnglg
         @logger = logger
       end
 
       # @param component [String] Only include tickets tagged with this component
       # @param status [String] The status of tickets to be moved (Usually "Awaiting QA Release")
       # @param excluded_ticket_keys [Array<String>] ticket keys to be excluded from consideration
-      # @param custom_flag_messages [FlagMessages]
+      # @param custom_flag_messages [Apadmi::Grout::FlagMessages]
+      # @param options [Apadmi::Grout::FindTicketsOptions]
       # @return [Array<JIRA::Resource::Issue>] the issues ready to move
       def run(
         component,
         status,
         excluded_ticket_keys,
-        custom_flag_messages = FlagMessages.new(
-          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no PRs connected to it. CI still moved it",
-          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no MERGED PRs and at least one OPEN PR",
-          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has only DECLINED PRs",
-          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no MERGED PRs"
-        )
+        custom_flag_messages = nil,
+        options = nil
       )
-        issues = @jira_wrapper.search_unblocked_issues(component, status).reject do |issue|
-          puts issue.key
+        custom_flag_messages ||= Apadmi::Grout::FlagMessages.default(status)
+        options ||= Apadmi::Grout::FindTicketsOptions.new(include_no_sprint_tickets: false)
+
+        issues = @jira_wrapper.search_unblocked_issues(
+          component, status, [],
+          allow_no_sprint: options.include_no_sprint_tickets
+        ).reject do |issue|
           excluded_ticket_keys.include? issue.key
         end
 
-        @logger.message("Found issues to consider #{issues.map(&:key).join(", ")}")
+        issue_keys = issues.map(&:key)
+        @logger.message("Found issues to consider #{issue_keys.join(", ")}")
+
+        # Get the issues in the git changelog, filtered for the issues being considered
+        changelog_ids = @issues_from_changelog_action.issue_ids_from_changelog(
+          @git_utils.merge_changelog(issue_keys)
+        )
+
         final_list = issues.filter do |issue|
           # Decide whether to include this ticket based on PRs
-          process_prs(issue, custom_flag_messages)
+          status = process_prs(issue, custom_flag_messages)
+          decide_should_include(issue, status, changelog_ids)
         end
+
         @logger.message("Final list:  #{final_list.map(&:key).join(", ")}")
         final_list
       end
 
       private
 
+      # @param issue [JIRA::Resource::Issue]
+      # @param pr_status [Int] status of whether or not we can move
+      # @param changelog_ids [Array<String>] the ticket ids pulled from git
+      def decide_should_include(issue, pr_status, changelog_ids)
+        # For merged PRs, check if the ticket appears in the changelog.
+        # If it doesn't then it's likely it was merged AFTER this release build was triggered and shouldn't be moved
+        # by this build
+        if pr_status == PrStatus::MERGED
+          is_in_changelog = changelog_ids.include?(issue.key)
+          @logger.message("NOTE: Not including #{issue.key} since it's not in the git changelog.") unless is_in_changelog
+          return is_in_changelog
+        end
+
+        pr_status != PrStatus::UN_INCLUDED
+      end
+
       # @param issue [JIRA::Resource::Issue]
       # @param custom_flag_messages [FlagMessages]
-      # @return [Boolean] whether or not this ticket can be moved
+      # @return [Int] status of whether or not we can move
       def process_prs(issue, custom_flag_messages)
         prs = @jira_wrapper.get_ticket_prs(issue)
 
         if prs.empty?
           @logger.message("#{issue.key} has no PRs. Flagging it: STILL MOVABLE")
           @jira_wrapper.flag_ticket(issue.key, custom_flag_messages.no_prs_flag_msg)
-          return true
+          return PrStatus::UNMERGED_BUT_INCLUDED
         elsif prs.all?(&:open)
           @logger.message("#{issue.key} has only open PRs. Flagging it: NOT MOVABLE")
           @jira_wrapper.flag_ticket(issue.key, custom_flag_messages.open_prs_flag_msg)
-          return false
+          return PrStatus::UN_INCLUDED
         elsif prs.all?(&:declined)
           @logger.message("#{issue.key} has only declined PRs. Flagging it: NOT MOVABLE")
           @jira_wrapper.flag_ticket(issue.key, custom_flag_messages.declined_prs_flag_msg)
-          return false
+          return PrStatus::UN_INCLUDED
         elsif prs.none?(&:merged)
           @logger.message("#{issue.key} has no merged PRs. Flagging it: NOT MOVABLE")
           @jira_wrapper.flag_ticket(issue.key, custom_flag_messages.no_merged_prs_flag_msg)
-          return false
+          return PrStatus::UN_INCLUDED
         end
 
-        true # At least one merged PR, so it's included
+        PrStatus::MERGED # At least one merged PR
       end
     end
   end

data/lib/apadmi/grout/jira/models/find_tickets_options.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    FindTicketsOptions = Struct.new(
+      :include_no_sprint_tickets,
+      keyword_init: true
+    )
+  end
+end

data/lib/apadmi/grout/jira/models/flag_messages.rb

@@ -1,8 +1,25 @@
 # frozen_string_literal: true
 
-FlagMessages = Struct.new(
-  :no_prs_flag_msg,
-  :open_prs_flag_msg,
-  :declined_prs_flag_msg,
-  :no_merged_prs_flag_msg
-)
+module Apadmi
+  module Grout
+    FlagMessages = Struct.new(
+      :no_prs_flag_msg,
+      :open_prs_flag_msg,
+      :declined_prs_flag_msg,
+      :no_merged_prs_flag_msg
+    ) do
+      # Get default flag messages
+      # @param status [String] status ticket will be moving to
+      # @return [Apadmi::Grout::FlagMessages]
+      def self.default(status)
+        FlagMessages.new(
+          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no PRs connected to it. CI still moved it. " \
+          "(WARNING: this may cause the `fix_versions` to be incorrect)",
+          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no MERGED PRs and at least one OPEN PR",
+          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has only DECLINED PRs",
+          "REASON FOR FLAG: Check this ticket - it was put in #{status} but has no MERGED PRs"
+        )
+      end
+    end
+  end
+end

data/lib/apadmi/grout/jira/wrapper/jira_wrapper.rb

@@ -46,16 +46,19 @@ module Apadmi
       # @param [String] component
       # @param [String] status
       # @param [String[]] ticket_types
+      # @param [Boolean] allow_no_sprint
       # @return [Array<JIRA::Resource::Issue>]
-      def search_unblocked_issues(component, status, ticket_types = [])
+      def search_unblocked_issues(component, status, ticket_types = [], allow_no_sprint: false)
         component_filter = (" AND component = '#{component}' " unless component.empty?) || ""
         status_filter = (" AND status = '#{status}' " unless status.empty?) || ""
         type_filter = ("AND (#{ticket_types.map { |type| "type = #{type}" }.join("OR ")})" unless ticket_types.empty?) || ""
+        empty_sprint_condition = ("OR sprint is EMPTY" if allow_no_sprint) || ""
 
         jql_search = %{
           project = '#{@project}'
           #{status_filter} #{component_filter} #{type_filter}
-          AND sprint in openSprints() AND (labels not in(Blocked) or labels is EMPTY) AND Flagged is EMPTY
+          AND (sprint in openSprints() #{empty_sprint_condition}) AND (labels not in(Blocked) or labels is EMPTY)
+          AND Flagged is EMPTY
         }
 
         @jira_client.Issue.jql(jql_search, { max_results: 1000 }).uniq

data/lib/apadmi/grout/release_notes/actions/issues_from_changelog_action.rb

@@ -20,8 +20,6 @@ module Apadmi
         @jira_wrapper.find_issues_by_keys(ids)
       end
 
-      private
-
       # @param changelog [String] raw git changelog
       # @return [Array<String>] list of issue ids from changelog
       def issue_ids_from_changelog(changelog)

data/lib/apadmi/grout/utils/filename_utils.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # Generic Filename Utils
+    class FilenameUtils
+      # Constructs a standard Apadmi filename for a build output binary
+      # @param [Hash] options the options to create a filename with
+      # @option options [String] :client_name The client name
+      # @option options [String] :product_name The product name
+      # @option options [String] :platform The product's platform
+      # @option options [String] :version Version number
+      # @option options [String] :build_number Build number
+      # @option options [String] :data (Today) The date for the file
+      # @option options [String] :suffix Suffix to identify what this output is (e.g. SOURCE, UAT, QA, DEV)
+      # @return [String] A filename formatted such as "Apadmi-Grout-Ruby-v1.0.0(2921)-2021-06-22-DEV"
+      def self.binary_output_filename(options = {})
+        client_name = options[:client_name]
+        raise ":client_name shouldn't be empty" if client_name.blank?
+
+        product_name = options[:product_name]
+        raise ":product_name shouldn't be empty" if product_name.blank?
+
+        platform = options[:platform]
+        raise ":platform shouldn't be empty" if platform.blank?
+
+        version = options[:version]
+        raise ":version shouldn't be empty" if version.blank?
+
+        build_number = options[:build_number]
+        raise ":build_number shouldn't be empty" if build_number.blank?
+
+        date = options[:date] || Time.now.strftime("%Y-%m-%d")
+        suffix = ("-#{options[:suffix]}" unless options[:suffix].blank?) || ""
+
+        "#{client_name}-#{product_name}-#{platform}-v#{version}(#{build_number})-#{date}#{suffix}"
+      end
+    end
+  end
+end

data/lib/apadmi/grout/utils/git_utils.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Apadmi
+  module Grout
+    # Generic Git related utils
+    class GitUtils
+      # Gets the root of the Git repo we're in
+      # @return [String] The full path for the root of this Git repo
+      def self.git_root
+        stdout, stderr, = Open3.capture3("git rev-parse --show-toplevel")
+        raise "Failed to get git root: #{stderr}" unless stderr.strip.empty?
+
+        stdout.strip
+      end
+
+      # Gets the number of commits accessible from HEAD treating the history as a graph.
+      # See more details here: https://git-scm.com/docs/git-rev-list
+      # @return [String] The number of commits
+      def self.number_of_commits
+        stdout, stderr, = Open3.capture3("git rev-list HEAD --count")
+        raise "Failed to get commit number: #{stderr}" unless stderr.strip.empty?
+
+        stdout.strip
+      end
+
+      # Gets all the merges accessible from the current HEAD which matches at least one of the given grep conditions
+      # @param grep_conditions [Array<String>] values to be passed in as grep cases (https://git-scm.com/docs/git-log)
+      def self.merge_changelog(grep_conditions)
+        command = "git log HEAD --merges --format=%s#{grep_conditions.map { |c| " --grep #{c}" }.join(" ")}"
+        stdout, stderr, = Open3.capture3(command)
+        raise "Failed to get changelog: #{stderr}" unless stderr.strip.empty?
+
+        stdout
+      end
+    end
+  end
+end

data/lib/apadmi/grout/version.rb

@@ -2,6 +2,6 @@
 
 module Apadmi
   module Grout
-    VERSION = "0.0.5"
+    VERSION = "1.2.0"
   end
 end

data/lib/apadmi_grout.rb

@@ -16,5 +16,8 @@ require_relative "apadmi/grout/jira/wrapper/jira_wrapper"
 require_relative "apadmi/grout/jira/models/pull_request"
 require_relative "apadmi/grout/jira/models/version"
 require_relative "apadmi/grout/jira/models/flag_messages"
+require_relative "apadmi/grout/jira/models/find_tickets_options"
 
 require_relative "apadmi/grout/utils/logger"
+require_relative "apadmi/grout/utils/git_utils"
+require_relative "apadmi/grout/utils/filename_utils"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apadmi_grout
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.2.0
 platform: ruby
 authors:
-- Sam
+- Apadmi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,7 @@ files:
 - lib/apadmi/grout/di.rb
 - lib/apadmi/grout/jira/actions/find_tickets_to_move_action.rb
 - lib/apadmi/grout/jira/actions/move_jira_tickets_action.rb
+- lib/apadmi/grout/jira/models/find_tickets_options.rb
 - lib/apadmi/grout/jira/models/flag_messages.rb
 - lib/apadmi/grout/jira/models/pull_request.rb
 - lib/apadmi/grout/jira/models/version.rb
@@ -74,6 +75,8 @@ files:
 - lib/apadmi/grout/release_notes/actions/issues_from_changelog_action.rb
 - lib/apadmi/grout/release_notes/models/release_notes_config.rb
 - lib/apadmi/grout/release_notes/models/release_notes_templates.rb
+- lib/apadmi/grout/utils/filename_utils.rb
+- lib/apadmi/grout/utils/git_utils.rb
 - lib/apadmi/grout/utils/logger.rb
 - lib/apadmi/grout/version.rb
 - lib/apadmi_grout.rb