apadmi_grout 1.0.0 → 2.0.0

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,57 @@
+# 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
+
+      # Runs a git fetch all
+      def self.fetch_all
+        stdout, stderr, = Open3.capture3("git fetch --all")
+        raise "Failed to fetch #{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
+
+      # Gets all the merges that are NOT accessible from 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.invert_changelog(grep_conditions)
+        command = "git log --all ^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/utils/network_service.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Apadmi
+  module Grout
+    # Utility class for running REST network calls
+    class NetworkService
+      APPLICATION_JSON = "application/json"
+      PATCH_CONTENT_TYPE = "application/json-patch+json"
+      CONTENT_TYPE = "Content-Type"
+      private_constant :CONTENT_TYPE, :APPLICATION_JSON
+
+      # @param username [String]
+      # @param password [String]
+      # @param base_url [String]
+      # Params are encoded for use in Basic Auth https://datatracker.ietf.org/doc/html/rfc7617
+      def initialize(username, password, base_url)
+        @username = username
+        @password = password
+        @base_url = base_url
+      end
+
+      # @param [String] path
+      # @return [Faraday::Response]
+      def do_get(path)
+        conn = setup_con
+        response = conn.get("#{@base_url}#{path}", CONTENT_TYPE => APPLICATION_JSON)
+        throw_if_error(response)
+        response
+      end
+
+      # @param [String] path
+      # @param [String] payload
+      # @return [Faraday::Response]
+      def do_put(path, payload)
+        conn = setup_con
+        response = conn.put("#{@base_url}#{path}", payload, CONTENT_TYPE => APPLICATION_JSON)
+        throw_if_error(response)
+        response
+      end
+
+      # @param [String] path
+      # @param [String] payload
+      # @return [Faraday::Response]
+      def do_post(path, payload)
+        conn = setup_con
+        response = conn.post("#{@base_url}#{path}", payload, CONTENT_TYPE => APPLICATION_JSON)
+        throw_if_error(response)
+        response
+      end
+
+      # @param [String] path
+      # @param [String] payload
+      # @return [Faraday::Response]
+      def do_patch(path, payload)
+        conn = setup_con
+        response = conn.patch("#{@base_url}#{path}", payload, CONTENT_TYPE => PATCH_CONTENT_TYPE)
+        throw_if_error(response)
+        response
+      end
+
+      # @param [String] path
+      # @return [Faraday::Response]
+      def do_delete(path)
+        conn = setup_con
+        response = conn.delete("#{@base_url}#{path}", CONTENT_TYPE => APPLICATION_JSON)
+        throw_if_error(response)
+        response
+      end
+
+      private
+
+      # @return [Faraday::Connection]
+      def setup_con
+        auth_str = "#{@username}:#{@password}"
+        conn = Faraday.new # create a new Connection with base URL
+        conn.headers["Authorization"] = "Basic #{Base64.strict_encode64(auth_str)}"
+        conn
+      end
+
+      # @param [Faraday::Response] response
+      def throw_if_error(response)
+        raise "Network call failed #{response.status} #{response.body}" unless (200..210).include?(response.status)
+      end
+    end
+  end
+end

data/lib/apadmi/grout/version.rb

@@ -2,6 +2,6 @@
 
 module Apadmi
   module Grout
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/apadmi_grout.rb

@@ -1,20 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "apadmi/grout/version"
-require_relative "apadmi/grout/di"
-
-require_relative "apadmi/grout/release_notes/actions/issues_from_changelog_action"
-require_relative "apadmi/grout/release_notes/actions/generate_release_notes_action"
-require_relative "apadmi/grout/release_notes/models/release_notes_config"
-require_relative "apadmi/grout/release_notes/models/release_notes_templates"
-
-require_relative "apadmi/grout/jira/actions/move_jira_tickets_action"
-require_relative "apadmi/grout/jira/actions/find_tickets_to_move_action"
-
-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/utils/logger"
+Dir[File.expand_path("apadmi/grout/**/*.rb", File.dirname(__FILE__))].sort.each do |current|
+  require current
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apadmi_grout
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
-- Sam
+- Apadmi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -63,18 +63,28 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE
 - README.md
+- lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_action.rb
+- lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_ado_action.rb
+- lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_jira_action.rb
+- lib/apadmi/grout/actions/generate_release_notes_action/generate_release_notes_action.rb
+- lib/apadmi/grout/actions/generate_release_notes_action/issue_classifier.rb
+- lib/apadmi/grout/actions/issues_from_changelog_action.rb
+- lib/apadmi/grout/actions/move_tickets_action.rb
 - 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/flag_messages.rb
