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-attribute-conditionalignore.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-attribute-conditionalignore.md')
| -rw-r--r-- | Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-attribute-conditionalignore.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-attribute-conditionalignore.md b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-attribute-conditionalignore.md new file mode 100644 index 0000000..1d0d4ba --- /dev/null +++ b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-attribute-conditionalignore.md @@ -0,0 +1,39 @@ +# ConditionalIgnore attribute
+
+This attribute is an alternative to the standard `Ignore` attribute in [NUnit](http://www.nunit.org/). It allows for ignoring tests only under a specified condition. The condition evaluates during `OnLoad`, referenced by ID.
+
+## Example
+
+The following example shows a method to use the `ConditionalIgnore` attribute to ignore a test if the Unity Editor is running macOS:
+
+```C#
+using UnityEditor;
+using NUnit.Framework;
+using UnityEngine.TestTools;
+
+[InitializeOnLoad]
+public class OnLoad
+{
+ static OnLoad()
+ {
+ var editorIsOSX = false;
+ #if UNITY_EDITOR_OSX
+ editorIsOSX = true;
+ #endif
+
+ ConditionalIgnoreAttribute.AddConditionalIgnoreMapping("IgnoreInMacEditor", editorIsOSX);
+ }
+}
+
+public class MyTestClass
+{
+ [Test, ConditionalIgnore("IgnoreInMacEditor", "Ignored on Mac editor.")]
+ public void TestNeverRunningInMacEditor()
+ {
+ Assert.Pass();
+ }
+}
+
+```
+
+> **Note**: You can only use `InitializeOnLoad` in **Edit Mode** tests.
\ No newline at end of file |