Xcode Unit Testing with Cocoapods

Question

I've been banging my head against a wall with this for the last few days but despite multiple Google/SO/Github searches I can't find a resolution to the issues I'm having!

All I'm trying to do is create some unit tests for my app which makes use of Firebase pods.

I'm using Xcode 7.3.1 & Cocoapods 1.0.1. Update: Issue remains with Xcode 8.0

With this podfile:

platform :ios, '9.0'
use_frameworks!
inhibit_all_warnings!

target 'MyApp' do
    pod 'Firebase'
    pod 'Firebase/Auth'
    pod 'Firebase/Database'
    pod 'Firebase/Storage'

    target 'MyAppTests' do
        inherit! :search_paths
    end
end

In my XCTest class I get

Missing required module 'Firebase'

error at @testable import MyApp

Alternatively with this podfile:

platform :ios, '9.0'
use_frameworks!
inhibit_all_warnings!

def common_pods
    pod 'SwiftyTimer'
    pod 'Firebase'
    pod 'Firebase/Auth'
    pod 'Firebase/Database'
    pod 'Firebase/Storage'
end

target 'MyApp' do
    common_pods
end

target 'MyAppTests' do
    common_pods
end

The tests build but my console is littered with warnings e.g.:

Class <-FirebaseClassName-> is implemented in both ...MyApp... and ...MyAppTests... One of the two will be used. Which one is undefined

I was only using Firebase Analytics. After Moving to Google analytics everything works like a charm. — marosoaie, Nov 24 '16 at 10:24
I haven't tried his myself yet but I might attempt to include Firebase manually not using cocoa pods: https://firebase.google.com/docs/ios/setup#frameworks — Jonny, Jun 26 '17 at 03:56

score 96 · Answer 1 · answered Jul 07 '16 at 20:36

96

I had the same issue. I solved it by moving pod 'Firebase' to my test target. Change your Podfile to this:

platform :ios, '9.0'
use_frameworks!
inhibit_all_warnings!

target 'MyApp' do
    pod 'Firebase/Auth'
    pod 'Firebase/Database'
    pod 'Firebase/Storage'

    target 'MyAppTests' do
        inherit! :search_paths
        pod 'Firebase'
    end
end

answered Jul 07 '16 at 20:36

Mackarous

1,467
1
11
8

1

Thanks but I just tried that and I still have the "Class ... is implemented in both ... " issue. – doovers Jul 07 '16 at 22:44
1

It worked for me but it still doesn't make sense to me. It's not the 1st time I can tell Firebase are setting up their podspecs weirdly, cf. https://twitter.com/dirtyhenry/status/836240557311684608 but the Firebase team doesn't reply :( – Mick F Mar 03 '17 at 15:50
5

Making this change didn't immediately clear the warning, but it was resolved after I ran `pod install`. – blwinters Sep 06 '17 at 21:52
1

Half problem solved. and other half is solved by Add "${PODS_ROOT}/Firebase/Core/Sources" to your Tests target only under Build Settings -> Header Search Paths – ArgaPK Dec 28 '17 at 10:14
After you make this change do not forget to run `pod install` in order to update project dependencies ;) – jawad Jan 13 '20 at 13:37
@Mackarous how do we achieve similar functionality with 'Swift Package Manager' – Saif Sep 27 '22 at 06:44

score 63 · Answer 2 · answered Nov 17 '16 at 19:41

63

Try changing the inheritance to :complete, as in:

target 'MyAppTests' do
    inherit! :complete
end

Importantly it allows anyone else checking out your repo to just do a pod update as usual without having to copy .xcconfig files or other hackery just to build.

answered Nov 17 '16 at 19:41

Andy Chou

854
6
5

1

This also have the "Class ... is implemented in both ... " issue – Diogo T Nov 21 '16 at 20:07
It made the compile time error disappear, but caused this one at runtime: clang: error: linker command failed with exit code 1 (use -v to see invocation) – CMont Aug 03 '17 at 04:02
Worked for me as well! Thanks :) – smapps Oct 25 '17 at 08:03

score 61 · Answer 3 · edited Jan 05 '22 at 10:56

61

Select your Unit Test Target setting.
Go to Build Settings.
Look for Header Search Paths.
Add this value $(SRCROOT)/Pods with recursive, then Xcode will resolve the path for you.

Here is Example

edited Jan 05 '22 at 10:56

answered Sep 10 '18 at 06:43

Kanika Sharma

631
5
11

1

Thank you @Kanika Sharma – Rahul K Rajan Feb 15 '20 at 10:26

score 35 · Answer 4 · edited Mar 19 '17 at 13:31

35

