fastlane-plugin-bugsnag 2.3.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3c60f5a8e31661e3a0e828b3e792535c6b31088924f48a25f8ae935e982986
-  data.tar.gz: 77589505109ad61b5bc91d19bfa07ff7b79f7b0a910fe7c84ebd311bdb8b8b99
+  metadata.gz: 042d2b301e0ad19225ace580396fb7e28a3c6937b886c121a397638d9045c943
+  data.tar.gz: 55b92ac267ac88e808bfa5b321d49619f2277915de491529315fcba948a15b18
 SHA512:
-  metadata.gz: 23c3d24f139d1a5249a74419bce45ac37beb6e24e94793cce45ccaf1df74ba4056f68d36b1af743cb6a9e9a3293119b8c48f9543784edcd3edbf11656f9a3093
-  data.tar.gz: d4dba2b84a6feb931045c5777928f76c29b472206d6c1e886b5a332c32d6e9c6acec7b3ce96b23d7b7df48754a69973bc7e5d1754d279ed9cab53436c897763d
+  metadata.gz: f78c4a5367838ec3cad6c73babe205613fc568a46410f5d1ae229f331b7349dbfc94d6a3f06c8a205cd313e56cd30645f81fe080d89c8b9468927a815458de03
+  data.tar.gz: 167d065c493176c4011801d16d95b811cf4c48eef54754883b5ff98a1ee4236520f524df2458072698c373e466a3cdc0594e2e6cdd3069cfbd80ff6ecc0bc94d

data/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
+
+

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

@@ -1,63 +1,66 @@
-require "xmlsimple"
+require "rexml/document"
 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 @@ module Fastlane
           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 @@ module Fastlane
                                        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 @@ module Fastlane
             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
@@ -263,11 +287,18 @@ module Fastlane
       def self.options_from_android_manifest file_path
         options = {}
         begin
-          meta_data = parse_android_manifest_options(XmlSimple.xml_in(file_path))
+          xml_content = File.read(file_path)
+          doc = REXML::Document.new(xml_content)
+          meta_data = {}
+          REXML::XPath.each(doc, "//meta-data") do |element|
+            name = element.attributes["android:name"]
+            value = element.attributes["android:value"]
+            meta_data[name] = value if name
+          end
           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
+        rescue ArgumentError, REXML::ParseException, Errno::ENOENT, Errno::EACCES => e
           nil
         end
         options
@@ -288,6 +319,10 @@ module Fastlane
         options
       end
 
+      # NOTE: The following methods are no longer used.
+      # XML parsing is now handled directly via REXML::XPath in options_from_android_manifest.
+      # Kept for reference only.
+
       def self.parse_android_manifest_options config_hash
         map_meta_data(get_meta_data(config_hash))
       end
@@ -316,45 +351,6 @@ module Fastlane
         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

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

@@ -1,15 +1,16 @@
 require_relative "find_info_plist_path"
+require_relative "bugsnag_cli"
+
 
 module Fastlane
   module Actions
     class UploadSymbolsToBugsnagAction < Action
-
-      UPLOAD_SCRIPT_PATH = File.expand_path(
-        File.join(File.dirname(__FILE__), '..', '..', '..', '..', '..', 'bugsnag-dsym-upload'))
-
       def self.run(params)
+        bugsnag_cli_path = BugsnagCli.get_bugsnag_cli_path(params)
+        UI.verbose("Using bugsnag-cli from path: #{bugsnag_cli_path}")
+
         # 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
+        # input in Fastfile, find an API key from 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]}")
@@ -18,7 +19,7 @@ module Fastlane
 
         # 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:")
+        UI.verbose("Uploading dSYMs to Bugsnag with the following parameters:")
         rjust = 30 # set justification width for keys for the list of parameters to output
         params.values.each do |param|
           UI.verbose("  #{param[0].to_s.rjust(rjust)}: #{param[1]}")
