どのような開発でもそうですが、パッケージにテストを追加するのは良いことです。パッケージにテストを設定するには、以下の 3 つを行う必要があります。
Editor と Runtime サブフォルダー内のパッケージの Tests フォルダーにテストファイルを加えます。例えば、テストを持つ単純なパッケージは以下のようになります。
MyPackage
├── package.json
├── Editor
│ ├── MyPackage.Editor.asmdef
│ └── EditorExample.cs
├── Runtime
│ ├── MyPackage.Runtime.asmdef
│ └── RuntimeExample.cs
└── Tests
├── Editor
│ ├── MyPackage.EditorTests.asmdef
│ └── EditorExampleTest.cs
└── Runtime
├── MyPackage.RuntimeTests.asmdef
└── RuntimeExampleTest.cs
これらの各サブフォルダーには .asmdef
ファイルが含まれている必要があります。このファイルはエディターとランタイムアセンブリへの参照を提供します。アセンブリ定義ファイルは、テストアセンブリファイルへの参照も提供します。詳細は、テスト用アセンブリ定義ファイルを参照してください。
アセンブリ定義ファイルを直接編集できます。以下の参照を必ず加えてください。
属性 | タイプ | 説明 |
---|---|---|
name | 文字列 | ファイル拡張子を除いたアセンブリの名前。 |
references | 文字列の配列 | エディターとランタイムのアセンブリへの参照。アセンブリ定義ファイルは、エディターとランタイム、どちらのテストかによって異なる参照が必要です。 - エディターテストの場合は、パッケージのエディターアセンブリとランタイムアセンブリへの参照を加えます。 - ランタイムテストの場合は、パッケージのランタイムアセンブリのみへの参照を追加します。 |
optionalUnityReferences | 文字列の配列 | アセンブリをテストアセンブリとするには、この Unity 参照のリストに “TestAssemblies” を加える必要があります。これにより、unit.framework.dll と UnityEngine.TestRunner.dll ライブラリへの参照がアセンブリ定義に追加されます。 |
includePlatforms | 文字列の配列 | エディターテストの場合は、このプラットフォームのリストに エディター プラットフォームを加える必要があります。 |
ヒント: インスペクターでアセンブリ定義ファイルを編集することもできます。詳細はアセンブリ定義を参照してください。
以下は、エディターテスト .asmdef
ファイルの例です。
{
"name": "MyPackage.Editor.Tests",
"references": [
"MyPackage.Editor",
"MyPackage"
],
"optionalUnityReferences": [
"TestAssemblies"
],
"includePlatforms": [
"Editor"
],
"excludePlatforms": []
}
以下は、ランタイムテスト .asmdef
ファイルの例です。
{
"name": "MyPackage.Tests",
"references": [
"MyPackage"
],
"optionalUnityReferences": [
"TestAssemblies"
],
"includePlatforms": [],
"excludePlatforms": []
}
埋め込みパッケージの場合は開発中のため、明示的にテストを有効にする必要はありません。
ただし、他の種類の依存関係に対しては、testables 属性をプロジェクトマニフェストに加え、実行するテストを含むパッケージの名前を追加する必要があります。これには、プロジェクトの直接的および間接的な依存関係が含まれます。以下はその例です。
{
"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 Runner に com.unity.some-package と com.unity.other-package パッケージのテストを加えています。
ノート: テストランナーが常に testables 属性の変更を即座に反映するとは限らないため、パッケージの再インポートが必要な場合があります。