Skip to content

Commit

Permalink
Apply Xcode 11 XCTUnwrap fix to library and framwork targets.
Browse files Browse the repository at this point in the history
  • Loading branch information
dnkoutso committed Jan 21, 2020
1 parent e62532c commit 5603f1d
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 7 deletions.
19 changes: 19 additions & 0 deletions lib/cocoapods/target/build_settings.rb
Expand Up @@ -1037,6 +1037,12 @@ def initialize(target, configuration_name, configuration: nil)
[]
end

# @return [Array<String>]
define_build_settings_method :system_framework_search_paths, :build_setting => true, :memoized => true, :sorted => true, :uniqued => true do
return ['$(PLATFORM_DIR)/Developer/usr/lib'] if should_apply_xctunwrap_fix?
[]
end

#-------------------------------------------------------------------------#

# @!group Libraries
Expand All @@ -1048,6 +1054,7 @@ def initialize(target, configuration_name, configuration: nil)

# @return [Array<String>]
define_build_settings_method :library_search_paths, :build_setting => true, :memoized => true, :sorted => true, :uniqued => true, :from_pod_targets_to_link => true, :from_search_paths_aggregate_targets => :vendored_dynamic_library_search_paths do
return ['$(PLATFORM_DIR)/Developer/usr/lib'] if should_apply_xctunwrap_fix?
[]
end

Expand Down Expand Up @@ -1113,6 +1120,7 @@ def other_swift_flags_without_swift?

# @return [Array<String>]
define_build_settings_method :swift_include_paths, :build_setting => true, :memoized => true, :sorted => true, :uniqued => true, :from_pod_targets_to_link => true, :from_search_paths_aggregate_targets => :swift_include_paths_to_import do
return ['$(PLATFORM_DIR)/Developer/usr/lib'] if should_apply_xctunwrap_fix?
[]
end

Expand Down Expand Up @@ -1246,6 +1254,17 @@ def user_target_xcconfig_values_by_consumer_by_key
merged_xcconfigs(user_target_xcconfig_values_by_consumer_by_key, :user_target_xcconfig)
end

# Xcode 11 causes an issue with frameworks or libraries before 12.2 deployment target that link or are part of
# test bundles that use XCTUnwrap. Apple has provided an official work around for this.
#
# @see https://developer.apple.com/documentation/xcode_release_notes/xcode_11_release_notes
#
# @return [Boolean] Whether to apply the fix or not.
#
def should_apply_xctunwrap_fix?
target.library? && target.user_targets.any? { |ut| Version.new(ut.deployment_target) <= Version.new('12.1')}
end

#-------------------------------------------------------------------------#
end
end
Expand Down
6 changes: 4 additions & 2 deletions spec/spec_helper.rb
Expand Up @@ -138,10 +138,12 @@ def fixture_pod_target_with_specs(specs, build_type = Pod::BuildType.static_libr

def fixture_aggregate_target(pod_targets = [], build_type = Pod::BuildType.static_library,
user_build_configurations = Pod::Target::DEFAULT_BUILD_CONFIGURATIONS, archs = [],
platform = Pod::Platform.new(:ios, '6.0'), target_definition = nil)
platform = Pod::Platform.new(:ios, '6.0'), target_definition = nil, user_project = nil,
user_target_uuids = [])
target_definition ||= pod_targets.flat_map(&:target_definitions).first || fixture_target_definition
Pod::AggregateTarget.new(config.sandbox, build_type, user_build_configurations, archs, platform,
target_definition, config.sandbox.root.dirname, nil, nil, 'Release' => pod_targets)
target_definition, config.sandbox.root.dirname, user_project, user_target_uuids,
'Release' => pod_targets)
end

#-----------------------------------------------------------------------------#
Expand Down
54 changes: 49 additions & 5 deletions spec/unit/target/build_settings/aggregate_target_settings_spec.rb
Expand Up @@ -13,13 +13,18 @@ def pod_target(spec, target_definition)
end

before do
@target_definition = fixture_target_definition
project_path = SpecHelper.create_sample_app_copy_from_fixture('SampleProject')
@project = Xcodeproj::Project.open(project_path)
@project.save
@native_target = @project.targets.find { |t| t.name == 'SampleProject' }
@target_definition = fixture_target_definition('SampleProject')
@specs = specs
@specs.first.user_target_xcconfig = { 'OTHER_LDFLAGS' => '-no_compact_unwind', 'USE_HEADERMAP' => 'NO' } unless @specs.empty?
@specs.first.pod_target_xcconfig = { 'CLANG_CXX_LANGUAGE_STANDARD' => 'c++11' } unless @specs.empty?
@pod_targets = @specs.map { |spec| pod_target(spec, @target_definition) }
@target = fixture_aggregate_target(@pod_targets, BuildType.static_library, { 'Release' => :release }, [],
Platform.new(:ios, '6.0'), @target_definition)
Platform.new(:ios, '6.0'), @target_definition, @project,
[@native_target.uuid])
unless @specs.empty?
@target.target_definition.whitelist_pod_for_configuration(@specs.first.name, 'Release')
end
Expand Down Expand Up @@ -190,7 +195,7 @@ def pod_target(spec, target_definition)
end

