fastlane-plugin-bugsnag 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02c60ef7d341ce29ce5d18ec3f5c93362c7ed029e9d3d1ea7d088a71d82c5236
-  data.tar.gz: e03e1f3969e5b1c41b13ce7c0f92b3e3cd4f09bd684d861f3b5d48099d18455b
+  metadata.gz: ad582c6af1ea151c4ac204309b0d3fe48da1aa071eb9274b25ea8dc5ba993835
+  data.tar.gz: 5f9526a7383816b5e747fe8f8ba879a911e81a176f589057353158eba93d49c4
 SHA512:
-  metadata.gz: 76f80373a17c95b8887cc7cfbd1fbff3e58742c989bb83623277de768eb82ed1a9ef32ef613ab6194f2d719003f762fec780ed2ca56a7bae98cf23f531a3df3d
-  data.tar.gz: 2e339494643b6e71de5b8c70bcbef48e7d876930009aca03c6236ffbbe58d85f67999bd383cfed2b0330fca7c3d4ad5de80c34ca5c51bcc14b82781f6ffe2737
+  metadata.gz: 639170c3dd8dd10827bc50757fcb0aaf2074a864d547dc55943e4540dad4a6c00ed97265aeacc42d21e6d55ca84e234c6b69de763d3214156b0042ba0a8c55ab
+  data.tar.gz: bb33da203e7a26e0eb75efc929573140b1bf59236aaba4613263026579864acc61e7bbd485cc3cc12b951220e85390f7f2603003954761c2beec5327799bfb41

data/bugsnag-dsym-upload

