fastlane-plugin-bugsnag 1.4.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e181711b183200492623830bb7769c7d7939ec4c5c712ba7f0c40893f55e5e87
-  data.tar.gz: b1f4993b0a3dc8e3bc8ad57e1f28c05fc88ebe760405c7322641aa92cb940335
+  metadata.gz: 0f2f91641496dae26549b47215b4cf137e6c03d7307f38b491903a8505cb26c1
+  data.tar.gz: eca880b9cd9aa3afaca45892e01ba63130fb29d069a40eb2f2a8fef98c5dee51
 SHA512:
-  metadata.gz: d4cbb540fcaa9e5ff405e792416208bc520c7c99bca291f781e354fdf4f8bfacc4360cf2eba1f6f32a5eec4f1749fd5120e14907b505ec13d88d95716d2c7a6f
-  data.tar.gz: 0bcc646b32248169a424b581cd5e85ba2da983f3d66ac372496eea90fcf34b0014704809f4e782a6fa7d0df65b9c04de560a296acb2993ee444bfb3956af4337
+  metadata.gz: 56875d0eb5b5d644030466ab85c80817524d953c3286593fdbc7c2d9db4e81d919f90d6875a40d6d4adce8d81846db0b85069fbf07cc470d927bc6530f4b2836
+  data.tar.gz: 456b9b1d0ece3dcedd9302654ac25be698b075a44bb108c6c11257f6b8c4d23ebd4e6c641bccf41d40aaabf2d83c074a13d92ceca9647dfffbfb0e7c488f496b

data/bugsnag-dsym-upload