it 'links the pod targets with the aggregate target' do
@xcconfig.to_hash['OTHER_LDFLAGS'].should.include '-l"BananaLib-Pods"'
@xcconfig.to_hash['OTHER_LDFLAGS'].should.include '-l"BananaLib-Pods-SampleProject"'
end
end

Expand Down Expand Up @@ -316,6 +321,43 @@ def specs
@target.stubs(:build_type => BuildType.static_library)
@generator.generate.to_hash['LD_RUNPATH_SEARCH_PATHS'].should == "$(inherited) '@executable_path/Frameworks' '@loader_path/Frameworks'"
end

it 'includes the xctunwrap fix for library targets with iOS deployment target <= 12.1' do
SpecHelper.create_sample_app_copy_from_fixture('SampleProject/Sample Lib')
project_path = File.join(temporary_directory, 'SampleProject', 'Sample Lib', 'Sample Lib.xcodeproj')
project = Xcodeproj::Project.open(project_path)
project.save
native_target = project.targets.find { |t| t.name == 'SampleFramework' }
target_definition = fixture_target_definition('SampleFramework')
pod_targets = specs.map { |spec| pod_target(spec, target_definition) }
target = fixture_aggregate_target(pod_targets, BuildType.static_library, { 'Release' => :release }, [],
Platform.new(:ios, '6.0'), target_definition, project,
[native_target.uuid])
generator = AggregateTargetSettings.new(target, 'Release', :configuration => :release)
hash = generator.generate.to_hash
hash['SYSTEM_FRAMEWORK_SEARCH_PATHS'].should.include '"$(PLATFORM_DIR)/Developer/usr/lib"'
hash['LIBRARY_SEARCH_PATHS'].should.include '"$(PLATFORM_DIR)/Developer/usr/lib"'
hash['SWIFT_INCLUDE_PATHS'].should.include '"$(PLATFORM_DIR)/Developer/usr/lib"'
end

it 'does not include xctunwrap fix for a library target with higher than 12.1 deployment target' do
SpecHelper.create_sample_app_copy_from_fixture('SampleProject/Sample Lib')
project_path = File.join(temporary_directory, 'SampleProject', 'Sample Lib', 'Sample Lib.xcodeproj')
project = Xcodeproj::Project.open(project_path)
project.save
native_target = project.targets.find { |t| t.name == 'SampleFramework' }
native_target.stubs(:deployment_target).returns('12.2')
target_definition = fixture_target_definition('SampleFramework')
pod_targets = specs.map { |spec| pod_target(spec, target_definition) }
target = fixture_aggregate_target(pod_targets, BuildType.static_library, { 'Release' => :release }, [],
Platform.new(:ios, '12.2'), target_definition, project,
[native_target.uuid])
generator = AggregateTargetSettings.new(target, 'Release', :configuration => :release)
hash = generator.generate.to_hash
hash['SYSTEM_FRAMEWORK_SEARCH_PATHS'].should.be.nil
hash['LIBRARY_SEARCH_PATHS'].should.not.include '"$(PLATFORM_DIR)/Developer/usr/lib"'
hash['SWIFT_INCLUDE_PATHS'].should.be.nil
end
end

describe 'with a scoped pod target' do
Expand Down Expand Up @@ -387,14 +429,16 @@ def pod_target(spec, target_definition)

it 'includes correct default runpath search path list for OSX unit test bundle user target' do
@target.stubs(:platform).returns(Platform.new(:osx, '10.10'))
mock_user_target = mock('usertarget', :symbol_type => :unit_test_bundle)
mock_user_target = mock('usertarget')
mock_user_target.stubs(:symbol_type).returns(:unit_test_bundle)
@target.stubs(:user_targets).returns([mock_user_target])
@generator.generate.to_hash['LD_RUNPATH_SEARCH_PATHS'].should == "$(inherited) '@executable_path/../Frameworks' '@loader_path/../Frameworks'"
end

it 'includes correct default runpath search path list for OSX application user target' do
@target.stubs(:platform).returns(Platform.new(:osx, '10.10'))
mock_user_target = mock('usertarget', :symbol_type => :application)
mock_user_target = mock('usertarget')
mock_user_target.stubs(:symbol_type).returns(:application)
@target.stubs(:user_targets).returns([mock_user_target])
@generator.generate.to_hash['LD_RUNPATH_SEARCH_PATHS'].should == "$(inherited) '@executable_path/../Frameworks' '@loader_path/Frameworks'"
end
Expand Down

0 comments on commit 5603f1d

Please sign in to comment.