-- lib/apadmi/grout/jira/models/pull_request.rb
-- lib/apadmi/grout/jira/models/version.rb
-- lib/apadmi/grout/jira/wrapper/jira_wrapper.rb
-- lib/apadmi/grout/release_notes/actions/generate_release_notes_action.rb
-- 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/models/ado_config.rb
+- lib/apadmi/grout/models/find_tickets_options.rb
+- lib/apadmi/grout/models/flag_messages.rb
+- lib/apadmi/grout/models/issue.rb
+- lib/apadmi/grout/models/pull_request.rb
+- lib/apadmi/grout/models/release_notes_config.rb
+- lib/apadmi/grout/models/release_notes_templates.rb
+- lib/apadmi/grout/service/board_service/ado_board_service.rb
+- lib/apadmi/grout/service/board_service/board_service.rb
+- lib/apadmi/grout/service/board_service/jira_board_service.rb
+- lib/apadmi/grout/utils/filename_utils.rb
+- lib/apadmi/grout/utils/git_utils.rb
 - lib/apadmi/grout/utils/logger.rb
+- lib/apadmi/grout/utils/network_service.rb
 - lib/apadmi/grout/version.rb
 - lib/apadmi_grout.rb
 homepage: https://bitbucket.org/apadmi/apadmi-grout-ruby/

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

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Apadmi
-  module Grout
-    # 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::DefaultLogger] // or your own logger!
-      def initialize(jira_wrapper, logger)
-        @jira_wrapper = jira_wrapper
-        @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]
-      # @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"
-        )
-      )
-        issues = @jira_wrapper.search_unblocked_issues(component, status).reject do |issue|
-          puts issue.key
-          excluded_ticket_keys.include? issue.key
-        end
-
-        @logger.message("Found issues to consider #{issues.map(&:key).join(", ")}")
-        final_list = issues.filter do |issue|
-          # Decide whether to include this ticket based on PRs
-          process_prs(issue, custom_flag_messages)
-        end
-        @logger.message("Final list:  #{final_list.map(&:key).join(", ")}")
-        final_list
-      end
-
-      private
-
-      # @param issue [JIRA::Resource::Issue]
-      # @param custom_flag_messages [FlagMessages]
-      # @return [Boolean] whether or not this ticket can be moved
-      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
-        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
-        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
-        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
-        end
-
-        true # At least one merged PR, so it's included
-      end
-    end
-  end
-end

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

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Apadmi
-  module Grout
-    # Moves all given jira tickets to a given status and assigns fix versions
-    class MoveJiraTicketsAction
-      # @param [Apadmi::Grout::JiraWrapper]
-      # @param [Apadmi::Grout::DefaultLogger] // or your own logger!
-      def initialize(jira_wrapper, logger)
-        @jira_wrapper = jira_wrapper
-        @logger = logger
-      end
-
-      # @param [Array<String>] version_strings
-      # @param [Array<JIRA::Resource::Issue>] issues
-      # @param [String] new_status
-      def run(version_strings, issues, new_status)
-        if issues.empty?
-          @logger.error("No issues found, aborting")
-          return
-        end
-
-        @logger.message("Creating versions #{version_strings}")
-        versions = create_or_get_versions(version_strings)
-
-        @logger.message("Transitioning issues: #{issues.map(&:key).join(", ")}")
-        issues.each { |issue| move_issue(issue, new_status, versions) }
-
-        @logger.success("Issues transitioned successfully :D")
-      end
-
-      # @param [Array<String>] version_strings
-      # @return [Array<JIRA::Resource::Version>]
-      def create_or_get_versions(version_strings)
-        all_versions = @jira_wrapper.all_versions
-        version_strings.map do |version|
-          existing_version = all_versions.find { |v| v.name == version }
-          if !existing_version.nil?
-            existing_version
-          else
-            date = Time.now.strftime("%Y-%m-%d")
-            @jira_wrapper.create_version(date, version)
-          end
-        end
-      end
-
-      # @param [JIRA::Resource::Issue] issue
-      # @param [String] new_status
-      # @param [Array<JIRA::Resource::Version>] versions
-      def move_issue(issue, new_status, versions)
-        @jira_wrapper.transition_issue(issue, new_status)
-        @jira_wrapper.assign_fixversions(issue.id, versions)
-      end
-
-      private :create_or_get_versions, :move_issue
-    end
-  end
-end

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

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-FlagMessages = Struct.new(
-  :no_prs_flag_msg,
-  :open_prs_flag_msg,
-  :declined_prs_flag_msg,
-  :no_merged_prs_flag_msg
-)

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Apadmi
-  module Grout
-    # Represents a version object derived from the Jira REST API response.
-    class Version
-      attr_reader :self, :id, :description, :name, :archived, :released, :release_date, :overdue, :user_release_date, :project_id
-
-      def initialize(json)
-        @self = json["self"]
-        @id = json["id"]
-        @description = json["description"]
-        @name = json["name"]
-        @archived = json["archived"]
-        @released = json["released"]
-        @release_date = json["release_date"]
-        @overdue = json["overdue"]
-        @user_release_date = json["user_release_date"]
-        @project_id = json["project_id"]
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require "mustache"
-
-module Apadmi
-  module Grout
-    # Finds and returns a list of all the issues who's ids exist in the given changelog
-    class GenerateReleaseNotesAction
-      # @param jira_base_url [String] Jira base url
-      def initialize(jira_base_url)
-        @jira_base_url = jira_base_url
-      end
-
-      # @param config [Apadmi::Grout::ReleaseNotesConfig]
-      def run(config)
-        base_url = "#{@jira_base_url}/browse/"
-
-        Mustache.render(
-          config.templates.document_template,
-          config: config,
-          rendered_moved_issues: render_classified_issues(config.templates.list_template, base_url, config.classified_moved_issues),
-          rendered_release_issues: render_classified_issues(config.templates.list_template, base_url, config.classified_release_issues)
-        ).strip
-      end
-
-      private
-
-      def render_classified_issues(template, base_url, classified_issues)
-        return if classified_issues.empty
-
-        Mustache.render(
-          template,
-          classified_issues: classified_issues,
-          base_url: base_url
-        )
-      end
-    end
-  end
-end

