fastlane-plugin-bugsnag 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d3998cc286232a7f3d2ec963ed35420f020015e
+  data.tar.gz: 57a410de55d97ed5d19ea6ce08c36ddf7520b2d0
+SHA512:
+  metadata.gz: 4d43547635bd11fea2b6cfa290e6aff090f921d920fa831e94f7db8f6d0a2014e8c1c39a1021a0f01e24040179a3ba2482a895c3cd8100d81ef4c30db1951730
+  data.tar.gz: cf8084b78c671410580d4a42f5ff5e35c91e658c51cd0edc9dd0df092bd9810871d279a7cbccc6a9da7a9cb320c5083da8309ddd77c1bb1c1cdfdaab679edae5

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Bugsnag, Inc.
+
+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/bugsnag-dsym-upload

@@ -0,0 +1,150 @@
+#!/usr/bin/env bash
+#
+#   Given a directory, uploads any *.dSYM bundles with the directory to
+#   Bugsnag. As a pre-upload step, bitcode symbol maps can be combined with
+#   dSYM files to ensure symbols are sent for bitcode-enabled binaries.
+#
+#   Depends on:
+#   * curl
+#   * dwarfdump
+#   * dsymutil (for --symbol-maps, optional)
+#   * unzip (for uploading a .zip file, optional)
+
+function print_usage() {
+    echo "Usage: $0 [--symbol-maps DIR] dSYMS_PATH"
+    echo
+    echo "-h, --help          Displays this message"
+    echo "-v, --verbose       Print verbose logging output during execution"
+    echo "--symbol-maps DIR   Path to a directory of bitcode symbol maps. The"
+    echo "                    dSYM files will be restored with symbols prior to"
+    echo "                    upload. Requires dsymutil."
+    echo "--upload-server URL The server receiving dSYM files. Set this value if"
+    echo "                    using an on-premise Bugsnag installation"
+    echo
+    echo "dSYMS_PATH          A directory or .zip file containing *.dSYM bundles to"
+    echo "                    upload"
+}
+
+function exit_with_usage() {
+    echo $1
+    echo
+    print_usage
+    exit 1
+}
+
+function log() {
+    if [[ $silent != 1 ]]; then
+        echo $@
+    fi
+}
+
+function log_verbose() {
+    if [[ $verbose == 1 ]]; then
+        log $@
+    fi
+}
+
+upload_server=https://upload.bugsnag.com
+unset symbol_maps
+unset dsym_dir
+unset verbose
+unset silent
+
+while [[ $# -gt 0 ]]; do
+    case $1 in
+        -h|--help)
+            print_usage
+            exit 0;;
+        -s|--silent)
+            silent=1
+            shift;;
+        -v|--verbose)
+            verbose=1
+            shift;;
+        --symbol-maps)
+            symbol_maps=$2
+            shift
+            shift;;
+        --upload-server)
+            upload_server=$2
+            shift
+            shift;;
+        -*)
+            exit_with_usage "Invalid parameter provided: $1";;
+        *)
+            dsym_dir=$1
+            break;;
+    esac
+done
+
+if [[ ! -z $symbol_maps ]]; then
+    if [[ ! -d $symbol_maps ]]; then
+        exit_with_usage "Bitcode symbol map parameter is not a directory"
+    elif [[ ! -x "$(command -v dsymutil 2>/dev/null)" ]]; then
+        exit_with_usage "dsymutil command not found."
+    fi
+fi
+if [[ -z $dsym_dir ]]; then
+    exit_with_usage "No dSYM directory provided"
+fi
+if [[ ! -d $dsym_dir ]]; then
+    if [[ $dsym_dir == *".zip" ]]; then
+        if [[ ! -x "$(command -v unzip 2>/dev/null)" ]]; then
+            exit_with_usage "unzip command not found."
+        fi
+        temp_dir=$(mktemp -dt "bugsnag-dsym-upload")
+        unzip -qq $dsym_dir -d $temp_dir
+        dsym_dir=$temp_dir
+    else
+        exit_with_usage "'$dsym_dir' is not a directory or a zip file"
+    fi
+fi
+
+# Set IFS to ensure that file paths with spaces in get processed correctly
+IFS=$'\n'
+
+log_verbose "Uploading files to $upload_server"
+success_count=0
+fail_count=0
+
+for dsym in $dsym_dir/*.dSYM; do
+    log_verbose "Preparing to upload $dsym"
+
+    if [[ -d $symbol_maps ]]; then
+        log_verbose "Updating file with bitcode symbol maps in $symbol_maps"
+        dsymutil "$dsym" --symbol-map "$symbol_maps"
+    fi
+
+    dwarf_data=$dsym/Contents/Resources/DWARF
+    if [[ ! -d $dwarf_data ]]; then
+        log_verbose "Skipping file missing DWARF data: $dsym"
+        fail_count=$((fail_count+1))
+        continue
+    fi
+    for file in $dwarf_data/*; do
+        uuid=$(dwarfdump -u $file 2>/dev/null)
+        if [[ $uuid == UUID* ]]; then
+            log Uploading $uuid
+            output=$(curl --silent --show-error $upload_server -F dsym=@\"$file\")
+            if [ $? -eq 0 ]; then
+                success_count=$((success_count+1))
+            else
+                fail_count=$((fail_count+1))
+                log_verbose "Failed to upload file: $file"
+            fi
+            echo $output | grep -v '^OK$'
+            log
+        else
+            log_verbose "Skipping file without UUID: $file"
+            fail_count=$((fail_count+1))
+        fi
+    done
+done
+
+if [ $success_count -gt 0 ]; then
+    log "$success_count files uploaded successfully"
+fi
+
+if [ $fail_count -gt 0 ]; then
+    log "$fail_count files failed to upload"
+fi

data/lib/fastlane/plugin/bugsnag.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/bugsnag/version'
+
+module Fastlane
+  module Bugsnag
+    # 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::Bugsnag.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/bugsnag/actions/upload_symbols_to_bugsnag.rb

@@ -0,0 +1,104 @@
+module Fastlane
+  module Actions
+    class UploadSymbolsToBugsnagAction < Action
+
+      UPLOAD_SCRIPT_PATH = File.expand_path(
+        File.join(File.dirname(__FILE__), '..', '..', '..', '..', '..', 'bugsnag-dsym-upload'))
+
+      def self.run(params)
+        parse_dsym_paths(params[:dsym_path]).each do |dsym_path|
+          if dsym_path.end_with?(".zip") or File.directory?(dsym_path)
+            args = upload_args(dsym_path, params[:symbol_maps_path], params[:upload_url])
+            success = Kernel.system(UPLOAD_SCRIPT_PATH, *args)
+            UI.success("Uploaded dSYMs in #{dsym_path}") if success
+          else
+            UI.user_error!("The specified symbol file path cannot be used: #{dsym_path}")
+          end
+        end
+      end
+
+      def self.description
+        "Uploads symbol files to Bugsnag"
+      end
+
+      def self.authors
+        ["kattrali"]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.details
+        "Takes debug symbol (dSYM) files from a macOS, iOS, or tvOS project and uploads them to Bugsnag to improve stacktrace quality"
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac, :tvos].include?(platform)
+      end
+
+      def self.available_options
+        validate_dsym_path = proc do |value|
+          value = [value] unless value.is_a? Array
+          value.each do |path|
+            unless File.exist?(path)
+              UI.user_error!("Could not find file at path '#{File.expand_path(path)}'")
+            end
+            unless File.directory?(path) or path.end_with?(".zip", ".dSYM")
+              UI.user_error!("Symbolication file needs to be a directory containing dSYMs, a .dSYM file or a .zip file, got #{File.expand_path(path)}")
+            end
+          end
+        end
+        validate_symbol_maps = proc do |path|
+          return if path.nil?
+
+          unless File.exist?(path) and File.directory?(path)
+            UI.user_error!("Symbol maps file needs to be a directory containing symbol map files")
+          end
+        end
+        [
+          FastlaneCore::ConfigItem.new(key: :dsym_path,
+                                       env_name: "BUGSNAG_DSYM_PATH",
+                                       description: "Path to the DSYM directory, file, or zip to upload",
+                                       default_value: default_dsym_path,
+                                       optional: true,
+                                       verify_block: validate_dsym_path),
+          FastlaneCore::ConfigItem.new(key: :upload_url,
+                                       env_name: "BUGSNAG_UPLOAD_URL",
+                                       description: "URL of the server receiving uploaded files",
+                                       default_value: nil,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :symbol_maps_path,
+                                       env_name: "BUGSNAG_SYMBOL_MAPS_PATH",
+                                       description: "Path to the BCSymbolMaps directory to build complete dSYM files",
+                                       default_value: nil,
+                                       optional: true,
+                                       verify_block: validate_symbol_maps)
+        ]
+      end
+
+      private
+
+      def self.upload_args dir, symbol_maps_dir, upload_url
+        args = ["--silent"]
+        args += ["--upload-server", upload_url] unless upload_url.nil?
+        args += ["--symbol-maps", symbol_maps_dir] unless symbol_maps_dir.nil?
+        args << dir
+        args
+      end
+
+      def self.parse_dsym_paths dsym_path
+        dsym_paths = dsym_path.is_a?(Array) ? dsym_path : [dsym_path]
+        dsym_paths.compact.map do |path|
+          path.end_with?(".dSYM") ? File.dirname(path) : path
+        end.uniq
+      end
+
+      def self.default_dsym_path
+        Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH] ||
+          Actions.lane_context[SharedValues::DSYM_PATHS] ||
+          Dir["./**/*.dSYM.zip"] + Dir["./**/*.dSYM"]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Bugsnag
+    VERSION = "1.1.0"
+  end
+end