@@ -150,7 +150,7 @@ for dsym in $dsym_dir/*.dSYM; do
 
             # 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 --http1.1 $upload_server -F dsym=@\"$file\" $args"
+            curl_cmd="curl --fail --silent --show-error --http1.1 $upload_server -F dsym=@\"$file\" $args"
             output=$(sh -c "$curl_cmd")
 
             if [ $? -eq 0 ] && [ "$output" != "invalid apiKey" ]; then

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

@@ -9,32 +9,31 @@ module Fastlane
 
       def self.run(params)
         payload = {buildTool: BUILD_TOOL, sourceControl: {}}
-        if lane_context[:PLATFORM_NAME] == :android
-          payload.merge!(options_from_android_manifest(params[:config_file])) if params[:config_file]
-        else
-          payload.merge!(options_from_info_plist(params[:config_file])) if params[:config_file]
-        end
 
-        default_plist = default_info_plist_path
-        default_manifest = default_android_manifest_path
-        if (lane_context[:PLATFORM_NAME] == :android and params[:config_file] == default_manifest) or
-           (lane_context[:PLATFORM_NAME] != :android and params[:config_file] == default_plist)
-          # Load custom API key and version properties only if config file has not been overridden
-          payload[:apiKey] = params[:api_key] unless params[:api_key].nil?
-          payload[:appVersion] = params[:app_version] unless params[:app_version].nil?
-          payload[:appVersionCode] = params[:android_version_code] unless params[:android_version_code].nil?
-          payload[:appBundleVersion] = params[:ios_bundle_version] unless params[:ios_bundle_version].nil?
+        # If a configuration file was found or was specified, load in the options:
+        if params[:config_file]
+          UI.message("Loading build information from #{params[:config_file]}")
+          config_options = load_config_file_options(params[:config_file])
+
+          # for each of the config options, if it's not been overriden by any
+          # input to the lane, write it to the payload:
+          payload[:apiKey] = params[:api_key] || config_options[:apiKey]
+          payload[:appVersion] = params[:app_version] || config_options[:appVersion]
+          payload[:appVersionCode] = params[:android_version_code] || config_options[:appVersionCode]
+          payload[:appBundleVersion] = params[:ios_bundle_version] || config_options[:appBundleVersion]
+          payload[:releaseStage] = params[:release_stage] || config_options[:releaseStage] || "production"
         else
-          # Print which file is populating version and API key information since the value has been
-          # overridden
-          UI.message("Loading API key and app version info from #{params[:config_file]}")
+          # No configuration file was found or specified, use the input parameters:
+          payload[:apiKey] = params[:api_key]
+          payload[:appVersion] = params[:app_version]
+          payload[:appVersionCode] = params[:android_version_code]
+          payload[:appBundleVersion] = params[:ios_bundle_version]
+          payload[:releaseStage] = params[:release_stage] || "production"
         end
-        payload.delete(:config_file)
-
-        # Overwrite automated options with configured if set
-        payload[:releaseStage] = params[:release_stage] unless params[:release_stage].nil?
-        payload[:builderName] = params[:builder]
 
+        # If builder, or source control information has been provided into
+        # Fastlane, apply it to the payload here.
+        payload[:builderName] = params[:builder] if params[:builder]
         payload[:sourceControl][:revision] = params[:revision] if params[:revision]
         payload[:sourceControl][:repository] = params[:repository] if params[:repository]
         payload[:sourceControl][:provider] = params[:provider] if params[:provider]
@@ -47,6 +46,13 @@ module Fastlane
         if payload[:appVersion].nil?
           UI.user_error! missing_app_version_message(params)
         end
+
+        # If verbose flag is enabled (`--verbose`), display the payload debug info
+        UI.verbose("Sending build to Bugsnag with payload:")
+        payload.each do |param|
+          UI.verbose("  #{param[0].to_s.rjust(18)}: #{param[1]}")
+        end
+
         send_notification(params[:endpoint], ::JSON.dump(payload))
       end
 
@@ -60,16 +66,16 @@ module Fastlane
           end
         else
           if params[:config_file]
-            message << "Set BugsnagAPIKey in your Info.plist file to detect API key automatically."
+            message << "Set bugsnag.apiKey in your Info.plist file to detect API key automatically."
           else
-            message << "Set the config_file option with the path to your Info.plist and set BugsnagAPIKey in it to detect API key automatically."
+            message << "Set the config_file option with the path to your Info.plist and set bugsnag.apiKey in it to detect API key automatically."
           end
         end
         message
       end
 
       def self.missing_app_version_message(params)
-        message = "An app version must be specified release a build."
+        message = "An app version must be specified release a build. "
         if lane_context[:PLATFORM_NAME] == :android
           if params[:config_file]
             message << "Set com.bugsnag.android.APP_VERSION in your AndroidManifest.xml to detect this value automatically."
@@ -115,32 +121,27 @@ module Fastlane
       end
 
       def self.available_options
-        options = load_default_values
+        git_options = load_git_remote_options
         [
           FastlaneCore::ConfigItem.new(key: :config_file,
                                        description: "AndroidManifest.xml/Info.plist location",
                                        optional: true,
-                                       default_value: options[:config_file]),
+                                       default_value: default_config_file_path),
           FastlaneCore::ConfigItem.new(key: :api_key,
                                        description: "Bugsnag API Key",
-                                       optional: true,
-                                       default_value: options[:apiKey]),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :app_version,
                                        description: "App version being built",
-                                       optional: true,
-                                       default_value: options[:appVersion]),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :android_version_code,
                                        description: "Android app version code",
-                                       optional: true,
-                                       default_value: options[:appVersionCode]),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :ios_bundle_version,
                                        description: "iOS/macOS/tvOS bundle version",
-                                       optional: true,
-                                       default_value: options[:appBundleVersion]),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :release_stage,
                                        description: "Release stage being built, i.e. staging, production",
-                                       optional: true,
-                                       default_value: options[:releaseStage] || "production"),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :builder,
                                        description: "The name of the entity triggering the build",
                                        optional: true,
@@ -148,19 +149,19 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :repository,
                                        description: "The source control repository URL for this application",
                                        optional: true,
-                                       default_value: options[:repository]),
+                                       default_value: git_options[:repository]),
           FastlaneCore::ConfigItem.new(key: :revision,
                                        description: "The source control revision id",
                                        optional: true,
-                                       default_value: options[:revision]),
+                                       default_value: git_options[:revision]),
           FastlaneCore::ConfigItem.new(key: :provider,
                                        description: "The source control provider, one of 'github-enterprise', 'gitlab-onpremise', or 'bitbucket-server', if any",
                                        optional: true,
                                        default_value: nil,
                                        verify_block: proc do |value|
-                                         valid = ['github-enterprise', 'gitlab-onpremise', 'bitbucket-server'].include? value
+                                         valid = ['github', 'github-enterprise', 'gitlab', 'gitlab-onpremise', 'bitbucket', 'bitbucket-server'].include? value
                                          unless valid
-                                           UI.user_error!("Provider must be one of 'github-enterprise', 'gitlab-onpremise', 'bitbucket-server', or unspecified")
+                                           UI.user_error!("Provider must be one of 'github', 'github-enterprise', 'gitlab', 'gitlab-onpremise', 'bitbucket', 'bitbucket-server', or unspecified")
                                          end
                                        end),
           FastlaneCore::ConfigItem.new(key: :endpoint,
@@ -172,69 +173,98 @@ module Fastlane
 
       private
 
-      def self.load_default_values
-        options = {releaseStage: "production", user: `whoami`.chomp}
+      # Get any Git options (remote repo, and revision) from the directory
+      def self.load_git_remote_options
+        git_options = {repository:nil, revision:nil}
+        require "git"
+        begin
+          repo = Git.open(Dir.pwd)
+          origin = repo.remotes.detect {|r| r.name == "origin"}
+          origin = repo.remotes.first unless origin
+          if origin
+            git_options[:repository] = origin.url
+            git_options[:revision] = repo.revparse("HEAD")
+          end
+        rescue
+        end
+        return git_options
+      end
+
+      # Used to get a default configuration file (AndroidManifest.xml or Info.plist)
+      def self.default_config_file_path
         case lane_context[:PLATFORM_NAME]
         when nil
           if file_path = default_android_manifest_path
-            options.merge!(load_default_android_values(file_path))
+            return file_path
           elsif file_path = default_info_plist_path
-            options.merge!(options_from_info_plist(file_path))
+            return file_path
           end
         when :android
           if file_path = default_android_manifest_path
-            options.merge!(load_default_android_values(file_path))
+            return file_path
           end
         else
           if file_path = default_info_plist_path
-            options.merge!(options_from_info_plist(file_path))
+            return file_path
           end
         end
+      end
 
-        if git_opts = git_remote_options
-          options.merge!(git_opts)
+      def self.load_config_file_options config_file
+        options = {}
+        case File.extname(config_file)
+        when ".xml"
+          options = load_options_from_xml(config_file)
+          return options
+        when ".plist"
+          options = load_options_from_plist(config_file)
+          return options
+        else
+          UI.user_error("File type of '#{config_file}' was not recognised. This should be .xml for Android and .plist for Cococa")
         end
-        options
       end
 
-      def self.load_default_android_values file_path
-        options = options_from_android_manifest(file_path)
-        build_gradle_path = Dir.glob("{android/,}app/build.gradle").first
-        build_gradle_path ||= Dir.glob("build.gradle").first
-        options.merge!(options_from_build_gradle(build_gradle_path)) if build_gradle_path
-        options
+      def self.default_info_plist_path
+        Dir.glob("./{ios/,}*/Info.plist").reject {|path| path =~ /build|test/i }.first
       end
 