@@ -28,8 +29,24 @@ module Fastlane
 
         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], api_key, verbose, params[:ignore_missing_dwarf], params[:ignore_empty_dsym])
-            success = Kernel.system(UPLOAD_SCRIPT_PATH, *args)
+            args = BugsnagCli.upload_args(
+              "\"#{dsym_path}\"",
+              params[:upload_url],
+              params[:project_root],
+              api_key,
+              params[:ignore_missing_dwarf],
+              params[:ignore_empty_dsym],
+              params[:dryrun],
+              params[:log_level],
+              params[:port],
+              params[:retries],
+              params[:timeout],
+              params[:configuration],
+              params[:scheme],
+              params[:config_file],
+              params[:xcode_project]
+            )
+            success = BugsnagCli.upload_dsym bugsnag_cli_path, args
             if success
               UI.success("Uploaded dSYMs in #{dsym_path}")
             else
@@ -106,12 +123,6 @@ module Fastlane
                                        description: "URL of the server receiving uploaded files",
                                        default_value: nil,
                                        optional: true),
-          FastlaneCore::ConfigItem.new(key: :symbol_maps_path,
-                                       env_name: "BUGSNAG_SYMBOL_MAPS_PATH",
-                                       description: "Path to the BCSymbolMaps directory to build complete dSYM files",
-                                       default_value: nil,
-                                       optional: true,
-                                       verify_block: validate_symbol_maps),
           FastlaneCore::ConfigItem.new(key: :project_root,
                                        env_name: "BUGSNAG_PROJECT_ROOT",
                                        description: "Root path of the project",
@@ -129,11 +140,55 @@ module Fastlane
                                        optional: true,
                                        default_value: false,
                                        is_string: false),
+          FastlaneCore::ConfigItem.new(key: :dryrun,
+                                       env_name: "BUGSNAG_DRYRUN",
+                                       description: "Performs a dry-run of the command without sending any information to BugSnag",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :log_level,
+                                       env_name: "BUGSNAG_LOG_LEVEL",
+                                       description: "Sets the level of logging to debug, info, warn or fatal",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :port,
+                                       env_name: "BUGSNAG_PORT",
+                                       description: "The port number for the BugSnag upload server",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :retries,
+                                       env_name: "BUGSNAG_RETRIES",
+                                       description: "The number of retry attempts before failing an upload request",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :timeout,
+                                       env_name: "BUGSNAG_TIMEOUT",
+                                       description: "The number of seconds to wait before failing an upload request",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :configuration,
+                                       env_name: "BUGSNAG_CONFIGURATION",
+                                       description: "The configuration used to build the application",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       env_name: "BUGSNAG_SCHEME",
+                                       description: "The name of the Xcode options.Scheme used to build the application",
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :config_file,
                                        env_name: "BUGSNAG_CONFIG_FILE",
                                        description: "Info.plist location",
                                        optional: true,
-                                       default_value: FindInfoPlist.default_info_plist_path)
+                                       default_value: FindInfoPlist.default_info_plist_path),
+          FastlaneCore::ConfigItem.new(key: :xcode_project,
+                                       env_name: "BUGSNAG_XCODE_PROJECT",
+                                       description: "The path to an Xcode project, workspace or containing directory from which to obtain build information",
+                                       optional: true),
+          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
 
@@ -154,17 +209,7 @@ module Fastlane
         }
       end
 
-      def self.upload_args dir, symbol_maps_dir, upload_url, project_root, api_key, verbose, ignore_missing_dwarf, ignore_empty_dsym
-        args = [verbose ? "--verbose" : "--silent"]
-        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-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?
-        args << dir
-        args
-      end
+
 
       # returns an array of unique dSYM-containing directory paths to upload
       def self.parse_dsym_paths dsym_path
@@ -207,4 +252,4 @@ module Fastlane
       end
     end
   end
-end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Bugsnag
-    VERSION = "2.3.1"
+    VERSION = "3.1.0"
   end
 end