data/lib/apadmi/grout/release_notes/models/release_notes_config.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module Apadmi
-  module Grout
-    # @param tasks [Array<JIRA::Resource::Issue>]
-    # @param features [Array<JIRA::Resource::Issue>] aka stories
-    # @param improvements [Array<JIRA::Resource::Issue>]
-    # @param defects [Array<JIRA::Resource::Issue>] aka bugs
-    # @param others [Array<JIRA::Resource::Issue>] any other non-standard issue types
-    ClassifiedIssues = Struct.new(
-      :tasks,
-      :features,
-      :improvements,
-      :defects,
-      :others
-    ) do
-      # @return returns true if all categories are empty
-      def empty
-        tasks.empty? && features.empty? &&
-          improvements.empty? && defects.empty? && others.empty?
-      end
-    end
-
-    # @param title [String] The title of the document
-    # @param app_version [String] The app version pertaining to this release
-    # @param min_os_version [String] The min supported os version of this release
-    # @param date [String] Today's date
-    # @param moved_issues [Array<JIRA::Resource::Issue>] Issues moved to a new state by this build job
-    # @param release_issues [Array<JIRA::Resource::Issue>] Issues considered part of this release
-    # @param commit_hash [String] Commit hash from which release was built
-    # @param ci_build_number [String] CI build number which built the release
-    # @param ci_build_url [String] Link to CI build job
-    # @param templates [Apadmi::Grout::Templates] Mustache templates to use to generate the document
-    ReleaseNotesConfig = Struct.new(
-      :title,
-      :app_version,
-      :min_os_version,
-      :date,
-      :moved_issues,
-      :release_issues,
-      :commit_hash,
-      :ci_build_number,
-      :ci_build_url,
-      :templates
-    ) do
-      def classified_moved_issues
-        classify_issues(moved_issues)
-      end
-
-      def classified_release_issues
-        classify_issues(release_issues)
-      end
-
-      private
-
-      def classify_issues(issues)
-        ClassifiedIssues.new(
-          filter_issues_by_type(%w[Task], issues),
-          filter_issues_by_type(%w[Story Debt], issues),
-          filter_issues_by_type(%w[Improvement Rework], issues),
-          filter_issues_by_type(%w[Bug], issues),
-          issues - filter_issues_by_type(%w[Task Story Debt Improvement Rework Bug], issues)
-        )
-      end
-
-      # @param types [Array<String>] List of types to match on
-      # @param issues [Array<JIRA::Resource::Issue>]
-      # @return [Array<JIRA::Resource::Issue>]
-      def filter_issues_by_type(types, issues)
-        issues.find_all { |issue| types.include?(issue.issuetype.name) }
-      end
-    end
-  end
-end