为什么单元测试中的代码无法找到捆绑资源？

Question

我正在单元测试的一些代码需要加载资源文件。它包含以下行：

NSString *path = [[NSBundle mainBundle] pathForResource:@"foo" ofType:@"txt"];

在应用程序中它运行得很好，但是当由单元测试框架 pathForResource: 运行时返回 nil，这意味着它无法找到 foo.txt。

我已经确保 foo.txt 包含在单元测试目标的复制捆绑资源构建阶段中，那么为什么它找不到该文件呢？

Answer 1

当单元测试工具运行您的代码时，您的单元测试包不是主包。

即使您正在运行测试，而不是您的应用程序，您的应用程序包仍然是主包。 （据推测，这可以防止您正在测试的代码搜索错误的包。）因此，如果您将资源文件添加到单元测试包中，则在搜索主包时将找不到它。如果将上面的行替换为：

NSBundle *bundle = [NSBundle bundleForClass:[self class]];
NSString *path = [bundle pathForResource:@"foo" ofType:@"txt"];

那么您的代码将搜索单元测试类所在的包，一切都会好起来的。

Answer 2

Swift 实现：

Swift 2

let testBundle = NSBundle(forClass: self.dynamicType)
let fileURL = testBundle.URLForResource("imageName", withExtension: "png")
XCTAssertNotNil(fileURL)

Swift 3、Swift 4

let testBundle = Bundle(for: type(of: self))
let filePath = testBundle.path(forResource: "imageName", ofType: "png")
XCTAssertNotNil(filePath)

Bundle 提供了发现配置的主路径和测试路径的方法：

@testable import Example

class ExampleTests: XCTestCase {
        
    func testExample() {
        let bundleMain = Bundle.main
        let bundleDoingTest = Bundle(for: type(of: self ))
        let bundleBeingTested = Bundle(identifier: "com.example.Example")!
                
        print("bundleMain.bundlePath : \(bundleMain.bundlePath)")
        // …/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/Library/Xcode/Agents
        print("bundleDoingTest.bundlePath : \(bundleDoingTest.bundlePath)")
        // …/PATH/TO/Debug/ExampleTests.xctest
        print("bundleBeingTested.bundlePath : \(bundleBeingTested.bundlePath)")
        // …/PATH/TO/Debug/Example.app
        
        print("bundleMain = " + bundleMain.description) // Xcode Test Agent
        print("bundleDoingTest = " + bundleDoingTest.description) // Test Case Bundle
        print("bundleUnderTest = " + bundleBeingTested.description) // App Bundle

在 Xcode 6|7|8|9 中， 单元测试包路径将位于Developer/Xcode/DerivedData中，类似于......

/Users/
  UserName/
    Library/
      Developer/
        Xcode/
          DerivedData/
            App-qwertyuiop.../
              Build/
                Products/
                  Debug-iphonesimulator/
                    AppTests.xctest/
                      foo.txt

，与Developer/CoreSimulator/Devices分开code> 常规（非单元测试）捆绑路径：

/Users/
  UserName/
    Library/
    Developer/
      CoreSimulator/
        Devices/
          _UUID_/
            data/
              Containers/
                Bundle/
                  Application/
                    _UUID_/
                      App.app/

另请注意，默认情况下，单元测试可执行文件与应用程序代码链接。但是，单元测试代码应该仅在测试包中具有目标成员资格。应用程序代码应该仅在应用程序包中具有目标成员资格。在运行时，单元测试目标包注入到应用程序包中用于执行。

Swift Package Manager (SPM) 4:

let testBundle = Bundle(for: type(of: self)) 
print("testBundle.bundlePath = \(testBundle.bundlePath) ")

注意：默认情况下，命令行 swift test 将创建一个 MyProjectPackageTests .xctest 测试包。并且，swift 包generate-xcodeproj 将创建一个MyProjectTests.xctest 测试包。这些不同的测试包具有不同的路径。 此外，不同的测试包可能有一些内部目录结构和内容差异。

在任何一种情况下，.bundlePath 和 .bundleURL 将返回当前在 macOS 上运行的测试包的路径。然而，Bundle 目前尚未在 Ubuntu Linux 上实现。

此外，命令行 swift build 和 swift test 目前不提供复制资源的机制。

但是，通过一些努力，可以设置使用 Swift Package Manger 与 macOS Xcode、macOS 命令行和 Ubuntu 命令行环境中的资源的流程。可以在此处找到一个示例： 004.4'2 SW Dev Swift Package Manager (SPM) With Resources Qref< /a>

另请参阅：在单元中使用资源使用 Swift Package Manager 进行测试

Swift Package Manager (SwiftPM) 5.3+

Swift 5.3 包括 包管理器资源 SE-0271 演变提案，“状态：已实施 (Swift 5.3) ”。 :-)

资源并不总是供包的客户端使用；资源的一种用途可能包括仅单元测试所需的测试装置。此类资源不会与库代码一起合并到包的客户端中，而只会在运行包的测试时使用。

• 在 target 和 testTarget API 中添加新的 resources 参数，以允许显式声明资源文件。

SwiftPM 使用文件系统约定来确定属于包中每个目标的源文件集：具体来说，目标的源文件是位于目标的指定“目标目录”下的源文件。默认情况下，这是一个与目标同名的目录，位于“Sources”（对于常规目标）或“Tests”（对于测试目标）中，但可以在包清单中自定义该位置。< /p>

// 获取 DefaultSettings.plist 文件的路径。
let path = Bundle.module.path(forResource: "DefaultSettings", ofType: "plist")

// 加载可以位于捆绑包中的资源存档中的图像。
让图像= UIImage（命名：“MyIcon”，在：Bundle.module，兼容：UITraitCollection（userInterfaceStyle：.dark））

// 在已编译的 Metal 着色器库中查找顶点函数。
让着色器 = 尝试 mtlDevice.makeDefaultLibrary(bundle: Bundle.module).makeFunction(name: "vertexShader")

// 加载纹理。
让纹理= MTKTextureLoader（设备：mtlDevice）.newTexture（名称：“草”，scaleFactor：1.0，捆绑包：Bundle.module，选项：选项）

示例

// swift-tools-version:5.3
import PackageDescription