-      def self.default_android_manifest_path
-        Dir.glob("./{android/,}{app,}/src/main/AndroidManifest.xml").first
+      def self.load_options_from_plist file_path
+        options = {}
+        plist_getter = Fastlane::Actions::GetInfoPlistValueAction
+        bugsnag_dict = plist_getter.run(path: file_path, key: "bugsnag")
+        api_key = bugsnag_dict["apiKey"] unless bugsnag_dict.nil?
+        release_stage = bugsnag_dict["releaseStage"] unless bugsnag_dict.nil?
+        if api_key.nil?
+          api_key = plist_getter.run(path: file_path, key: "BugsnagAPIKey")
+        end
+        options[:apiKey] = api_key
+        options[:releaseStage] = release_stage
+        options[:appVersion] = plist_getter.run(path: file_path, key: "CFBundleShortVersionString")
+        options[:appBundleVersion] = plist_getter.run(path: file_path, key: "CFBundleVersion")
+        return options
       end
 
-      def self.default_info_plist_path
-        Dir.glob("./{ios/,}*/Info.plist").reject {|path| path =~ /build|test/i }.first
+      def self.default_android_manifest_path
+        Dir.glob("./{android/,}{app,}/src/main/AndroidManifest.xml").first
       end
 
-      def self.options_from_info_plist file_path
-        plist_getter = Fastlane::Actions::GetInfoPlistValueAction
-        {
-          apiKey: plist_getter.run(path: file_path, key: "BugsnagAPIKey"),
-          appVersion: plist_getter.run(path: file_path, key: "CFBundleShortVersionString"),
-          appBundleVersion: plist_getter.run(path: file_path, key: "CFBundleVersion"),
-          config_file: file_path,
-        }
+      def self.load_options_from_xml file_path
+        options = options_from_android_manifest(file_path)
+        build_gradle_path = Dir.glob("{android/,}app/build.gradle").first || Dir.glob("build.gradle").first
+        options.merge!(options_from_build_gradle(build_gradle_path)) if build_gradle_path
+        return options
       end
 
       def self.options_from_android_manifest file_path
         options = {}
         begin
           meta_data = parse_android_manifest_options(XmlSimple.xml_in(file_path))