@@ -15,6 +15,7 @@ function print_usage() {
     echo
     echo "-h, --help          Displays this message"
     echo "-v, --verbose       Print verbose logging output during execution"
+    echo "--api-key API_KEY   The API key of the project the dSYM should be applied to"
     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."
@@ -51,6 +52,7 @@ unset dsym_dir
 unset verbose
 unset silent
 unset project_root
+unset api_key
 
 while [[ $# -gt 0 ]]; do
     case $1 in
@@ -71,6 +73,10 @@ while [[ $# -gt 0 ]]; do
             upload_server=$2
             shift
             shift;;
+        --api-key)
+            api_key=$2
+            shift
+            shift;;
         --project-root)
             project_root=$2
             shift
@@ -131,12 +137,23 @@ for dsym in $dsym_dir/*.dSYM; do
         uuid=$(dwarfdump -u $file 2>/dev/null)
         if [[ $uuid == UUID* ]]; then
             log Uploading $uuid
+
+            # Attach the api key and project root parameters if they have been provided
+            args=""
             if [[ ! -z $project_root ]]; then
-                output=$(curl --silent --show-error $upload_server -F dsym=@\"$file\" -F projectRoot=$project_root)
-            else
-                output=$(curl --silent --show-error $upload_server -F dsym=@\"$file\")
+                args="-F projectRoot=$project_root "
             fi
-            if [ $? -eq 0 ]; then
+
+            if [[ ! -z $api_key ]]; then
+                args="$args-F apiKey=$api_key"
+            fi
+
+            # We need to shell out to perform the curl as there seems to be some indirect
+            # wrapping of this script which causes the command to fail if called directly.
+            curl_cmd="curl --silent --show-error $upload_server -F dsym=@\"$file\" $args"
+            output=$(sh -c "$curl_cmd")
+
+            if [ $? -eq 0 ] && [ "$output" != "invalid apiKey" ]; then
                 success_count=$((success_count+1))
             else
                 fail_count=$((fail_count+1))

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

@@ -6,9 +6,21 @@ module Fastlane
         File.join(File.dirname(__FILE__), '..', '..', '..', '..', '..', 'bugsnag-dsym-upload'))
 
       def self.run(params)
+        options = {}
+        options = options_from_info_plist(params[:config_file]) if params[:config_file]
+
+        if (params[:config_file] == default_info_plist_path || options[:apiKey].nil? || options[:apiKey].empty?)
+          # Load custom API key if config file has not been overridden or the API key couldn't be found in config files
+          options[:apiKey] = params[:api_key] unless params[:api_key].nil?
+        else
+          # Print which file is populating version and API key information since the value has been
+          # overridden
+          UI.message("Loading API key from #{params[:config_file]}")
+        end
+
         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], params[:project_root], params[:verbose])
+            args = upload_args(dsym_path, params[:symbol_maps_path], params[:upload_url], params[:project_root], options[:apiKey], params[:verbose])
             success = Kernel.system(UPLOAD_SCRIPT_PATH, *args)
             if success
               UI.success("Uploaded dSYMs in #{dsym_path}")
@@ -59,7 +71,23 @@ module Fastlane
             UI.user_error!("Symbol maps file needs to be a directory containing symbol map files")
           end
         end
+        validate_api_key = proc do |key|
+          return if key.nil?
+
+          unless !key[/\H/] and key.length == 32
+            UI.user_error!("API key should be a 32 character hexdeciaml string")
+          end
+        end
+
+        options = {}
+        options = options_from_info_plist(default_info_plist_path) if file_path = default_info_plist_path
         [
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "BUGSNAG_API_KEY",
+                                       description: "Bugsnag API Key",
+                                       optional: true,
+                                       default_value: options[:apiKey],
+                                       verify_block: validate_api_key),
           FastlaneCore::ConfigItem.new(key: :dsym_path,
                                        type: Array,
                                        env_name: "BUGSNAG_DSYM_PATH",
@@ -83,6 +111,10 @@ module Fastlane
                                        description: "Root path of the project",
                                        default_value: Dir::pwd,
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :config_file,
+                                       description: "Info.plist location",
+                                       optional: true,
+                                       default_value: options[:config_file]),
           FastlaneCore::ConfigItem.new(key: :verbose,
                                        env_name: "BUGSNAG_VERBOSE",
                                        description: "Print helpful debug info",
@@ -93,8 +125,21 @@ module Fastlane
 
       private
 
-      def self.upload_args dir, symbol_maps_dir, upload_url, project_root, verbose
+      def self.default_info_plist_path
+        Dir.glob("./{ios/,}*/Info.plist").reject {|path| path =~ /build|test/i }.first
+      end
+
+      def self.options_from_info_plist file_path
+        plist_getter = Fastlane::Actions::GetInfoPlistValueAction
+        {
+          apiKey: plist_getter.run(path: file_path, key: "BugsnagAPIKey"),
+          config_file: file_path,
+        }
+      end
+
+      def self.upload_args dir, symbol_maps_dir, upload_url, project_root, api_key, verbose
         args = [verbose ? "--verbose" : "--silent"]
+        args += ["--api-key", api_key] unless api_key.nil?
         args += ["--upload-server", upload_url] unless upload_url.nil?
         args += ["--symbol-maps", symbol_maps_dir] unless symbol_maps_dir.nil?
         args += ["--project-root", project_root] unless project_root.nil?
@@ -110,9 +155,10 @@ module Fastlane
       end
 
       def self.default_dsym_path
-        Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH] ||
-          Actions.lane_context[SharedValues::DSYM_PATHS] ||
-          Dir["./**/*.dSYM.zip"] + Dir["./**/*.dSYM"]
+        path = Dir["./**/*.dSYM.zip"] + Dir["./**/*.dSYM"]
+        dsym_paths = Actions.lane_context[SharedValues::DSYM_PATHS] if defined? SharedValues::DSYM_PATHS
+        dsyms_output_path = Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH] if defined? SharedValues::DSYM_OUTPUT_PATH
+        dsyms_output_path || dsym_paths || path
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Bugsnag
-    VERSION = "1.3.4"
+    VERSION = "1.4.0"
   end
 end

data/spec/bugsnag_upload_dsym_action_spec.rb

@@ -3,6 +3,11 @@ require 'spec_helper'
 Action = Fastlane::Actions::UploadSymbolsToBugsnagAction
 
 describe Action do
+  def load_default_opts
+    Action.available_options.map do |x|
+      [x.key, x.default_value]
+    end.to_h
+  end
 
   context "the packaged gem" do
     gem_name = "fastlane-plugin-bugsnag-#{Fastlane::Bugsnag::VERSION}"
@@ -22,57 +27,61 @@ describe Action do
   describe '#run' do
     it 'silences script output by default' do
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
-                                              "--silent", FIXTURE_PATH).and_return(true)
-      Action.run({dsym_path: FIXTURE_PATH})
+                                              "--silent", 
+                                              "--project-root", Dir::pwd,
+                                              FIXTURE_PATH).and_return(true)
+      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH}))
     end
 
     it 'prints verbose if verbose flag set' do
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
-                                              "--verbose", FIXTURE_PATH).and_return(true)
-      Action.run({dsym_path: FIXTURE_PATH, verbose: true})
+                                              "--verbose", 
+                                              "--project-root", Dir::pwd,
+                                              FIXTURE_PATH).and_return(true)
+      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, verbose: true}))
     end
 
     it 'UI.user_error when script fails' do
       expect(Fastlane::UI).to receive(:user_error!).with("Failed uploading #{FIXTURE_PATH}")
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
-        "--silent", FIXTURE_PATH).and_return(false)
-      Action.run({dsym_path: FIXTURE_PATH})
+        "--silent", "--project-root", Dir::pwd, FIXTURE_PATH).and_return(false)
+      Action.run(load_default_opts.merge({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'})
+      Action.run(load_default_opts.merge({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')})
+      Action.run(load_default_opts.merge({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).and_return(true)
-      Action.run({dsym_path: File.join(FIXTURE_PATH, 'dSYMs/app.dSYM')})
+                                              "--silent", "--project-root", Dir::pwd, directory).and_return(true)
+      Action.run(load_default_opts.merge({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).and_return(true)
-      Action.run({dsym_path: path})
+                                              "--silent", "--project-root", Dir::pwd, path).and_return(true)
+      Action.run(load_default_opts.merge({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).and_return(true)
+                                              "--silent", "--project-root", Dir::pwd, zip1).and_return(true)
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
-                                              "--silent", zip2).and_return(true)
-      Action.run({dsym_path: [zip1, zip2]})
+                                              "--silent", "--project-root", Dir::pwd, zip2).and_return(true)
+      Action.run(load_default_opts.merge({dsym_path: [zip1, zip2]}))
     end
 
     it 'uploads multiple .dSYM files multiple directories' do
@@ -82,10 +91,10 @@ describe Action do
       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]).and_return(true)
+                                              "--silent", "--project-root", Dir::pwd, directories[0]).and_return(true)
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
-                                              "--silent", directories[1]).and_return(true)
-      Action.run({dsym_path: [dsym1, dsym2, dsym3, dsym4]})
+                                              "--silent", "--project-root", Dir::pwd, directories[1]).and_return(true)
+      Action.run(load_default_opts.merge({dsym_path: [dsym1, dsym2, dsym3, dsym4]}))
     end
 
     it 'uploads multiple .dSYM files in a single directory' do
@@ -93,8 +102,8 @@ describe Action do
       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).and_return(true)
-      Action.run({dsym_path: [dsym1, dsym2]})
+                                              "--silent", "--project-root", Dir::pwd, directory).and_return(true)
+      Action.run(load_default_opts.merge({dsym_path: [dsym1, dsym2]}))
     end
 
     it 'accepts a project root argument' do
