mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Riccardo Cipolleschi
34fafb2b88
Summary: This Diff adds a couple of APIs to the `react_native_pods.rb` file to simplify further the migration to the New Architecture for the iOS app. Specifically, it aims to simplify [this](https://reactnative.dev/docs/next/new-architecture-app-intro#ios---build-the-project) steps by offering a RN-managed min version and creating the .xcode.env file for the user if it is missing. ## Changelog [iOS][Added] - Add new API to simplify app migration Reviewed By: cortinico Differential Revision: D39469599 fbshipit-source-id: f0323e86c83c2731671fcd5bb4288071304bb43b
505 lines
18 KiB
Ruby
505 lines
18 KiB
Ruby
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
||
#
|
||
# This source code is licensed under the MIT license found in the
|
||
# LICENSE file in the root directory of this source tree.
|
||
|
||
require "test/unit"
|
||
require_relative "../utils.rb"
|
||
require_relative "../flipper.rb"
|
||
require_relative "./test_utils/PodMock.rb"
|
||
require_relative "./test_utils/InstallerMock.rb"
|
||
require_relative "./test_utils/EnvironmentMock.rb"
|
||
require_relative "./test_utils/SysctlCheckerMock.rb"
|
||
require_relative "./test_utils/FileMock.rb"
|
||
require_relative "./test_utils/systemUtils.rb"
|
||
require_relative "./test_utils/PathnameMock.rb"
|
||
|
||
class UtilsTests < Test::Unit::TestCase
|
||
def setup
|
||
@base_path = "~/app/ios"
|
||
Pathname.pwd!(@base_path)
|
||
File.enable_testing_mode!
|
||
end
|
||
|
||
def teardown
|
||
File.reset()
|
||
Pod::UI.reset()
|
||
Pathname.reset()
|
||
Pod::Config.reset()
|
||
SysctlChecker.reset()
|
||
Environment.reset()
|
||
ENV['RCT_NEW_ARCH_ENABLED'] = '0'
|
||
ENV['USE_HERMES'] = '1'
|
||
system_reset_commands
|
||
end
|
||
|
||
# ======================= #
|
||
# TEST - warnIfNotOnArm64 #
|
||
# ======================= #
|
||
|
||
def test_warnIfNotOnArm64_whenSysctlReturnsNot1_printsNothing
|
||
# Arrange
|
||
SysctlChecker.set_call_sysctl_arm64_return_value(23)
|
||
Environment.set_ruby_platform("something")
|
||
|
||
# Act
|
||
ReactNativePodsUtils.warn_if_not_on_arm64()
|
||
|
||
# Assert
|
||
assert_equal(Pod::UI.collected_messages, [])
|
||
assert_equal(Pod::UI.collected_warns, [])
|
||
|
||
end
|
||
|
||
def test_warnIfNotOnArm64_whenSysctlReturns1AndRubyIncludeArm64_printsNothing
|
||
# Arrange
|
||
SysctlChecker.set_call_sysctl_arm64_return_value(1)
|
||
Environment.set_ruby_platform("arm64-darwin21")
|
||
|
||
# Act
|
||
ReactNativePodsUtils.warn_if_not_on_arm64()
|
||
|
||
# Assert
|
||
assert_equal(Pod::UI.collected_messages, [])
|
||
assert_equal(Pod::UI.collected_warns, [])
|
||
end
|
||
|
||
def test_warnIfNotOnArm64_whenSysctlReturns1AndRubyNotIncludeArm64_warns
|
||
# Arrange
|
||
SysctlChecker.set_call_sysctl_arm64_return_value(1)
|
||
Environment.set_ruby_platform("something else")
|
||
|
||
# Act
|
||
ReactNativePodsUtils.warn_if_not_on_arm64()
|
||
|
||
# Assert
|
||
assert_equal(Pod::UI.collected_messages, [])
|
||
assert_equal(Pod::UI.collected_warns, [
|
||
'Do not use "pod install" from inside Rosetta2 (x86_64 emulation on arm64).',
|
||
' - Emulated x86_64 is slower than native arm64',
|
||
' - May result in mixed architectures in rubygems (eg: ffi_c.bundle files may be x86_64 with an arm64 interpreter)',
|
||
'Run "env /usr/bin/arch -arm64 /bin/bash --login" then try again.',
|
||
])
|
||
end
|
||
|
||
# ====================== #
|
||
# TEST - getDefaultFlags #
|
||
# ====================== #
|
||
def test_getDefaultFlag_whenOldArchitecture()
|
||
# Arrange
|
||
ENV['RCT_NEW_ARCH_ENABLED'] = '0'
|
||
|
||
# Act
|
||
flags = ReactNativePodsUtils.get_default_flags()
|
||
|
||
# Assert
|
||
assert_equal(flags, {
|
||
:fabric_enabled => false,
|
||
:hermes_enabled => true,
|
||
:flipper_configuration => FlipperConfiguration.disabled
|
||
})
|
||
end
|
||
|
||
def test_getDefaultFlag_whenOldArchitectureButHermesDisabled()
|
||
# Arrange
|
||
ENV['RCT_NEW_ARCH_ENABLED'] = '0'
|
||
ENV['USE_HERMES'] = '0'
|
||
|
||
# Act
|
||
flags = ReactNativePodsUtils.get_default_flags()
|
||
|
||
# Assert
|
||
assert_equal(flags, {
|
||
:fabric_enabled => false,
|
||
:hermes_enabled => false,
|
||
:flipper_configuration => FlipperConfiguration.disabled
|
||
})
|
||
end
|
||
|
||
def test_getDefaultFlag_whenNewArchitecture()
|
||
# Arrange
|
||
ENV['RCT_NEW_ARCH_ENABLED'] = '1'
|
||
|
||
# Act
|
||
flags = ReactNativePodsUtils.get_default_flags()
|
||
|
||
# Assert
|
||
assert_equal(flags, {
|
||
:fabric_enabled => true,
|
||
:hermes_enabled => true,
|
||
:flipper_configuration => FlipperConfiguration.disabled
|
||
})
|
||
end
|
||
|
||
def test_getDefaultFlag_whenNewArchitectureButHermesDisabled()
|
||
# Arrange
|
||
ENV['RCT_NEW_ARCH_ENABLED'] = '1'
|
||
ENV['USE_HERMES'] = '0'
|
||
|
||
# Act
|
||
flags = ReactNativePodsUtils.get_default_flags()
|
||
|
||
# Assert
|
||
assert_equal(flags, {
|
||
:fabric_enabled => true,
|
||
:hermes_enabled => false,
|
||
:flipper_configuration => FlipperConfiguration.disabled
|
||
})
|
||
end
|
||
|
||
# ============== #
|
||
# TEST - has_pod #
|
||
# ============== #
|
||
def test_hasPod_whenInstallerDoesNotHavePod_returnFalse
|
||
# Arrange
|
||
installer = InstallerMock.new(PodsProjectMock.new([], {"other_pod" => {}}))
|
||
|
||
# Act
|
||
result = ReactNativePodsUtils.has_pod(installer, "some_pod")
|
||
|
||
# Assert
|
||
assert_equal(result, false)
|
||
|
||
end
|
||
|
||
def test_hasPod_whenInstallerHasPod_returnTrue
|
||
# Arrange
|
||
installer = InstallerMock.new(PodsProjectMock.new([], {"some_pod" => {}}))
|
||
|
||
# Act
|
||
result = ReactNativePodsUtils.has_pod(installer, "some_pod")
|
||
|
||
# Assert
|
||
assert_equal(result, true)
|
||
end
|
||
|
||
# ============================ #
|
||
# Test - Exclude Architectures #
|
||
# ============================ #
|
||
def test_excludeArchitectures_whenHermesEngineIsNotIncluded_excludeNothing
|
||
# Arrange
|
||
user_project_mock = prepare_empty_user_project_mock()
|
||
pods_projects_mock = PodsProjectMock.new()
|
||
installer = InstallerMock.new(PodsProjectMock.new(), [
|
||
AggregatedProjectMock.new(user_project_mock)
|
||
])
|
||
|
||
# Act
|
||
ReactNativePodsUtils.exclude_i386_architecture_while_using_hermes(installer)
|
||
|
||
# Assert
|
||
user_project_mock.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["EXCLUDED_ARCHS[sdk=iphonesimulator*]"], "")
|
||
end
|
||
assert_equal(user_project_mock.save_invocation_count, 1)
|
||
assert_equal(pods_projects_mock.save_invocation_count, 0)
|
||
end
|
||
|
||
def test_excludeArchitectures_whenHermesEngineIsIncluded_excludeI386
|
||
# Arrange
|
||
user_project_mock = prepare_empty_user_project_mock()
|
||
pods_projects_mock = PodsProjectMock.new([], {"hermes-engine" => {}})
|
||
installer = InstallerMock.new(pods_projects_mock, [
|
||
AggregatedProjectMock.new(user_project_mock)
|
||
])
|
||
|
||
# Act
|
||
ReactNativePodsUtils.exclude_i386_architecture_while_using_hermes(installer)
|
||
|
||
# Assert
|
||
user_project_mock.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["EXCLUDED_ARCHS[sdk=iphonesimulator*]"], "i386")
|
||
end
|
||
|
||
assert_equal(user_project_mock.save_invocation_count, 1)
|
||
assert_equal(pods_projects_mock.save_invocation_count, 1)
|
||
end
|
||
|
||
# ================= #
|
||
# Test - Fix Config #
|
||
# ================= #
|
||
|
||
def test_fixLibrarySearchPath_whenThereIsNoSearchPaths_doNothing
|
||
# Arrange
|
||
buildConfig = BuildConfigurationMock.new("Debug")
|
||
|
||
# Act
|
||
ReactNativePodsUtils.fix_library_search_path(buildConfig)
|
||
|
||
# Assert
|
||
assert_nil(buildConfig.build_settings["LIBRARY_SEARCH_PATHS"])
|
||
end
|
||
|
||
def test_fixLibrarySearchPath_whenThereAreSearchPathsAndSwiftUnescaped_removesSwift5_5
|
||
# Arrange
|
||
buildConfig = BuildConfigurationMock.new("Debug", {"LIBRARY_SEARCH_PATHS" => [
|
||
"$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)",
|
||
"\"$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)\"",
|
||
"$(SDKROOT)/usr/lib/swift"
|
||
]})
|
||
|
||
# Act
|
||
ReactNativePodsUtils.fix_library_search_path(buildConfig)
|
||
|
||
# Assert
|
||
assert_equal(buildConfig.build_settings["LIBRARY_SEARCH_PATHS"], ["$(SDKROOT)/usr/lib/swift"])
|
||
end
|
||
|
||
def test_fixLibrarySearchPath_whenThereAreSearchPathsAndSwiftEscaped_removesSwift5_5
|
||
# Arrange
|
||
buildConfig = BuildConfigurationMock.new("Debug", {"LIBRARY_SEARCH_PATHS" => [
|
||
"$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)",
|
||
"\"$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)\"",
|
||
"another/path",
|
||
"\"$(SDKROOT)/usr/lib/swift\""
|
||
]})
|
||
|
||
# Act
|
||
ReactNativePodsUtils.fix_library_search_path(buildConfig)
|
||
|
||
# Assert
|
||
assert_equal(buildConfig.build_settings["LIBRARY_SEARCH_PATHS"], ["another/path", "\"$(SDKROOT)/usr/lib/swift\""])
|
||
end
|
||
|
||
def test_fixLibrarySearchPath_whenThereAreSearchPathsAndNoSwift_removesSwift5_5AndAddsSwiftAsFirst
|
||
# Arrange
|
||
buildConfig = BuildConfigurationMock.new("Debug", {"LIBRARY_SEARCH_PATHS" => [
|
||
"another/path"
|
||
]})
|
||
|
||
# Act
|
||
ReactNativePodsUtils.fix_library_search_path(buildConfig)
|
||
|
||
# Assert
|
||
assert_equal(buildConfig.build_settings["LIBRARY_SEARCH_PATHS"], ["$(SDKROOT)/usr/lib/swift", "another/path"])
|
||
end
|
||
|
||
# ============================== #
|
||
# Test - Fix Library Search Path #
|
||
# ============================== #
|
||
|
||
def test_fixLibrarySearchPaths_correctlySetsTheSearchPathsForAllProjects
|
||
first_target = prepare_target("FirstTarget")
|
||
second_target = prepare_target("SecondTarget")
|
||
third_target = prepare_target("ThirdTarget")
|
||
user_project_mock = UserProjectMock.new("a/path", [
|
||
prepare_config("Debug"),
|
||
prepare_config("Release"),
|
||
],
|
||
:native_targets => [
|
||
first_target,
|
||
second_target
|
||
]
|
||
)
|
||
pods_projects_mock = PodsProjectMock.new([], {"hermes-engine" => {}}, :native_targets => [
|
||
third_target
|
||
])
|
||
installer = InstallerMock.new(pods_projects_mock, [
|
||
AggregatedProjectMock.new(user_project_mock)
|
||
])
|
||
|
||
# Act
|
||
ReactNativePodsUtils.fix_library_search_paths(installer)
|
||
|
||
# Assert
|
||
user_project_mock.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["LIBRARY_SEARCH_PATHS"], [
|
||
"$(SDKROOT)/usr/lib/swift", "another/path"
|
||
])
|
||
end
|
||
|
||
user_project_mock.native_targets.each do |target|
|
||
target.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["LIBRARY_SEARCH_PATHS"], [
|
||
"$(SDKROOT)/usr/lib/swift", "another/path"
|
||
])
|
||
end
|
||
end
|
||
|
||
pods_projects_mock.native_targets.each do |target|
|
||
target.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["LIBRARY_SEARCH_PATHS"], [
|
||
"$(SDKROOT)/usr/lib/swift", "another/path"
|
||
])
|
||
end
|
||
end
|
||
|
||
assert_equal(user_project_mock.save_invocation_count, 1)
|
||
assert_equal(pods_projects_mock.save_invocation_count, 1)
|
||
end
|
||
|
||
# ============================================= #
|
||
# Test - Fix React-bridging Header Search Paths #
|
||
# ============================================= #
|
||
|
||
def test_fixReactBridgingHeaderSearchPaths_correctlySetsTheHeaderSearchPathsForAllTargets
|
||
# Arrange
|
||
first_target = prepare_target("FirstTarget")
|
||
second_target = prepare_target("SecondTarget")
|
||
third_target = TargetMock.new("ThirdTarget", [
|
||
BuildConfigurationMock.new("Debug", {
|
||
"HEADER_SEARCH_PATHS" => '$(inherited) "${PODS_ROOT}/Headers/Public" '
|
||
}),
|
||
BuildConfigurationMock.new("Release", {
|
||
"HEADER_SEARCH_PATHS" => '$(inherited) "${PODS_ROOT}/Headers/Public" '
|
||
}),
|
||
], nil)
|
||
|
||
user_project_mock = UserProjectMock.new("a/path", [
|
||
prepare_config("Debug"),
|
||
prepare_config("Release"),
|
||
],
|
||
:native_targets => [
|
||
first_target,
|
||
second_target
|
||
]
|
||
)
|
||
pods_projects_mock = PodsProjectMock.new([], {"hermes-engine" => {}}, :native_targets => [
|
||
third_target
|
||
])
|
||
installer = InstallerMock.new(pods_projects_mock, [
|
||
AggregatedProjectMock.new(user_project_mock)
|
||
])
|
||
|
||
# Act
|
||
ReactNativePodsUtils.fix_react_bridging_header_search_paths(installer)
|
||
|
||
# Assert
|
||
first_target.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["HEADER_SEARCH_PATHS"].strip,
|
||
'$(inherited) "$(PODS_ROOT)/Headers/Private/React-bridging/react/bridging" "$(PODS_CONFIGURATION_BUILD_DIR)/React-bridging/react_bridging.framework/Headers"'
|
||
)
|
||
end
|
||
second_target.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["HEADER_SEARCH_PATHS"].strip,
|
||
'$(inherited) "$(PODS_ROOT)/Headers/Private/React-bridging/react/bridging" "$(PODS_CONFIGURATION_BUILD_DIR)/React-bridging/react_bridging.framework/Headers"'
|
||
)
|
||
end
|
||
third_target.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["HEADER_SEARCH_PATHS"].strip,
|
||
'$(inherited) "${PODS_ROOT}/Headers/Public" "$(PODS_ROOT)/Headers/Private/React-bridging/react/bridging" "$(PODS_CONFIGURATION_BUILD_DIR)/React-bridging/react_bridging.framework/Headers"'
|
||
)
|
||
end
|
||
end
|
||
|
||
# ================================= #
|
||
# Test - Apply Mac Catalyst Patches #
|
||
# ================================= #
|
||
|
||
def test_applyMacCatalystPatches_correctlyAppliesNecessaryPatches
|
||
first_target = prepare_target("FirstTarget")
|
||
second_target = prepare_target("SecondTarget")
|
||
third_target = prepare_target("ThirdTarget", "com.apple.product-type.bundle")
|
||
user_project_mock = UserProjectMock.new("a/path", [
|
||
prepare_config("Debug"),
|
||
prepare_config("Release"),
|
||
],
|
||
:native_targets => [
|
||
first_target,
|
||
second_target
|
||
]
|
||
)
|
||
pods_projects_mock = PodsProjectMock.new([third_target], {"hermes-engine" => {}}, :native_targets => [])
|
||
installer = InstallerMock.new(pods_projects_mock, [
|
||
AggregatedProjectMock.new(user_project_mock)
|
||
])
|
||
|
||
# Act
|
||
ReactNativePodsUtils.apply_mac_catalyst_patches(installer)
|
||
|
||
# Assert
|
||
first_target.build_configurations.each do |config|
|
||
assert_nil(config.build_settings["CODE_SIGN_IDENTITY[sdk=macosx*]"])
|
||
end
|
||
|
||
second_target.build_configurations.each do |config|
|
||
assert_nil(config.build_settings["CODE_SIGN_IDENTITY[sdk=macosx*]"])
|
||
end
|
||
|
||
third_target.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["CODE_SIGN_IDENTITY[sdk=macosx*]"], "-")
|
||
end
|
||
|
||
user_project_mock.native_targets.each do |target|
|
||
target.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["DEAD_CODE_STRIPPING"], "YES")
|
||
assert_equal(config.build_settings["PRESERVE_DEAD_CODE_INITS_AND_TERMS"], "YES")
|
||
assert_equal(config.build_settings["LIBRARY_SEARCH_PATHS"], ["$(SDKROOT)/usr/lib/swift", "$(SDKROOT)/System/iOSSupport/usr/lib/swift", "$(inherited)"])
|
||
end
|
||
end
|
||
|
||
assert_equal(user_project_mock.save_invocation_count, 1)
|
||
end
|
||
|
||
# ==================================== #
|
||
# Test - Set Node_Modules User Setting #
|
||
# ==================================== #
|
||
|
||
def test_setNodeModulesUserSettings_addTheUserSetting
|
||
# Arrange
|
||
react_native_path = "react_native/node_modules"
|
||
user_project_mock = prepare_empty_user_project_mock()
|
||
pods_projects_mock = PodsProjectMock.new([], {"hermes-engine" => {}})
|
||
installer = InstallerMock.new(pods_projects_mock, [
|
||
AggregatedProjectMock.new(user_project_mock)
|
||
])
|
||
|
||
# Act
|
||
ReactNativePodsUtils.set_node_modules_user_settings(installer, react_native_path)
|
||
|
||
# Assert
|
||
user_project_mock.build_configurations.each do |config|
|
||
assert_equal(config.build_settings["REACT_NATIVE_PATH"], "${PODS_ROOT}/../#{react_native_path}")
|
||
end
|
||
|
||
assert_equal(user_project_mock.save_invocation_count, 1)
|
||
assert_equal(pods_projects_mock.save_invocation_count, 1)
|
||
assert_equal(Pod::UI.collected_messages, ["Setting REACT_NATIVE build settings"])
|
||
end
|
||
|
||
# =================================== #
|
||
# Test - Prepare React Native Project #
|
||
# =================================== #
|
||
def test_createXcodeEnvIfMissing_whenItIsPresent_doNothing
|
||
# Arrange
|
||
File.mocked_existing_files("/.xcode.env")
|
||
# Act
|
||
ReactNativePodsUtils.create_xcode_env_if_missing
|
||
# Assert
|
||
assert_equal(File.exist_invocation_params, ["/.xcode.env"])
|
||
assert_equal($collected_commands, [])
|
||
end
|
||
|
||
def test_createXcodeEnvIfMissing_whenItIsNotPresent_createsIt
|
||
# Arrange
|
||
|
||
# Act
|
||
ReactNativePodsUtils.create_xcode_env_if_missing
|
||
# Assert
|
||
assert_equal(File.exist_invocation_params, ["/.xcode.env"])
|
||
assert_equal($collected_commands, ["echo 'export NODE_BINARY=$(command -v node)' > /.xcode.env"])
|
||
end
|
||
end
|
||
|
||
def prepare_empty_user_project_mock
|
||
return UserProjectMock.new("a/path", [
|
||
BuildConfigurationMock.new("Debug"),
|
||
BuildConfigurationMock.new("Release"),
|
||
])
|
||
end
|
||
|
||
def prepare_config(config_name)
|
||
return BuildConfigurationMock.new(config_name, {"LIBRARY_SEARCH_PATHS" => [
|
||
"$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)",
|
||
"\"$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)\"",
|
||
"another/path",
|
||
]})
|
||
end
|
||
|
||
def prepare_target(name, product_type = nil)
|
||
return TargetMock.new(name, [
|
||
prepare_config("Debug"),
|
||
prepare_config("Release")
|
||
], product_type)
|
||
end
|