低级别测试类型

低级别测试（LLT） 框架包括两种不同的测试类型：

• 显式（Explicit） ：由模块构建目标对定义的独立测试。
• 隐式（Implicit） ：位于所测试模块中且无需构建目标对的测试。

显式测试

显式测试 是由模块构建目标对定义的独立测试。显式测试设计为在编译时间和运行时间方面做到轻量级。之所以称为 显式 ，是因为显式测试需要显式UE模块构建和目标文件，与 隐式 测试相反，后者无需这些。这意味着显式测试需要 .Build.cs 和 .Target.cs 文件，而隐式测试不需要。有关显式测试和隐式测试之间区别的更多信息，请参阅隐式测试小节。

创建显式测试

执行以下步骤，创建显式测试：

1. 在 Source/Programs 目录中，创建一个新目录，名称与你要测试模块的名称相同，并在此目录中添加 .Build.cs 文件。

   要查看示例，找到目录 Engine/Source/Programs/LowLevelTests，其中包含名为基础测试（Foundation Tests）的显式测试目标。

2. 从 TestModuleRules 继承你的模块类。
   • 如果你要编写插件测试，则将新模块放到与插件 Source 目录同一级别的 Tests 目录。
   • 如果你要构建不使用Catch2的测试模块，则继承基类构造函数，将其中第二个参数设置为false：base(Target, false) 。
3. 使用新 Metadata 对象参数调用 UpdateBuildGraphPropertiesFile 。
   • 此信息用于生成BuildGraph脚本测试元数据。
   • 有关BuildGraph脚本生成的更多信息，请参阅生成BuildGraph脚本元数据小节。

