Class UnityPlatformAttribute

Use this attribute to define a specific set of platforms you want or do not want your test(s) to run on.

You can use this attribute on the test method, test class, or test assembly level. Use the supported RuntimePlatform enumeration values to specify the platforms. You can also specify which platforms to test by passing one or more RuntimePlatform values along with or without the include or exclude properties as parameters to the Platform attribute constructor.

The test(s) skips if the current target platform is:

  • Not explicitly specified in the included platforms list
  • In the excluded platforms list
Inheritance
object
Attribute
NUnitAttribute
UnityPlatformAttribute
Implements
IApplyToTest
Inherited Members
Namespace: UnityEngine.TestTools
Assembly: UnityEngine.TestRunner.dll
Syntax
[AttributeUsage(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = true)]
public class UnityPlatformAttribute : NUnitAttribute, IApplyToTest
Examples
using UnityEngine;
using UnityEngine.TestTools;
using NUnit.Framework;

[TestFixture]
public class TestClass
{
    [Test]
    [UnityPlatform(RuntimePlatform.WindowsPlayer)]
    public void TestMethod()
    {
        Assert.AreEqual(Application.platform, RuntimePlatform.WindowsPlayer);
    }
}

Constructors

UnityPlatformAttribute()

Constructs a new instance of the UnityPlatformAttribute class.

Declaration
public UnityPlatformAttribute()

UnityPlatformAttribute(params RuntimePlatform[])

Constructs a new instance of the UnityPlatformAttribute class with a list of platforms to include.

Declaration
public UnityPlatformAttribute(params RuntimePlatform[] include)
Parameters
Type Name Description
RuntimePlatform[] include

The different RuntimePlatform to run the test on.

Properties

exclude

List the platforms you do not want to have your tests run on.

Declaration
public RuntimePlatform[] exclude { get; set; }
Property Value
Type Description
RuntimePlatform[]

include

A subset of platforms you need to have your tests run on.

Declaration
public RuntimePlatform[] include { get; set; }
Property Value
Type Description
RuntimePlatform[]

Methods

ApplyToTest(Test)

Modifies a test as defined for the specific attribute.

Declaration
public void ApplyToTest(Test test)
Parameters
Type Name Description
Test test

The test to modify

Implements

NUnit.Framework.Interfaces.IApplyToTest