Unity Test Frameworkパッケージには、Unityエディターをフリーズさせてしまうような落とし穴が依然として存在します。 拙著『Unity Test Framework完全攻略ガイド』を読んでいれば回避できるものですが、同人誌を読んでいないAIコーディングエージェントは容易にその穴にはまります*1。
そこで、これらをテスト実行前に検知するRoslynアナライザー「UTF Analyzers」を作成し、OSSとして公開しました。
一般にLLMは否定形の命令に弱く、Agent Skillsなどによる回避は確実性に欠けるうえ、コンテキストウィンドウを無駄に使います。 またUnityエディターがフリーズしたとき、その原因がテストコードの書き方によるものとは考えないようで(それはそう)、環境要因を疑って迷走しはじめます。 そのため、コンパイル時にアナライザーによって防ぐのが最適解です。

もちろん人間もうっかりミスをするので、自らテストコードを書く際にも有効です。 現状はクリティカルな問題を回避するアナライザーと、他のアナライザーの診断のうちテストコードにそぐわないものを抑止するサプレッサーのみ実装していますが、今後、よりよいテストコードの書き方をサジェストする診断も追加していく予定です。
なお、主用途がAIコーディングエージェント向けのため、CodeFixは提供していません。
診断ルール(v1.1.0 時点)
構造 (UTF1xxx)
テストメソッドのシグネチャおよび属性の組み合わせに関するルール。 UTFのバージョンによりますが、Unityエディタがフリーズしたり、実行時エラーになるもの。デフォルトの重大度はErrorです。
| Id | Title |
|---|---|
| UTF1001 | コルーチン形式のテストメソッドでは、TestCase 属性および TestCaseSource 属性はサポートされません |
| UTF1002 | テストメソッドの戻り値の型として Task<TResult> はサポートされません |
| UTF1003 | コルーチン形式のテストメソッドでは、Pairwise 属性、Sequential 属性、および Combinatorial 属性はサポートされません |
| UTF1004 | async メソッドでは、OneTimeSetUp 属性および OneTimeTearDown 属性はサポートされません |
| UTF1005 | ICommandWrapper を実装する属性は、async テストメソッドおよびコルーチン形式のテストメソッドではサポートされません |
アサーション (UTF2xxx)
アサーションおよび制約の誤用に関するルール。 Unityエディタがフリーズしたり、実行時エラーになるもの。デフォルトの重大度はErrorです。
| Id | Title |
|---|---|
| UTF2001 | Assert.ThrowsAsync、CatchAsync、および DoesNotThrowAsync はサポートされません |
| UTF2002 | Throws 制約、Assert.Throws、Assert.Catch、および Assert.DoesNotThrow の実際の値として、async デリゲートはサポートされません |
| UTF2003 | 制約モデルの実際の値として、async デリゲートはサポートされません |
| UTF2004 | AllocatingGCMemory 制約の実際の値としてサポートされるのは TestDelegate のみです |
| UTF2005 | DelayedConstraint はサポートされません |
サプレッサー (UTF3xxx)
テストコードにそぐわない、他のアナライザーによって報告される診断を抑制します。
| Id | Title |
|---|---|
| UTF3001 | Assert.Multiple が利用できない場合、NUnit2045 (Use Assert.Multiple) を抑制します |
| UTF3002 | メンバーが UnitySetUp または UnityOneTimeSetUp メソッドで初期化される場合、CS8618 (Non-nullable field or property is uninitialized) を抑制します |
| UTF3003 | UnityTearDown または UnityOneTimeTearDown メソッドを持つテストフィクスチャでは、CA1001 (Types that own disposable fields should be disposable) を抑制します |
| UTF3004 | UnitySetUp、UnityOneTimeSetUp、UnityTearDown、および UnityOneTimeTearDown メソッドでは、NUnit1028 (The non-test method is public) を抑制します |
| UTF3005 | テストメソッドでは、CA1707 (Identifiers should not contain underscores) を抑制します |
| UTF3006 | テストメソッドでは、VSTHRD200 (Use Async suffix for async methods) を抑制します |
拡張 (UTF5xxx)
カスタム属性、制約、および比較器の作成者向けのルール。 UTFのバージョンによりますが、Unityエディタがフリーズしたり、実行時エラーになるもの。デフォルトの重大度はErrorです。
| Id | Title |
|---|---|
| UTF5001 | ApplyToTest、ApplyToContext、および Wrap は例外をスローしてはいけません |
使用方法
UPMパッケージ版は、パッケージをインストールするだけでプロジェクト内のすべてのテストアセンブリにアナライザが適用されます*2。 またNUnit.Analyzers v3.9.0も同梱しています。
UTF Analyzers単体はNuGetパッケージとしても配布しており、NuGetForUnity および UnityNuGet*3からインストールできます。
諸事情あってパッケージIDが表記揺れを起こしていますが見逃してください。
参考
ユニットテストを体系的に学びたい、AIコーディングエージェントの書いたテストをちゃんとレビューしたい、フレームワークを拡張したい、という方はぜひお読みください! www.nowsprinting.com
AIコーディングエージェントにテスト設計とテストファースト開発をさせるAgent Skillsも公開しています。 www.nowsprinting.com


