Unity で複数のTestsフォルダを Unity Test Runner が認識してくれない時の対処方法

#Unity

概要

Unity 2020.3 LTS バージョンにて、複数のTests フォルダに分けてテストコードを作成したとき、 Unity Test Runner が認識してくれなかったときの対処方法を記載しています。

以下のような構成でテストコードを作成しているとき、一つのテストフォルダ配下しか認識してくれなかった時があり、解決するために確認したことを記載しています。

Directories And Files

上記のように２つの Tests フォルダ配下にそれぞれ必要なテストコードを作成していましたが、片方の Tests フォルダしか認識してくれません。

Window -> General -> Test Runner で Unity Test Runner を開くと以下のように、NodachiFrameowork 配下の Tests しか認識していません。

UTF

確認

Unity Test Runner では Edit Mode と Play Mode の２種類のテストモードがあり、２つの Tests フォルダ配下に、それぞれ Edit Mode でのテストコードを格納しています。

Tests フォルダにはテスト実行時に必要とするアセンブリ定義ファイルが格納されており、その設定がおかしい可能性があります。

とりあえず Unity Editor 上でアセンブリ定義ファイルをクリックして画面上の Inspector を確認してみます。

ちゃんと認識してくれる Tests フォルダ配下のアセンブリ定義ファイルと認識してくれない Tests フォルダ配下のアセンブリ定義を比較してみます。

platform

微妙に違いました。画像の左は、Unity Test Runner 上から最初に Create EditMode Test Assembly Folder ボタンを押して作成した Tests フォルダ配下に自動的に作成されたアセンブリ定義ファイルです。画像の右は Unity Editor の Project ウィンドウ上で右クリック -> Craete -> Testing -> Tests Assembly Folderで作成されたアセンブリ定義ファイルにの Edit Mode にチェックを入れたものです。

差異

注意深くみればもう判るのですが、 Tests として認識されないアセンブリ定義ファイルのほうは、Exclude Platforms とジャンル名が異なります。

platform

ということで、Edit Mode を除外する設定となってしまっていました。

修正

アセンブリ定義ファイルはテキスト形式ですので、直接エディタで開き編集できます。

以下、編集前。ハイライト部分を修正しました。

Ng_TestsAssembly.asmdef

{
    "name": "XxxxTests",
    "rootNamespace": "",
    "references": [
        "UnityEngine.TestRunner",
        "UnityEditor.TestRunner",
        "テストに必要なパッケージ"
    ],
    "includePlatforms": [],
    "excludePlatforms": [
        "Editor"
    ],
    "allowUnsafeCode": false,
    "overrideReferences": true,
    "precompiledReferences": [
        "nunit.framework.dll"
    ],
    "autoReferenced": false,
    "defineConstraints": [
        "UNITY_INCLUDE_TESTS"
    ],
    "versionDefines": [],
    "noEngineReferences": false
}

以下は修正後です。

OK_TestsAssembly.asmdef

{
    "name": "XxxxTests",
    "rootNamespace": "",
    "references": [
        "UnityEngine.TestRunner",
        "UnityEditor.TestRunner",
        "テストに必要なパッケージ"
    ],
    "includePlatforms": [
        "Editor"
    ],
    "excludePlatforms": [],
    "allowUnsafeCode": false,
    "overrideReferences": true,
    "precompiledReferences": [
        "nunit.framework.dll"
    ],
    "autoReferenced": false,
    "defineConstraints": [
        "UNITY_INCLUDE_TESTS"
    ],
    "versionDefines": [],
    "noEngineReferences": false
}