apadmi_grout 2.0.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8da866b98ba10eeb0dd9a8a664bd926e8c657cb918bf8a73474d1e3aacd941c4
-  data.tar.gz: '0759b30f1bcbe228e7c1a22eecc52bad02f8174d31584d130936a9d3203d35ef'
+  metadata.gz: 58507ab047f8ae45fff33f92ac13ae75d57680c0d29abdaaedf39ea0e27e82c2
+  data.tar.gz: d598788e30b14c306d107c7522c2e1646f95f54e92cb8f4aa74806326a85b10d
 SHA512:
-  metadata.gz: fd158cbb2bda541b4fbb80137200c60793d86d1257705aec7ffe5450f1fd66a6d8dc13f6e1135ca5c2db28a8049a92db4e1d76b678b0aa745314cdd7bdd92fed
-  data.tar.gz: f0a7a913306577749fcba0a68ce1311e073ce4f21ac0e15d50f87527f7a65a8c27e0f3136e871d7d0b5ab457da99369bc9c99a91007f361f4cb102c435e3751f
+  metadata.gz: acc0fa240dde5f43293978694005ff9509dd39fdfeb89ea2db207f0944ab54d8eab598da6f133d9595e12c870b4a1ee7d6307c3060f376544231bff2493572c5
+  data.tar.gz: 230e4d0c686736605ac0a2548fc500c398d4e7c41b39d1aff55b93ed567cad887503cfa2684066a06a59f8f77e0f0bc05a5298d5647074235e1ef7ee06968ec7

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Core Changelog
 
+## [2.2.1] - 2022-08-21
+* Reduce ruby version to match what bitrise has installed
+
+## [2.2.0] - 2022-08-16
+* Bumped min ruby version to 3.0.0 to prevent subtle bugs
+* Removed references to JIRA in default release note templates
+* Fixed issues with git warnings being treated like errors
+
+## [2.1.0] - 2022-07-26
+* Added a few bitrise utils to support listing builds, triggering builds and downloading artifacts.
+* Added utilities to the network service to upload files
+
 ## [2.0.0] - 2022-05-25
 * Almost total refactor to support having different board providers (other than jira)
 * Implement ADO support for all existing actions

data/lib/apadmi/grout/di.rb

@@ -25,7 +25,7 @@ module Apadmi
         project,
         logger = Apadmi::Grout::DefaultLogger.new
       )
-        network_service = Apadmi::Grout::NetworkService.new(username, token, base_url)
+        network_service = Apadmi::Grout::NetworkService.init_for_basic_auth(username, token, base_url)
         jira_board_service = Apadmi::Grout::JiraBoardService.new(username, token, base_url, context_path, project, network_service)
         git_utils = Apadmi::Grout::GitUtils
         issues_from_changelog_action = Apadmi::Grout::IssuesFromChangelogAction.new(jira_board_service, "#{project}-", logger)
@@ -51,7 +51,7 @@ module Apadmi
         )
       )
         ticket_prefix = "#"
-        network_service = Apadmi::Grout::NetworkService.new("", personal_access_token, base_url)
+        network_service = Apadmi::Grout::NetworkService.init_for_basic_auth("", personal_access_token, base_url)
         ado_board_service = Apadmi::Grout::AdoBoardService.new(network_service, ado_config, logger)
         git_utils = Apadmi::Grout::GitUtils
         issues_from_changelog_action = Apadmi::Grout::IssuesFromChangelogAction.new(ado_board_service, ticket_prefix, logger)
@@ -65,6 +65,11 @@ module Apadmi
           generate_release_notes_action: Apadmi::Grout::GenerateReleaseNotesAction.new(Apadmi::Grout::AdoIssueClassifier.new)
         )
       end
+
+      def self.bitrise_service(api_token, base_url, app_slug)
+        network_service = Apadmi::Grout::NetworkService.new(api_token, base_url)
+        Apadmi::Grout::BitriseService.new(app_slug, network_service)
+      end
     end
   end
 end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Apadmi
+  module Grout
+    STATUS_RUNNING = 0
+    STATUS_SUCCESS = 1
+    STATUS_FAILED = 2
+    STATUS_ABORTED_FAIL = 3
+    STATUS_ABORTED_SUCCESS = 4
+
+    BitriseBuild = Struct.new(:triggered_at, :slug, :status, :commit_hash) do
+      def finished_with_success
+        STATUS_SUCCESS == status
+      end
+    end
+
+    Artifact = Struct.new(:title, :download_url)
+
+    TriggeredBitriseBuild = Struct.new(:build_number, :build_slug, :build_url, :message, :service, :slug, :status, :triggered_workflow) do
+      def finished_with_success
+        STATUS_SUCCESS == status
+      end
+
+      def self.from_json(json)
+        TriggeredBitriseBuild.new(
+          json["build_number"],
+          json["build_slug"],
+          json["build_url"],
+          json["message"],
+          json["service"],
+          json["slug"],
+          json["status"],
+          json["triggered_workflow"]
+        )
+      end
+    end
+  end
+end

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

