文档

Unity 引擎

Unity 引擎

向包添加测试

在 Development 期间使用测试验证行为。
阅读时间4 分钟最后更新于 8 天前

与Any类型的Development一样,最好将测试添加到包。必须执行三件事才能设置包的 ON 测试:
  1. 创建 C# 测试文件并将它们放在 Tests Folder 下。
  2. 创建测试 asmdef 文件。
  3. 为包启用测试。

测试文件的位置

您可以将测试文件添加到包的 Tests Folder 的
Editor
和
Runtime
子文件夹中。例如,带有测试的 Simple 包可能如下所示:
<package-root> ├── package.json ├── Editor │ ├── <company-name>.<package-name>.Editor.asmdef │ └── EditorExample.cs ├──运行时 │ ├── <company-name>.<package-name>.asmdef │ └── RuntimeExample.cs └── Tests ├── Editor │ ├── <company-name>.<package-name>.Editor.Tests.asmdef │ └── EditorExampleTest.cs └── Runtime ├── <company-name>.<package-name>.Tests.asmdef └── RuntimeExampleTest.cs
每个子文件夹必须包含一个
.asmdef
文件,该文件提供对 Editor 和运行时程序集的引用。程序Assembly Definition文件还提供了对测试程序程序集文件的引用。有关更多信息,请参阅 Assembly Definition 文件。

用于测试的 Assembly Definition 文件

使用 Test Framework 包可创建或编辑 Assembly Definition 文件。有关更多信息,请参阅创建测试程序集。
虽然可以选择直接编辑程序Assembly Definition文件,但需要make添加以下引用:

属性

Type(类型)

描述

name字符串没有文件扩展名的程序集的 Name。
参考:字符串数组对 Editor 和运行时时程序集的引用。Assembly Definition 文件需要不同的引用,具体取决于测试类型 ON:
- 对于 Editor 测试,请添加包的 Editor 和 运行时 程序集的引用。
- 对于运行时时测试,仅添加对包的运行时时程程序集的引用。
optionalUnityReferences字符串数组Unity 引用的列表必须包含用于将程序集标记为测试程序集的
"TestAssemblies"
。这会将对
nunit.framework.dll
和
UnityEngine.TestRunner.dll
库的引用添加到 Assembly Definition。
includePlatforms字符串数组对于 Editor 测试,此平台列表必须包含
"Editor"
平台。
提示
还可以在 Inspector 中编辑 Assembly Definition 文件。请参阅程序集定义以了解更多信息。

Editor 文件示例

Editor 测试
.asmdef
文件如下所示:
{ "name": "MyCompany.MyPackage.Editor.Tests", "references": [ "MyPackage.Editor", "MyPackage" ], "optionalUnityReferences": [ "TestAssemblies" ], "includePlatforms": [ “Editor” ], "excludePlatforms": []}

运行时文件示例

运行时测试
.asmdef
文件如下所示:
{ "name": "MyCompany.MyPackage.Tests", "references": [ "MyPackage" ], "optionalUnityReferences": [ "TestAssemblies" ], "includePlatforms": [], "excludePlatforms": []}

为包启用测试

对于嵌入式式包,不需要显式Enable测试,因为嵌入式包正在Development中。
但是,对于其他类型的依赖项,您需要将可测试项属性添加到 Project 清单,并添加具有要运行的测试的包的名称。这包括Project的直接和间接依赖关系。例如:
{ "dependencies": { "com.unity.some-package":"1.0.0", "com.unity.other-package":"2.0.0", "com.unity.yet-another-package":"3.0.0" }, "testables": ["com.unity.some-package", "com.unity.other-package"]}
此示例为 Unity 的 Test Framework 包中的 COM. unity.some-包和 COM. Unity.Other-包添加测试。
注意
您可能需要再次导入包,因为 Test Framework 并不总是能立即获取对
testables
属性的更改。