data/spec/bugsnag_upload_dsym_action_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+Action = Fastlane::Actions::UploadSymbolsToBugsnagAction
+
+FIXTURE_PATH = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
+
+describe Action do
+
+  it 'has an executable upload script' do
+    expect(File.exist?(Action::UPLOAD_SCRIPT_PATH)).to be true
+  end
+
+  describe '#run' do
+    it 'silences script output by default' do
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent", FIXTURE_PATH)
+      Action.run({dsym_path: FIXTURE_PATH})
+    end
+
+    it 'requires the dSYM file path to exist' do
+      expect(Fastlane::UI).to receive(:user_error!)
+
+      Action.run({dsym_path: 'fake/file/path'})
+    end
+
+    it 'rejects dSYM files which are not a .zip or a directory' do
+      expect(Fastlane::UI).to receive(:user_error!)
+
+      Action.run({dsym_path: File.join(FIXTURE_PATH, 'invalid_file')})
+    end
+
+    it 'uploads a single .dSYM file' do
+      directory = File.join(FIXTURE_PATH, 'dSYMs')
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent", directory)
+      Action.run({dsym_path: File.join(FIXTURE_PATH, 'dSYMs/app.dSYM')})
+    end
+
+    it 'uploads a .zip of .dSYM files' do
+      path = File.join(FIXTURE_PATH, 'files.zip')
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent", path)
+      Action.run({dsym_path: path})
+    end
+
+    it 'uploads multiple .zip files' do
+      zip1 = File.join(FIXTURE_PATH, 'files.zip')
+      zip2 = File.join(FIXTURE_PATH, 'more_files.zip')
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent", zip1)
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent", zip2)
+      Action.run({dsym_path: [zip1, zip2]})
+    end
+
+    it 'uploads multiple .dSYM files multiple directories' do
+      dsym1 = File.join(FIXTURE_PATH, 'dSYMs/app.dSYM')
+      dsym2 = File.join(FIXTURE_PATH, 'stuff/app.dSYM')
+      dsym3 = File.join(FIXTURE_PATH, 'dSYMs/app2.dSYM')
+      dsym4 = File.join(FIXTURE_PATH, 'stuff/app2.dSYM')
+      directories = [File.join(FIXTURE_PATH, 'dSYMs'), File.join(FIXTURE_PATH, 'stuff')]
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent", directories[0])
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent", directories[1])
+      Action.run({dsym_path: [dsym1, dsym2, dsym3, dsym4]})
+    end
+
+    it 'uploads multiple .dSYM files in a single directory' do
+      dsym1 = File.join(FIXTURE_PATH, 'dSYMs/app.dSYM')
+      dsym2 = File.join(FIXTURE_PATH, 'dSYMs/app2.dSYM')
+      directory = File.join(FIXTURE_PATH, 'dSYMs')
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent", directory)
+      Action.run({dsym_path: [dsym1, dsym2]})
+    end
+
+    context 'using a private server' do
+      it 'uploads to the private server' do
+        expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                                "--silent",
+                                                "--upload-server", "http://myserver.example.com",
+                                                FIXTURE_PATH)
+        Action.run({dsym_path: FIXTURE_PATH,
+                    upload_url: "http://myserver.example.com"})
+      end
+    end
+
+    context 'using bitcode' do
+      it 'combines dSYM files with symbols' do
+        path = File.join(FIXTURE_PATH, 'BCSymbolMaps')
+        expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                                "--silent",
+                                                "--symbol-maps", path,
+                                                FIXTURE_PATH)
+        Action.run({dsym_path: FIXTURE_PATH, symbol_maps_path: path})
+      end
+    end
+  end
+end

