fastlane-plugin-bitrise_bcsymbolmaps 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca1d83242d17b2462a1662e3a51fa79d8d5423066a5bacc968b3215b75100ec8
+  data.tar.gz: 80c87e4b63d79f320a90d93bcb0889c17e4c3a4e14c747427d0f33273265f792
+SHA512:
+  metadata.gz: 810030fdaeadff3af7ab511ffb1ce396957cfe940dd7e2a6b8a1fd5f8d14b27c40567c0388ea3e0d76eea6b03ff8e2ae949101ae26b524de6c5d5fb8a9d0a828
+  data.tar.gz: 4d759dbda10f270a6bc62cfb16c8de34f8e43749f24e392ce64f4c5247df42c013d9b0612109c082c8b892247013c15f19a2ca0976a5a8db92471faf638756cb

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Oleksandr Skrypnyk <olexandr.skrypnyk@me.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# bitrise_bcsymbolmaps plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-bitrise_bcsymbolmaps)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-bitrise_bcsymbolmaps`, add it to your project by running:
+
+```bash
+fastlane add_plugin bitrise_bcsymbolmaps
+```
+
+## About bitrise_bcsymbolmaps
+
+Download BCSymbolMaps from Bitrise before uploading them to a crash reporting tool.
+
+## 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`.
+
+In order to download bitcode symbol maps, provide a Personal Access Token from Bitrise as well as a app slug (last segment of the app URL).
+We're assuming that release builds are coming from `release/*` branches (thanks to [Gitflow](https://nvie.com/posts/a-successful-git-branching-model/)) and we only need successful builds (`status: "1"`).
+
+```ruby
+build = bitrise_download_bcsymbolmaps(
+  api_access_token: ENV["BITRISE_TOKEN"],
+  app_slug: ENV["BITRISE_APP_SLUG"],
+  branch: "release/#{version}",
+  status: "1"
+)
+```
+
+This will return an object with two attributes: `build_number` and `commit_hash`. Having this information is sufficient to [download dSYMs from AppStore Connect](fastlane/Fastfile#L23-L27) and [create a release on Bugsnag](fastlane/Fastfile#L29-L34).
+
+After all the operations are done, you might want to cleanup a work directory.
+
+```ruby
+bitrise_clean_bcsymbolmaps
+```
+
+## 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_bcsymbolmaps.rb

@@ -0,0 +1,13 @@
+require 'fastlane/plugin/bitrise_bcsymbolmaps/version'
+
+module Fastlane
+  module BitriseBcsymbolmaps
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+Fastlane::BitriseBcsymbolmaps.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/bitrise_bcsymbolmaps/actions/bitrise_clean_bcsymbolmaps.rb

@@ -0,0 +1,22 @@
+module Fastlane
+  module Actions
+    class BitriseCleanBcsymbolmapsAction < Action
+      def self.run(params)
+        FileUtils.rm_rf Dir.glob(File.join(Dir.pwd, "BCSymbolMaps*"))
+        FileUtils.rm_rf File.join(Dir.pwd, "fastlane", "BCSymbolmaps")
+      end
+
+      def self.description
+        "Cleans up downloaded artifacts."
+      end
+
+      def self.authors
+        ["Oleksandr Skrypnyk"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitrise_bcsymbolmaps/actions/bitrise_download_bcsymbolmaps.rb

@@ -0,0 +1,178 @@
+require 'fastlane/action'
+require 'json'
+require 'net/http'
+require 'uri'
+require 'zip'
+
+module Fastlane
+  module Actions
+    class BitriseDownloadBcsymbolmapsAction < Action
+      API_VERSION = "v0.1"
+
+      Build = Struct.new(:build_number, :commit_hash)
+
+      def self.run(params)
+        build_response = bitrise_get_latest_build(params[:api_access_token], params[:app_slug], params[:branch], params[:status])
+        return if build_response.code != "200"
+        build_slug = get_build_slug(build_response)
+        build_number = get_build_number(build_response).to_s
+        build_commit_hash = get_build_commit_hash(build_response)
+
+        artifacts_response = bitrise_get_artifacts(params[:api_access_token], params[:app_slug], build_slug)
+        return if artifacts_response.code != "200"
+        artifact_slug = get_artifact_slug(artifacts_response)
+
+        artifact_response = bitrise_get_artifact(params[:api_access_token], params[:app_slug], build_slug, artifact_slug)
+        return if artifact_response.code != "200"
+        artifact_link = get_artifact_link(artifact_response)
+
+        destination_path = File.join(Dir.pwd, "fastlane", "BCSymbolMaps")
+        prepare_destination_path(destination_path)
+        zip_path = download_file_with_prompt(artifact_link, build_number)
+        extract_zip(zip_path)
+
+        Build.new(build_number, build_commit_hash)
+      end
+
+      def self.description
+        "Downloads BCSymbolMaps from Bitrise before uploading them to a crash reporting tool."
+      end
+
+      def self.authors
+        ["Oleksandr Skrypnyk"]
+      end
+
+      def self.return_value
+        "Struct (build number, commit hash)"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_access_token,
+                                  env_name: "BITRISE_BCSYMBOLMAPS_API_TOKEN",
+                               description: "Bitrise Personal Access Token",
+                                  optional: false,
+                              verify_block: proc do |value|
+                                UI.user_error!("No token for bitrise_download_bcsymbolmaps action given, pass using `api_access_token: \"<YOUR TOKEN>\"`") unless value
+                              end),
+          FastlaneCore::ConfigItem.new(key: :app_slug,
+                                  env_name: "BITRISE_BCSYMBOLMAPS_APP_SLUG",
+                               description: "Bitrise App Slug",
+                                  optional: false,
+                              verify_block: proc do |value|
+                                UI.user_error!("No app slug for bitrise_download_bcsymbolmaps action given, pass using `app_slug: \"<APP SLUG>\"`") unless value
+                              end),
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                  env_name: "BITRISE_BCSYMBOLMAPS_BRANCH",
+                               description: "Git Branch",
+                                  optional: false,
+                              verify_block: proc do |value|
+                                UI.user_error!("No git branch for bitrise_download_bcsymbolmaps action given, pass using `branch: \"<BRANCH>\"`") unless value
+                              end),
+          FastlaneCore::ConfigItem.new(key: :status,
+                                  env_name: "BITRISE_BCSYMBOLMAPS_STATUS",
+                               description: "Build Status",
+                                  optional: true,
+                              verify_block: proc do |value|
+                                UI.user_error!("No status for bitrise_download_bcsymbolmaps action given, pass using `status: \"<STATUS>\"`") unless value
+                              end)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.perform_api_request(token, path)
+        uri = URI.parse("https://api.bitrise.io/#{API_VERSION}#{path}")
+        request = Net::HTTP::Get.new(uri)
+        request["Accept"] = "application/json"
+        request["Authorization"] = token
+        req_options = {use_ssl: uri.scheme == "https"}
+        Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+          http.request(request)
+        end
+      end
+
+      def self.bitrise_get_latest_build(token, app_slug, branch, status)
+        perform_api_request(token, "/apps/#{app_slug}/builds?branch=#{branch}&status=#{status}")
+      end
+
+      def self.get_latest_build(response)
+        json = JSON.parse(response.body)
+        json["data"].sort { |lhs, rhs| rhs["build_number"].to_i <=> lhs["build_number"].to_i }.first
+      end
+
+      def self.get_build_slug(response)
+        get_latest_build(response)["slug"]
+      end
+
+      def self.get_build_number(response)
+        get_latest_build(response)["build_number"]
+      end
+      
+      def self.get_build_commit_hash(response)
+        get_latest_build(response)["commit_hash"]
+      end
+
+      def self.bitrise_get_artifacts(token, app_slug, build_slug)
+        perform_api_request(token, "/apps/#{app_slug}/builds/#{build_slug}/artifacts")
+      end
+      
+      def self.get_artifact_slug(response)
+        json = JSON.parse(response.body)
+        json["data"].select { |artifact| artifact["artifact_type"] == "ios-ipa" }.first["slug"]
+      end
+
+      def self.bitrise_get_artifact(token, app_slug, build_slug, artifact_slug)
+        perform_api_request(token, "/apps/#{app_slug}/builds/#{build_slug}/artifacts/#{artifact_slug}")
+      end
+
+      def self.get_artifact_link(response)
+        json = JSON.parse(response.body)
+        json["data"]["expiring_download_url"]
+      end
+
+      def self.extract_zip(file)
+        Zip::File.open(file) do |zip_file|
+          zip_file.glob("BCSymbolMaps/*.bcsymbolmap").each do |f|
+            fpath = File.join(Dir.pwd, "fastlane", f.name)
+            zip_file.extract(f, fpath) unless File.exist?(fpath)
+          end
+        end
+      end
+
+      def self.download_file_with_prompt(url, build_number)
+        file_path = File.join(Dir.pwd, "BCSymbolMaps-#{build_number}.zip")
+
+        if File.exists?(file_path)
+          if UI.confirm("File at #{file_path} is already exists. Do you want to overwrite it?")
+            UI.verbose("Overwriting an already exisiting file at #{file_path}")
+            File.rm(file_path)
+            self.download_file(url, file_path)
+          else
+            UI.verbose("Skipping download")
+          end
+        else
+          UI.message("Downloading a BCSymbolMaps")
+          self.download_file(url, file_path)
+        end
+
+        file_path
+      end
+
+      def self.download_file(url, file_path)
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.scheme == "https")
+        res = http.get(uri.request_uri)
+        File.binwrite(file_path, res.body)
+      end
+
+      def self.prepare_destination_path(destination_path)
+        FileUtils.rm_r(destination_path) if Dir.exists?(destination_path)
+        FileUtils.mkdir_p(destination_path)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module BitriseBcsymbolmaps
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-bitrise_bcsymbolmaps
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Oleksandr Skrypnyk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-24 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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.148.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.148.0
+description:
+email: olexandr.skrypnyk@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/bitrise_bcsymbolmaps.rb
+- lib/fastlane/plugin/bitrise_bcsymbolmaps/actions/bitrise_clean_bcsymbolmaps.rb
+- lib/fastlane/plugin/bitrise_bcsymbolmaps/actions/bitrise_download_bcsymbolmaps.rb
+- lib/fastlane/plugin/bitrise_bcsymbolmaps/version.rb
+homepage: https://github.com/sxua/fastlane-plugin-bitrise_bcsymbolmaps
+licenses:
+- MIT
+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: Download BCSymbolMaps from Bitrise
+test_files: []