fastlane-plugin-bitrise_automation 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0241689ccd66d05a0836120f501ef00feffdfa51348545c49b66b32eaa01dd82'
-  data.tar.gz: 8e60ba4980310e128b1d8f2027ba957a93edef5da559f3a50176d22e40a3256d
+  metadata.gz: 995f0a752fe79b180ba1fbd4d9f74b8dba9b61946dfc4ae8f0234d5eb9dd1e87
+  data.tar.gz: 7637f6ad20acb0880c3f0c9e3455c86fa058a24788266b56a3c8b7c5b6cac9bc
 SHA512:
-  metadata.gz: 6495f2a4420b45222c9c9d0a876fbb22895da86aa10c7d844f2067ebbd67be5f79c4a5001b800345e9955c9f6f6b97c01547c35013927a90c04e4526e08b4b46
-  data.tar.gz: a38360cbfa1de1e1cd476fa4afd768456dd443571f02e00aaa3bf489e45dc2724a431a5991333e9647e71388d4dac02b97cc8ab59d6d842661eecbbb66629dbe
+  metadata.gz: 06054d6a913718bc2ae33e4705d3238b573fc7a1f6fb0da068c8a41f653d7a53d07ecb4133f67bb20c3c06c4b0abfa2d22aa27a8f67b3617c30c811efdf55505
+  data.tar.gz: 6b68a62d4ed134d5619bdc9021c9cf516aac6d4b3079f9b767a36e3896a2e8e29273b0cec9872b7f4b4b601b897dc2ad3e15bb640e215cca703bd3757a222628

data/README.md

@@ -12,7 +12,7 @@ fastlane add_plugin bitrise_automation
 
 ## About bitrise_automation
 
