iOS - 'MyProject-Swift.h' file not found when running Unit Tests for Swift

96
votes

I am trying to setup Unit Testing for my project. It is an existing Objective-C app, that I have recently added one Swift class to. I have setup the 'MyProject-Swift.h' and Swift Bridging files (both 'MyProject' and 'MyProjectTest') and I am able to build and run the app just fine using both Objective-C and Swift code.

However, now I want to run some Unit Tests on the new Swift class. I setup my test file and it looks like the following:

MySwiftClassTests.swift:

import UIKit
import XCTest
import MyProject

class MySwiftClassTests: XCTestCase {

    override func setUp() {
        super.setUp()
        // Put setup code here. This method is called before the invocation of each test method in the class.
    }

    override func tearDown() {
        // Put teardown code here. This method is called after the invocation of each test method in the class.
        super.tearDown()
    }

    func testExample() {
        // This is an example of a functional test case.
        XCTAssert(true, "Pass")
    }

    func testPerformanceExample() {
        // This is an example of a performance test case.
        self.measureBlock() {
            // Put the code you want to measure the time of here.
        }
    }

}

I get this error when running the app as Test:

'MyProject-Swift.h' file not found

I am not sure why this happens only when trying to run the Tests. Any suggestions?

11
iosunit-testingswiftheader
Add updates on this? I'm facing the same problem... – hyouuu
@Coveloper - How are you able to set the targets for the '-Swift.h' file? It is not a real file that sits in the project, but instead compiled by Xcode on build. – JimmyJammed
Here's an update to my "I also get the 'MyProject-Swift.h' file not found error.." comment above: I found a workaround by setting the MyProjectTests target's Product Module Name to MyProject as opposed to MyProjectTests. So, now both targets (MyProject and MyProjectTests) have the same Product Module Name. That's weird, but it works and is low risk since it's the Test target. I should mention that my project name is actually like My-Project thus My_Project is the actual module name.) – finneycanhelp
"MyProject-Swift.h" file is generated at "$(TARGET_TEMP_DIR)/../$(PROJECT_NAME).build/DerivedSources". I end up adding this to Header Search Paths for my Unit Test target. – gagarwal
@gagarwal Adding "$(TARGET_TEMP_DIR)/../$(PROJECT_NAME).build/DerivedSources" to the Header Search Paths for my Unit Test target worked. :) Make a SO answer out of that comment and I can award you the bounty plus make it clear for others what a great answer it is. – finneycanhelp

11 Answers

150
votes

"MyProject-Swift.h" file is generated at following path:

"$(TARGET_TEMP_DIR)/../$(PROJECT_NAME).build/DerivedSources"

I end up adding this to Header Search Paths for my Unit Test target.

Also as @hyouuu pointed out about being the known issue, hopefully Apple will provide some good solution at their end. Until I believe we need to use this above solution.

https://developer.apple.com/library/content/documentation/Xcode/Conceptual/RN-Xcode-Archive/Chapters/xc6_release_notes.html

35
votes

Thanks to @gagarwal for figuring this out. In our case the product name has a space, which is collapsed in $PROJECT_NAME, so I had to hard code it. Additionally, by using $CONFIGURATION_TEMP_DIR instead of $TARGET_TEMP_DIR, you can remove the parent directory (../) from the path. So the solution is to add the following to the Header Search Paths in your test target:

"$(CONFIGURATION_TEMP_DIR)/Product Name With Spaces.build/DerivedSources"

Or, if your product does not contain spaces:

"$(CONFIGURATION_TEMP_DIR)/$(PROJECT_NAME).build/DerivedSources"
14
votes

Saw in the Xcode 6.1 release note, that this is a known issue... sign... Search for "-swift.h" in the release note https://developer.apple.com/library/content/documentation/Xcode/Conceptual/RN-Xcode-Archive/Chapters/xc6_release_notes.html

Tests written in Objective-C cannot import the Swift generated interfaces header ($(PRODUCT_MODULE_NAME)-Swift.h) for application targets, and therefore cannot be used to test code that requires this header.

Tests for Swift code should be written in Swift. Tests written in Objective-C for framework targets can access the Swift generated interfaces by importing the framework module using @import FrameworkName;. (16931027)

Please see @gagarwal's workaround below which WORKS!

8
votes

I had a similar issue to yours, I think; here was my setup.

I had an object defined in Swift:

// file Foo.swift
@objc public class Foo {
    // ...
}

This class was then used in the initializer of an Objective-C object:

// file Bar.h
#import "MyProject-Swift.h"

@interface Bar: NSObject

- (instancetype)initWithFoo:(Foo *)foo;

@end

This made my unit tests for Bar not compile, since the MyProject-Swift.h header isn't real and the unit test target can't see it. The release note shared by @hyouuu is on point - but I'm not testing a Swift class, I'm testing an Objective-C class!

I was able to fix this by changing the header file for Bar to use a forward class reference instead:

// file Bar.h
@class Foo;

@interface Bar: NSObject

- (instancetype)initWithFoo:(Foo *)foo;

@end

I then included MyProject-Swift.h in Bar.m, and everything worked - my tests of Objective-C objects written in Objective-C compiled properly and continued running, and I could write new tests for Swift objects in Swift.

Hope this helps!

4
votes

After I tried out everything I could find on the topic, the thing that worked for me was actually running the app although it was still showing the 'ModuleName-Swift.h file not found' error.

It went away and my app works perfectly fine. I guess I should have considered that earlier... The error keeps coming back, but after running the app it always just goes away again. So the issue is not really solved for me, but I can continue working on other topics for now...

1
votes

A simple 

@testable import MyProject

has done the job for me.

0
votes

Strangely, I was seeing this same error, but only when targeting a device (not the simulator). Before running the test I would see the red exclamation point next to the import statement for "MyProjectNameTests-Swift.h".

However, funny thing is, if I just go ahead and run the test anyway (despite this apparent build error), then during the build phase that happens thereafter, XCode actually does generate the "MyProjectNameTests-Swift.h" file, and the test runs just fine!

So, at least in my case, there was no need for the other solutions here, evidently, although I believe they do work also.

I should also note that I deleted my DerivedData directory prior to this, so maybe that is a step also worth trying.

0
votes

On one of my clients project they added frameworks directly in the project. I solved the errors like this;

  • Command 1
  • option command J
  • now type the framework name (that gives the error) in the filter
  • select the framework
  • option command 1
  • in Target Membership select your *UITests target
-1
votes

mySwiftClassTests (and any other swift classes you want to use in objective-c) needs to be marked @objc:

@objc class MySwiftClassTests: XCTestCase
-1
votes

I couldn't get it to work by adding that filepath mentioned by other answers, but I realized the file where it was complaining wasn't even being tested. I just had to remove it from the test target using the Right Utilities Side Bar.

-2
votes

Adding a .swift file to that target fixes issue on it.