diff options
| author | Andrew Lee <alee14498@protonmail.com> | 2020-04-19 17:19:32 -0400 |
|---|---|---|
| committer | Andrew Lee <alee14498@protonmail.com> | 2020-04-19 17:19:32 -0400 |
| commit | c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78 (patch) | |
| tree | ee4d51c7c1d633e11f46453ef1edd3c77c4ef9f7 /Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-itest-adaptor.md | |
| download | Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.tar.gz Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.tar.bz2 Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.zip | |
Inital commit
Diffstat (limited to 'Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-itest-adaptor.md')
| -rw-r--r-- | Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-itest-adaptor.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-itest-adaptor.md b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-itest-adaptor.md new file mode 100644 index 0000000..77232be --- /dev/null +++ b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-itest-adaptor.md @@ -0,0 +1,31 @@ +# ITestAdaptor
+`ITestAdaptor` is a representation of a node in the test tree implemented as a wrapper around the [NUnit](http://www.nunit.org/) [ITest](https://github.com/nunit/nunit/blob/master/src/NUnitFramework/framework/Interfaces/ITest.cs) interface.
+
+## Properties
+
+| Syntax | Description |
+| ---------- | ------------------------------------------------------------ |
+| `string Id` | The ID of the test tree node. The ID can change if you add new tests to the suite. Use `UniqueName`, if you want to have a more permanent point of reference. |
+| `string Name` | The name of the test. E.g., `MyTest`. |
+| `string FullName` | The full name of the test. E.g., `MyNamespace.MyTestClass.MyTest`. |
+| `int TestCaseCount` | The total number of test cases in the node and all sub-nodes. |
+| `bool HasChildren` | Whether the node has any children. |
+| `bool IsSuite` | Whether the node is a test suite/fixture. |
+| `IEnumerable<ITestAdaptor> Children` | The child nodes. |
+| `ITestAdaptor Parent` | The parent node, if any. |
+| `int TestCaseTimeout` | The test case timeout in milliseconds. Note that this value is only available on TestFinished. |
+| `ITypeInfo TypeInfo` | The type of test class as an `NUnit` [ITypeInfo](https://github.com/nunit/nunit/blob/master/src/NUnitFramework/framework/Interfaces/ITypeInfo.cs). If the node is not a test class, then the value is `null`. |
+| `IMethodInfo Method` | The [Nunit IMethodInfo](https://github.com/nunit/nunit/blob/master/src/NUnitFramework/framework/Interfaces/IMethodInfo.cs) of the test method. If the node is not a test method, then the value is `null`. |
+| `string[] Categories` | An array of the categories applied to the test or fixture. |
+| `bool IsTestAssembly` | Whether the node represents a test assembly. |
+| `RunState RunState` | The run state of the test node. Either `NotRunnable`, `Runnable`, `Explicit`, `Skipped`, or `Ignored`. |
+| `string Description` | The description of the test. |
+| `string SkipReason` | The skip reason. E.g., if ignoring the test. |
+| `string ParentId` | The ID of the parent node. |
+| `string ParentFullName` | The full name of the parent node. |
+| `string UniqueName` | A unique generated name for the test node. E.g., `Tests.dll/MyNamespace/MyTestClass/[Tests][MyNamespace.MyTestClass.MyTest]`. |
+| `string ParentUniqueName` | A unique name of the parent node. E.g., `Tests.dll/MyNamespace/[Tests][MyNamespace.MyTestClass][suite]`. |
+| `int ChildIndex` | The child index of the node in its parent. |
+| `TestMode TestMode` | The mode of the test. Either **Edit Mode** or **Play Mode**. |
+
+> **Note**: Some properties are not available when receiving the test tree as a part of a test result coming from a standalone Player, such as `TypeInfo` and `Method`.
\ No newline at end of file |