Merge pull request #89 from bugsnag/je/plat-14602-create-build-cli

Use the Bugsnag CLI to send build information

Author: joshedney

tools/fastlane-plugin/lib/fastlane/plugin/bugsnag/actions/bugsnag_cli.rb

@@ -0,0 +1,116 @@
+require 'os'
+require 'rbconfig'
+
+class BugsnagCli
+  def self.get_bugsnag_cli_path(params)
+    bundled_bugsnag_cli_path = self.get_bundled_path
+    bundled_bugsnag_cli_version = Gem::Version.new(`#{bundled_bugsnag_cli_path} --version`.scan(/(?:\d+\.?){3}/).first)
+
+    if params[:bugsnag_cli_path]
+      bugsnag_cli_path = params[:bugsnag_cli_path] || bundled_bugsnag_cli_path
+
+      bugsnag_cli_version = Gem::Version.new(`#{bugsnag_cli_path} --version`.scan(/(?:\d+\.?){3}/).first)
+
+      if bugsnag_cli_version < bundled_bugsnag_cli_version
+        FastlaneCore::UI.warning("The installed bugsnag-cli at #{bugsnag_cli_path} is outdated (#{bugsnag_cli_version}). The current bundled version is: #{bundled_bugsnag_cli_version}. It is recommended that you either update your installed version or use the bundled version.")
+      end
+      FastlaneCore::UI.verbose("Using bugsnag-cli from path: #{bugsnag_cli_path}")
+      bugsnag_cli_path
+    else
+      FastlaneCore::UI.verbose("Using bundled bugsnag-cli from path: #{bundled_bugsnag_cli_path}")
+      bundled_bugsnag_cli_path
+    end
+  end
+
+  def self.get_bundled_path
+    host_cpu = RbConfig::CONFIG['host_cpu']
+    if OS.mac?
+      if host_cpu =~ /arm|aarch64/
+        self.bin_folder('arm64-macos-bugsnag-cli')
+      else
+        self.bin_folder('x86_64-macos-bugsnag-cli')
+      end
+    elsif OS.windows?
+      if OS.bits == 64
+        self.bin_folder('x86_64-windows-bugsnag-cli.exe')
+      else
+        self.bin_folder('i386-windows-bugsnag-cli.exe')
+      end
+    else
+      if host_cpu =~ /arm|aarch64/
+        self.bin_folder('arm64-linux-bugsnag-cli')
+      elsif OS.bits == 64
+        self.bin_folder('x86_64-linux-bugsnag-cli')
+      else
+        self.bin_folder('i386-linux-bugsnag-cli')
+      end
+    end
+  end
+
+  def self.bin_folder(filename)
+    File.expand_path("../../../../../bin/#{filename}", File.dirname(__FILE__))
+  end
+
+  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)
+    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 FastlaneCore::Globals.verbose?
+    args
+  end
+
+  def self.upload_args dir, upload_url, project_root, api_key, ignore_missing_dwarf, ignore_empty_dsym, dryrun, log_level, port, retries, timeout, configuration, scheme, plist, xcode_project
+    args = []
+    args += ["--verbose"] if FastlaneCore::Globals.verbose?
+    args += ["--ignore-missing-dwarf"] if ignore_missing_dwarf
+    args += ["--ignore-empty-dsym"] if ignore_empty_dsym
+    args += ["--api-key", api_key] unless api_key.nil?
+    args += ["--upload-api-root-url", upload_url] unless upload_url.nil?
+    args += ["--project-root", project_root] unless project_root.nil?
+    args += ["--dry-run"] if dryrun
+    args += ["--log-level", log_level] unless log_level.nil?
+    args += ["--port", port] unless port.nil?
+    args += ["--retries", retries] unless retries.nil?
+    args += ["--timeout", timeout] unless timeout.nil?
+    args += ["--configuration", configuration] unless configuration.nil?
+    args += ["--scheme", scheme] unless scheme.nil?
+    args += ["--plist", plist] unless plist.nil?
+    args += ["--xcode-project", xcode_project] unless xcode_project.nil?
+    args << dir
+    args
+  end
+
+  def self.upload_dsym cli_path, args
+    bugsnag_cli_command = "#{cli_path} upload dsym #{args.join(' ')}"
+    FastlaneCore::UI.verbose("Running command: #{bugsnag_cli_command}")
+    Kernel.system(bugsnag_cli_command)
+  end
+
+  def self.create_build cli_path, args
+    bugsnag_cli_command = "#{cli_path} create-build #{args.join(' ')}"
+    FastlaneCore::UI.verbose("Running command: #{bugsnag_cli_command}")
+    Kernel.system(bugsnag_cli_command)
+  end
+end
+
+