-
           options[:apiKey] = meta_data["com.bugsnag.android.API_KEY"]
           options[:appVersion] = meta_data["com.bugsnag.android.APP_VERSION"]
           options[:releaseStage] = meta_data["com.bugsnag.android.RELEASE_STAGE"]
         rescue ArgumentError
           nil
         end
-        options[:config_file] = file_path
         options
       end
 
@@ -253,23 +283,6 @@ module Fastlane
         options
       end
 
-      def self.git_remote_options
-        require "git"
-        begin
-          repo = Git.open(Dir.pwd)
-          origin = repo.remotes.detect {|r| r.name == "origin"}
-          origin = repo.remotes.first unless origin
-          if origin
-            return {
-              repository: origin.url,
-              revision: repo.revparse("HEAD"),
-            }
-          end
-        rescue
-        end
-        nil
-      end
-
       def self.parse_android_manifest_options config_hash
         map_meta_data(get_meta_data(config_hash))
       end

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

@@ -6,21 +6,24 @@ 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]}")
+        # If we have not explicitly set an API key through env, or parameter
+        # input in Fastfile, find an API key in the Info.plist in config_file param
+        api_key = params[:api_key]
+        if params[:config_file] && params[:api_key] == nil
+          UI.message("Using the API Key from #{params[:config_file]}")
+          api_key = options_from_info_plist(params[:config_file])[:apiKey]
+        end
+
+        # If verbose flag is enabled (`--verbose`), display the plugin action debug info
+        # Store the verbose flag for use in the upload arguments.
+        verbose = UI.verbose("Uploading dSYMs to Bugsnag with the following parameters:")
+        params.values.each do |param|
+          UI.verbose("  #{param[0].to_s.rjust(18)}: #{param[1]}")
         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], options[:apiKey], params[:verbose])
+            args = upload_args(dsym_path, params[:symbol_maps_path], params[:upload_url], params[:project_root], api_key, verbose)
             success = Kernel.system(UPLOAD_SCRIPT_PATH, *args)
             if success
               UI.success("Uploaded dSYMs in #{dsym_path}")
@@ -34,7 +37,7 @@ module Fastlane
       end
 
       def self.description
-        "Uploads symbol files to Bugsnag"
+        "Uploads dSYM debug symbol files to Bugsnag"
       end
 
       def self.authors
@@ -66,27 +69,25 @@ module Fastlane
         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
         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 hexadecimal string")
           end
         end
 
-        options = {}
-        options = options_from_info_plist(default_info_plist_path) if file_path = default_info_plist_path
+        # If the Info.plist is in a default location, we'll get API key here
+        # This will be overwritten if you pass in an API key parameter in your
+        # Fastfile, or have an API key environment variable set.
         [
           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,
@@ -112,27 +113,32 @@ module Fastlane
                                        default_value: Dir::pwd,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :config_file,
+                                       env_name: "BUGSNAG_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",
-                                       skip_type_validation: true,
-                                       optional: true),
+                                       default_value: default_info_plist_path)
         ]
       end
 
       private
 
       def self.default_info_plist_path
-        Dir.glob("./{ios/,}*/Info.plist").reject {|path| path =~ /build|test/i }.first
+        # Find first 'Info.plist' in the current working directory
+        # ignoring any in 'build', or 'test' folders
+        return 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
+        bugsnag_dict = plist_getter.run(path: file_path, key: "bugsnag")
+        api_key = bugsnag_dict["apiKey"] unless bugsnag_dict.nil?
+        # From v6.0.0 of bugsnag-cocoa, the API key is in 'bugsnag.apiKey',
+        # use 'BugsnagAPIKey' as a fallback if it exists (<v6.x.x)
+        if api_key.nil?
+          api_key = plist_getter.run(path: file_path, key: "BugsnagAPIKey")
+        end
         {
-          apiKey: plist_getter.run(path: file_path, key: "BugsnagAPIKey"),
+          apiKey: api_key,
           config_file: file_path,
         }
       end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Bugsnag