  targets: [
    .target(
      name: "CLIQuickstartLib",
      dependencies: [],
      resources: [
        // Apply platform-specific rules.
        // For example, images might be optimized per specific platform rule.
        // If path is a directory, the rule is applied recursively.
        // By default, a file will be copied if no rule applies.
        .process("Resources"),
      ]),
    .testTarget(
      name: "CLIQuickstartLibTests",
      dependencies: [],
      resources: [
        // Copy directories as-is. 
        // Use to retain directory structure.
        // Will be at top level in bundle.
        .copy("Resources"),
      ]),

当前问题

• 测试中的 Swift 5.3 SPM 资源使用了错误的捆绑路径？
• Swift 包管理器 - 测试目标中的资源

Xcode

Bundle.module 由 SwiftPM 生成（请参阅 Build/BuildPlan.swift SwiftTargetBuildDescriptiongenerateResourceAccessor())，因此不是由 Xcode 构建时存在于 Foundation.Bundle 中。

Xcode 将手动向模块添加一个 Resources 引用文件夹，添加 Xcode 构建阶段 copy 将 Resource 放入某个 *.bundle 目录，并为 Xcode 构建添加一个 #ifdef Xcode 编译器指令以使用资源。

#if Xcode 
extension Foundation.Bundle {
  
  /// Returns resource bundle as a `Bundle`.
  /// Requires Xcode copy phase to locate files into `*.bundle`
  /// or `ExecutableNameTests.bundle` for test resources
  static var module: Bundle = {
    var thisModuleName = "CLIQuickstartLib"
    var url = Bundle.main.bundleURL
    
    for bundle in Bundle.allBundles 
      where bundle.bundlePath.hasSuffix(".xctest") {
      url = bundle.bundleURL.deletingLastPathComponent()
      thisModuleName = thisModuleName.appending("Tests")
    }
    
    url = url.appendingPathComponent("\(thisModuleName).bundle")
    
    guard let bundle = Bundle(url: url) else {
      fatalError("Bundle.module could not load: \(url.path)")
    }
    
    return bundle
  }()
  
  /// Directory containing resource bundle
  static var moduleDir: URL = {
    var url = Bundle.main.bundleURL
    for bundle in Bundle.allBundles 
      where bundle.bundlePath.hasSuffix(".xctest") {
      // remove 'ExecutableNameTests.xctest' path component
      url = bundle.bundleURL.deletingLastPathComponent()
    }
    return url
  }()
  
}
#endif

Answer 3

在 Swift 3 中，语法 self.dynamicType 已被弃用，请改用此语法

let testBundle = Bundle(for: type(of: self))
let fooTxtPath = testBundle.path(forResource: "foo", ofType: "txt")

或

let fooTxtURL = testBundle.url(forResource: "foo", withExtension: "txt")

Answer 4

确认资源已添加到测试目标。

Answer 5

如果您的项目中有多个目标，那么您需要在目标成员资格中可用的不同目标之间添加资源，并且可能需要在不同的目标之间切换，如 3 个步骤所示下图

Answer 6

我必须确保设置此常规测试复选框

Answer 7

对于像我这样的人来说，在原始帖子中错过了这一点：

确保 foo.md 包含在单元测试目标的复制捆绑资源构建阶段

Answer 8

有一段代码可以在以下位置找到该文件：
如何检查文件是否存在存在于 Swift 的 Documents 目录中吗？

我在测试中使用了它，如下所示，该测试测试我的文件是否已创建并给出其位置以供进一步测试。

        let fileFound = XCTestExpectation (description: "Checking for DB File Found")
    
    
    
    let path = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true)[0] as String
    let url = NSURL(fileURLWithPath: path)
    if let pathComponent = url.appendingPathComponent("filename.ext") {
        let filePath = pathComponent.path
        let fileManager = FileManager.default
        if fileManager.fileExists(atPath: filePath) {
            fileFound.fulfill()
            print("DB FILE AVAILABLE")
        } else {
            print("DB FILE NOT AVAILABLE")
        }
    } else {
        print("DB FILE PATH NOT AVAILABLE")
    }
    
    wait(for: [fileFound], timeout: 5)

这并不是测试文件是否在正确的位置创建，而是测试文件是否已创建。