data/spec/fixtures/BCSymbolMaps/real.bcsymbolmap

@@ -0,0 +1 @@
+yep, I am a symbol map!

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# This module is only used to check the environment is currently a testing env
+module SpecHelper
+end
+
+require 'fastlane' # to import the Action super class
+require 'fastlane/plugin/bugsnag' # import the actual plugin

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-bugsnag
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Delisa Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-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: 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'
+  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.28.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.28.5
+description: 
+email: iskanamagus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- bugsnag-dsym-upload
+- lib/fastlane/plugin/bugsnag.rb
+- lib/fastlane/plugin/bugsnag/actions/upload_symbols_to_bugsnag.rb
+- lib/fastlane/plugin/bugsnag/version.rb
+- spec/bugsnag_upload_dsym_action_spec.rb
+- spec/fixtures/BCSymbolMaps/real.bcsymbolmap
+- spec/fixtures/dSYMs/app.dSYM/Contents/Resources/DWARF/app
+- spec/fixtures/dSYMs/app2.dSYM/Contents/Resources/DWARF/app2
+- spec/fixtures/files.zip
+- spec/fixtures/invalid_file
+- spec/fixtures/more_files.zip
+- spec/fixtures/stuff/app.dSYM/Contents/Resources/DWARF/app
+- spec/fixtures/stuff/app2.dSYM/Contents/Resources/DWARF/app2
+- spec/spec_helper.rb
+homepage: https://github.com/bugsnag/bugsnag-upload
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Uploads dSYM files to Bugsnag
+test_files:
+- spec/bugsnag_upload_dsym_action_spec.rb
+- spec/fixtures/BCSymbolMaps/real.bcsymbolmap
+- spec/fixtures/dSYMs/app.dSYM/Contents/Resources/DWARF/app
+- spec/fixtures/dSYMs/app2.dSYM/Contents/Resources/DWARF/app2
+- spec/fixtures/files.zip
+- spec/fixtures/invalid_file
+- spec/fixtures/more_files.zip
+- spec/fixtures/stuff/app.dSYM/Contents/Resources/DWARF/app
+- spec/fixtures/stuff/app2.dSYM/Contents/Resources/DWARF/app2
+- spec/spec_helper.rb