-    VERSION = "1.4.2"
+    VERSION = "2.0.0"
   end
 end

data/spec/bugsnag_upload_dsym_action_spec.rb

@@ -3,10 +3,8 @@ 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
+  def run_with args
+    Action.run(Fastlane::ConfigurationHelper.parse(Action, args))
   end
 
   context "the packaged gem" do
@@ -27,51 +25,43 @@ describe Action do
   describe '#run' do
     it 'silences script output by default' do
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_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", 
+                                              "--silent",
                                               "--project-root", Dir::pwd,
                                               FIXTURE_PATH).and_return(true)
-      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, verbose: true}))
+      run_with({dsym_path: FIXTURE_PATH})
     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", "--project-root", Dir::pwd, FIXTURE_PATH).and_return(false)
-      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH}))
+                                              "--silent",
+                                              "--project-root", Dir::pwd,
+                                              FIXTURE_PATH).and_return(false)
+      run_with({dsym_path: FIXTURE_PATH})
     end
 
     it 'requires the dSYM file path to exist' do
-      expect(Fastlane::UI).to receive(:user_error!)
-
-      Action.run(load_default_opts.merge({dsym_path: 'fake/file/path'}))
+      expect(Fastlane::UI).to receive(:user_error!).at_least(:once)
+      run_with({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(load_default_opts.merge({dsym_path: File.join(FIXTURE_PATH, 'invalid_file')}))
+      expect(Fastlane::UI).to receive(:user_error!).at_least(:once)
+      run_with({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", "--project-root", Dir::pwd, directory).and_return(true)
-      Action.run(load_default_opts.merge({dsym_path: File.join(FIXTURE_PATH, 'dSYMs/app.dSYM')}))
+      run_with({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", "--project-root", Dir::pwd, path).and_return(true)
-      Action.run(load_default_opts.merge({dsym_path: path}))
+      run_with({dsym_path: path})
     end
 
     it 'uploads multiple .zip files' do
@@ -81,7 +71,7 @@ describe Action do
                                               "--silent", "--project-root", Dir::pwd, zip1).and_return(true)
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
                                               "--silent", "--project-root", Dir::pwd, zip2).and_return(true)
-      Action.run(load_default_opts.merge({dsym_path: [zip1, zip2]}))
+      run_with({dsym_path: [zip1, zip2]})
     end
 
     it 'uploads multiple .dSYM files multiple directories' do
@@ -94,7 +84,7 @@ describe Action do
                                               "--silent", "--project-root", Dir::pwd, directories[0]).and_return(true)
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
                                               "--silent", "--project-root", Dir::pwd, directories[1]).and_return(true)
-      Action.run(load_default_opts.merge({dsym_path: [dsym1, dsym2, dsym3, dsym4]}))
+      run_with({dsym_path: [dsym1, dsym2, dsym3, dsym4]})
     end
 
     it 'uploads multiple .dSYM files in a single directory' do
@@ -103,7 +93,7 @@ describe Action do
       directory = File.join(FIXTURE_PATH, 'dSYMs')
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
                                               "--silent", "--project-root", Dir::pwd, directory).and_return(true)
-      Action.run(load_default_opts.merge({dsym_path: [dsym1, dsym2]}))
+      run_with({dsym_path: [dsym1, dsym2]})
     end
 
     it 'accepts a project root argument' do
@@ -112,48 +102,75 @@ describe Action do
                                               "--silent",
                                               "--project-root", root_path,
                                               FIXTURE_PATH).and_return(true)
-      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, project_root: root_path}))
+      run_with({dsym_path: FIXTURE_PATH, project_root: root_path})
     end
 
     it 'accepts an API key argument' do
-      api_key = "1234567890ABCDE"
+      api_key = "123456789123456789001234567890FF"
       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}))
+      run_with({dsym_path: FIXTURE_PATH, api_key: api_key})
     end
 
     it 'accepts an API key argument with no project root' do
-      api_key = "1234567890ABCDE"
+      api_key = "123456789012345678901234567890FF"
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
                                               "--silent",
                                               "--api-key", api_key,
+                                              "--project-root", `pwd`.chomp,
                                               FIXTURE_PATH).and_return(true)
-      Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, api_key: api_key, project_root: nil}))
+      run_with({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"
+      api_key = "12345678901234567890123456789AAA" # Uses the API Key from ./spec/fixtures/ios_proj/FirstRealFolder/Info.plist
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
                                               "--silent",
-                                              "--api-key", "other-key",
+                                              "--api-key", api_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}))
+        run_with({dsym_path: FIXTURE_PATH, project_root: root_path})
       end
     end
-    
-    it 'allows config file to overwrite parameter' do
+
+    it 'uses legacy API key argument from plist' do
+      root_path = "/test/test/test"
+      api_key = "12345678901234567890123456789BBB" # Uses the API Key from ./spec/fixtures/ios_proj_legacy/Project/Info.plist
       expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
                                               "--silent",
-                                              "--api-key", "project-key",
+                                              "--api-key", api_key,
+                                              "--project-root", root_path,
+                                              FIXTURE_PATH).and_return(true)
+      Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj_legacy')) do
+        run_with({dsym_path: FIXTURE_PATH, project_root: root_path})
+      end
+    end
+
+    it 'allows option input to overwrite the config file api key' do
+      # The order of precedence is 1. option input, 2. env variable, 3. default or config file input (for api key only)
+      # The API key in ./spec/fixtures/ios_proj_legacy/Project/Info.plist is 12345678912345678900123456789AAA.
+      api_key = "12345678912345678900123456789CCC"
+      expect(Kernel).to receive(:system).with(Action::UPLOAD_SCRIPT_PATH,
+                                              "--silent",
+                                              "--api-key", api_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')}))
+        run_with({dsym_path: FIXTURE_PATH, api_key: api_key, config_file: File.join('Project', 'Info.plist')})
+      end
+    end
+
+    it 'reject an invalid API key' do
+      api_key = "this-is-not-a-hex-key"
+      expect(Fastlane::UI).to receive(:user_error!).with("API key should be a 32 character hexadecimal string")
+      expect(Fastlane::UI).to receive(:user_error!).with("Failed uploading #{FIXTURE_PATH}")
+      Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
+        run_with({dsym_path: FIXTURE_PATH, api_key: api_key, config_file: File.join('Project', 'Info.plist')})
       end
     end
 
@@ -164,7 +181,7 @@ describe Action do
                                                 "--upload-server", "http://myserver.example.com",
                                                 "--project-root", Dir::pwd,
                                                 FIXTURE_PATH).and_return(true)
-        Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, upload_url: "http://myserver.example.com"}))
+        run_with({dsym_path: FIXTURE_PATH, upload_url: "http://myserver.example.com"})
       end
     end
 
@@ -176,7 +193,7 @@ describe Action do
                                                 "--symbol-maps", path,
                                                 "--project-root", Dir::pwd,
                                                 FIXTURE_PATH).and_return(true)
-        Action.run(load_default_opts.merge({dsym_path: FIXTURE_PATH, symbol_maps_path: path}))
+        run_with({dsym_path: FIXTURE_PATH, symbol_maps_path: path})
       end
     end
   end

data/spec/fixtures/ios_proj/FirstRealFolder/Info.plist

@@ -2,8 +2,11 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-    <key>BugsnagAPIKey</key>
-    <string>other-key</string>
+	<key>bugsnag</key>
+	<dict>
+		<key>apiKey</key>
+		<string>12345678901234567890123456789AAA</string>
+	</dict>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>$(DEVELOPMENT_LANGUAGE)</string>
 	<key>CFBundleExecutable</key>
@@ -17,9 +20,9 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>3.0-other</string>
+	<string>2.0-other</string>
 	<key>CFBundleVersion</key>
-	<string>56</string>
+	<string>22</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
 	<key>UILaunchStoryboardName</key>
@@ -45,5 +48,3 @@
 	</array>
 </dict>
 </plist>
-
-

data/spec/fixtures/ios_proj/Project/Info.plist

@@ -2,8 +2,11 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-    <key>BugsnagAPIKey</key>
-    <string>project-key</string>
+	<key>bugsnag</key>
+	<dict>
+		<key>apiKey</key>
+		<string>12345678901234567890123456789DDD</string>
+	</dict>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>$(DEVELOPMENT_LANGUAGE)</string>
 	<key>CFBundleExecutable</key>
@@ -17,9 +20,9 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.0-project</string>
+	<string>3.0-project</string>
 	<key>CFBundleVersion</key>
-	<string>6</string>
+	<string>33</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
 	<key>UILaunchStoryboardName</key>
@@ -45,4 +48,3 @@
 	</array>
 </dict>
 </plist>
-

data/spec/fixtures/ios_proj/aaTests/Info.plist

@@ -2,8 +2,11 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-    <key>BugsnagAPIKey</key>
-    <string>test-key</string>
+	<key>bugsnag</key>
+	<dict>
+		<key>apiKey</key>
+		<string>12345678901234567890123456789EEE</string>
+	</dict>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>$(DEVELOPMENT_LANGUAGE)</string>
 	<key>CFBundleExecutable</key>
@@ -45,4 +48,3 @@
 	</array>
 </dict>
 </plist>
-

data/spec/fixtures/ios_proj_legacy/Project/Info.plist

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>BugsnagAPIKey</key>
+    <string>12345678901234567890123456789BBB</string>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>4.0-project</string>
+	<key>CFBundleVersion</key>
+	<string>44</string>
+	<key>LSRequiresIPhoneOS</key>
+	<true/>
+	<key>UILaunchStoryboardName</key>
+	<string>LaunchScreen</string>
+	<key>UIMainStoryboardFile</key>
+	<string>Main</string>
+	<key>UIRequiredDeviceCapabilities</key>
+	<array>
+		<string>armv7</string>
+	</array>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>UISupportedInterfaceOrientations~ipad</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationPortraitUpsideDown</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+</dict>
+</plist>

data/spec/send_build_to_bugsnag_spec.rb

@@ -5,53 +5,66 @@ require 'fastlane/actions/get_info_plist_value'
 BuildAction = Fastlane::Actions::SendBuildToBugsnagAction
 
 describe BuildAction do
-  def load_default_opts
-    BuildAction.available_options.map do |x|
-      [x.key, x.default_value]
-    end.to_h
+  def run_with args
+    BuildAction.run(Fastlane::ConfigurationHelper.parse(BuildAction, args))
   end
 
   context 'building an iOS project' do
     it 'detects default Info.plist file excluding test dirs' do
       expect(BuildAction).to receive(:send_notification) do |url, body|
         payload = ::JSON.load(body)
-        expect(payload['appVersion']).to eq '3.0-other'
-        expect(payload['appBundleVersion']).to eq '56'
-        expect(payload['apiKey']).to eq 'other-key'
+        expect(payload['appVersion']).to eq '2.0-other'
+        expect(payload['appBundleVersion']).to eq '22'
+        expect(payload['apiKey']).to eq '12345678901234567890123456789AAA'
       end
 
       Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
-        BuildAction.run(load_default_opts)
+        run_with({})
+      end
+    end
+
+    it 'reads api key from legacy location' do
+      # the API key is now in `bugsnag.apiKey`, it used to be in 'BugsnagAPIKey',
+      # test this can be extracted correctly from the `ios_proj_legacy`
+      expect(BuildAction).to receive(:send_notification) do |url, body|
+        payload = ::JSON.load(body)
+        expect(payload['appVersion']).to eq '4.0-project'
+        expect(payload['appBundleVersion']).to eq '44'
+        expect(payload['apiKey']).to eq '12345678901234567890123456789BBB'
+      end
+
+      Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj_legacy')) do
+        run_with({})
       end
     end
 
     context 'using default config_file option' do
-      context 'override API key option' do
+      context 'override API key from config' do
         it 'reads API key from the api_key option' do
           expect(BuildAction).to receive(:send_notification) do |url, body|
             payload = ::JSON.load(body)
-            expect(payload['apiKey']).to eq 'baobab'
+            expect(payload['apiKey']).to eq '12345678901234567890123456789FFF'
           end
 
           Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
-            BuildAction.run(load_default_opts.merge({
-              api_key: 'baobab'
-            }))
+            run_with({
+              api_key: '12345678901234567890123456789FFF'
+            })
           end
         end
 
-        it 'reads version info from the config file' do
+        it 'uses input versions from options' do
           expect(BuildAction).to receive(:send_notification) do |url, body|
             payload = ::JSON.load(body)
