summaryrefslogtreecommitdiff
path: root/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/extension-retrieve-test-list.md
diff options
context:
space:
mode:
Diffstat (limited to 'Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/extension-retrieve-test-list.md')
-rw-r--r--Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/extension-retrieve-test-list.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/extension-retrieve-test-list.md b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/extension-retrieve-test-list.md
new file mode 100644
index 0000000..a2b9313
--- /dev/null
+++ b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/extension-retrieve-test-list.md
@@ -0,0 +1,13 @@
+# How to retrieve the list of tests
+It is possible to use the [TestRunnerApi](./reference-test-runner-api.md) to retrieve the test tree for a given test mode (**Edit Mode** or **Play Mode**). You can retrieve the test tree by invoking `RetrieveTestList` with the desired `TestMode` and a callback action, with an [ITestAdaptor](./reference-itest-adaptor.md) representing the test tree.
+
+## Example
+The following example retrieves the test tree for Edit Mode tests and prints the number of total test cases:
+``` C#
+var api = ScriptableObject.CreateInstance<TestRunnerApi>();
+api.RetrieveTestList(TestMode.EditMode, (testRoot) =>
+{
+ Debug.Log(string.Format("Tree contains {0} tests.", testRoot.TestCaseCount));
+});
+```
+