fastlane-plugin-bitrise_automation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0241689ccd66d05a0836120f501ef00feffdfa51348545c49b66b32eaa01dd82'
+  data.tar.gz: 8e60ba4980310e128b1d8f2027ba957a93edef5da559f3a50176d22e40a3256d
+SHA512:
+  metadata.gz: 6495f2a4420b45222c9c9d0a876fbb22895da86aa10c7d844f2067ebbd67be5f79c4a5001b800345e9955c9f6f6b97c01547c35013927a90c04e4526e08b4b46
+  data.tar.gz: a38360cbfa1de1e1cd476fa4afd768456dd443571f02e00aaa3bf489e45dc2724a431a5991333e9647e71388d4dac02b97cc8ab59d6d842661eecbbb66629dbe

data/LICENSE

@@ -0,0 +1,12 @@
+ISC License (ISC)
+
+Copyright 2019 Natura Cosméticos
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
+provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# bitrise_automation plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-bitrise_automation)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-bitrise_automation`, add it to your project by running:
+
+```bash
+fastlane add_plugin bitrise_automation
+```
+
+## About bitrise_automation
+
+Interact with [Bitrise](https://bitrise.io/) projects from fastlane.
+
+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).
+
+This plugin assumes you already have an app configured on Bitrise and uses a Personal Access Token from Bitrise to communicate with the Bitrise API. Check the [official documentation](https://devcenter.bitrise.io/api/authentication/) to learn how to acquire a token.
+
+### Features
+
+- Trigger a workflow asynchronously (returning immediately after build has been requested)
+- Trigger a workflow synchronously (waiting until the build executes and finishes)
+- 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
+
+### 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.
+- 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
+
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/bitrise_automation.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/bitrise_automation/version'
+
+module Fastlane
+  module BitriseAutomation
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::BitriseAutomation.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,111 @@
+require 'fastlane/action'
+require_relative '../helper/bitrise_automation_helper'
+
+module Fastlane
+  module Actions
+    class BitriseBuildArtifactsAction < Action
+      def self.run(params)
+        response = Helper::BitriseRequestHelper.get(params, "builds/#{params[:build_slug]}/artifacts")
+
+        if response.code == "200"
+          json_response = JSON.parse(response.body)['data']
+        else
+          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]}.")
+
+        artifacts = json_response.map do |artifact|
+          {
+            "title" => artifact["title"],
+            "artifact_type" => artifact["artifact_type"],
+            "slug" => artifact["slug"],
+            "file_size_bytes" => artifact["file_size_bytes"]
+          }
+        end
+
+        artifacts.each do |artifact|
+          FastlaneCore::PrintTable.print_values(config: artifact,
+                                                title: artifact['title'])
+        end
+
+        if params[:download]
+          artifacts_dir = 'artifacts'
+          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'])
+
+            download_artifact(artifact_details, artifacts_dir)
+            UI.message("Finished downloading artifact '#{artifact['title']}'.")
+          end
+        end
+
+        artifacts
+      end
+
+      def self.get_artifact_details(params, artifact_slug)
+        response = Helper::BitriseRequestHelper.get(params, "builds/#{params[:build_slug]}/artifacts/#{artifact_slug}")
+
+        if response.code == "200"
+          json_response = JSON.parse(response.body)['data']
+        else
+          UI.crash!("Error fetching build artifacts details on Bitrise.io. Status code: #{response.code}. #{response}")
+        end
+
+        json_response
+      end
+
+      def self.download_artifact(artifact, dir)
+        file_name = artifact['title']
+        url = artifact['expiring_download_url']
+
+        sh("curl --fail --silent -o '#{dir}/#{file_name}' '#{url}'")
+      end
+
+      def self.description
+        "Get the list or full contents of the artifacts produced by a build on Bitrise"
+      end
+
+      def self.authors
+        ["Mario Cecchi", "Henrique Alves"]
+      end
+
+      def self.return_value
+        "Returns the list of artifacts produced by a build on Bitrise"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :app_slug,
+                                  env_name: "BITRISE_APP_SLUG",
+                               description: "The app slug of the project on Bitrise",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :access_token,
+                                  env_name: "BITRISE_ACCESS_TOKEN",
+                               description: "The personal access token used to call Bitrise API",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :build_slug,
+                                  env_name: "BITRISE_BUILD_SLUG",
+                               description: "The slug that identifies the build on Bitrise",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :download,
+                                  env_name: "BITRISE_ARTIFACTS_DOWNLOAD",
+                               description: "Whether to download or not the produced artifacts",
+                                  optional: true,
+                             default_value: false,
+                                 is_string: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'fastlane/action'
+require_relative '../helper/bitrise_automation_helper'
+
+module Fastlane
+  module Actions
+    class BitriseBuildStatusAction < Action
+      def self.run(params)
+        get_status(params, params[:build_slug])
+      end
+
+      def self.get_status(params, build_slug)
+        response = Helper::BitriseRequestHelper.get(params, "builds/#{build_slug}")
+
+        if response.code == "200"
+          json_response = JSON.parse(response.body)['data']
+        else
+          UI.crash!("Error fetching build status on Bitrise.io. Status code: #{response.code}. #{response}")
+        end
+
+        build_infos = {}
+        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
+      end
+
+      def self.description
+        "Get the status of the Bitrise build"
+      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
+        [
+          FastlaneCore::ConfigItem.new(key: :app_slug,
+                                  env_name: "BITRISE_APP_SLUG",
+                               description: "The app slug of the project on Bitrise",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :access_token,
+                                  env_name: "BITRISE_ACCESS_TOKEN",
+                               description: "The personal access token used to call Bitrise API",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :build_slug,
+                                  env_name: "BITRISE_BUILD_SLUG",
+                               description: "The slug that identifies the build on Bitrise",
+                                  optional: false,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+require 'fastlane/action'
+require_relative '../helper/bitrise_automation_helper'
+
+module Fastlane
+  module Actions
+    class TriggerBitriseWorkflowAction < Action
+      def self.run(params)
+        UI.verbose("Requesting new Bitrise.io build...")
+
+        response = Helper::BitriseRequestHelper.post(params, 'builds', {
+          hook_info: {
+            type: "bitrise"
+          },
+          build_params: {
+            workflow_id: params[:workflow],
+            commit_hash: params[:commit_hash],
+            commit_message: params[:build_message]
+          }
+        }.to_json)
+
+        if response.code == "201"
+          json_response = JSON.parse(response.body)
+          UI.success("Build triggered successfully 🚀 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}")
+        end
+
+        build_infos = {}
+        build_infos["status"] = json_response["status"]
+        build_infos["build_url"] = json_response["build_url"]
+        build_infos["build_number"] = json_response["build_number"]
+        build_infos["build_slug"] = json_response["build_slug"]
+
+        if params[:wait_for_build]
+          build_status = wait_until_build_completion(params, build_infos["build_slug"])
+
+          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.")
+          end
+        end
+
+        build_infos
+      end
+
+      def self.wait_until_build_completion(params, build_slug)
+        build_status = {}
+        loop do
+          build_status = BitriseBuildStatusAction.get_status(params, build_slug)
+
+          break if build_status['status'] != 0
+
+          if build_status['is_on_hold']
+            UI.message("Build is still on hold. Sleeping...")
+          else
+            UI.message("Build is running with status '#{build_status['status_text']}'. Sleeping...")
+          end
+
+          sleep(30)
+        end
+        build_status
+      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
+        [
+          FastlaneCore::ConfigItem.new(key: :app_slug,
+                                  env_name: "BITRISE_APP_SLUG",
+                               description: "The app slug of the project on Bitrise",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :access_token,
+                                  env_name: "BITRISE_ACCESS_TOKEN",
+                               description: "The personal access token used to call Bitrise API",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :workflow,
+                                  env_name: "BITRISE_WORKFLOW",
+                               description: "The name of the workflow on Bitrise",
+                                  optional: false,
+                                      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,
+                                      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,
+                                      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)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class BitriseRequestHelper
+      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)
+        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)
+        end
+
+        private
+
+        def bitrise_client
+          uri = URI.parse("https://api.bitrise.io/")
+          https = Net::HTTP.new(uri.host, uri.port)
+          https.use_ssl = true
+          https
+        end
+
+        def bitrise_headers(access_token)
+          { 'Content-Type' => 'application/json', 'Authorization' => access_token }
+        end
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-bitrise_automation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mario Cecchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.150.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.150.3
+description: 
+email: mcecchi@thoughtworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- 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/trigger_bitrise_workflow_action.rb
+- lib/fastlane/plugin/bitrise_automation/helper/bitrise_automation_helper.rb
+- lib/fastlane/plugin/bitrise_automation/version.rb
+homepage: https://github.com/natura-cosmeticos/fastlane-plugin-bitrise-automation
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Trigger builds on Bitrise, check their status and download artifacts using
+  Fastlane
+test_files: []