The issue is that Firebase does something special with the Header Search Paths after CocoaPods generates its own value for the setting so CocoaPods doesn't pick up on this change in order to carry it over to the test target. You can solve this one of two ways:

Locate MyAppTests.<configuration>.xcconfig in the file navigator and add the following to HEADER_SEARCH_PATHS:

${PODS_ROOT}/Firebase/Analytics/Sources [*]
Find the setting for Header Search Paths in Build Settings and add that same value as in option 1 to the list. You shouldn't need to set it as recursive.

_{* As per AKM's comment, this changed to ${PODS_ROOT}/Firebase/Core/Sources in version 3.14.0}

edited Mar 19 '17 at 13:31

Lope

5,388
4
30
40

answered Sep 20 '16 at 19:49

Will

3,770
3
21
19

Tried that but still getting same warnings – doovers Sep 28 '16 at 23:04
8

As of Firebase 3.14.0 This solution is valid, however the patch changed to`${PODS_ROOT}/Firebase/Core/Sources` – AKM Feb 24 '17 at 14:45
1

New path worked for me as well! I'm running CocoaPods *version 1.2.0*, but keep in mind I also had to add `inherit! :search_paths` to the test target in the `Podfile`. – Paulo Mattos Apr 20 '17 at 16:39
2. does not work for me. Using Firebase 3.x (not the newest 4.x) – Jonny Jun 26 '17 at 06:50
Issue can be followed here: https://github.com/firebase/firebase-ios-sdk/issues/58 – CMont Aug 03 '17 at 10:43
Half Problem solved and in other half include pod 'Firebase' in test target. – ArgaPK Dec 28 '17 at 10:16

score 10 · Answer 5 · answered Aug 30 '19 at 07:24

10

Adding ${SRCROOT}/Pods/Firebase/CoreOnly/Sources into the unit test target's "Header search paths" fixed the problem. Steps:

Select your unit tests target
Go to Build Settings
Search for header search path
Add ${SRCROOT}/Pods/Firebase/CoreOnly/Sources

After this the tests can run and the error will disappear.

answered Aug 30 '19 at 07:24

User123335511231

11,654
4
18
22

This is what worked for me. No need to touch podfile or xcconfig. Thanks for sharing. – Saran Feb 17 '21 at 19:32

score 9 · Answer 6 · answered May 06 '18 at 23:24

Three Steps before I could get this to work:

CocoaPods : 1.5.0 Swift 4 Firebase : 4.13.0

Step 1: Make sure to add the following target block into your podfile.

# Uncomment the next line to define a global platform for your project
platform :ios, '11.3'

target 'TIMII' do
# Comment the next line if you're not using Swift and don't want to use dynamic frameworks
use_frameworks!

# Pods for TIMII
pod 'Firebase/Core'
pod 'Firebase/Database'
pod 'Firebase/Auth'
pod 'Firebase/Storage'

    target 'TIMIITests' do
        inherit! :search_paths
        pod 'Firebase/Core'
    end

end

Step 2: Within the YourAppTests Project Navigator Build Settings tab. Find the Header Search Path row and add to Debug the following line

$(inherited) ${PODS_ROOT}/Firebase/Core/Sources

Step 3: In terminal run:

pod update

Prefer `pod install` over `pod update` unless you explicitly want to update your pods. Docs: https://guides.cocoapods.org/using/pod-install-vs-update.html — Sam, Aug 11 '22 at 02:29
This answer really helped me. Thanks. Other ways from this post did not work for me. — DJ-Glock, Jul 16 '23 at 18:57

score 8 · Answer 7 · answered Feb 21 '20 at 17:40

8

A simpler method that also works:

target 'MyApp' do
    pod 'Firebase/Auth'
    pod 'Firebase/Database'
    pod 'Firebase/Storage'

    target :MyAppTests
end

answered Feb 21 '20 at 17:40

Daniel

475
6
10

1

This works perfectly. Thank you. Any documentation on the syntax? What does `: MyAppTests` mean? – Tim Chen Mar 21 '21 at 06:25
This works for me as well, and syntax looks the simplest! – Bruce May 06 '21 at 09:11

JosephH · Answer 8 · 2018-05-19T10:29:35.127

7

The problem is recorded in the firebase project here:

https://github.com/firebase/firebase-ios-sdk/issues/58

There is a workaround:

Add "${PODS_ROOT}/Firebase/Core/Sources" to your Tests target only under Build Settings -> Header Search Paths

but this is also fixed by upgrading to CocoaPods 1.4.0 or later, which is a better solution.

At the time I'm writing this (November 2017) cocoapods 1.4.0 is still in beta, so to install it you need to explicitly request the beta:

gem install cocoapods --pre

This and then doing a pod install solved the problem running my tests.

edited May 19 '18 at 10:29

answered Nov 16 '17 at 23:42

JosephH

37,173
19
130
154

1

what is it "PODS_ROOT" ?? – ArgaPK Dec 22 '17 at 14:44
@ArgaPK It's a variable that cocoapods sets. Just paste exactly what I wrote between the ""s into Xcode. Really the best way is to upgrade your CocoaPods to >= 1.4.0. – JosephH Dec 22 '17 at 14:49
1

@JosephH updating my cocoapods to 1.5.2 didn't solve the problem, unfortunately. – Stacy Smith May 17 '18 at 14:37
@AnastasiaKovaleva did you run `pod install` after upgrading? – JosephH May 19 '18 at 10:30
@JosephH Running `pod install` solved my problem! Thanks a lot! – Stacy Smith May 21 '18 at 12:10

score 5 · Answer 9 · answered Feb 08 '19 at 11:03

I tried all the above and ran into various different errors, originally starting with Missing required module 'Firebase', then getting "Class ... is implemented in both ... " or linker issues if I tried to add Firebase Pods to my test target.

The solution that worked for me was to:

Remove test target entirely from Podfile and run 'pod update' to ensure the XCode project is in sync.
Open my test target's Build Settings and update header search paths to only include the following 3 items:
- $(inherited) non-recursive
- $(SRCROOT)/Pods/Headers/Public recursive
- $(SRCROOT)/Pods/Firebase recursive

At this point cleaning the build folder, re-building then re-running the tests worked for me. Hope this helps someone!

score 4 · Accepted Answer · answered Sep 29 '16 at 00:00

4

The solution for me was to update cocoapods to version 1.1.0.rc.2.

sudo gem install cocoapods --pre

answered Sep 29 '16 at 00:00

doovers

8,545
10
42
70

Unfortunately it doesn't work for me...I have to take back my upvote! – Zeb Oct 05 '16 at 08:27
Sorry it didn't help you out guys, not sure why it solved the problem for me and not you... – doovers Oct 05 '16 at 19:27
I am on 1.20 and no luck – UKDataGeek Feb 27 '17 at 21:51

score 2 · Answer 11 · answered Oct 24 '16 at 01:48

2

I had a similar problem. Phrased in terms of your question, I copied the contents of my MyApp.<configuration>.xcconfig file to my MyAppTests.<configuration>.xcconfig file. I cleaned and built the tests, and it worked.

answered Oct 24 '16 at 01:48

Jason

413
5
11

This was the only solution that worked for me. Thanks! I'm thinking about do a post install processing in the Podfile doing this – SauloT Oct 27 '16 at 22:26

score 1 · Answer 12 · answered Nov 06 '17 at 12:22

1

Add "${PODS_ROOT}/Firebase/Core/Sources" to your Tests target only under Build Settings -> Header Search Paths

answered Nov 06 '17 at 12:22

Karthick Vadivel

421
5
10

What is it ? PODS_ROOT – ArgaPK Dec 22 '17 at 14:44
it will fetch directory for pod – Karthick Vadivel Dec 27 '17 at 06:38

Stanislau Baranouski · Answer 13 · 2018-05-24T07:49:56.773

As @Will mentioned an issue around Header Search Paths after CocoaPods installation.

I have a project with multiple targets where pod 'Firebase' embedded into separate module, lets say MyProject-Shared. Firebase pod at 'Podfile' installed only for 'MyProject-Shared' target. Other modules, which wants to use 'MyProject-Shared' can't be compiled due an error:

'missing required module "Firebase" '

The trick in my case was to add following missing header search path at each target's Build Settings referencing to Analytics-Framework:

"${PODS_ROOT}/Firebase/CoreOnly/Sources"

Please see pic below:

Hope it will save your time.

score 0 · Answer 14 · answered Sep 10 '19 at 11:59

`Missing required module Firebase` NO CocoaPods solution

For those who encounter the same problem but NOT using CocoaPods:

If you're using Firebase, than you have some folder containing Firebase.h and module.modulemap file. For example - YOUR_PROJECT_DIR/Linking

If your Main project target is working correct way, than you should go to ProjectSettings -> Targets. Select test target. Search for User headers and add the path to YOUR_PROJECT_DIR/Linking. Select recursive option and you should be good to go.

See the screenshot for more details:

Xcode Unit Testing with Cocoapods

14 Answers14

`Missing required module Firebase` NO CocoaPods solution

Linked

Xcode Unit Testing with Cocoapods

14 Answers14

Missing required module Firebase NO CocoaPods solution

Linked

`Missing required module Firebase` NO CocoaPods solution