Repository navigation
Expand file tree
/
Copy pathfirebase_spm_test.rb
More file actions
3394 lines (2776 loc) · 137 KB
/
Copy pathfirebase_spm_test.rb
File metadata and controls
3394 lines (2776 loc) · 137 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# frozen_string_literal: true
# rubocop:disable Metrics, Style/Documentation, Style/OneClassPerFile, Style/GlobalVars, Naming/MethodName
require 'minitest/autorun'
require 'json'
# Mock Pod::Specification to capture dependency calls
class MockSpec
attr_reader :dependencies, :name
def initialize(name: 'RNFBApp')
@dependencies = []
@name = name
end
def dependency(name, version)
@dependencies << { name: name, version: version }
end
end
# Mocks for rnfirebase_add_spm_embed_phase's Xcodeproj-shaped installer walk.
# These stand in for real Xcodeproj::Project::Object::PBX* types so the
# embed-phase logic can be tested without CocoaPods/Xcodeproj installed.
class MockPhase
attr_accessor :name, :shell_script, :shell_path, :always_out_of_date, :input_paths, :output_paths
def initialize(name)
@name = name
end
end
class MockTarget
attr_reader :shell_script_build_phases, :build_configurations, :dependencies
attr_accessor :package_product_dependencies, :name
def initialize(phase_names = [], package_product_dependencies: [], build_config_names: %w[Debug Release],
name: 'testing')
@shell_script_build_phases = phase_names.map { |phase_name| MockPhase.new(phase_name) }
@package_product_dependencies = package_product_dependencies
@build_configurations = build_config_names.map { |config_name| MockBuildConfig.new(config_name) }
@dependencies = []
@name = name
end
# Mirrors `PBXNativeTarget#add_dependency` for the probe order aggregate.
def add_dependency(other)
@dependencies << MockTargetDependency.new(other, nil)
end
def new_shell_script_build_phase(name)
phase = MockPhase.new(name)
@shell_script_build_phases << phase
phase
end
# Mirrors `AbstractTarget#build_settings(name)` → the named configuration's
# `build_settings` hash. `rnfirebase_add_spm_core_to_app_target` uses this
# API; `rnfirebase_apply_spm_build_settings` reads `config.build_settings`
# directly — both must see the same mutable hash.
def build_settings(config_name)
config = @build_configurations.find { |c| c.name == config_name }
config.build_settings
end
# Mirrors `PBXNativeTarget#frameworks_build_phase` (singular) → finds or
# creates the target's one `PBXFrameworksBuildPhase`. Defaults to an empty
# phase so every pre-existing test that never calls this keeps passing
# unmodified -- this method, and the `files` collection it exposes, did not
# exist on this mock before the fix for the missing `PBXBuildFile` link.
def frameworks_build_phase
@frameworks_build_phase ||= MockFrameworksBuildPhase.new
end
end
# Mirrors `Xcodeproj::Project::Object::PBXFrameworksBuildPhase`'s
# `has_many :files, PBXBuildFile` -- the real collection
# `rnfirebase_add_spm_core_to_app_target` must append a `PBXBuildFile` to in
# order for Xcode to actually link a package product dependency, not just
# declare it (see `MockTarget#frameworks_build_phase` above).
class MockFrameworksBuildPhase
attr_accessor :files
def initialize
@files = []
end
end
class MockUserProject
attr_reader :native_targets, :root_object
attr_accessor :save_count
def initialize(native_targets, package_references: [])
@native_targets = native_targets
@root_object = MockRootObject.new(package_references)
@save_count = 0
end
# Stands in for `Xcodeproj::Project#new(klass)`, which allocates a
# project-managed object of the given class.
def new(klass)
klass.new
end
def save
@save_count += 1
end
end
# Stands in for `Xcodeproj::Project::Object::PBXProject` (the real
# `Xcodeproj::Project#root_object`) -- specifically its `package_references`
# attribute (a `has_many :package_references, [XCRemoteSwiftPackageReference,
# XCLocalSwiftPackageReference]` collection), the only part of it
# rnfirebase_add_spm_core_to_app_target / rnfirebase_remove_spm_core_from_app_target
# read and mutate directly.
class MockRootObject
attr_accessor :package_references
def initialize(package_references = [])
@package_references = package_references
end
end
# Mocks for rnfirebase_add_spm_core_to_app_target /
# rnfirebase_remove_spm_core_from_app_target's use of
# Xcodeproj::Project::Object::XCRemoteSwiftPackageReference /
# XCSwiftPackageProductDependency. Defined under the real `Xcodeproj::Project::Object`
# namespace so production code's direct class references resolve to these
# lightweight stand-ins, instead of requiring the real (much heavier) `xcodeproj`
# gem. Local/Linux `yarn tests:ios:ruby` runs without installing xcodeproj;
# CI shape coverage lives on tests_e2e_ios.yml (debug + spm) after
# `BUNDLE_FROZEN=true bundle install` on the root Gemfile.
module Xcodeproj
module Project
module Object
class XCRemoteSwiftPackageReference
attr_accessor :repositoryURL, :requirement
attr_reader :referrers
def initialize
@referrers = []
end
def add_referrer(referrer)
@referrers << referrer
end
def remove_referrer(referrer)
@referrers.delete(referrer)
end
def remove_from_project
@referrers.clear
end
end
class XCLocalSwiftPackageReference < XCRemoteSwiftPackageReference
attr_accessor :relative_path
end
class XCSwiftPackageProductDependency
attr_reader :package
attr_accessor :product_name
def package=(new_package)
@package&.remove_referrer(self)
@package = new_package
new_package&.add_referrer(self)
end
def remove_from_project
@package&.remove_referrer(self)
end
end
# Mirrors `Xcodeproj::Project::Object::PBXBuildFile` -- specifically its
# `has_one :product_ref, XCSwiftPackageProductDependency` attribute, the
# real one `rnfirebase_add_spm_core_to_app_target` must set (not
# `file_ref`, which is for plain file references) so a package product
# dependency actually gets linked into the target's Frameworks build
# phase, rather than merely declared on
# `target.package_product_dependencies`. `file_ref` is modeled too, for
# completeness, but unused by production code here.
class PBXBuildFile
attr_accessor :product_ref, :file_ref
end
class PBXTargetDependency
attr_accessor :product_ref, :target, :name, :target_proxy
end
end
end
end
# Stands in for `Xcodeproj::Project::Object::XCBuildConfiguration`, the real
# element type of `AbstractTarget#build_configurations`. Exposes both `name`
# (for `target.build_settings(config.name)`) and a mutable `build_settings`
# hash (for `rnfirebase_apply_spm_build_settings`, which reads
# `config.build_settings` directly).
# Target dependency that records either a same-project target or a package productRef.
class MockTargetDependency
attr_accessor :target, :product_ref
def initialize(target, product_ref)
@target = target
@product_ref = product_ref
end
end
class MockBuildConfig
attr_reader :name, :build_settings
def initialize(name)
@name = name
@build_settings = {}
end
end
# Stand-ins for `Pod::BuildType` and `Pod::Podfile::TargetDefinition`, just
# deep enough for `rnfirebase_fail_if_spm_static_linkage!` to read
# `target.target_definition.build_type.static?` -- the actual source of
# truth for the Podfile's `use_frameworks!(:linkage => ...)` choice.
#
# Deliberately *not* `AggregateTarget#build_as_static?` itself: real
# CocoaPods hardcodes every aggregate ("Pods-<target>") target's own
# `build_type` to `static_framework`/`static_library` regardless of
# `:linkage` (see `Installer::Analyzer#generate_aggregate_target`), so it's
# always `true` and can't distinguish the case this check cares about.
class MockBuildType
attr_reader :kind
def self.dynamic_framework
new(kind: :dynamic_framework)
end
def self.static_framework
new(kind: :static_framework)
end
def self.static_library
new(kind: :static_library)
end
def initialize(static: false, kind: nil)
@kind = kind || (static ? :static_framework : :dynamic_framework)
end
def static?
%i[static_framework static_library].include?(@kind)
end
def ==(other)
other.is_a?(MockBuildType) && other.kind == kind
end
end
# `uses_frameworks: false` models a Podfile with no `use_frameworks!` at all:
# real CocoaPods then reports a `static_library` build type, which is also
# `static?`, so the check must name that case distinctly in its message.
class MockTargetDefinition
attr_reader :build_type
def initialize(static: false, uses_frameworks: true)
@uses_frameworks = uses_frameworks
@build_type = uses_frameworks ? MockBuildType.new(static: static) : MockBuildType.static_library
end
def uses_frameworks?
@uses_frameworks
end
end
# Stands in for `Pod::AggregateTarget` -- specifically its `user_project`
# (`Xcodeproj::Project`) and `target_definition`
# (`Pod::Podfile::TargetDefinition`) attributes, the two real properties
# every `rnfirebase_*` post-install helper in firebase_spm.rb actually reads
# off an `installer.aggregate_targets` entry. Deliberately does *not* model
# `Pod::Target#build_as_static?`/`#build_type` (the real aggregate target's
# own, always-static build type) -- see `MockBuildType`'s comment above for
# why that would model the wrong signal entirely for this check.
class MockAggregateTarget
attr_reader :user_project, :name, :target_definition
def initialize(user_project, name: 'Pods-testing', static_linkage: false, uses_frameworks: true)
@user_project = user_project
@name = name
@target_definition = MockTargetDefinition.new(static: static_linkage, uses_frameworks: uses_frameworks)
end
end
# Stands in for `Pod::Informative` (CocoaPods' user-facing error class) so
# `rnfirebase_fail_if_spm_static_linkage!` can be tested without the real
# `cocoapods-core` gem installed in this dependency-free Ruby unit-test job.
unless defined?(Pod::Informative)
module Pod
class Informative < StandardError
end
end
end
Pod.const_set(:BuildType, MockBuildType) unless defined?(Pod::BuildType)
class MockPodTarget
attr_reader :name, :build_type
def initialize(name, build_type:)
@name = name
@build_type = build_type
end
end
# Stands in for `Pod::UI` (CocoaPods' user-facing output helper) so tests can
# assert on `Pod::UI.warn` calls -- e.g. from `rnfirebase_hook_cocoapods_post_install!`'s
# guard clauses -- without the real `cocoapods-core` gem installed in this
# dependency-free Ruby unit-test job. Collects everything printed so tests
# can assert on it; cleared in `setup` below since (like `Pod::Informative`
# above) it can't be "undefined" again once defined in this process.
unless defined?(Pod::UI)
module Pod
module UI
class << self
attr_accessor :warnings, :messages
end
def self.warn(message)
(self.warnings ||= []) << message
end
def self.puts(message)
(self.messages ||= []) << message
end
end
end
end
# `colored2` (a real CocoaPods dependency) patches `String#yellow` etc.,
# used by a couple of existing `Pod::UI.puts "...".yellow + ...` call sites
# in firebase_spm.rb. Stubbed as a no-op here so those call sites don't
# raise `NoMethodError` now that `defined?(Pod::UI)` is true above.
unless String.method_defined?(:yellow)
class String
def yellow
self
end
end
end
# Stands in for `Pod::Installer` -- specifically its `aggregate_targets`
# attribute (a plain `attr_reader`), the only part of the real installer
# every `rnfirebase_*` post-install helper in firebase_spm.rb actually reads.
# Optional `pods_project` covers `rnfirebase_ensure_pods_uuid_counter_safe!`
# / `rnfirebase_verify_pods_project_uuid_integrity!`.
# `rnfirebase_hook_cocoapods_post_install!` itself is tested separately,
# against a fake class shaped like `Pod::Installer` (see
# `new_fake_cocoapods_installer_class` below), since there's no real
# `Pod::Installer` to alias/wrap without a full CocoaPods environment.
class MockInstaller
attr_reader :aggregate_targets, :pods_project, :pod_targets, :podfile
def initialize(aggregate_targets, pods_project: nil, pod_targets: [], podfile: nil)
@aggregate_targets = aggregate_targets
@pods_project = pods_project
@pod_targets = pod_targets
@podfile = podfile
end
end
# Stands in for `Pod::Project` (CocoaPods' Xcodeproj subclass) -- specifically
# `@uuid_prefix`, `@generated_uuids`, `@available_uuids`, `objects_by_uuid`,
# and `root_object`, the surfaces
# `rnfirebase_ensure_pods_uuid_counter_safe!` /
# `rnfirebase_verify_pods_project_uuid_integrity!` read and mutate.
class MockPodsProject
attr_reader :objects_by_uuid, :targets
attr_accessor :root_object, :save_count
def initialize(uuid_prefix:, objects_by_uuid: {}, generated_uuids: [], available_uuids: [], root_object: nil,
targets: [])
@uuid_prefix = uuid_prefix
@objects_by_uuid = objects_by_uuid
@generated_uuids = generated_uuids
@available_uuids = available_uuids
@root_object = root_object
@targets = targets
@save_count = 0
end
def save
@save_count += 1
end
def new(klass)
klass.new
end
def new_aggregate_target(name)
target = MockTarget.new([], name: name)
@targets << target
target
end
end
# Stands in for an `Xcodeproj::Project::Object` entry in `objects_by_uuid` --
# only `uuid` + `isa` are needed for the Pods UUID integrity check.
class MockProjectObject
attr_reader :uuid, :isa
def initialize(uuid, isa:)
@uuid = uuid
@isa = isa
end
end
class FirebaseSpmTest < Minitest::Test
def setup
# Remove spm_dependency if defined from a previous test
if defined?(spm_dependency)
Object.send(:remove_method, :spm_dependency)
end
# NOTE: a Ruby global variable can't be "undefined" again once assigned in this
# process, so `defined?($RNFirebaseDisableSPM)` stays true for the rest of the
# suite after the first test that touches it. Resetting the value to nil (rather
# than relying on `defined?` alone) is exactly the behavior rnfirebase_spm_disabled?
# is meant to guard against, so tests below assert on it explicitly.
$RNFirebaseDisableSPM = nil
ENV.delete('RNFB_TEST_RN_BARE_DYNAMIC_FIREBASE')
# `RNFirebaseSPM` gives us a real, deliberate reset primitive for the SPM
# active/version/url state instead of relying on that same one-way-`defined?`
# workaround -- unlike a bare global, `reset!` can put it back to a genuinely
# "never activated" state between tests, not just back to a falsy value.
# Guarded with `defined?` because the very first test's `setup` runs before
# any test has `load`ed firebase_spm.rb yet, so the constant doesn't exist.
RNFirebaseSPM.reset! if defined?(RNFirebaseSPM)
@expo_created_by_test = false
Expo.send(:remove_const, :PrecompiledModules) if defined?(Expo::PrecompiledModules)
# Outer Expo constant removal is ownership-gated: see teardown.
# Reset the `Pod::UI` mock's captured output between tests.
Pod::UI.warnings = []
Pod::UI.messages = []
end
def load_firebase_spm
# Force re-evaluation of the file
load File.join(__dir__, '..', 'firebase_spm.rb')
end
# Removes the outer `Expo` constant only when this test instance created it
# (tracked via @expo_created_by_test) and it is still an empty module. A
# pre-existing Expo constant that existed before the test ran is preserved.
# Direct testing of teardown mechanics is impractical without calling teardown
# manually or examining cross-instance state; the Expo restore tests exercise
# the full create-use-clean path through the normal Minitest lifecycle.
def teardown
Expo.send(:remove_const, :PrecompiledModules) if defined?(Expo::PrecompiledModules)
return unless @expo_created_by_test
Object.send(:remove_const, :Expo) if defined?(Expo) && Expo.is_a?(Module) && Expo.constants.empty?
end
# Creates the outer `Expo` module if not already defined, marking this test
# instance as the owner so teardown can remove it. Both
# `stub_expo_precompiled_modules` and any test that manually constructs a
# partial `Expo::PrecompiledModules` must go through this helper.
def ensure_expo_module!
return if defined?(Expo)
Object.const_set(:Expo, Module.new)
@expo_created_by_test = true
end
def stub_expo_precompiled_modules(enabled:, linkage:)
ensure_expo_module!
precompiled_modules = Module.new
precompiled_modules.define_singleton_method(:enabled?) { enabled }
precompiled_modules.define_singleton_method(:linkage) { |_| linkage }
Expo.const_set(:PrecompiledModules, precompiled_modules)
end
# ── Missing spm_dependency fails loud (CocoaPods Firebase path removed) ──
def test_missing_spm_single_product_fails_loud
load_firebase_spm
spec = MockSpec.new
error = assert_raises(Pod::Informative) do
firebase_dependency(spec, '13.0.0', ['FirebaseAuth'], 'Firebase/Auth')
end
assert_empty spec.dependencies
assert_includes error.message, 'spm_dependency'
end
def test_missing_spm_multiple_products_fails_loud
load_firebase_spm
spec = MockSpec.new
error = assert_raises(Pod::Informative) do
firebase_dependency(spec, '13.0.0',
['FirebaseCrashlytics'],
['Firebase/Crashlytics', 'FirebaseCoreExtension'])
end
assert_empty spec.dependencies
assert_includes error.message, 'no longer distributed through CocoaPods'
end
# ── SPM path (spm_dependency IS defined) ──
def test_spm_single_product
# Define spm_dependency mock to capture the call
spm_calls = []
Object.define_method(:spm_dependency) do |spec, **kwargs|
spm_calls << { spec: spec, **kwargs }
end
load_firebase_spm
spec = MockSpec.new
firebase_dependency(spec, '12.10.0', ['FirebaseAuth'], 'Firebase/Auth')
# CocoaPods dependency should NOT be called
assert_equal 0, spec.dependencies.length
# SPM dependency should be called with correct params
assert_equal 1, spm_calls.length
call = spm_calls[0]
assert_equal spec, call[:spec]
assert_equal 'https://github.com/firebase/firebase-ios-sdk.git', call[:url]
assert_equal({ kind: 'exactVersion', version: '12.10.0' }, call[:requirement])
assert_equal ['FirebaseAuth'], call[:products]
end
def test_spm_multiple_products_ignores_cocoapods_extras
spm_calls = []
Object.define_method(:spm_dependency) do |spec, **kwargs|
spm_calls << { spec: spec, **kwargs }
end
load_firebase_spm
spec = MockSpec.new
# Crashlytics: SPM only needs FirebaseCrashlytics, CocoaPods needs 2 pods
firebase_dependency(spec, '12.10.0',
['FirebaseCrashlytics'],
['Firebase/Crashlytics', 'FirebaseCoreExtension'])
# CocoaPods not called
assert_equal 0, spec.dependencies.length
# SPM called with only the SPM products (no FirebaseCoreExtension)
assert_equal 1, spm_calls.length
assert_equal ['FirebaseCrashlytics'], spm_calls[0][:products]
end
def test_probe_dynamic_firebase_leaves_local_umbrella_owned_by_app_target
spm_calls = []
Object.define_method(:spm_dependency) do |spec, **kwargs|
spm_calls << { spec: spec, **kwargs }
end
ENV['RNFB_TEST_RN_BARE_DYNAMIC_FIREBASE'] = '1'
load_firebase_spm
spec = MockSpec.new
firebase_dependency(spec, '12.10.0', %w[FirebaseCore FirebaseInstallations], 'Firebase/CoreOnly')
assert_empty spec.dependencies
assert RNFirebaseSPM.active?
assert RNFirebaseSPM.umbrella?
assert_empty spm_calls,
'RNFBApp must not get a direct package-product dependency; ' \
'it exposes transitive Firebase headers to Objective-C++'
end
def test_probe_dynamic_firebase_flag_off_keeps_remote_products
spm_calls = []
Object.define_method(:spm_dependency) do |spec, **kwargs|
spm_calls << { spec: spec, **kwargs }
end
ENV['RNFB_TEST_RN_BARE_DYNAMIC_FIREBASE'] = '0'
load_firebase_spm
spec = MockSpec.new
firebase_dependency(spec, '12.10.0', %w[FirebaseCore FirebaseInstallations], 'Firebase/CoreOnly')
assert_equal 1, spm_calls.length
assert_equal RNFirebaseSPM.url, spm_calls[0][:url]
assert_equal %w[FirebaseCore FirebaseInstallations], spm_calls[0][:products]
refute RNFirebaseSPM.umbrella?
end
def test_add_core_links_local_umbrella_when_probe_active
load_firebase_spm
RNFirebaseSPM.activate!('12.10.0', mode: :umbrella)
target = MockTarget.new(['[CP] Embed Pods Frameworks'])
user_project = MockUserProject.new([target])
installer = MockInstaller.new([MockAggregateTarget.new(user_project)])
rnfirebase_add_spm_core_to_app_target(installer)
assert_equal 1, target.package_product_dependencies.length
ref = target.package_product_dependencies[0]
assert_equal RNFIREBASE_SPM_UMBRELLA_PRODUCT, ref.product_name
assert_equal RNFirebaseSPM.umbrella_path, ref.package.relative_path
assert_equal 1, target.frameworks_build_phase.files.length
assert_equal 1, user_project.save_count
end
def test_probe_graph_keeps_umbrella_product_on_app_and_injects_only_artifact_paths_into_pod
spm_calls = []
Object.define_method(:spm_dependency) do |spec, **kwargs|
spm_calls << { spec: spec, **kwargs }
end
ENV['RNFB_TEST_RN_BARE_DYNAMIC_FIREBASE'] = '1'
load_firebase_spm
firebase_dependency(
MockSpec.new,
'12.10.0',
%w[FirebaseCore FirebaseInstallations],
'Firebase/CoreOnly'
)
app_target = MockTarget.new(['[CP] Embed Pods Frameworks'], name: 'testing')
user_project = MockUserProject.new([app_target])
rnfb_app_pod = MockTarget.new([], name: 'RNFBApp')
pods_project = MockPodsProject.new(uuid_prefix: 'ABCDEF', targets: [rnfb_app_pod])
pods_project.root_object = MockRootObject.new
installer = MockInstaller.new(
[MockAggregateTarget.new(user_project)],
pods_project: pods_project
)
rnfirebase_add_spm_core_to_app_target(installer)
rnfirebase_apply_spm_build_settings(installer)
assert_empty spm_calls, 'firebase_dependency must not attach RNFBFirebase to the pod'
assert_equal [RNFIREBASE_SPM_UMBRELLA_PRODUCT],
app_target.package_product_dependencies.map(&:product_name)
assert_empty rnfb_app_pod.package_product_dependencies
app_ref = app_target.package_product_dependencies.fetch(0)
assert_same app_ref, app_target.frameworks_build_phase.files.fetch(0).product_ref
rnfb_app_pod.build_configurations.each do |config|
settings = config.build_settings
assert_equal [
'$(inherited)',
'${BUILD_DIR}/${CONFIGURATION}${EFFECTIVE_PLATFORM_NAME}',
'${BUILD_DIR}/${CONFIGURATION}${EFFECTIVE_PLATFORM_NAME}/RNFBFirebase.swiftmodule'
], rnfirebase_build_setting_list(settings['SWIFT_INCLUDE_PATHS'])
assert_equal [
'$(inherited)',
'${BUILD_DIR}/${CONFIGURATION}${EFFECTIVE_PLATFORM_NAME}/PackageFrameworks'
], rnfirebase_build_setting_list(settings['FRAMEWORK_SEARCH_PATHS'])
assert_equal [
'$(inherited)',
'-ObjC',
'-framework',
RNFIREBASE_SPM_UMBRELLA_PRODUCT
], rnfirebase_build_setting_list(settings['OTHER_LDFLAGS'])
end
order_target = pods_project.targets.find { |candidate| candidate.name == RNFIREBASE_SPM_PROBE_ORDER_TARGET }
refute_nil order_target
assert_empty order_target.package_product_dependencies
assert_equal(
[RNFIREBASE_SPM_UMBRELLA_PRODUCT],
order_target.dependencies.map { |dep| dep.product_ref.product_name }
)
assert_equal [order_target], rnfb_app_pod.dependencies.map(&:target)
assert_empty(rnfb_app_pod.dependencies.select(&:product_ref))
end
# ── $RNFirebaseDisableSPM semantics (must check truthiness, not defined?) ──
def test_disable_spm_true_fails_loud_without_cocoapods_pods
Object.define_method(:spm_dependency) { |*| raise 'spm_dependency should not be called' }
load_firebase_spm
$RNFirebaseDisableSPM = true
spec = MockSpec.new
error = assert_raises(Pod::Informative) do
firebase_dependency(spec, '13.0.0', ['FirebaseAuth'], 'Firebase/Auth')
end
assert_empty spec.dependencies
assert_includes error.message, 'no longer distributed through CocoaPods'
assert_includes error.message, '$RNFirebaseDisableSPM = true'
assert_includes error.message, 'use_frameworks! :linkage => :dynamic'
end
def test_disable_spm_false_still_uses_spm
spm_calls = []
Object.define_method(:spm_dependency) do |spec, **kwargs|
spm_calls << { spec: spec, **kwargs }
end
load_firebase_spm
# Config generators / Expo plugins / env-templated Podfiles may emit `false`
# rather than omitting the assignment entirely. This must NOT disable SPM.
$RNFirebaseDisableSPM = false
spec = MockSpec.new
firebase_dependency(spec, '12.10.0', ['FirebaseAuth'], 'Firebase/Auth')
assert_equal 0, spec.dependencies.length
assert_equal 1, spm_calls.length
assert_equal ['FirebaseAuth'], spm_calls[0][:products]
end
def test_disable_spm_unset_uses_spm
spm_calls = []
Object.define_method(:spm_dependency) do |spec, **kwargs|
spm_calls << { spec: spec, **kwargs }
end
load_firebase_spm
spec = MockSpec.new
firebase_dependency(spec, '12.10.0', ['FirebaseAuth'], 'Firebase/Auth')
assert_equal 0, spec.dependencies.length
assert_equal 1, spm_calls.length
end
# ── URL from package.json ──
def test_reads_spm_url_from_package_json
load_firebase_spm
assert_equal 'https://github.com/firebase/firebase-ios-sdk.git', RNFirebaseSPM.url
end
def test_local_umbrella_package_exact_version_matches_package_json_sdk_pin
app_package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
expected_version = app_package.dig('sdkVersions', 'ios', 'firebase')
manifest = File.read(File.join(__dir__, '..', 'ios', 'RNFBFirebase', 'Package.swift'))
exact_versions = manifest.scan(/exact:\s*"([^"]+)"/).flatten
assert_equal [expected_version], exact_versions
end
# ── RNFirebaseSPM.active? tracking (replaces reflecting into RN's `SPM`
# internal object, which rnfirebase_add_spm_embed_phase used to do) ──
def test_spm_path_sets_active_flag
Object.define_method(:spm_dependency) { |*| nil }
load_firebase_spm
refute RNFirebaseSPM.active?
firebase_dependency(MockSpec.new, '12.10.0', ['FirebaseAuth'], 'Firebase/Auth')
assert RNFirebaseSPM.active?
end
def test_missing_spm_dependency_fails_loud_without_cocoapods_pods
load_firebase_spm
spec = MockSpec.new
error = assert_raises(Pod::Informative) do
firebase_dependency(spec, '13.0.0', ['FirebaseAuth'], 'Firebase/Auth')
end
assert_empty spec.dependencies
refute RNFirebaseSPM.active?
assert_includes error.message, 'no longer distributed through CocoaPods'
assert_includes error.message, 'spm_dependency'
end
def test_disabled_spm_fails_loud_even_if_spm_dependency_defined
Object.define_method(:spm_dependency) { |*| raise 'spm_dependency should not be called' }
load_firebase_spm
$RNFirebaseDisableSPM = true
error = assert_raises(Pod::Informative) do
firebase_dependency(MockSpec.new, '13.0.0', ['FirebaseAuth'], 'Firebase/Auth')
end
refute RNFirebaseSPM.active?
assert_includes error.message, '$RNFirebaseDisableSPM = true'
end
def test_active_raises_when_flag_set_without_version
load_firebase_spm
RNFirebaseSPM.instance_variable_set(:@active, true)
RNFirebaseSPM.instance_variable_set(:@version, nil)
error = assert_raises(Pod::Informative) { RNFirebaseSPM.active? }
assert_includes error.message, 'marked active without a recorded version'
end
def test_active_raises_when_flag_set_with_empty_version
load_firebase_spm
RNFirebaseSPM.instance_variable_set(:@active, true)
RNFirebaseSPM.instance_variable_set(:@version, ' ')
error = assert_raises(Pod::Informative) { RNFirebaseSPM.active? }
assert_includes error.message, 'marked active without a recorded version'
end
# ── rnfirebase_build_setting_list ──
def test_build_setting_list_dups_non_empty_array
load_firebase_spm
original = ['$(inherited)', '-ObjC']
result = rnfirebase_build_setting_list(original)
assert_equal original, result
refute_same original, result
end
def test_build_setting_list_defaults_nil_empty_string_and_empty_array
load_firebase_spm
assert_equal ['$(inherited)'], rnfirebase_build_setting_list(nil)
assert_equal ['$(inherited)'], rnfirebase_build_setting_list('')
assert_equal ['$(inherited)'], rnfirebase_build_setting_list([])
end
def test_build_setting_list_splits_whitespace_string
load_firebase_spm
assert_equal %w[$(inherited) -ObjC], rnfirebase_build_setting_list('$(inherited) -ObjC')
end
# ── rnfirebase_add_spm_embed_phase (invoked automatically by
# rnfirebase_hook_cocoapods_post_install!, tested separately below) ──
def test_embed_phase_noop_when_spm_not_active
load_firebase_spm
installer = MockInstaller.new(nil) # would raise if ever touched
rnfirebase_add_spm_embed_phase(installer)
# No error raised => returned early without walking `installer.aggregate_targets`.
end
def test_embed_phase_noop_without_cp_embed_pods_frameworks_phase
load_firebase_spm
RNFirebaseSPM.activate!('12.10.0')
target = MockTarget.new(['[CP] Some Other Phase'])
user_project = MockUserProject.new([target])
installer = MockInstaller.new([MockAggregateTarget.new(user_project)])
rnfirebase_add_spm_embed_phase(installer)
# Unchanged: still only the pre-existing unrelated phase, no RNFB phase added.
assert_equal 1, target.shell_script_build_phases.length
assert_equal '[CP] Some Other Phase', target.shell_script_build_phases[0].name
assert_equal 0, user_project.save_count
end
def test_embed_phase_adds_phase_when_active_and_cp_phase_present
load_firebase_spm
RNFirebaseSPM.activate!('12.10.0')
target = MockTarget.new(['[CP] Embed Pods Frameworks'])
user_project = MockUserProject.new([target])
installer = MockInstaller.new([MockAggregateTarget.new(user_project)])
rnfirebase_add_spm_embed_phase(installer)
rnfb_phase = target.shell_script_build_phases.find { |p| p.name == RNFIREBASE_SPM_EMBED_PHASE_NAME }
refute_nil rnfb_phase
assert_equal '/bin/bash', rnfb_phase.shell_path
assert_equal '1', rnfb_phase.always_out_of_date
assert_includes rnfb_phase.shell_script, 'PackageFrameworks'
# Regression net for #9154 / SAE-1: the embed script must filter out
# static (ar archive) frameworks before rsync, via `file -b` and
# "dynamically linked". Fast, dependency-free guard against a future
# refactor stripping the filter from the generated phase text.
assert_includes rnfb_phase.shell_script, 'dynamically linked'
assert_includes rnfb_phase.shell_script, 'file -b'
assert_includes rnfb_phase.shell_script,
'Skipping ${framework_name}: binary missing or not dynamically linked'
assert_equal ['${BUILT_PRODUCTS_DIR}/PackageFrameworks'], rnfb_phase.input_paths
assert_equal ['${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}'], rnfb_phase.output_paths
assert_equal 1, user_project.save_count
end
def test_embed_phase_is_idempotent_across_repeated_pod_installs
load_firebase_spm
RNFirebaseSPM.activate!('12.10.0')
target = MockTarget.new(['[CP] Embed Pods Frameworks'])
user_project = MockUserProject.new([target])
installer = MockInstaller.new([MockAggregateTarget.new(user_project)])
rnfirebase_add_spm_embed_phase(installer)
rnfirebase_add_spm_embed_phase(installer)
matching = target.shell_script_build_phases.select { |p| p.name == RNFIREBASE_SPM_EMBED_PHASE_NAME }
assert_equal 1, matching.length
# The second, redundant call must not re-save the pbxproj: nothing about
# the phase actually changed, so re-saving would be needless diff churn
# on a file consumers commit to source control.
assert_equal 1, user_project.save_count
end
# ── rnfirebase_add_spm_core_to_app_target ──
def test_add_core_noop_when_spm_not_active
load_firebase_spm
installer = MockInstaller.new(nil) # would raise if ever touched
rnfirebase_add_spm_core_to_app_target(installer)
# No error raised => returned early without walking `installer.aggregate_targets`.
end
def test_add_core_noop_without_cp_embed_pods_frameworks_phase
load_firebase_spm
RNFirebaseSPM.activate!('12.10.0')
target = MockTarget.new(['[CP] Some Other Phase'])
user_project = MockUserProject.new([target])
installer = MockInstaller.new([MockAggregateTarget.new(user_project)])
rnfirebase_add_spm_core_to_app_target(installer)
assert_empty target.package_product_dependencies
assert_equal 0, user_project.save_count
end
def test_add_core_links_firebase_core_when_active_and_cp_phase_present
load_firebase_spm
RNFirebaseSPM.activate!('12.10.0')
target = MockTarget.new(['[CP] Embed Pods Frameworks'])
user_project = MockUserProject.new([target])
installer = MockInstaller.new([MockAggregateTarget.new(user_project)])
rnfirebase_add_spm_core_to_app_target(installer)
assert_equal 1, target.package_product_dependencies.length
ref = target.package_product_dependencies[0]
assert_equal 'FirebaseCore', ref.product_name
assert_equal RNFirebaseSPM.url, ref.package.repositoryURL
assert_equal({ kind: 'exactVersion', version: '12.10.0' }, ref.package.requirement)
search_path = '${SYMROOT}/${CONFIGURATION}${EFFECTIVE_PLATFORM_NAME}/'
target.build_configurations.each do |config|
assert_includes target.build_settings(config.name)['SWIFT_INCLUDE_PATHS'], search_path
end
assert_equal 1, user_project.save_count
end
# Regression test for the missing-link bug (#9158): declaring a
# `package_product_dependencies` entry alone tells Xcode the target
# *depends* on the package product, but never actually links it -- that
# requires a matching `PBXBuildFile` (with its `product_ref` pointed at the
# same dependency) in the target's `PBXFrameworksBuildPhase`. Without it,
# native code calling FIRApp/FIROptions directly (as Expo's generated
# AppDelegate does) fails at the link step with "Undefined symbols ...
# _OBJC_CLASS_$_FIRApp", even though `pod install` appears to succeed.
def test_add_core_links_build_file_into_frameworks_build_phase
load_firebase_spm
RNFirebaseSPM.activate!('12.10.0')
target = MockTarget.new(['[CP] Embed Pods Frameworks'])
user_project = MockUserProject.new([target])
installer = MockInstaller.new([MockAggregateTarget.new(user_project)])
rnfirebase_add_spm_core_to_app_target(installer)
ref = target.package_product_dependencies[0]
build_files = target.frameworks_build_phase.files
assert_equal 1, build_files.length
assert_same ref, build_files[0].product_ref
end
def test_add_core_is_idempotent_across_repeated_pod_installs
load_firebase_spm
RNFirebaseSPM.activate!('12.10.0')
target = MockTarget.new(['[CP] Embed Pods Frameworks'])
user_project = MockUserProject.new([target])
installer = MockInstaller.new([MockAggregateTarget.new(user_project)])
rnfirebase_add_spm_core_to_app_target(installer)
rnfirebase_add_spm_core_to_app_target(installer)
assert_equal 1, target.package_product_dependencies.length
# The early-exit guard (`target.package_product_dependencies.any? { ... }`)
# must also stop a second `pod install` from double-linking the build
# file it added on the first call.
assert_equal 1, target.frameworks_build_phase.files.length
# The second, redundant call must not re-save the pbxproj: nothing about
# the target actually changed on the second pass.
assert_equal 1, user_project.save_count
end
def test_stable_object_uuid_depends_only_on_the_object_role
load_firebase_spm
remote = rnfirebase_stable_object_uuid('remote-package:https://github.com/firebase/firebase-ios-sdk.git')
product = rnfirebase_stable_object_uuid('product-dependency:testrnbare:FirebaseCore')
build_file = rnfirebase_stable_object_uuid('build-file:testrnbare:FirebaseCore')
assert_equal remote, rnfirebase_stable_object_uuid('remote-package:https://github.com/firebase/firebase-ios-sdk.git')