4. 假定你有一个名为 UEModuleTests 的显式测试模块。你的显式测试 .Build.cs 文件应类似于如下内容：

   UEModuleTests/UEModuleTests.Build.cs

    public class UEModuleTests : TestModuleRules
    {
        public UEModuleTests(ReadOnlyTargetRules Target) : base(Target)
        {
            PrivateIncludePaths.AddRange(
                // 所有私有包含路径
            );
            PrivateDependencyModuleNames.AddRange(
                // 要链接到的所有私有依赖项
            );
   
            // 其他类型的依赖项或特定于模块的逻辑
   
            UpdateBuildGraphPropertiesFile(new Metadata("UEModule", "UE Module"));
        }
    }
   Copy full snippet

   public class UEModuleTests : TestModuleRules { public UEModuleTests(ReadOnlyTargetRules Target) : base(Target) { PrivateIncludePaths.AddRange( // 所有私有包含路径 ); PrivateDependencyModuleNames.AddRange( // 要链接到的所有私有依赖项 ); // 其他类型的依赖项或特定于模块的逻辑 UpdateBuildGraphPropertiesFile(new Metadata("UEModule", "UE Module")); } }
5. 添加测试目标文件（ .Target.cs ），其中包含从 TestTargetRules 继承的类。
6. 如有必要覆盖默认编译。
   • 目标是建立一个最小的可测试模块，该模块没有未为低级别测试增加价值的默认功能。
   • 你可以单独指定受支持的平台。默认平台为：Win64、Mac、Linux和Android。
   • 你可以启用特定于项目的全局定义，并设置Catch2定义，如基准支持所需的定义。

7. 你的显式测试 .Target.cs 文件应类似于如下内容：

   UEModuleTests/UEModuleTests.Target.cs

    [SupportedPlatforms(UnrealPlatformClass.All)]
    public class UEModuleTestsTarget : TestTargetRules
    {
        public UEModuleTestsTarget(TargetInfo Target) : base(Target)
        {
            // 像其他目标一样设置：设置编译标志、全局定义等。
            GlobalDefinitions.Add("CATCH_CONFIG_ENABLE_BENCHMARKING=1");
        }
    }
   Copy full snippet

   [SupportedPlatforms(UnrealPlatformClass.All)] public class UEModuleTestsTarget : TestTargetRules { public UEModuleTestsTarget(TargetInfo Target) : base(Target) { // 像其他目标一样设置：设置编译标志、全局定义等。 GlobalDefinitions.Add("CATCH_CONFIG_ENABLE_BENCHMARKING=1"); } }

后续步骤

现在你可以在模块的 Private 文件夹中编写C++测试文件，并在这些文件中编写Catch2测试。对于测试技巧和最佳实践，请参阅编写低级别测试文档。最后，了解如何构建和运行你的测试。构建和执行低级别测试的方式不止一种。请参阅构建和运行低级别测试文档，选择适合你开发需求的最佳方法。

生成BuildGraph脚本元数据文件

如果你要使用BuildGraph构建和运行你的测试，你需要为显式测试启用生成BuildGraph脚本元数据文件。通过 GenerateProjectFiles.bat 生成IDE解决方案时，显式测试模块会生成BuildGraph .xml 文件。

引擎配置设置是约束此生成的条件。你可以在 Engine/Config/BaseEngine.ini 中设置此配置：

[LowLevelTestsSettings]
bUpdateBuildGraphPropertiesFile=true
Copy full snippet

[LowLevelTestsSettings] bUpdateBuildGraphPropertiesFile=true

当你运行 GenerateProjectFiles.bat 时，会在 Build/LowLevelTests/<TEST_NAME>.xml 文件夹中为每个测试目标生成测试元数据 .xml 文件，其中 <TEST_NAME> 为测试目标的名称。对于NDA平台，会在 Platforms/<PLATFORM_NAME>/Build/LowLevelTests/<TEST_NAME>.xml 下生成这些文件。你可以选择性地在包含全局属性的测试文件旁边放一个附加 General.xml 文件。

如果文件已经存在，则根据C#描述的 Metadata 对象更新文件。项目文件生成所访问的文件夹和文件必须可写。通常，这些文件在源代码控制下为只读，因此需在生成之前检出文件或使其可写。

要查看示例，找到目录 Engine/Build/LowLevelTests ，其中包含名为Foundation的 .xml 文件。这是用于基础测试的已生成BuildGraph元数据。

显式测试参考

测试模块规则参考

TestModuleRules 类会使用 UpdateBuildGraphPropertiesFile 扩展 ModuleRules 。UpdateBuildGraphPropertiesFile 会接受 Metadata 对象，该对象会生成BuildGraph测试元数据 .xml 文件。通过 Metadata 对象，你可以设置以下属性：

TestModuleRules 将覆盖来自其基类 ModuleRules 的很多默认UBT标记。这样可以减少编译膨胀，并最大限度地减少大多数开箱即用测试的编译时间。你始终可以在 TestModuleRules 派生类中覆盖这些默认值，但不得直接在 TestModuleRules 中更改默认值。

测试目标规则参考

TestTargetRules 通过以下标记扩展 TargetRules ：

就像 TestModuleRules 一样， TestTargetRules 可设置默认UBT标记。尤其是，它可以禁用UE功能，如UObjects、本地化、统计数据等。

引擎测试

在此类型的显式测试中，LLT框架将编译和运行包含引擎模块的显式测试。因为对于大多数平台来说，加载资产需要烘焙，无法使用引擎模块，因此引擎测试仅适用于 .Target.cs 文件中设置的以下标记：

public UEModuleTestsTarget(TargetInfo Target) : base(Target)
{
  bUsePlatformFileStub = true;
  bMockEngineDefaults = true;
}
Copy full snippet

public UEModuleTestsTarget(TargetInfo Target) : base(Target) { bUsePlatformFileStub = true; bMockEngineDefaults = true; }

隐式测试

隐式测试位于你要测试的相同模块中。所有隐式测试均通过 WITH_LOW_LEVEL_TESTS 定义进行有条件的编译。虽然可以将隐式测试放置在模块中的任意位置，例如 Private 文件夹中，但很难将其与模块源代码区分。要确保你的测试易发现，请遵循以下惯例：

• 在模块中创建级别和 Public 与 Private 文件夹相同的 Tests 文件夹。
• 每当有与源文件匹配的测试时，都会在 Tests 中镜像模块的文件夹结构。

由于没有像显式测试所需的显式目标，因此隐式测试需要进行构建的现有目标。这要求隐式测试使用虚幻编译工具生成用于隐式测试的可执行文件。有关更多信息，请参阅构建和运行低级别测试文档的构建隐式测试小节。

目录结构

在下方示例中，模块名为 SampleModule ，目录结构如下：

.
└── SampleModule/
    ├── Public/
    │   └── SampleCode.h
    └── Private/
        ├── SampleCode.cpp
        └── SampleModuleSubDirectory/
            ├── MoreSampleCode.h
            └── MoreSampleCode.cpp
Copy full snippet

. └── SampleModule/ ├── Public/ │ └── SampleCode.h └── Private/ ├── SampleCode.cpp └── SampleModuleSubDirectory/ ├── MoreSampleCode.h └── MoreSampleCode.cpp

要将隐式测试添加到此模块，创建与 Public 和 Private 目录级别相同的 Tests 目录，并镜像 Private 目录的目录结构。对于每个C++文件，在相同的相对位置创建相应的测试文件。产生的结构如下所示：

.
└── SampleModule/
    ├── Public/
    │   └── SampleCode.h
    ├── Private/
    │   ├── SampleCode.cpp
    │   └── SampleModuleSubDirectory/
    │       ├── MoreSampleCode.h
    │       └── MoreSampleCode.cpp
    └── Tests/
        ├── SampleCodeTests.cpp
        └── SampleModuleSubDirectory/
            └── MoreSampleCodeTests.cpp
Copy full snippet

. └── SampleModule/ ├── Public/ │ └── SampleCode.h ├── Private/ │ ├── SampleCode.cpp │ └── SampleModuleSubDirectory/ │ ├── MoreSampleCode.h │ └── MoreSampleCode.cpp └── Tests/ ├── SampleCodeTests.cpp └── SampleModuleSubDirectory/ └── MoreSampleCodeTests.cpp

借助此结构，文件 SampleCodeTests.cpp 包含用于 SampleCode.cpp 文件的测试， MoreSampleCodeTests.cpp 包含用于 MoreSampleCode.cpp 文件的测试。

下一步

当你确定什么测试最适合你的需求后，请参阅编写低级别测试文档，了解如何在虚幻引擎中编写低级别测试。