apadmi_grout 1.2.0 → 2.2.0

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # @param tasks [Array<Apadmi::Grout::Issue>]
+    # @param features [Array<Apadmi::Grout::Issue>] aka stories
+    # @param improvements [Array<Apadmi::Grout::Issue>]
+    # @param defects [Array<Apadmi::Grout::Issue>] aka bugs
+    # @param others [Array<Apadmi::Grout::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<Apadmi::Grout::Issue>] Issues moved to a new state by this build job
+    # @param release_issues [Array<Apadmi::Grout::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
+    )
+  end
+end

data/lib/apadmi/grout/{release_notes/models → models}/release_notes_templates.rb

@@ -9,7 +9,7 @@ module Apadmi
 
 ### Version
 {{config.app_version}}
-{{config.hello}}
+
 ### Release date
 {{config.date}}
 
@@ -20,9 +20,9 @@ module Apadmi
 Commit Hash: {{config.commit_hash}}
 [CI/CD build \#{{config.ci_build_number}}]({{config.ci_build_url}})
 
-## Jira Tickets Moved By This Build
+## Tickets Moved By This Build
 {{ rendered_moved_issues }}
-## Jira Sprint Release notes
+## Sprint Release notes
 {{ rendered_release_issues }} }
       end
 
@@ -30,35 +30,35 @@ Commit Hash: {{config.commit_hash}}
         %{### New functionality
 {{# classified_issues.features.first}}
 {{# classified_issues.features}}
-* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+* [{{ key }} - {{ summary }}]({{ url }})
 {{/ classified_issues.features}}
 
 {{/ classified_issues.features.first}}
 {{# classified_issues.improvements.first}}
 ### Improvements
   {{# classified_issues.improvements}}
-* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+* [{{ key }} - {{ summary }}]({{ url }})
   {{/ classified_issues.improvements}}
 
 {{/ classified_issues.improvements.first}}
 {{# classified_issues.tasks.first}}
 ### Completed Tasks
   {{# classified_issues.tasks}}
-* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+* [{{ key }} - {{ summary }}]({{ url }})
   {{/ classified_issues.tasks}}
 
 {{/ classified_issues.tasks.first}}
 {{# classified_issues.defects.first}}
 ### Fixed defects
   {{# classified_issues.defects}}
-* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+* [{{ key }} - {{ summary }}]({{ url }})
   {{/ classified_issues.defects}}
 
 {{/ classified_issues.defects.first}}
 {{# classified_issues.others.first}}
 ### Other issue types
   {{# classified_issues.others}}
-* [{{ key }} - {{ summary }}]({{ base_url }}{{ key }})
+* [{{issue_type}} - {{ key }} - {{ summary }}]({{ url }})
   {{/ classified_issues.others}}
 
 {{/ classified_issues.others.first}}}

data/lib/apadmi/grout/service/bitrise_service/bitrise_service.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "open-uri"
+require "fileutils"
+
+module Apadmi
+  module Grout
+    # Utility class for abstracting a some of the bitrise APIs
+    class BitriseService
+      # @param [String] app_slug
+      # @param [Apadmi::Grout::NetworkService] network_service
+      def initialize(app_slug, network_service)
+        @app_slug = app_slug
+        @network_service = network_service
+      end
+
+      # @param [Integer] pull_request_id
+      # @param [String] workflow
+      # @return [Array<BitriseBuild>]
+      def list_builds(pull_request_id, workflow)
+        res = @network_service.do_get("/#{@app_slug}/builds?pull_request_id=#{pull_request_id}&workflow=#{workflow}")
+        parsed = JSON.parse(res.body)
+        items = parsed["data"]
+
+        return [] if items.nil? || items.empty?
+
+        items.map do |item|
+          BitriseBuild.new(
+            item["triggered_at"],
+            item["slug"],
+            item["status"],
+            item["commit_hash"]
+          )
+        end
+      end
+
+      # @param [String] build_slug
+      # @param [String] artifact_slug
+      # @return [Artifact]
+      def retrieve_artifact_metadata(build_slug, artifact_slug)
+        res = @network_service.do_get("/#{@app_slug}/builds/#{build_slug}/artifacts/#{artifact_slug}")
+        parsed = JSON.parse(res.body)
+
+        Artifact.new(parsed["data"]["title"], parsed["data"]["expiring_download_url"])
+      end
+
+      # @param [String] build_slug
+      # @param [String] output_dir
+      # Download all artifacts from a given build to a specified directory
+      def download_artifacts(build_slug, output_dir)
+        res = @network_service.do_get("/#{@app_slug}/builds/#{build_slug}/artifacts")
+        parsed = JSON.parse(res.body)
+        items = parsed["data"]
+
+        artifacts = items.map do |item|
+          retrieve_artifact_metadata(build_slug, item["slug"])
+        end
+
+        FileUtils.mkdir_p output_dir
+
+        artifacts.each do |item|
+          File.open("#{output_dir}/#{item.title}", "wb") do |file|
+            # rubocop:disable Security/Open
+            file.write URI.open(item.download_url).read
+            # rubocop:enable Security/Open
+          end
+        end
+        artifacts
+      end
+
+      # @param [String] workflow
+      # @param [String] branch
+      # @param [String] dest the destination branch of the pr
+      # @param [String] pull_request_id
+      # @param [String] pull_request_repo_url
+      # @param [String] commit_hash
+      def trigger_build(workflow, branch, dest, pull_request_id, pull_request_repo_url, commit_hash)
+        params = {
+          workflow_id: workflow,
+          branch: branch,
+          commit_hash: commit_hash
+        }
+
+        params[:branch_dest] = dest unless dest.strip.blank?
+        params[:pull_request_id] = pull_request_id unless pull_request_id.strip.blank?
+        params[:pull_request_repository_url] = pull_request_repo_url unless pull_request_repo_url.strip.blank?
+
+        payload = {
+          hook_info: {
+            type: "bitrise"
+          },
+          build_params: params,
+          triggered_by: "curl"
+        }
+
+        res = @network_service.do_post("/#{@app_slug}/builds", payload.to_json)
+        parsed = JSON.parse(res.body)
+
+        TriggeredBitriseBuild.from_json(parsed)
+      end
+    end
+  end
+end

data/lib/apadmi/grout/service/board_service/ado_board_service.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+require_relative "./board_service"
+
+module Apadmi
+  module Grout
+    # Provides a layer of abstraction on top of the ADO api
+    class AdoBoardService < BoardService
+      API_VERSION_PARAM = "api-version=6.0"
+
+      # @param [Apadmi::Grout::NetworkService] network_service
+      # @param [Apadmi::Grout::AdoConfig] ado_config
+      # @param [Logger] logger
+      def initialize(network_service, ado_config, logger)
+        @network_service = network_service
+        @ado_config = ado_config
+        @logger = logger
+      end
+
+      # @param [String[]] keys
+      # @return [Array<Apadmi::Grout::Issue>]
+      def find_issues_by_keys(keys)
+        return [] if keys.length <= 0
+
+        keys = keys.map { |k| sanitise_key(k) } # Allows supporting raw keys, and keys prefixed with a hash which is common ADO practice
+
+        res = @network_service.do_get("/wit/workitems?ids=#{keys.join(",")}&api-version=7.1-preview.2")
+        parsed = JSON.parse(res.body)
+        items = parsed["value"]
+
+        return if items.nil? || items.empty?
+
+        items.map { |i| Apadmi::Grout::Issue.from_ado_hash(i) }
+      end
+
+      # @param component [String] Included to be consistent with JIRA, this will boil down to a tag in ADO
+      # @param status [String]
+      # @param ticket_types [String[]]
+      # @param options [Apadmi::Grout::AdoFindTicketsOptions] Additional options to filter by
+
+      # @return [Array<Apadmi::Grout::Issue>]
+      def search_unblocked_issues(component, status, ticket_types = [], options = nil)
+        tags = (options&.required_tags || []).push(*component).filter { |it| !it.blank? }
+        not_tags = (options&.not_tags || []).filter { |it| !it.blank? }
+
+        raise "Tags can either be required or not required, not both" unless (tags & not_tags).empty?
+
+        tags_filter = tags.map { |tag| " AND [System.Tags] CONTAINS '#{tag}' " }.join(" ")
+        not_tags_filter = not_tags.map { |tag| " AND [System.Tags] NOT CONTAINS '#{tag}'" }.join(" ")
+
+        status_filter = ("AND [System.State]='#{status}' " unless status.blank?) || ""
+        type_filter = ("AND [System.WorkItemType] IN (#{ticket_types.map { |t| "'#{t}'" }.join(", ")})" unless ticket_types.empty?) || ""
+        wiql = %(
+          Select [System.Id]
+          From WorkItems
+          Where [System.Id] >= 1
+          #{status_filter}
+          #{tags_filter}
+          #{not_tags_filter}
+          #{type_filter}
+        )
+
+        get_issues_by_wiql(wiql)
+      end
+
+      # @param [String] key
+      # @param [String] comment
+      def flag_ticket(key, comment)
+        key = sanitise_key(key)
+
+        add_tag(key, @ado_config.flag_tag)
+        add_comment(key, comment) unless comment.blank?
+      end
+
+      # @param [String] key
+      def un_flag_ticket(key)
+        key = sanitise_key(key)
+
+        remove_tag(key, @ado_config.flag_tag)
+      end
+
+      # @param [String] key
+      # @param [String] comment
+      def add_comment(key, comment)
+        key = sanitise_key(key)
+
+        payload = {
+          "text" => comment
+        }
+        @network_service.do_post("/wit/workitems/#{key}/comments?#{API_VERSION_PARAM}-preview.3", payload.to_json)
+      end
+
+      # @param [String] key
+      # @param [String] tag
+      def add_tag(key, tag)
+        payload = [{
+          "op" => "add",
+          "path" => "/fields/System.Tags",
+          "value" => tag
+        }]
+        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+      end
+
+      # @param [String] key
+      # @param [String] tag
+      def remove_tag(key, tag)
+        current_tags = get_work_item(key)["fields"]["System.Tags"].split("; ")
+        new_tags = current_tags.filter { |t| t != tag }
+
+        payload = [{
+          "op" => "replace",
+          "path" => "/fields/System.Tags",
+          "value" => new_tags.join("; ")
+        }]
+        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+      end
+
+      # @param [String] key
+      def flagged?(key)
+        current_tags = get_work_item(key)["fields"]["System.Tags"].split("; ")
+        current_tags.include?(@ado_config.flag_tag)
+      end
+
+      # @param [String] key
+      # @return [RawWorkItemHash]
+      def get_work_item(key)
+        key = sanitise_key(key)
+
+        res = @network_service.do_get("/wit/workitems/#{key}?#{API_VERSION_PARAM}")
+        JSON.parse(res.body)
+      end
+
+      # @param [String] key
+      # @param [Array<String>] versions
+      def assign_fixversions(key, versions)
+        key = sanitise_key(key)
+
+        payload = [{
+          "op" => "replace",
+          "path" => "/fields/Microsoft.VSTS.Build.IntegrationBuild",
+          "value" => versions.join("; ")
+        }]
+        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+      end
+
+      # @param [String] key
+      # @return [Array<String>] fix versions
+      def get_ticket_fixversions(key)
+        key = sanitise_key(key)
+
+        get_work_item(key)["fields"]["Microsoft.VSTS.Build.IntegrationBuild"].split("; ")
+      end
+
+      # @param [Apadmi::Grout::Issue] issue
+      # @param [String] state_name
+      def transition_issue(issue, state_name)
+        key = sanitise_key(issue.key)
+
+        payload = [{
+          "op" => "add",
+          "path" => "/fields/System.State",
+          "value" => state_name
+        }]
+        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+      end
+
+      # @param [String] key
+      # @return [String]
+      def get_ticket_status(key)
+        key = sanitise_key(key)
+
+        get_work_item(key)["fields"]["System.State"]
+      end
+
+      private
+
+      def sanitise_key(key)
+        key = key.to_s.strip.delete_prefix "#"
+        raise "Invalid key" if key.blank?
+
+        key
+      end
+
+      # @param wiql_query [String]
+      # @return [Array<Apadmi::Grout::Issue>]
+      def get_issues_by_wiql(wiql_query)
+        @logger.message("Executing wiql")
+        @logger.message(wiql_query)
+
+        payload = { "query" => wiql_query }
+        res = @network_service.do_post("/wit/wiql?#{API_VERSION_PARAM}", payload.to_json)
+        parsed = JSON.parse(res.body)
+        items = parsed["workItems"] || []
+        ids = items.map { |item| item["id"] } || []
+        find_issues_by_keys(ids)
+      end
+    end
+  end
+end

data/lib/apadmi/grout/service/board_service/board_service.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    # A generic board service to be implemented by whatever
+    # board providers we have e.g. JIRA and ADO
+    class BoardService
+      # @param [String[]] keys
+      # @return [Array<Apadmi::Grout::Issue>]
+      def find_issues_by_keys(_keys)
+        raise "Unimplemented :("
+      end
+
+      # @param [String] _component
+      # @param [String] _status
+      # @param [String[]] _ticket_types
+      # @param [Apadmi::Grout::JiraFindTicketsOptions|Apadmi::Grout::JiraFindTicketsOptions] _options
+      # @return [Array<Apadmi::Grout::Issue>]
+      def search_unblocked_issues(_component, _status, _ticket_types = [], _options = nil)
+        raise "Unimplemented :("
+      end
+
+      # @param [String] _key
+      # @param [String] _comment
+      def flag_ticket(_key, _comment)
+        raise "Unimplemented :("
+      end
+
+      # @param [String] _key
+      def un_flag_ticket(_key)
+        raise "Unimplemented :("
+      end
+
+      # @param [String] _key
+      # @return bool
+      def flagged?(_key)
+        raise "Unimplemented :("
+      end
+
+      # @param [String] _key
+      # @param [Array<String>] _version_strings
+      def assign_fixversions(_key, _version_strings)
+        raise "Unimplemented :("
+      end
+
+      # @param [String] _key
+      # @return [Array<String>]
+      def get_ticket_fixversions(_key)
+        raise "Unimplemented :("
+      end
+
+      # @param [Apadmi::Grout::Issue] _issue
+      # @param [String] _state_name
+      def transition_issue(_issue, _state_name)
+        raise "Unimplemented :("
+      end
+    end
+  end
+end