-Interact with [Bitrise](https://bitrise.io/) projects from fastlane.
+Interact with [Bitrise](https://bitrise.io/) projects from fastlane. This allows you to trigger a Bitrise workflow and its related information using the [Bitrise API](https://devcenter.bitrise.io/api/api-index/).
 
 This is useful if you want to interact with Bitrise from your terminal using Fastlane or if you are encapsulating Bitrise builds from another CI (such as Jenkins).
 
@@ -25,14 +25,79 @@ This plugin assumes you already have an app configured on Bitrise and uses a Per
 - Check build success/failure (exiting with success or failure according to the status on Bitrise)
 - Retrieve the list of artifacts from a build
 - Download the artifacts produced by a build
+- Automatic retry of requests when the connection to the Bitrise API fails or returns a 5xx error
 
 ### Known issues
 
-- For now the only option is to trigger a build via a commit hash. It should be more flexible as Bitrise allows triggering by branch, tag, commit or default strategy.
+- Triggering a build with a tag is not yet implemented
 - The author option to trigger the build is not implemented
 - The environments option to trigger the build is not implemented
 - Pagination on API responses is not implemented
 
+## Usage
+
+It is recommended to set the `BITRISE_APP_SLUG` and `BITRISE_ACCESS_TOKEN` environment variables to avoid committing those values into your repository.
+
+### trigger_bitrise_workflow
+Use this action to trigger a workflow on Bitrise and query its status.
+
+| Key | Description | Environment variable | Default value |
+| --- | --- | --- | --- |
+| `app_slug` | The app slug of the project on Bitrise | BITRISE_APP_SLUG | |
+| `access_token` | The [personal access token](https://devcenter.bitrise.io/api/authentication/) used to call Bitrise API | BITRISE_ACCESS_TOKEN | |
+| `workflow` | The name of the workflow to trigger | BITRISE_WORKFLOW | |
+| `branch` | The name of branch that will be checked out | BITRISE_BUILD_BRANCH | |
+| `commit_hash` | The hash of the commit that will be checked out (overrides branch parameter) | BITRISE_BUILD_COMMIT_HASH | |
+| `build_message` | A custom message that will be used to identify the build | BITRISE_BUILD_MESSAGE | |
+| `triggered_by` | A custom message that will be used to identify where the build was triggered from (optional) | BITRISE_BUILD_TRIGGERED_BY | |
+| `wait_for_build` | Whether the action should wait until the build finishes or return immediately after requesting the build | BITRISE_WAIT_FOR_BUILD | false |
+| `download_artifacts` | Whether to download or not the produced artifacts | BITRISE_DOWNLOAD_ARTIFACTS | false |
+
+The returned value is a hash containing the information about the build. 
+
+| Hash key | Description |
+| --- | --- |
+| `status` | The status of the build |
+| `build_slug` | The build slug that can be used to identify the build on other actions |
+| `build_number` | The build number |
+| `build_url` | The URL to the build page on Bitrise |
+
+### bitrise_build_status
+Use this action to query the status of a build on Bitrise.
+
+| Key | Description | Environment variable | Default value |
+| --- | --- | --- | --- |
+| `app_slug` | The app slug of the project on Bitrise | BITRISE_APP_SLUG | |
+| `access_token` | The [personal access token](https://devcenter.bitrise.io/api/authentication/) used to call Bitrise API | BITRISE_ACCESS_TOKEN | |
+| `build_slug` | The slug that identifies the build on Bitrise | BITRISE_BUILD_SLUG | |
+
+The returned value is a hash containing the information about the build status. 
+
+| Hash key | Description |
+| --- | --- |
+| `status` | The status of the build: not finished (0), successful (1), failed (2), aborted with failure (3), aborted with success (4) |
+| `status_text` | The status text |
+| `is_on_hold` | Indicates whether the build has started yet (true: the build hasn't started) |
+| `abort_reason` | If the build has been aborted, indicates the reason why |
+
+### bitrise_build_artifacts
+Use this action to retrieve information about the artifacts of a build or to automatically download them from Bitrise.
+
+| Key | Description | Environment variable | Default value |
+| --- | --- | --- | --- |
+| `app_slug` | The app slug of the project on Bitrise | BITRISE_APP_SLUG | |
+| `access_token` | The [personal access token](https://devcenter.bitrise.io/api/authentication/) used to call Bitrise API | BITRISE_ACCESS_TOKEN | |
+| `build_slug` | The slug that identifies the build on Bitrise | BITRISE_BUILD_SLUG | |
+| `download_artifacts` | Whether to download or not the produced artifacts | BITRISE_DOWNLOAD_ARTIFACTS | false |
+
+The returned value is an list of hashes containing the information about the artifacts. If there are no artifacts, it returns an empty list.
+
+| Hash key | Description |
+| --- | --- |
+| `artifact_type` | The type of the artifact as detected by Bitrise |
+| `file_size_bytes` | The size of the artifact in bytes |
+| `slug` | The slug that identifies the artifact |
+| `title` | The name of artifact |
 
 ## Example
 

data/lib/fastlane/plugin/bitrise_automation/actions/bitrise_build_artifacts_action.rb

@@ -5,7 +5,11 @@ module Fastlane
   module Actions
     class BitriseBuildArtifactsAction < Action
       def self.run(params)
-        response = Helper::BitriseRequestHelper.get(params, "builds/#{params[:build_slug]}/artifacts")
+        get_artifacts(params, params[:build_slug])
+      end
+
+      def self.get_artifacts(params, build_slug)
+        response = Helper::BitriseRequestHelper.get(params, "builds/#{build_slug}/artifacts")
 
         if response.code == "200"
           json_response = JSON.parse(response.body)['data']
@@ -13,7 +17,7 @@ module Fastlane
           UI.crash!("Error fetching build artifacts list on Bitrise.io. Status code: #{response.code}. #{response}")
         end
 
-        UI.message("Found #{json_response.size} artifacts on Bitrise for build #{params[:build_slug]}.")
+        UI.message("Found #{json_response.size} artifacts on Bitrise for build #{build_slug}.")
 
         artifacts = json_response.map do |artifact|
           {
@@ -29,14 +33,14 @@ module Fastlane
                                                 title: artifact['title'])
         end
 
-        if params[:download]
+        if params[:download_artifacts] && !artifacts.empty?
           artifacts_dir = 'artifacts'
-          UI.message("Download option is on. Will start download of #{artifacts.size} artifacts to #{artifacts_dir}.")
+          UI.message("Download option is on. Will start download of #{artifacts.size} artifacts to '#{artifacts_dir}'.")
           Dir.mkdir(artifacts_dir) unless Dir.exist?(artifacts_dir)
 
           artifacts.each do |artifact|
             UI.message("Fetching artifact '#{artifact['title']}' of type '#{artifact['artifact_type']}' (#{artifact['file_size_bytes']} bytes)...")
-            artifact_details = get_artifact_details(params, artifact['slug'])
+            artifact_details = get_artifact_details(params, build_slug, artifact['slug'])
 
             download_artifact(artifact_details, artifacts_dir)
             UI.message("Finished downloading artifact '#{artifact['title']}'.")
@@ -46,8 +50,8 @@ module Fastlane
         artifacts
       end
 
-      def self.get_artifact_details(params, artifact_slug)
-        response = Helper::BitriseRequestHelper.get(params, "builds/#{params[:build_slug]}/artifacts/#{artifact_slug}")
+      def self.get_artifact_details(params, build_slug, artifact_slug)
+        response = Helper::BitriseRequestHelper.get(params, "builds/#{build_slug}/artifacts/#{artifact_slug}")
 
         if response.code == "200"
           json_response = JSON.parse(response.body)['data']
@@ -94,8 +98,8 @@ module Fastlane
                                description: "The slug that identifies the build on Bitrise",
                                   optional: false,
                                       type: String),
-          FastlaneCore::ConfigItem.new(key: :download,
-                                  env_name: "BITRISE_ARTIFACTS_DOWNLOAD",
+          FastlaneCore::ConfigItem.new(key: :download_artifacts,
+                                  env_name: "BITRISE_DOWNLOAD_ARTIFACTS",
                                description: "Whether to download or not the produced artifacts",
                                   optional: true,
                              default_value: false,

data/lib/fastlane/plugin/bitrise_automation/actions/bitrise_build_status_action.rb

@@ -5,7 +5,10 @@ module Fastlane
   module Actions
     class BitriseBuildStatusAction < Action
       def self.run(params)
-        get_status(params, params[:build_slug])
+        status = get_status(params, params[:build_slug])
+        FastlaneCore::PrintTable.print_values(config: status,
+                                              title: "Bitrise build '#{params[:build_slug]}' status")
+        status
       end
 
       def self.get_status(params, build_slug)
@@ -21,6 +24,7 @@ module Fastlane
         build_infos["is_on_hold"] = json_response["is_on_hold"]
         build_infos["status"] = json_response["status"]
         build_infos["status_text"] = json_response["status_text"]
+        build_infos["abort_reason"] = json_response["abort_reason"]
         build_infos
       end
 

data/lib/fastlane/plugin/bitrise_automation/actions/interrupt_action.rb

@@ -0,0 +1,38 @@
+require 'fastlane/action'
+require_relative '../helper/bitrise_automation_helper'
+
+module Fastlane
+  module Actions
+    class InterruptAction < Action
+      def self.run(params)
+        begin
+          UI.message("Test interrupt - sleeping")
+          sleep(60)
+        rescue Interrupt => e
+          UI.message("interrupted")
+        end
+      end
+
+      def self.description
+        "Trigger a Bitrise workflow with the specified parameters, synchronously or asynchronously"
+      end
+
+      def self.authors
+        ["Mario Cecchi", "Henrique Alves"]
+      end
+
+      def self.return_value
+        "Returns the information of the Bitrise build"
+      end
+
+      def self.available_options
+        [
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitrise_automation/actions/trigger_bitrise_workflow_action.rb

@@ -5,26 +5,30 @@ module Fastlane
   module Actions
     class TriggerBitriseWorkflowAction < Action
       def self.run(params)
-        UI.verbose("Requesting new Bitrise.io build...")
+        UI.message("Requesting new Bitrise.io build for workflow '#{params[:workflow]}'...")
 
-        response = Helper::BitriseRequestHelper.post(params, 'builds', {
+        trigger_payload = {
           hook_info: {
             type: "bitrise"
           },
           build_params: {
-            workflow_id: params[:workflow],
-            commit_hash: params[:commit_hash],
-            commit_message: params[:build_message]
+            workflow_id: params[:workflow]
           }
-        }.to_json)
+        }
+        trigger_payload[:build_params][:branch] = params[:branch] unless params[:branch].nil? || params[:branch].empty?
+        trigger_payload[:build_params][:commit_hash] = params[:commit_hash] unless params[:commit_hash].nil? || params[:commit_hash].empty?
+        trigger_payload[:build_params][:commit_message] = params[:build_message] unless params[:build_message].nil? || params[:build_message].empty?
+        trigger_payload[:triggered_by] = params[:triggered_by] unless params[:triggered_by].nil? || params[:triggered_by].empty?
+
+        response = Helper::BitriseRequestHelper.post(params, 'builds', trigger_payload.to_json)
 
         if response.code == "201"
           json_response = JSON.parse(response.body)
-          UI.success("Build triggered successfully 🚀 URL: #{json_response['build_url']}")
+          UI.success("Build #{json_response['build_number']} triggered successfully on Bitrise 🚀 URL: #{json_response['build_url']}")
           FastlaneCore::PrintTable.print_values(config: json_response,
                                                 title: "Bitrise API response")
         else
-          UI.crash!("Error requesting new build on Bitrise.io. Status code: #{response.code}. #{response}")
+          UI.crash!("Error requesting new build on Bitrise.io. Status code: #{response.code}. #{response.body}")
         end
 
         build_infos = {}
@@ -36,11 +40,19 @@ module Fastlane
         if params[:wait_for_build]
           build_status = wait_until_build_completion(params, build_infos["build_slug"])
 
+          if params[:download_artifacts]
+            BitriseBuildArtifactsAction.get_artifacts(params, build_infos["build_slug"])
+          end
+
+          build_infos["status"] = build_status["status_text"]
           if build_status["status"] == 1
             UI.success("Build has finished successfully on Bitrise!")
-            build_infos["status"] = build_status["status_text"]
           elsif build_status["status"] == 2
-            UI.build_failure!("Build has FAILED. Check Bitrise for details.")
+            UI.build_failure!("Build has FAILED on Bitrise. Check more details at #{build_infos['build_url']}.")
+          elsif build_status["status"] == 3 || build_status["status"] == 4
+            UI.build_failure!("Build has been ABORTED on Bitrise. Abort reason: '#{build_status['abort_reason']}'. Check more details at #{build_infos['build_url']}.")
+          else
+            UI.build_failure!("Build has ended with unknown status on Bitrise: #{build_status}. Check more details at #{build_infos['build_url']}.")
           end
         end
 
@@ -91,23 +103,39 @@ module Fastlane
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :workflow,
                                   env_name: "BITRISE_WORKFLOW",
-                               description: "The name of the workflow on Bitrise",
+                               description: "The name of the workflow to trigger",
                                   optional: false,
                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                  env_name: "BITRISE_BUILD_BRANCH",
+                               description: "The name of branch that will be checked out",
+                                  optional: true,
+                                      type: String),
           FastlaneCore::ConfigItem.new(key: :commit_hash,
                                   env_name: "BITRISE_BUILD_COMMIT_HASH",
-                               description: "The commit hash to be used on the build",
-                                  optional: false,
+                               description: "The hash of the commit that will be checked out",
+                                  optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :build_message,
                                   env_name: "BITRISE_BUILD_MESSAGE",
                                description: "A custom message that will be used to identify the build",
-                                  optional: false,
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :triggered_by,
+                                  env_name: "BITRISE_BUILD_TRIGGERED_BY",
+                               description: "A custom message that will be used to identify where the build was triggered from",
+                                  optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :wait_for_build,
                                   env_name: "BITRISE_WAIT_FOR_BUILD",
                                description: "Whether the action should wait until the build finishes or return immediately after requesting the build",
                                   optional: true,
+                             default_value: false,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :download_artifacts,
+                                  env_name: "BITRISE_DOWNLOAD_ARTIFACTS",
+                               description: "Whether to download or not the produced artifacts",
+                                  optional: true,
                              default_value: false,
                                  is_string: false)
         ]

data/lib/fastlane/plugin/bitrise_automation/helper/bitrise_automation_helper.rb

@@ -5,6 +5,7 @@ module Fastlane
 
   module Helper
     class BitriseRequestHelper
+      MAX_RETRY_ATTEMPTS = 2
       class << self
         def get(params, path)
           request = Net::HTTP::Get.new("/v0.1/apps/#{params[:app_slug]}/#{path}", bitrise_headers(params[:access_token]))
@@ -14,7 +15,7 @@ module Fastlane
         def post(params, path, body)
           request = Net::HTTP::Post.new("/v0.1/apps/#{params[:app_slug]}/#{path}", bitrise_headers(params[:access_token]))
           request.body = body
-          bitrise_client.request(request)
+          request_with_retries(request)
         end
 
         private
@@ -29,6 +30,29 @@ module Fastlane
         def bitrise_headers(access_token)
           { 'Content-Type' => 'application/json', 'Authorization' => access_token }
         end
+
+        def request_with_retries(request)
+          retries = 0
+          begin
+            response = bitrise_client.request(request)
+            if response.code.start_with?("5")
+              UI.error("Bitrise returned a server-side error. Status code: #{response.code}. #{response}")
+              raise "Bitrise API error: #{response.code}"
+            end
+          rescue StandardError => e
+            UI.error("There was an error making the request to Bitrise (retries: #{retries}). #{e}")
+            if retries < MAX_RETRY_ATTEMPTS
+              retries += 1
+              sleep(15)
+              UI.error("Retrying request (attempt #{retries})")
+              retry
+            else
+              UI.error("All retry attempts failed.")
+              raise e
+            end
+          end
+          response
+        end
       end
     end
   end

data/lib/fastlane/plugin/bitrise_automation/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module BitriseAutomation
-    VERSION = "0.1.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-bitrise_automation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mario Cecchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -147,6 +147,7 @@ files:
 - lib/fastlane/plugin/bitrise_automation.rb
 - lib/fastlane/plugin/bitrise_automation/actions/bitrise_build_artifacts_action.rb
 - lib/fastlane/plugin/bitrise_automation/actions/bitrise_build_status_action.rb
+- lib/fastlane/plugin/bitrise_automation/actions/interrupt_action.rb
 - lib/fastlane/plugin/bitrise_automation/actions/trigger_bitrise_workflow_action.rb
 - lib/fastlane/plugin/bitrise_automation/helper/bitrise_automation_helper.rb
 - lib/fastlane/plugin/bitrise_automation/version.rb