@@ -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
 

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

@@ -9,8 +9,16 @@ module Apadmi
       # 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, stderr, status = Open3.capture3("git rev-parse --show-toplevel")
+        raise "Failed to get git root: #{stderr}" unless status.success?
+
+        stdout.strip
+      end
+
+      # Gets the commit hash of the current HEAD
+      def self.commit_hash
+        stdout, stderr, status = Open3.capture3("git rev-parse HEAD")
+        raise "Failed to get hash: #{stderr}" unless status.success?
 
         stdout.strip
       end
@@ -19,16 +27,16 @@ module Apadmi
       # 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, stderr, status = Open3.capture3("git rev-list HEAD --count")
+        raise "Failed to get commit number: #{stderr}" unless status.success?
 
         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, stderr, status = Open3.capture3("git fetch --all")
+        raise "Failed to fetch #{stderr}" unless status.success?
 
         stdout.strip
       end
@@ -37,8 +45,8 @@ module Apadmi
       # @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, stderr, status = Open3.capture3(command)
+        raise "Failed to get changelog: #{stderr}" unless status.success?
 
         stdout
       end
@@ -47,8 +55,8 @@ module Apadmi
       # @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, stderr, status = Open3.capture3(command)
+        raise "Failed to get changelog: #{stderr}" unless status.success?
 
         stdout
       end

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

@@ -6,8 +6,11 @@ module Apadmi
   module Grout
     # Utility class for running REST network calls
     class NetworkService
+      attr_reader :base_url
+
       APPLICATION_JSON = "application/json"
       PATCH_CONTENT_TYPE = "application/json-patch+json"
+      FORM_CONTENT_TYPE = "application/x-www-form-urlencoded"
       CONTENT_TYPE = "Content-Type"
       private_constant :CONTENT_TYPE, :APPLICATION_JSON
 
@@ -15,10 +18,18 @@ module Apadmi
       # @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
+      def self.init_for_basic_auth(username, password, base_url, timeout = 30)
+        auth_str = "#{username}:#{password}"
+        auth_header = "Basic #{Base64.strict_encode64(auth_str)}"
+        NetworkService.new(auth_header, base_url, timeout)
+      end
+
+      # @param auth_header [String]
+      # @param base_url [String]
+      def initialize(auth_header, base_url, timeout = 30)
         @base_url = base_url
+        @auth_header = auth_header
+        @timeout = timeout
       end
 
       # @param [String] path
@@ -50,6 +61,30 @@ module Apadmi
         response
       end
 
+      def do_form_encoded_post(path, payload)
+        conn = setup_con
+        response = conn.post("#{@base_url}#{path}") do |req|
+          req.headers[CONTENT_TYPE] = FORM_CONTENT_TYPE
+          req.body = URI.encode_www_form(payload)
+        end
+        throw_if_error(response)
+        response
+      end
+
+      def do_file_post(path, file_path, type)
+        conn = Faraday.new do |f|
+          f.request :multipart
+          f.adapter :net_http
+        end
+        conn.options.timeout = @timeout
+        conn.headers["Authorization"] = @auth_header
+
+        payload = { file: Faraday::UploadIO.new(file_path, type) }
+        response = conn.post("#{@base_url}#{path}", payload)
+        throw_if_error(response)
+        response
+      end
+
       # @param [String] path
       # @param [String] payload
       # @return [Faraday::Response]
@@ -73,9 +108,9 @@ module Apadmi
 
       # @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.headers["Authorization"] = @auth_header
+        conn.options.timeout = @timeout
         conn
       end
 

data/lib/apadmi/grout/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apadmi_grout
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Apadmi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -72,12 +72,14 @@ files:
 - lib/apadmi/grout/actions/move_tickets_action.rb
 - lib/apadmi/grout/di.rb
 - lib/apadmi/grout/models/ado_config.rb
+- lib/apadmi/grout/models/bitrise.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/bitrise_service/bitrise_service.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
@@ -102,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.7.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Apadmi build tool utils for use through Fastlane on Android and iOS.