apadmi_grout 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f779ff10f50f15d2ce74311339c8407ae32eec3bcc8fb49f0ab3a85d8a0cbdc7
-  data.tar.gz: e0f9034584fdcafb95355ade65f64ccdd7e82acc2e07d62a5bd61129e3fc5464
+  metadata.gz: 9a8f0b024bb98a0372b85755e14bc753370328418273d6e0d07aba74f664bb9a
+  data.tar.gz: '04286d3e985378d78f1dec57c220f1a4a5ec35d90ccf4a407d3dde66f75f9a6d'
 SHA512:
-  metadata.gz: 10b206d1d56814b6288bf0db35259c02c81baf0c3554de6286627498c0d65ee6f8808fafcd5908038be9a196ae264952180fc4988ca15b4023dd03a1380c98be
-  data.tar.gz: ecbf93eb1f3bd3141a54949568edc1196ad6b7aaf7348f89f93e9fb46bf76aa424504cf2a5bc5d9effd78f811543322980c65a7e83231cdb283ca492aec53fc8
+  metadata.gz: 2c9d6d5fce5da1ffaa1ab71a7f54e4bba85a3f4fda470b0613049a2169ca9466d180b655c3129561e9046fe3d0a4041b85c2cf25d70dfd8ac7f521b70a6d5113
+  data.tar.gz: 13b59090e27577e87f7a52ef9dbcc085db1af1b0575a20e98642669155b0652e0e91976a4943f027e33c25d325fe0aa205afa481d761b7a944f5aebf3bf4138a

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Core Changelog
 
+## [1.2.0] - 2022-05-17
+* Filter out issues missing from git changelogs when finding tickets to move.
+
 ## [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

data/lib/apadmi/grout/di.rb

@@ -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,14 +2,26 @@
 
 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
 
@@ -30,50 +42,73 @@ module Apadmi
         options ||= Apadmi::Grout::FindTicketsOptions.new(include_no_sprint_tickets: false)
 
         issues = @jira_wrapper.search_unblocked_issues(
-          component,
-          status,
-          [],
+          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/flag_messages.rb

@@ -13,7 +13,8 @@ module Apadmi
       # @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",
+          "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"

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/git_utils.rb

@@ -24,6 +24,16 @@ module Apadmi
 
         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 = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apadmi_grout
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
-- Sam
+- Apadmi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday