【Unity】com.unity.search.extensionsに依存しているとEditMode TestがFailする話

はじめに

先日Unityが公開している(といってもOfficialではない)パッケージであるcom.unity.search.extensionsに依存しているプロジェクトのEditMode TestがFailしてしまうことに気が付きました。

ValidateCustomIndexation(t:shader sh_rendertype=opaque [Assets/Materials/SurfaceShader.shader] => 1 ) (0.013s)
---
  Query t:shader sh_rendertype=opaque yielded 0 expected was 1
  Expected: 1
  But was:  0

---
at CustomIndexationTests+<ValidateCustomIndexation>d__2.MoveNext () [0x00105] in Library/PackageCache/com.unity.search.extensions/Indexing/CustomIndexationTests.cs:77
at UnityEngine.TestTools.TestEnumerator+<Execute>d__7.MoveNext () [0x0004e] in Library/PackageCache/com.unity.test-framework/UnityEngine.TestRunner/NUnitExtensions/Attributes/TestEnumerator.cs:44

github.com

これが結構根深い問題でして、意外と解決が難しかったりします。ちなみに同様の問題提起をしているIssueもあります。
github.com

今回は原因と暫定的な対処法について紹介したいと思います。

はじめに
問題
対処法

問題

まずcom.unity.search.extensionsには[UnityTest]を利用したEditMode Testが実装されています。
github.com

そのテストがFailしてしまう状態で公開されている + 利用者側のEditMode Testに入り込んでくるという罠を抱えています。

バージョニングについて

com.unity.search.extensionsのバージョニングはかなり適当なので辛いです。

package.jsonはv1.0.1を指していますが、同じバージョンでも頻繁に更新がされています。またgit URLで取得するスタイルなので、取得タイミングによっては中身が変わります。
github.com

packages-lock.jsonのhashにより利用するパッケージのコミットハッシュが固定されるのでまだ良いですが、バージョンはあてにせず最悪コミットハッシュを明示的に指定しましょう。

testableについて

またmanifest.jsonにtestableで明示的にcom.unity.search.extensionsをしないようにしてみました。

{
  "dependencies": {
    "com.unity.search.extensions": "https://github.com/Unity-Technologies/com.unity.search.extensions.git?path=package",
    ...
  },
  "testables": [
      // ここにcom.unity.search.extensionsを指定しない
  ]
}

しかしそれでも何故かEditMode Testに含まれてしまいました。有識者に何故か教えていただきたいです...。

追記(2024/11/26)

testablesがうまく動作しないのは、com.unity.search.extensions.editor.asmdefのdefineConstraintsにUNITY_INCLUDE_TESTSがないことが原因でした。
github.com

おそらく多分UNITY_INCLUDE_TESTSの有無がUnityのtestable判定に関係してるんだと思います。editor用のasmdefにtest入れ込んでしまったことが大きな要因な気がしてます。

これもパッケージの中身を書き換えないといけないので、利用者としては辛いですね。

PR・Issueについて

PRやIssueは受け付けていませんスタイルです。

This repository is read-only. Owners won't accept pull requests, GitHub review requests, or any other GitHub-hosted issue management requests.

なので中身を変えたいとなったら、forkして自前で修正するしかありません。

対処法

testableで上手く解決できれば良かったのですが上手くできず、以下の3つが考えられました。

CIでFilterをかける
forkして改造
TestがPassするようにする

CIでFilterをかける

CIでEditMode Testを実行している場合は、com.unity.search.extensionsに依存していると失敗します。それを防ぐにはCommand Line引数によりTest対象から外すことができます。

docs.unity3d.com
docs.unity3d.com

しかしローカルでテストを実行する際は大体Unity Editor上でしょうし、やって損はないものの問題の解決には至りません。

forkして改造

なしではないとは思いますが、まあ辛いことが多いですね。

TestがPassするようにする

Assets/Materials/SurfaceShader.shaderというパスでopaqueなShaderを配置してあげるとテストが通るようになります。

var shaderInPackage = "Assets/Materials/SurfaceShader.shader";
yield return new CustomIndexationTestCase("t:shader sh_rendertype=opaque", shaderInPackage, true);

com.unity.search.extensions/package/Indexing/CustomIndexationTests.cs at 4996b11aa61dd5b0bdda66b897ac1a15b9d58c72 · Unity-Technologies/com.unity.search.extensions · GitHub

大分いかついパスですが、まあ一番コスパよく対応するならこれが良いのかなと思います。

↓例

Shader "Unlit/SurfaceShader"
{
    Properties
    {
        _MainTex ("Texture", 2D) = "white" {}
    }
    SubShader
    {
        Tags { "RenderType"="Opaque" }
        LOD 100

        Pass
        {
            CGPROGRAM
            #pragma vertex vert
            #pragma fragment frag
            // make fog work
            #pragma multi_compile_fog

            #include "UnityCG.cginc"

            struct appdata
            {
                float4 vertex : POSITION;
                float2 uv : TEXCOORD0;
            };

            struct v2f
            {
                float2 uv : TEXCOORD0;
                UNITY_FOG_COORDS(1)
                float4 vertex : SV_POSITION;
            };

            sampler2D _MainTex;
            float4 _MainTex_ST;

            v2f vert (appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                o.uv = TRANSFORM_TEX(v.uv, _MainTex);
                UNITY_TRANSFER_FOG(o,o.vertex);
                return o;
            }

            fixed4 frag (v2f i) : SV_Target
            {
                // sample the texture
                fixed4 col = tex2D(_MainTex, i.uv);
                // apply fog
                UNITY_APPLY_FOG(i.fogCoord, col);
                return col;
            }
            ENDCG
        }
    }
}