@@ -103,7 +112,49 @@ describe Action do
                                               "--silent",
                                               "--project-root", root_path,
                                               FIXTURE_PATH).and_return(true)
-      Action.run({dsym_path: FIXTURE_PATH, project_root: root_path})
+      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, project_root: root_path}))
+    end
+
+    it 'accepts an API key argument' do
+      api_key = "1234567890ABCDE"
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent",
+                                              "--api-key", api_key,
+                                              "--project-root", Dir::pwd,
+                                              FIXTURE_PATH).and_return(true)
+      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, api_key: api_key}))
+    end
+
+    it 'accepts an API key argument with no project root' do
+      api_key = "1234567890ABCDE"
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent",
+                                              "--api-key", api_key,
+                                              FIXTURE_PATH).and_return(true)
+      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, api_key: api_key, project_root: nil}))
+    end
+
+    it 'uses default API key argument from plist' do
+      root_path = "/test/test/test"
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent",
+                                              "--api-key", "other-key",
+                                              "--project-root", root_path,
+                                              FIXTURE_PATH).and_return(true)
+      Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
+        Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, project_root: root_path}))
+      end
+    end
+    
+    it 'allows config file to overwrite parameter' do
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent",
+                                              "--api-key", "project-key",
+                                              "--project-root", File.join(FIXTURE_PATH, 'ios_proj'),
+                                              FIXTURE_PATH).and_return(true)
+      Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
+        Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, api_key: "ignored:", config_file: File.join('Project', 'Info.plist')}))
+      end
     end
 
     context 'using a private server' do
@@ -111,9 +162,9 @@ describe Action do
         expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
                                                 "--silent",
                                                 "--upload-server", "http://myserver.example.com",
+                                                "--project-root", Dir::pwd,
                                                 FIXTURE_PATH).and_return(true)
-        Action.run({dsym_path: FIXTURE_PATH,
-                    upload_url: "http://myserver.example.com"})
+        Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, upload_url: "http://myserver.example.com"}))
       end
     end
 
@@ -123,8 +174,9 @@ describe Action do
         expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
                                                 "--silent",
                                                 "--symbol-maps", path,
+                                                "--project-root", Dir::pwd,
                                                 FIXTURE_PATH).and_return(true)
-        Action.run({dsym_path: FIXTURE_PATH, symbol_maps_path: path})
+        Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, symbol_maps_path: path}))
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-bugsnag
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Delisa Mason
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-17 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple