update send build tests to work with the cli

joshedney · joshedney · commit c7b1df41068d · 2025-09-04T14:31:59.000+01:00
diff --git a/tools/fastlane-plugin/lib/fastlane/plugin/bugsnag/actions/send_build_to_bugsnag.rb b/tools/fastlane-plugin/lib/fastlane/plugin/bugsnag/actions/send_build_to_bugsnag.rb
@@ -8,63 +8,91 @@ module Actions
     class SendBuildToBugsnagAction < Action
       def self.run(params)
         bugsnag_cli_path = BugsnagCli.get_bugsnag_cli_path(params)
-        UI.verbose("Using bugsnag-cli from path: #{bugsnag_cli_path}")
-
-        payload = {}
+        verbose = UI.verbose("Using bugsnag-cli from path: #{bugsnag_cli_path}")
 
         # If a configuration file was found or was specified, load in the options:
+        config_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[:versionName] = params[:app_version] || config_options[:appVersion]
-          payload[:versionCode] = params[:android_version_code] || config_options[:appVersionCode]
-          payload[:bundleVersion] = params[:ios_bundle_version] || config_options[:appBundleVersion]
-          payload[:releaseStage] = params[:release_stage] || config_options[:releaseStage] || "production"
-        else
-          # No configuration file was found or specified, use the input parameters:
-          payload[:apiKey] = params[:api_key]
-          payload[:versionName] = params[:app_version]
-          payload[:versionCode] = params[:android_version_code]
-          payload[:bundleVersion] = params[:ios_bundle_version]
-          payload[:releaseStage] = params[:release_stage] || "production"
         end
 
-        # 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[:revision] = params[:revision] if params[:revision]
-        payload[:repository] = params[:repository] if params[:repository]
-        payload[:provider] = params[:provider] if params[:provider]
-
-        payload[:autoAssignRelease] = params[:auto_assign_release] if params[:auto_assign_release]
-
-        # If provided apply metadata to payload.
-        payload[:metadata] = params[:metadata]
-
-        payload[:retries] = params[:retries] if params[:retries]
-        payload[:timeout] = params[:timeout] if params[:timeout]
-        payload[:buildApiRootUrl] = params[:endpoint] if params[:endpoint]
-
-        payload.reject! {|k,v| v == nil || (v.is_a?(Hash) && v.empty?)}
-
-        if payload[:apiKey].nil? || !payload[:apiKey].is_a?(String)
+        api_key = params[:api_key] || config_options[:apiKey] unless (params[:api_key].nil? && config_options[:apiKey].nil?)
+        version_name = params[:app_version] || config_options[:appVersion] unless (params[:app_version].nil? && config_options[:appVersion].nil?)
+        version_code = params[:android_version_code] || config_options[:appVersionCode] unless (params[:android_version_code].nil? && config_options[:appVersionCode].nil?)
+        bundle_version = params[:ios_bundle_version] || config_options[:appBundleVersion] unless (params[:ios_bundle_version].nil? && config_options[:appBundleVersion].nil?)
+        release_stage = params[:release_stage] || config_options[:releaseStage] || "production" unless (params[:release_stage].nil? && config_options[:releaseStage].nil?)
+        builder = params[:builder] unless params[:builder].nil?
+        revision = params[:revision] unless params[:revision].nil?
+        repository = params[:repository] unless params[:repository].nil?
+        provider = params[:provider] unless params[:provider].nil?
+        auto_assign_release = params[:auto_assign_release] unless params[:auto_assign_release].nil?
+        metadata = params[:metadata] unless params[:metadata].nil?
+        retries = params[:retries] unless params[:retries].nil?
+        timeout = params[:timeout] unless params[:timeout].nil?
+        endpoint = params[:endpoint] unless params[:endpoint].nil?
+
+
+        if api_key.nil? || !api_key.is_a?(String)
           UI.user_error! missing_api_key_message(params)
         end
-        if payload[:versionName].nil?
+        if version_name.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]}")
+        args = create_build_args(
+          api_key,
+          version_name,
+          version_code,
+          bundle_version,
+          release_stage,
+          builder,
+          revision,
+          repository,
+          provider,
+          auto_assign_release,
+          metadata,
+          retries,
+          timeout,
+          endpoint,
+          verbose
+        )
+        bugsnag_cli_command = "#{bugsnag_cli_path} create-build #{args.join(' ')}"
+        UI.verbose("Running command: #{bugsnag_cli_command}")
+        success = Kernel.system(bugsnag_cli_command)
+        if success
+          UI.success("Build successfully sent to Bugsnag")
+        else
+          UI.user_error!("Failed to send build to Bugsnag.")
         end
+      end
 
-        send_notification(bugsnag_cli_path, ::JSON.dump(payload))
+      def self.create_build_args(api_key, version_name, version_code, bundle_version, release_stage, builder, revision, repository, provider, auto_assign_release, metadata, retries, timeout, endpoint, verbose)
+        args = []
+        args += ["--api-key", api_key] unless api_key.nil?
+        args += ["--version-name", version_name] unless version_name.nil?
+        args += ["--version-code", version_code] unless version_code.nil?
+        args += ["--bundle-version", bundle_version] unless bundle_version.nil?
+        args += ["--release-stage", release_stage] unless release_stage.nil?
+        args += ["--builder-name", builder] unless builder.nil?
+        args += ["--revision", revision] unless revision.nil?
+        args += ["--repository", repository] unless repository.nil?
+        args += ["--provider", provider] unless provider.nil?
+        args += ["--auto-assign-release"] if auto_assign_release
+        unless metadata.nil?
+          if metadata.is_a?(String)
+            #
+            args += ["--metadata", metadata]
+          elsif metadata.is_a?(Hash)
+            formatted_metadata = metadata.map { |k, v| %Q{"#{k}"="#{v}"} }.join(",")
+            args += ["--metadata", formatted_metadata]
+          end
+        end
+        args += ["--retries", retries] unless retries.nil?
+        args += ["--timeout", timeout] unless timeout.nil?
+        args += ["--build-api-root-url", endpoint] unless endpoint.nil?
+        args += ["--verbose"] if verbose
+        args
       end
 
       def self.missing_api_key_message(params)
@@ -182,8 +210,8 @@ def self.available_options
                                        end),
           FastlaneCore::ConfigItem.new(key: :endpoint,
                                        description: "Bugsnag deployment endpoint",
-                                       optional: true,
-                                       default_value: "https://build.bugsnag.com"),
+                                       default_value: nil,
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :metadata,
                                        description: "Metadata",
                                        optional:true,
@@ -221,7 +249,8 @@ def self.load_git_remote_options
             git_options[:repository] = origin.url
             git_options[:revision] = repo.revparse("HEAD")
           end
-        rescue
+        rescue => e
+          UI.verbose("Could not load git options: #{e.message}")
         end
         return git_options
       end
@@ -343,46 +372,6 @@ def self.map_meta_data(meta_data)
         end
         output
       end
-
-      def self.parse_response_body(response)
-        begin
-          JSON.load(response.body)
-        rescue
-          nil
-        end
-      end
-
-      def self.to_kebab_case(str)
-      str.gsub(/([a-z])([A-Z])/, '\1-\2').downcase
-      end
-
-      def self.json_to_cli_args(json_payload)
-        data = JSON.parse(json_payload)
-
-        data.map do |k, v|
-          key = to_kebab_case(k)
-          if v.is_a?(Hash)
-            # Convert nested hash into key=value pairs joined by commas
-            nested = v.map { |nk, nv| "#{to_kebab_case(nk)}=#{nv}" }.join(",")
-            "--#{key}=#{nested}"
-          else
-            "--#{key}=#{v}"
-          end
-        end.join(" ")
-      end
-
-      def self.send_notification(cli_path, body)
-        args = self.json_to_cli_args(body)
-        bugsnag_cli_command = "#{cli_path} create-build #{args}"
-
-        UI.verbose("Running command: #{bugsnag_cli_command}")
-        success = Kernel.system(bugsnag_cli_command)
-        if success
-          UI.success("Build successfully sent to Bugsnag")
-        else
-          UI.user_error!("Failed to send build to Bugsnag.")
-        end
-      end
     end
   end
 end
diff --git a/tools/fastlane-plugin/spec/send_build_to_bugsnag_spec.rb b/tools/fastlane-plugin/spec/send_build_to_bugsnag_spec.rb
@@ -15,13 +15,7 @@ def run_with args
 
   context 'building an iOS project' do
     it 'detects default Info.plist file excluding test dirs' do
-      expect(BuildAction).to receive(:send_notification) do |cli_path, body|
-        args = ::JSON.load(body)
-        expect(args['versionName']).to eq '2.0-other'
-        expect(args['bundleVersion']).to eq '22'
-        expect(args['apiKey']).to eq '12345678901234567890123456789AAA'
-      end
-
+      expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789AAA --version-name 2.0-other --bundle-version 22 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git").and_return(true)
       Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
         run_with({})
       end
@@ -30,13 +24,7 @@ def run_with args
     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 |cli_path, body|
-        args = ::JSON.load(body)
-        expect(args['versionName']).to eq '4.0-project'
-        expect(args['bundleVersion']).to eq '44'
-        expect(args['apiKey']).to eq '12345678901234567890123456789BBB'
-      end
-
+      expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789BBB --version-name 4.0-project --bundle-version 44 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git").and_return(true)
       Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj_legacy')) do
         run_with({})
       end
@@ -45,11 +33,7 @@ def run_with args
     context 'using default config_file 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 |cli_path, body|
-            args = ::JSON.load(body)
-            expect(args['apiKey']).to eq '12345678901234567890123456789FFF'
-          end
-
+          expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789FFF --version-name 2.0-other --bundle-version 22 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git").and_return(true)
           Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
             run_with({
               api_key: '12345678901234567890123456789FFF'
@@ -58,12 +42,7 @@ def run_with args
         end
 
         it 'uses input versions from options' do
-          expect(BuildAction).to receive(:send_notification) do |cli_path, body|
-            args = ::JSON.load(body)
-            expect(args['versionName']).to eq '8.0.0'
-            expect(args['bundleVersion']).to eq '800'
-          end
-
+          expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789AAA --version-name 8.0.0 --bundle-version 800 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git").and_return(true)
           Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
             run_with({
               app_version: '8.0.0',
@@ -76,13 +55,7 @@ def run_with args
 
     context 'override config_file option' do
       it 'reads API key and version info from the config file' do
-        expect(BuildAction).to receive(:send_notification) do |cli_path, body|
-          args = ::JSON.load(body)
-          expect(args['versionName']).to eq '3.0-project'
-          expect(args['bundleVersion']).to eq '33'
-          expect(args['apiKey']).to eq '12345678901234567890123456789DDD'
-        end
-
+        expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789DDD --version-name 3.0-project --bundle-version 33 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git").and_return(true)
         Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
           run_with({
             config_file: File.join('Project', 'Info.plist')
@@ -92,13 +65,7 @@ def run_with args
 
       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 |cli_path, body|
-            args = ::JSON.load(body)
-            expect(args['versionName']).to eq '3.0-project'
-            expect(args['bundleVersion']).to eq '33'
-            expect(args['apiKey']).to eq '12345678901234567890123456789EEE'
-          end
-
+          expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789EEE --version-name 3.0-project --bundle-version 33 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git").and_return(true)
           Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
             run_with({
               config_file: File.join('Project', 'Info.plist'),
@@ -108,13 +75,7 @@ def run_with args
         end
 
         it 'uses the input versions to override a non default config' do
-          expect(BuildAction).to receive(:send_notification) do |cli_path, body|
-            args = ::JSON.load(body)
-            expect(args['versionName']).to eq '9.0.0'
-            expect(args['bundleVersion']).to eq '900'
-            expect(args['apiKey']).to eq '12345678901234567890123456789DDD'
-          end
-
+          expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789DDD --version-name 9.0.0 --bundle-version 900 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git").and_return(true)
           Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
             run_with({
               config_file: File.join('Project', 'Info.plist'),
@@ -128,13 +89,7 @@ def run_with args
 
     context 'metadata added to args' do
       it "single key:value pair added" do
-        expect(BuildAction).to receive(:send_notification) do |cli_path, body|
-          args = ::JSON.load(body)
-          expect(args['versionName']).to eq '4.0-project'
-          expect(args['apiKey']).to eq '12345678901234567890123456789DDD'
-          expect(args['metadata']).to eq '"test1": "First test"'
-        end
-
+        expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789DDD --version-name 4.0-project --bundle-version 22 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git --metadata \"test1\": \"First test\"").and_return(true)
         Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
           run_with({
             app_version: '4.0-project',
@@ -145,19 +100,27 @@ def run_with args
       end
 
       it "multiple key:value pairs added" do
-        expect(BuildAction).to receive(:send_notification) do |cli_path, body|
-          args = ::JSON.load(body)
-          expect(args['versionName']).to eq '4.0-project'
-          expect(args['apiKey']).to eq '12345678901234567890123456789DDD'
-          expect(args['metadata']).to eq '"test1": "First test", "test2": "Second test", "test3": "Third test"'
+        expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789DDD --version-name 4.0-project --bundle-version 22 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git --metadata \"test1\": \"First test\", \"test2\": \"Second test\", \"test3\": \"Third test\"").and_return(true)
+        Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
+          run_with({
+                     app_version: '4.0-project',
+                     api_key: '12345678901234567890123456789DDD',
+                     metadata: '"test1": "First test", "test2": "Second test", "test3": "Third test"'
+                   })
         end
+      end
 
+      it "multiple key:value pairs added as a hash" do
+        expect(Kernel).to receive(:system).with("#{BUGSNAG_CLI_PATH} create-build --api-key 12345678901234567890123456789DDD --version-name 4.0-project --bundle-version 22 --builder-name josh.edney --revision 3a30a510ba898341ff8631da49dc7021fb28c40e --repository git@github.com:bugsnag/bugsnag-dsym-upload.git --metadata \"custom_field_1\"=\"value1\", \"custom_field_2\"=\"value2\"").and_return(true)
         Dir.chdir(File.join(FIXTURE_PATH, 'ios_proj')) do
           run_with({
-            app_version: '4.0-project',
-            api_key: '12345678901234567890123456789DDD',
-            metadata: '"test1": "First test", "test2": "Second test", "test3": "Third test"'
-          })
+                     app_version: '4.0-project',
+                     api_key: '12345678901234567890123456789DDD',
+                     metadata: {
+                       "custom_field_1": "value1",
+                       "custom_field_2": "value2"
+                     }
+                   })
         end
       end
     end
diff --git a/tools/fastlane-plugin/spec/spec_helper.rb b/tools/fastlane-plugin/spec/spec_helper.rb
@@ -8,3 +8,11 @@ module SpecHelper
 require 'fastlane/plugin/bugsnag' # import the actual plugin
 
 FIXTURE_PATH = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
+
+
+# expands the `got` and `expected` output in the RSpec output
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.max_formatted_output_length = nil # unlimited
+  end
+end
