File size: 6,127 Bytes
18a519f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | # UnitySetUp and UnityTearDown
The `UnitySetUp` and `UnityTearDown` attributes are identical to the standard `SetUp` and `TearDown` attributes, with the exception that they allow for [yielding instructions](reference-custom-yield-instructions.md). The `UnitySetUp` and `UnityTearDown` attributes expect a return type of [IEnumerator](https://docs.microsoft.com/en-us/dotnet/api/system.collections.ienumerator?view=netframework-4.8).
## UnitySetUp and UnityTeardown example
```c#
public class SetUpTearDownExample
{
[UnitySetUp]
public IEnumerator SetUp()
{
yield return new EnterPlayMode();
}
[Test]
public void MyTest()
{
Debug.Log("This runs inside playmode");
}
[UnityTearDown]
public IEnumerator TearDown()
{
yield return new ExitPlayMode();
}
}
```
## Execution order
`UnitySetUp` and `UnityTearDown` can be used with either the `Test` or `UnityTest` test attributes. In both cases the relative execution order of Unity and non-Unity `SetUp` and `TearDown` attributes is the same. The only difference is that a `UnityTest` allows for yielding instructions during the test that can result in a domain reload, in which case the non-Unity `SetUp` and `TearDown` methods are re-run before proceeding to the second part of the test.
> **Note**: Some browsers do not support SVG image files. If the image above does not display properly (for example, if you cannot see any text), please try another browser, such as [Google Chrome](https://www.google.com/chrome/) or [Mozilla Firefox](https://www.mozilla.org).
## Base and Derived classes
The term **base** in the execution order denotes a base class from which a test class inherits. `UnitySetUp` and `UnityTearDown` follow the same pattern as NUnit `SetUp` and `TearDown` attributes in determining execution order between base classes and their derivatives. `SetUp` methods are called on base classes first, and then on derived classes. `TearDown` methods are called on derived classes first, and then on the base class. See the [NUnit Documentation](https://docs.nunit.org/articles/nunit/technical-notes/usage/SetUp-and-TearDown.html) for more details.
### Base and Derived class example
```csharp
public class BaseClass
{
[OneTimeSetUp]
public void OneTimeSetUp()
{
Debug.Log("OneTimeSetUp Base");
}
[SetUp]
public void SetUp()
{
Debug.Log("SetUp Base");
}
[UnitySetUp]
public IEnumerator UnitySetUp()
{
Debug.Log("UnitySetup Base");
yield return null;
}
[TearDown]
public void TearDown()
{
Debug.Log("TearDown Base");
}
[UnityTearDown]
public IEnumerator UnityTearDown()
{
Debug.Log("UnityTearDown Base");
yield return null;
}
}
public class DerivedClass: BaseClass
{
[OneTimeSetUp]
public new void OneTimeSetUp()
{
Debug.Log("OneTimeSetUp");
}
[SetUp]
public new void SetUp()
{
Debug.Log("SetUp");
}
[UnitySetUp]
public new IEnumerator UnitySetUp()
{
Debug.Log("UnitySetup");
yield return null;
}
[Test]
public void UnitTest()
{
Debug.Log("Test");
}
[UnityTest]
public IEnumerator UnityTest()
{
Debug.Log("UnityTest before yield");
yield return null;
Debug.Log("UnityTest after yield");
}
[TearDown]
public new void TearDown()
{
Debug.Log("TearDown");
}
[UnityTearDown]
public new IEnumerator UnityTearDown()
{
Debug.Log("UnityTearDown");
yield return null;
}
[OneTimeTearDown]
public void OneTimeTearDown()
{
Debug.Log("OneTimeTearDown");
}
}
```
### Domain reload example
```csharp
public class BaseClass
{
[OneTimeSetUp]
public void OneTimeSetUp()
{
Debug.Log("OneTimeSetUp Base");
}
[SetUp]
public void SetUp()
{
Debug.Log("SetUp Base");
}
[UnitySetUp]
public IEnumerator UnitySetUp()
{
Debug.Log("UnitySetup Base");
yield return null;
}
[TearDown]
public void TearDown()
{
Debug.Log("TearDown Base");
}
[UnityTearDown]
public IEnumerator UnityTearDown()
{
Debug.Log("UnityTearDown Base");
yield return null;
}
}
public class DerivedClass: BaseClass
{
[OneTimeSetUp]
public new void OneTimeSetUp()
{
Debug.Log("OneTimeSetUp");
}
[SetUp]
public new void SetUp()
{
Debug.Log("SetUp");
}
[UnitySetUp]
public new IEnumerator UnitySetUp()
{
Debug.Log("UnitySetup");
yield return null;
}
[Test]
public void UnitTest()
{
Debug.Log("Test");
}
[UnityTest]
public IEnumerator UnityTest()
{
Debug.Log("UnityTest before yield");
yield return new EnterPlayMode();
//Domain reload happening
yield return new ExitPlayMode();
Debug.Log("UnityTest after yield");
}
[TearDown]
public new void TearDown()
{
Debug.Log("TearDown");
}
[UnityTearDown]
public new IEnumerator UnityTearDown()
{
Debug.Log("UnityTearDown");
yield return null;
}
[OneTimeTearDown]
public void OneTimeTearDown()
{
Debug.Log("OneTimeTearDown");
}
}
``` |