apadmi_grout 0.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b96da0fc11dca309a04de37dd5e40919d35bbc4dd1071dfa593e670bb0fe1903
-  data.tar.gz: e9a4218c2a49f038ea63c2ca7014fe441369962f7e69894d523430bc0bef90ac
+  metadata.gz: f779ff10f50f15d2ce74311339c8407ae32eec3bcc8fb49f0ab3a85d8a0cbdc7
+  data.tar.gz: e0f9034584fdcafb95355ade65f64ccdd7e82acc2e07d62a5bd61129e3fc5464
 SHA512:
-  metadata.gz: 447a9b2e1f1752430e5ae19fe0b8054e1a16e99e8988586ce06d21433df7cd4254b8a447f6dc78f40f7d9c91a7b3e09cab6ea02b843e0fb19f6d6951381e11b3
-  data.tar.gz: 49cb8803774da5be549481f27a661b7d3e820709aa1b42571363e8636c7b345a3d27d9cc84294d819eeb6fa16a33d46adb5e6ecdcc096e38e21f091e5ca9f53e
+  metadata.gz: 10b206d1d56814b6288bf0db35259c02c81baf0c3554de6286627498c0d65ee6f8808fafcd5908038be9a196ae264952180fc4988ca15b4023dd03a1380c98be
+  data.tar.gz: ecbf93eb1f3bd3141a54949568edc1196ad6b7aaf7348f89f93e9fb46bf76aa424504cf2a5bc5d9effd78f811543322980c65a7e83231cdb283ca492aec53fc8

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-# Fastlane Plugin Changelog
+# Core Changelog
 
-## [Unreleased]
+## [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
 
-## [0.1.0] - 2022-01-23
+## [1.0.0] - 2022-05-09 - Initial release
 
-- 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

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

@@ -16,21 +16,25 @@ module Apadmi
       # @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
 

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,24 @@
 # 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",
+          "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/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,29 @@
+# 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
+    end
+  end
+end

data/lib/apadmi/grout/version.rb

@@ -2,6 +2,6 @@
 
 module Apadmi
   module Grout
-    VERSION = "0.0.4"
+    VERSION = "1.1.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.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Sam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-12 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