-            expect(payload['appVersion']).to eq '4.0.0'
-            expect(payload['appBundleVersion']).to eq '400'
+            expect(payload['appVersion']).to eq '8.0.0'
+            expect(payload['appBundleVersion']).to eq '800'
           end
 
           Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
-            BuildAction.run(load_default_opts.merge({
-              app_version: '4.0.0',
-              ios_bundle_version: '400'
-            }))
+            run_with({
+              app_version: '8.0.0',
+              ios_bundle_version: '800'
+            })
           end
         end
       end
@@ -61,46 +74,49 @@ describe BuildAction do
       it 'reads API key and version info from the config file' do
         expect(BuildAction).to receive(:send_notification) do |url, body|
           payload = ::JSON.load(body)
-          expect(payload['appVersion']).to eq '2.0-project'
-          expect(payload['appBundleVersion']).to eq '6'
-          expect(payload['apiKey']).to eq 'project-key'
+          expect(payload['appVersion']).to eq '3.0-project'
+          expect(payload['appBundleVersion']).to eq '33'
+          expect(payload['apiKey']).to eq '12345678901234567890123456789DDD'
         end
 
         Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
-          BuildAction.run(load_default_opts.merge({
+          run_with({
             config_file: File.join('Project', 'Info.plist')
-          }))
+          })
         end
       end
 
-      context 'override API key option' do
-        it 'reads API key from the config file' do
+      context 'override API key, and config file' do
+        it 'uses the input api_key to override a non default config' do
           expect(BuildAction).to receive(:send_notification) do |url, body|
             payload = ::JSON.load(body)
-            expect(payload['apiKey']).to eq 'project-key'
+            expect(payload['appVersion']).to eq '3.0-project'
+            expect(payload['appBundleVersion']).to eq '33'
+            expect(payload['apiKey']).to eq '12345678901234567890123456789EEE'
           end
 
           Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
-            BuildAction.run(load_default_opts.merge({
+            run_with({
               config_file: File.join('Project', 'Info.plist'),
-              api_key: 'baobab'
-            }))
+              api_key: '12345678901234567890123456789EEE'
+            })
           end
         end
 
-        it 'reads version info from the config file' do
+        it 'uses the input versions to override a non default config' do
           expect(BuildAction).to receive(:send_notification) do |url, body|
             payload = ::JSON.load(body)
-            expect(payload['appVersion']).to eq '2.0-project'
-            expect(payload['appBundleVersion']).to eq '6'
+            expect(payload['appVersion']).to eq '9.0.0'
+            expect(payload['appBundleVersion']).to eq '900'
+            expect(payload['apiKey']).to eq '12345678901234567890123456789DDD'
           end
 
           Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
-            BuildAction.run(load_default_opts.merge({
+            run_with({
               config_file: File.join('Project', 'Info.plist'),
-              app_version: '4.0.0',
-              ios_bundle_version: '400'
-            }))
+              app_version: '9.0.0',
+              ios_bundle_version: '900'
+            })
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-bugsnag
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Delisa Mason
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
@@ -143,12 +143,13 @@ files:
 - spec/fixtures/ios_proj/FirstRealFolder/Info.plist
 - spec/fixtures/ios_proj/Project/Info.plist
 - spec/fixtures/ios_proj/aaTests/Info.plist
+- spec/fixtures/ios_proj_legacy/Project/Info.plist
 - spec/fixtures/more_files.zip
 - spec/fixtures/stuff/app.dSYM/Contents/Resources/DWARF/app
 - spec/fixtures/stuff/app2.dSYM/Contents/Resources/DWARF/app2
 - spec/send_build_to_bugsnag_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/bugsnag/bugsnag-upload
+homepage: https://github.com/bugsnag/bugsnag-dsym-upload
 licenses:
 - MIT
 metadata: {}
@@ -167,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Uploads dSYM files to Bugsnag
@@ -176,6 +176,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/bugsnag_upload_dsym_action_spec.rb
 - spec/send_build_to_bugsnag_spec.rb
+- spec/fixtures/ios_proj_legacy/Project/Info.plist
 - spec/fixtures/more_files.zip
 - spec/fixtures/BCSymbolMaps/real.bcsymbolmap
 - spec/fixtures/ios_proj/FirstRealFolder/Info.plist