tools/fastlane-plugin/lib/fastlane/plugin/bugsnag/actions/send_build_to_bugsnag.rb

@@ -1,63 +1,66 @@
 require "xmlsimple"
 require "json"
 require_relative "find_info_plist_path"
+require_relative "bugsnag_cli"
 
 module Fastlane
   module Actions
     class SendBuildToBugsnagAction < Action
-
-      BUILD_TOOL = "bugsnag-fastlane-plugin"
-
       def self.run(params)
-        payload = {buildTool: BUILD_TOOL, sourceControl: {}}
+        bugsnag_cli_path = BugsnagCli.get_bugsnag_cli_path(params)
 
         # 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[: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
-          # 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
 
-        # 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]
-
-        # If provided apply metadata to payload.
-        payload[:metadata] = params[:metadata]
-
-        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[:appVersion].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 = BugsnagCli.create_build_args(
+          api_key,
+          version_name,
+          version_code,
+          bundle_version,
+          release_stage,
+          builder,
+          revision,
+          repository,
+          provider,
+          auto_assign_release,
+          metadata,
+          retries,
+          timeout,
+          endpoint
+        )
+        success = BugsnagCli.create_build bugsnag_cli_path, args
+        if success
+          UI.success("Build successfully sent to Bugsnag")
+        else
+          UI.user_error!("Failed to send build to Bugsnag.")
         end
-
-        send_notification(params[:endpoint], ::JSON.dump(payload))
       end
 
       def self.missing_api_key_message(params)
@@ -146,6 +149,11 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :release_stage,
                                        description: "Release stage being built, i.e. staging, production",
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :auto_assign_release,
+                                       description: "Whether to automatically associate this build with any new error events and sessions that are received for",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
           FastlaneCore::ConfigItem.new(key: :builder,
                                        description: "The name of the entity triggering the build",
                                        optional: true,
@@ -170,13 +178,28 @@ 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,
-                                       type: Object, 
-                                       default_value: nil)
+                                       type: Object,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :retries,
+                                       description: "The number of retry attempts before failing an upload request",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :timeout,
+                                       description: "The number of seconds to wait before failing an upload request",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :bugsnag_cli_path,
+                                       env_name: "BUGSNAG_CLI_PATH",
+                                       description: "Path to your bugsnag-cli",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error! "'#{value}' is not executable" unless FastlaneCore::Helper.executable?(value)
+                                       end)
         ]
       end
 
@@ -194,7 +217,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
@@ -316,45 +340,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.send_notification(url, body)
-        require "net/http"
-        uri = URI.parse(url)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.read_timeout = 15
-        http.open_timeout = 15
-
-        http.use_ssl = uri.scheme == "https"
-
-        uri.path == "" ? "/" : uri.path
-        request = Net::HTTP::Post.new(uri, {"Content-Type" => "application/json"})
-        request.body = body
-        begin
-          response = http.request(request)
-        rescue => e
-          UI.user_error! "Failed to notify Bugsnag of a new build: #{e}"
-        end
-        if body = parse_response_body(response)
-          if body.has_key? "errors"
-            errors = body["errors"].map {|error| "\n  * #{error}"}.join
-            UI.user_error! "The following errors occurred while notifying Bugsnag:#{errors}.\n\nPlease update your lane config and retry."
-          elsif response.code != "200"
-            UI.user_error! "Failed to notify Bugsnag of a new build. Please retry. HTTP status code: #{response.code}"
-          end
-          if body.has_key? "warnings"
-            warnings = body["warnings"].map {|warn| "\n  * #{warn}"}.join
-            UI.important "Sending the build to Bugsnag succeeded with the following warnings:#{warnings}\n\nPlease update your lane config."
-          end
-        end
-      end
     end
   end
 end