fastlane-plugin-bitrise_automation 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45bdd3a1b6931f1d714dd90b9f5b141e0a3e716b782bea685ada224ecefcf7c5
-  data.tar.gz: afb31287838a6eb998ff322a955536d91d6f086af4c58add8a421009fe6d98ce
+  metadata.gz: 52d8e6af9f3d94409439d852326a6f3695bf4a5c79bc2ec1bb73697cb14f4bfb
+  data.tar.gz: a240c2baac03ac01441f88cd38d2939212d38e4c749ab177da22e3746b84ff76
 SHA512:
-  metadata.gz: 5548f5e317336d05d57be210e1dcc5ce763258a79117d4b45b099a55711b8500583a1910dcb1fce68558e317d9e2df9db4c847314932585cd26f34de711c09a8
-  data.tar.gz: b0dedb02ba555e46b6ba8a5418584a90ba7b30043e470e4f25fe78a3108cca3e6ec3110bc4d6b7b7e96ff5f8525a4b16b3a6508ced1e8103f3ad894db2c7d5dd
+  metadata.gz: bfd962e3d6e904987bc0eda66f75bcb415a5f9995e16410837b9f243c9cef49955ac1851a716ecdd349d9d9273a62c68a212725153b969269fdd6e3e50c36116
+  data.tar.gz: 4ed1d1619b5ae73215de09258e8e0bf33e3f027bf6338426df82848f6673d28b777231ec2c5e67f5cb0db400f9895cf800082dc15879ea65445ea4225a73ea57

data/README.md

@@ -25,10 +25,11 @@ 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
@@ -45,8 +46,10 @@ Use this action to trigger a workflow on Bitrise and query its status.
 | `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 | |
-| `commit_hash` | The hash of the commit that will be checked out  | BITRISE_BUILD_COMMIT_HASH | |
+| `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 |
 
@@ -75,6 +78,7 @@ The returned value is a hash containing the information about the build status.
 | `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.

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

@@ -24,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/trigger_bitrise_workflow_action.rb

@@ -5,18 +5,22 @@ 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)
@@ -24,7 +28,7 @@ module Fastlane
           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 = {}
@@ -35,14 +39,20 @@ 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 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
 
@@ -96,15 +106,25 @@ module Fastlane
                                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 hash of the commit that will be checked out",
-                                  optional: false,
+                                  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",

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

@@ -5,16 +5,17 @@ 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]))
-          bitrise_client.request(request)
+          request_with_retries(request)
         end
 
         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.2.0"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-bitrise_automation
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Mario Cecchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry