Add IPrebuildSetupWithTestData examples (UTF 1.6+)

Author: nowsprinting

Assets/APIExamples/Tests/Runtime/UnityTestFramework/PreBuildSetupAttributeExample.cs

@@ -7,13 +7,13 @@
 namespace APIExamples.UnityTestFramework
 {
     /// <summary>
-    /// <see cref="UnityEngine.TestTools.PrebuildSetupAttribute"/>で指定した<see cref="UnityEngine.TestTools.IPrebuildSetup"/>実装クラスの`Setup()`メソッドが使用されます
+    /// <see cref="UnityEngine.TestTools.PrebuildSetupAttribute"/> で指定した <see cref="UnityEngine.TestTools.IPrebuildSetup"/> 実装クラスの <c>Setup</c> メソッドが使用されます
+    /// <list type="bullet">
+    ///     <item>複数のテストに <c>PrebuildSetup</c> 属性が配置されていても、<c>Setup</c> の実行は1回だけです</item>
+    ///     <item><see cref="UnityEngine.TestTools.IPrebuildSetup"/> を実装していないクラスを渡した場合、何も起きません（エラーにもなりません）</item>
+    ///     <item><c>PrebuildSetup</c> 属性は、クラスにもメソッドにも配置できます</item>
+    /// </list>
     /// </summary>
-    /// <remarks>
-    /// - 複数のテストに属性が付与されていた場合、`Setup()`の実行は1回だけです
-    /// - <see cref="UnityEngine.TestTools.IPrebuildSetup"/>を実装していないクラスを渡した場合、何も起きません（エラーにもなりません）
-    /// - 属性は、クラスにもメソッドにも付与できます
-    /// </remarks>
     [PrebuildSetup(typeof(PreBuildSetupExample))]
     [PostBuildCleanup(typeof(PreBuildSetupExample))]
     public class PreBuildSetupAttributeExample

Assets/APIExamples/Tests/Runtime/UnityTestFramework/PreBuildSetupExample.cs

@@ -2,25 +2,34 @@
 // This software is released under the MIT License.
 
 using NUnit.Framework;
+using UnityEngine;
 using UnityEngine.TestTools;
 
 namespace APIExamples.UnityTestFramework
 {
+    /// <summary>
+    /// ビルド前後に処理を挿むための <see cref="UnityEngine.TestTools.IPrebuildSetup"/> および <see cref="UnityEngine.TestTools.IPostBuildCleanup"/> の実装例
+    /// </summary>
     public class PreBuildSetupExample : IPrebuildSetup, IPostBuildCleanup
     {
         ///<inheritdoc/>
+        /// <remarks>
+        /// Unityエディター実行（Edit ModeテストおよびPlay Modeテスト）では、すべてのテストの実行に先立って実行されます。
+        /// プレイヤー実行（Play Modeテスト）では、ビルド前に実行されます。
+        /// </remarks>
         public void Setup()
         {
-            // Edit ModeテストおよびPlay Modeテスト（Unityエディター実行）では、すべてのテストの実行に先立って実行される
-            // Play Modeテスト（プレイヤー実行）では、ビルド前に実行される
-            // テスト用のビルドにのみResourcesに含めたいアセットをコピーする使用例は `LoadAssetExample` を参照してください
+            Debug.Log("PreBuildSetupExample.Setup");
         }
 
         ///<inheritdoc/>
+        /// <remarks>
+        /// Unityエディター実行（Edit ModeテストおよびPlay Modeテスト）では、すべてのテストの実行終了後に実行されます。
+        /// プレイヤー実行（Play Modeテスト）では、ビルド後に実行されます。
+        /// </remarks>
         public void Cleanup()
         {
-            // Edit ModeテストおよびPlay Modeテスト（Unityエディター実行）では、すべてのテストの実行終了後に実行される
-            // Play Modeテスト（プレイヤー実行）では、ビルド後に実行される
+            Debug.Log("PreBuildSetupExample.Cleanup");
         }
 
         [Test]

Assets/APIExamples/Tests/Runtime/UnityTestFramework/PreBuildSetupWithTestDataAttributeExample.cs

@@ -0,0 +1,28 @@
+// Copyright (c) 2021-2025 Koji Hasegawa.
+// This software is released under the MIT License.
+
+#if ENABLE_UTF_1_6
+using NUnit.Framework;
+using UnityEngine.TestTools;
+
+namespace APIExamples.UnityTestFramework
+{
+    /// <summary>
+    /// <see cref="UnityEngine.TestTools.PrebuildSetupWithTestDataAttribute"/> で指定した <see cref="UnityEngine.TestTools.IPrebuildSetupWithTestData"/> 実装クラスの <c>Setup</c> メソッドが使用されます
+    /// </summary>
+    /// <remarks>
+    /// Required: Unity Test Framework v1.6 or later
+    /// </remarks>
+    /// <seealso cref="PreBuildSetupAttributeExample"/>
+    [PrebuildSetupWithTestData(typeof(PreBuildSetupWithTestDataExample))]
+    [PostBuildCleanupWithTestData(typeof(PreBuildSetupWithTestDataExample))]
+    public class PreBuildSetupWithTestDataAttributeExample
+    {
+        [Test]
+        public void PrebuildSetupWithTestDataAttributeを付与したテストの例()
+        {
+            Assert.That(true, Is.True);
+        }
+    }
+}
+#endif

Assets/APIExamples/Tests/Runtime/UnityTestFramework/PreBuildSetupWithTestDataAttributeExample.cs.meta

@@ -0,0 +1,51 @@
+// Copyright (c) 2021-2025 Koji Hasegawa.
+// This software is released under the MIT License.
+
+#if ENABLE_UTF_1_6
+using NUnit.Framework;
+using UnityEngine;
+using UnityEngine.TestTools;
+
+namespace APIExamples.UnityTestFramework
+{
+    /// <summary>
+    /// ビルド前後に処理を挿むための <see cref="UnityEngine.TestTools.IPrebuildSetupWithTestData"/> および <see cref="UnityEngine.TestTools.IPostbuildCleanupWithTestData"/> の実装例
+    /// </summary>
+    /// <remarks>
+    /// Required: Unity Test Framework v1.6 or later
+    /// </remarks>
+    /// <seealso cref="PreBuildSetupExample"/>
+    public class PreBuildSetupWithTestDataExample : IPrebuildSetupWithTestData, IPostbuildCleanupWithTestData
+    {
+        ///<inheritdoc/>
+        /// <remarks>
+        /// Unityエディター実行（Edit ModeテストおよびPlay Modeテスト）では、すべてのテストの実行に先立って実行されます。
+        /// プレイヤー実行（Play Modeテスト）では、ビルド前に実行されます。
+        /// <p/>
+        /// <see cref="TestData"/> には、テストモード、テストプラットフォーム、実行されるテストのリストが含まれます
+        /// </remarks>
+        public void Setup(TestData testData)
+        {
+            Debug.Log($"PreBuildSetupWithTestDataExample.Setup; testData: {testData}");
+        }
+
+        ///<inheritdoc/>
+        /// <remarks>
+        /// Unityエディター実行（Edit ModeテストおよびPlay Modeテスト）では、すべてのテストの実行終了後に実行されます。
+        /// プレイヤー実行（Play Modeテスト）では、ビルド後に実行されます。
+        /// <p/>
+        /// <see cref="TestData"/> には、テストモード、テストプラットフォーム、実行されるテストのリストが含まれます
+        /// </remarks>
+        public void Cleanup(TestData testData)
+        {
+            Debug.Log($"PreBuildSetupWithTestDataExample.Cleanup; testData: {testData}");
+        }
+
+        [Test]
+        public void IPrebuildSetupWithTestDataを実装したテストの例()
+        {
+            Assert.That(true, Is.True);
+        }
+    }
+}
+#endif