cocoapods-bugsnag 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 482f70c66ea52e9633b644d594c1c8ef9bdddbe5
-  data.tar.gz: f4a0810109c18cf8edd07bcbda48d2d84ec37d9b
+SHA256:
+  metadata.gz: 9bd7a73528694640aa6a5d4029fcf1cdbef07d71a0da73ab2b859272e491a8ca
+  data.tar.gz: 2c00d5eea8c273f5d30b2683cb04fb0bc446f17bdf2b2f6f3e6a0233bda6bb9d
 SHA512:
-  metadata.gz: 17a00ed6b43c406eba7390a722cf06930b32780c030efc2218b4d856a8a71981994fbc3925c87d4185b1ff988c7a2631c6445e1f45328e725b71dfa69a11e5ad
-  data.tar.gz: 8432e08a32cf59006b02fbe56fc846221544aaea895eea9c5eb3ae76d6e9d7a01dd3dd0c729028ef2b5899f8c25cbc276914ffca24bea94a34d722587d9c4e57
+  metadata.gz: '042861a83266e07106633d6b236fe5e3ac5271d2bacfd73bf2eb43e50388e81b7e371a7df0ee2bce2a3762f139629ef7a37a2beaa77b8cf73af2120dea75466e'
+  data.tar.gz: 9708b8a7b945b3e99c18df3d5768d1369f0353e83d1266fcf92b90dc2626b258140b55c58bde738fb040f1d1f4121d8fbcdbc9b906ca45c97e96d8ad5d4ecf4b

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 2.3.0 (13 Sept 2022)
+
+### Enhancements
+
+* The Xcode build phase is now compatible with Xcode 14's `ENABLE_USER_SCRIPT_SANDBOXING` build setting.
+  This requires all dSYM files to be specified in the build phase's "Input Files" list.
+  | [#28](https://github.com/bugsnag/cocoapods-bugsnag/pull/28)
+
+## 2.2.2 (17 May 2022)
+
+### Enhancements
+
+* Uploading can now be skipped by setting `DISABLE_COCOAPODS_BUGSNAG=YES` via Xcode's Build Settings, `xcconfig` or `xcodebuild`.
+  | [#25](https://github.com/bugsnag/cocoapods-bugsnag/pull/25)
+
+## 2.2.1 (20 Nov 2020)
+
+### Bug fixes
+
+* The Xcode build phase now specifies its dependencies for improved reliability with Xcode's new build system.
+  | [#20](https://github.com/bugsnag/cocoapods-bugsnag/pull/20)
+
 ## 2.2.0 (30 Sept 2020)
 
 ### Enhancements

data/README.md

@@ -40,9 +40,11 @@ pod install
 Once added, uploading your dSYM files to Bugsnag will occur automatically.
 
 By default, your Bugsnag API key will either be read from the `BUGSNAG_API_KEY`
-environment variable or from the `:bugsnag:apiKey` (or `BugsnagAPIKey`) value in your
-`Info.plist`. Alternatively edit the script in the new "Upload Bugsnag dSYM" build 
-phase in Xcode.
+environment variable (add an Xcode build setting with this name to set it) or
+from the `:bugsnag:apiKey` (or `BugsnagAPIKey`) value in your `Info.plist`.
+
+Uploading can be disabled by setting `DISABLE_COCOAPODS_BUGSNAG=YES` in Xcode's
+Build Settings or an `xcconfig` file, or as an argument to `xcodebuild`.
 
 ## Support
 
@@ -50,3 +52,7 @@ phase in Xcode.
 * [Search open and closed issues](https://github.com/bugsnag/cocoapods-bugsnag/issues?utf8=✓&q=is%3Aissue)
   for similar problems
 * [Open an issue](https://github.com/bugsnag/cocoapods-bugsnag/issues/new)
+
+## License
+
+This module is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.

data/cocoapods-bugsnag.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "cocoapods-bugsnag"
-  spec.version = "2.2.0"
+  spec.version = "2.3.0"
   spec.homepage = "https://bugsnag.com"
   spec.description = "Configures the dSYM upload phase of your project when integrated with bugsnag."
   spec.summary = "To get meaningful stacktraces from your crashes, the Bugsnag service needs your dSYM file for your build. This plugin adds an upload phase to your project where needed."
@@ -12,11 +12,13 @@ Gem::Specification.new do |spec|
     "cocoapods-bugsnag.gemspec"
   ]
   spec.extra_rdoc_files = [ "README.md", "CHANGELOG.md" ]
-  spec.test_files = [ "spec/cocoapods_bugsnag_spec.rb" ]
+  spec.test_files = [
+    "spec/cocoapods_bugsnag_spec.rb",
+    "spec/spec_helper.rb"
+  ]
   spec.require_paths = [ "lib" ]
   spec.license = "MIT"
 
   spec.add_dependency "cocoapods", "~> 1.0"
   spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "bacon", "~> 1.0"
 end

data/lib/cocoapods_bugsnag.rb

@@ -2,38 +2,55 @@ module Pod
   class Installer::UserProjectIntegrator::TargetIntegrator
 
     BUGSNAG_PHASE_NAME = "Upload Bugsnag dSYM"
+    BUGSNAG_PHASE_INPUT_PATHS = [
+      "${BUILT_PRODUCTS_DIR}/${INFOPLIST_PATH}",
+      "${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${TARGET_NAME}"]
+    BUGSNAG_PHASE_SHELL_PATH = "/usr/bin/env ruby"
     BUGSNAG_PHASE_SCRIPT = <<'RUBY'
-api_key = nil # Insert your key here to use it directly from this script
-
-# Attempt to get the API key from an environment variable
-unless api_key
-  api_key = ENV["BUGSNAG_API_KEY"]
-
-  # If not present, attempt to lookup the value from the Info.plist
-  unless api_key
-    info_plist_path = "#{ENV["BUILT_PRODUCTS_DIR"]}/#{ENV["INFOPLIST_PATH"]}"
-    plist_buddy_response = `/usr/libexec/PlistBuddy -c "print :bugsnag:apiKey" "#{info_plist_path}"`
-    plist_buddy_response = `/usr/libexec/PlistBuddy -c "print :BugsnagAPIKey" "#{info_plist_path}"` if !$?.success?
-    api_key = plist_buddy_response if $?.success?
-  end
+# Set DISABLE_COCOAPODS_BUGSNAG=YES via Xcode's Build Settings, xcconfig or xcodebuild to skip upload
+if ENV['DISABLE_COCOAPODS_BUGSNAG'] == 'YES'
+  puts 'Skipping dSYM upload'
+  return
 end
 
-fail("No Bugsnag API key detected - add your key to your Info.plist, BUGSNAG_API_KEY environment variable or this Run Script phase") unless api_key
+# Attempt to get the API key from an environment variable (or Xcode build setting)
+api_key = ENV["BUGSNAG_API_KEY"]
 
-fork do
-  Process.setsid
-  STDIN.reopen("/dev/null")
-  STDOUT.reopen("/dev/null", "a")
-  STDERR.reopen("/dev/null", "a")
+# If not present, attempt to lookup the value from the Info.plist
+unless api_key
+  info_plist_path = "#{ENV["BUILT_PRODUCTS_DIR"]}/#{ENV["INFOPLIST_PATH"]}"
+  plist_buddy_response = `/usr/libexec/PlistBuddy -c "print :bugsnag:apiKey" "#{info_plist_path}"`
+  plist_buddy_response = `/usr/libexec/PlistBuddy -c "print :BugsnagAPIKey" "#{info_plist_path}"` if !$?.success?
+  api_key = plist_buddy_response if $?.success?
+end
 
-  require 'shellwords'
+fail("No Bugsnag API key detected - add your key to your Info.plist or BUGSNAG_API_KEY environment variable") unless api_key
 
-  Dir["#{ENV["DWARF_DSYM_FOLDER_PATH"]}/*/Contents/Resources/DWARF/*"].each do |dsym|
-    curl_command = "curl --http1.1 -F dsym=@#{Shellwords.escape(dsym)} -F projectRoot=#{Shellwords.escape(ENV["PROJECT_DIR"])} "
-    curl_command += "-F apiKey=#{Shellwords.escape(api_key)} "
-    curl_command += "https://upload.bugsnag.com/"
-    system(curl_command)
+if ENV['ENABLE_USER_SCRIPT_SANDBOXING'] == 'YES'
+  count = ENV['SCRIPT_INPUT_FILE_COUNT'].to_i
+  abort 'error: dSYMs must be specified as build phase "Input Files" because ENABLE_USER_SCRIPT_SANDBOXING is enabled' unless count > 0
+  dsyms = []
+  for i in 0 .. count - 1
+    file = ENV["SCRIPT_INPUT_FILE_#{i}"]
+    next if file.end_with? '.plist'
+    if File.exist? file
+      dsyms.append file
+    else
+      abort "error: cannot read #{file}" unless ENV['DEBUG_INFORMATION_FORMAT'] != 'dwarf-with-dsym'
+    end
   end
+else
+  dsyms = Dir["#{ENV['DWARF_DSYM_FOLDER_PATH']}/*/Contents/Resources/DWARF/*"]
+end
+
+dsyms.each do |dsym|
+  Process.detach Process.spawn('/usr/bin/curl', '--http1.1',
+    '-F', "apiKey=#{api_key}",
+    '-F', "dsym=@#{dsym}",
+    '-F', "projectRoot=#{ENV['PROJECT_DIR']}",
+    'https://upload.bugsnag.com/',
+    %i[err out] => :close
+  )
 end
 RUBY
 
@@ -41,43 +58,54 @@ RUBY
     def integrate!
       integrate_without_bugsnag!
       return unless should_add_build_phase?
-      return if bugsnag_native_targets.empty?
+
       UI.section("Integrating with Bugsnag") do
         add_bugsnag_upload_script_phase
         user_project.save
       end
-      UI.puts "Added 'Upload Bugsnag dSYM' build phase"
     end
 
-
     def add_bugsnag_upload_script_phase
-      bugsnag_native_targets.each do |native_target|
+      native_targets.each do |native_target|
         phase = native_target.shell_script_build_phases.select do |bp|
           bp.name == BUGSNAG_PHASE_NAME
-        end.first || native_target.new_shell_script_build_phase(BUGSNAG_PHASE_NAME)
+        end.first || add_shell_script_build_phase(native_target, BUGSNAG_PHASE_NAME)
 
-        phase.shell_path = "/usr/bin/env ruby"
+        phase.input_paths = dsym_phase_input_paths(phase)
+        phase.shell_path = BUGSNAG_PHASE_SHELL_PATH
         phase.shell_script = BUGSNAG_PHASE_SCRIPT
         phase.show_env_vars_in_log = '0'
       end
     end
 
+    def add_shell_script_build_phase(native_target, name)
+      UI.puts "Adding '#{name}' build phase to '#{native_target.name}'"
+      native_target.new_shell_script_build_phase(name)
+    end
+
+    def dsym_phase_input_paths(phase)
+      (phase.input_paths + BUGSNAG_PHASE_INPUT_PATHS + target.framework_dsym_paths).uniq
+    end
+
     def should_add_build_phase?
       has_bugsnag_dep = target.target_definition.dependencies.any? do |dep|
-        dep.name.include?('Bugsnag')
+        dep.name.match?(/bugsnag/i)
       end
       uses_bugsnag_plugin = target.target_definition.podfile.plugins.key?('cocoapods-bugsnag')
       return has_bugsnag_dep && uses_bugsnag_plugin
     end
+  end
+end
 
-    def bugsnag_native_targets
-      @bugsnag_native_targets ||=(
-        native_targets.reject do |native_target|
-          native_target.shell_script_build_phases.any? do |bp|
-            bp.name == BUGSNAG_PHASE_NAME && bp.shell_script == BUGSNAG_PHASE_SCRIPT
-          end
-        end
-      )
+module Pod
+  class AggregateTarget
+    def framework_dsym_paths
+      return [] unless includes_frameworks?
+
+      framework_paths_by_config['Release'].map do |framework|
+        name = File.basename(framework.source_path, '.framework')
+        "#{framework.source_path}.dSYM/Contents/Resources/DWARF/#{name}"
+      end
     end
   end
 end

data/spec/cocoapods_bugsnag_spec.rb

@@ -1,3 +1,128 @@
-require 'bacon'
+# frozen_string_literal: true
 
+require 'cocoapods'
+require 'cocoapods_bugsnag'
+require 'tmpdir'
 
+# rubocop:disable Lint/MissingCopEnableDirective, Metrics/BlockLength
+
+RSpec.describe 'cocoapods-bugsnag' do
+  context 'with a user project' do
+    around(:each) do |t|
+      Dir.chdir(Dir.mktmpdir) { t.run }
+    end
+
+    let(:config) { Pod::Config.instance }
+
+    before do
+      user_project = Xcodeproj::Project.new('App.xcodeproj')
+      Pod::Generator::AppTargetHelper.add_app_target(user_project, :osx, '10.11')
+      user_project.save
+
+      CLAide::Command::PluginManager.load_plugins('cocoapods')
+    end
+
+    it 'adds a build phase if included in Podfile' do
+      File.write 'Podfile', <<~RUBY
+        use_frameworks!
+        plugin 'cocoapods-bugsnag'
+        target 'App' do
+          pod 'AFNetworking'
+          pod 'Bugsnag'
+        end
+      RUBY
+
+      installer = Pod::Installer.new(config.sandbox, config.podfile, config.lockfile)
+      installer.install!
+
+      expect(Pod::UI.output).to include "Adding 'Upload Bugsnag dSYM' build phase to 'App'"
+
+      expect(installer.aggregate_targets.flat_map(&:user_targets)).to all(satisfy do |target|
+        upload_phase = target.shell_script_build_phases.find { |bp| bp.name == 'Upload Bugsnag dSYM' }
+        expect(upload_phase.shell_path).to eq '/usr/bin/env ruby'
+        expect(upload_phase.shell_script).to include 'BUGSNAG_API_KEY'
+        expect(upload_phase.shell_script).to include 'SCRIPT_INPUT_FILE_COUNT'
+        expect(upload_phase.show_env_vars_in_log).to eq '0'
+        expect(upload_phase.input_paths).to eq %w[
+          ${BUILT_PRODUCTS_DIR}/${INFOPLIST_PATH}
+          ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${TARGET_NAME}
+          ${BUILT_PRODUCTS_DIR}/AFNetworking/AFNetworking.framework.dSYM/Contents/Resources/DWARF/AFNetworking
+          ${BUILT_PRODUCTS_DIR}/Bugsnag/Bugsnag.framework.dSYM/Contents/Resources/DWARF/Bugsnag
+        ]
+      end)
+    end
+
+    it 'does not remove existing input phases' do
+      File.write 'Podfile', <<~RUBY
+        use_frameworks!
+        plugin 'cocoapods-bugsnag'
+        target 'App' do
+          pod 'AFNetworking'
+          pod 'Bugsnag'
+        end
+      RUBY
+
+      installer = Pod::Installer.new(config.sandbox, config.podfile, config.lockfile)
+      installer.install!
+
+      expect(Pod::UI.output).to include "Adding 'Upload Bugsnag dSYM' build phase to 'App'"
+      Pod::UI.output = ''.dup
+
+      File.write 'Podfile', <<~RUBY
+        use_frameworks!
+        plugin 'cocoapods-bugsnag'
+        target 'App' do
+          # AFNetworking now omitted
+          pod 'Bugsnag'
+        end
+      RUBY
+
+      installer = Pod::Installer.new(config.sandbox, config.podfile, config.lockfile)
+      installer.install!
+
+      expect(Pod::UI.output).not_to include "Adding 'Upload Bugsnag dSYM' build phase to 'App'"
+
+      expect(installer.aggregate_targets.flat_map(&:user_targets)).to all(satisfy do |target|
+        upload_phase = target.shell_script_build_phases.find { |bp| bp.name == 'Upload Bugsnag dSYM' }
+        expect(upload_phase.input_paths).to include(
+          '${BUILT_PRODUCTS_DIR}/AFNetworking/AFNetworking.framework.dSYM/Contents/Resources/DWARF/AFNetworking'
+        )
+      end)
+    end
+
+    it 'does nothing if Bugsnag is not a dependency' do
+      File.write 'Podfile', <<~RUBY
+        plugin 'cocoapods-bugsnag'
+        target 'App'
+      RUBY
+
+      installer = Pod::Installer.new(config.sandbox, config.podfile, config.lockfile)
+      installer.install!
+
+      expect(Pod::UI.output).not_to include "Adding 'Upload Bugsnag dSYM' build phase to 'App'"
+
+      expect(installer.aggregate_targets.flat_map(&:user_targets)).to all(satisfy do |target|
+        upload_phase = target.shell_script_build_phases.find { |bp| bp.name == 'Upload Bugsnag dSYM' }
+        expect(upload_phase).to be_nil
+      end)
+    end
+
+    it 'does nothing if not added as a plugin' do
+      File.write 'Podfile', <<~RUBY
+        target 'App' do
+          pod 'Bugsnag'
+        end
+      RUBY
+
+      installer = Pod::Installer.new(config.sandbox, config.podfile, config.lockfile)
+      installer.install!
+
+      expect(Pod::UI.output).not_to include "Adding 'Upload Bugsnag dSYM' build phase to 'App'"
+
+      expect(installer.aggregate_targets.flat_map(&:user_targets)).to all(satisfy do |target|
+        upload_phase = target.shell_script_build_phases.find { |bp| bp.name == 'Upload Bugsnag dSYM' }
+        expect(upload_phase).to be_nil
+      end)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'cocoapods'
+
+module Pod
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    class << self
+      attr_accessor :output, :warnings, :next_input
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', _actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+
+      alias gets next_input
+
+      def print_warnings; end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Pod::UI.output = ''.dup
+    Pod::UI.warnings = ''.dup
+    Pod::UI.next_input = ''.dup
+    Pod::Config.instance = nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-bugsnag
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Delisa Mason
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: bacon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Configures the dSYM upload phase of your project when integrated with
   bugsnag.
 email:
@@ -68,11 +54,12 @@ files:
 - lib/cocoapods_bugsnag.rb
 - lib/cocoapods_plugin.rb
 - spec/cocoapods_bugsnag_spec.rb
+- spec/spec_helper.rb
 homepage: https://bugsnag.com
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -87,12 +74,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.14
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: To get meaningful stacktraces from your crashes, the Bugsnag service needs
   your dSYM file for your build. This plugin adds an upload phase to your project
   where needed.
 test_files:
 - spec/cocoapods_bugsnag_spec.rb
+- spec/spec_helper.rb