Class UITestFixture

Test fixture base class that creates a UIToolkit panel without the resources needed for an EditorWindow.

Inheritance

object

AbstractUITestFixture

UITestFixture

Inherited Members

AbstractUITestFixture.AddTestComponent<T>()

AbstractUITestFixture.RemoveTestComponent<T>()

AbstractUITestFixture.panel

AbstractUITestFixture.rootVisualElement

AbstractUITestFixture.panelName

AbstractUITestFixture.needsRendering

AbstractUITestFixture.pixelsPerPoint

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.UIElements.TestFramework

Assembly: Unity.UI.TestFramework.Runtime.dll

Syntax

public abstract class UITestFixture : AbstractUITestFixture

Remarks

Use this class when the UIToolkit content being tested can be decoupled from an actual EditorWindow. If an EditorWindow is required for the test, use EditorWindowUITestFixture<EditorWindowType> instead. To temporarily create an EditorWindow while developing or debugging tests that would otherwise use this class, see DebugUITestFixture. From a playmode context, it will run as a RuntimeUITestFixture, using a default runtime theme. UITestFrameworkRuntimeOptions to set a default runtime stylesheet."/>

Constructors

UITestFixture()

Instantiates a UITestFixture using the AutoDetect functionality.

Declaration

protected UITestFixture()

UITestFixture(bool)

Instantiates a UITestFixture using the AutoDetect functionality.

Declaration

protected UITestFixture(bool debugMode)

Parameters

Type	Name	Description
bool	debugMode	Enables debugging for Editor tests, functioning as DebugUITestFixture. Ignored for Runtime tests.

UITestFixture(FixtureType, bool)

Instantiates a UITestFixture for the supplied fixtureType.

Declaration

protected UITestFixture(UITestFixture.FixtureType fixtureType, bool debugMode = false)

Parameters

Type	Name	Description
UITestFixture.FixtureType	fixtureType	The type of test fixture to create.
bool	debugMode	Enables debugging for Editor tests, functioning as DebugUITestFixture. Ignored for Runtime tests.

Exceptions

Type	Condition
InvalidOperationException	Throws when trying to create an Editor UITestFixture in the wrong setting.

Properties

clearContentAfterTest

When set to true, the rootVisualElement will be cleared after each test.

Declaration

public override sealed bool clearContentAfterTest { get; set; }

Property Value

Type	Description
bool

Overrides

AbstractUITestFixture.clearContentAfterTest

panelSize

The size of the root VisualElement of the panel.

Declaration

public override sealed Vector2 panelSize { get; set; }

Property Value

Type	Description
Vector2

Overrides

AbstractUITestFixture.panelSize

simulate

Returns the PanelSimulator used by the test fixture.

Declaration

public override sealed PanelSimulator simulate { get; set; }

Property Value

Type	Description
PanelSimulator

Overrides

AbstractUITestFixture.simulate

Remarks

Use this property to interact with the simulated panel.

themeStyleSheet

Theme style sheet used by this test fixture.

Declaration

public override sealed ThemeStyleSheet themeStyleSheet { get; set; }

Property Value

Type	Description
ThemeStyleSheet

Overrides

AbstractUITestFixture.themeStyleSheet

Remarks

Defaults to null. When the value is null, the style applied will be the default theme style sheet.

Methods

AddTestComponent(UITestComponent)

Adds the component to the test fixture.

Declaration

public override sealed void AddTestComponent(UITestComponent component)

Parameters

Type	Name	Description
UITestComponent	component	The UITestComponent to add to the test fixture.

Overrides

AbstractUITestFixture.AddTestComponent(UITestComponent)

Remarks

Adding the component to the test fixture triggers relevant UITestComponent virtual methods based on the current test state.

FindTestComponent<T>()

Returns the first component of type T attached to the test fixture.

Declaration

public override sealed T FindTestComponent<T>()

Returns

Type	Description
T	The first component of type T.

Type Parameters

Name	Description
T	The type of UITestComponent to search for.

Overrides

AbstractUITestFixture.FindTestComponent<T>()

FixtureOneTimeSetUp()

Sets up the test fixture.

Declaration

public override void FixtureOneTimeSetUp()

Overrides

AbstractUITestFixture.FixtureOneTimeSetUp()

FixtureOneTimeTearDown()

Tears down the test fixture.

Declaration

public override void FixtureOneTimeTearDown()

Overrides

AbstractUITestFixture.FixtureOneTimeTearDown()

FixtureSetUp()

Sets up the test.

Declaration

public override void FixtureSetUp()

Overrides

AbstractUITestFixture.FixtureSetUp()

FixtureTearDown()

Tears down the test.

Declaration

public override void FixtureTearDown()

Overrides

AbstractUITestFixture.FixtureTearDown()

RecreatePanel()

Recreates the simulated UIToolkit panel, providing a fresh instance.

Declaration

public override sealed void RecreatePanel()

Overrides

AbstractUITestFixture.RecreatePanel()

ReleasePanel()

Releases the currently simulated UIToolkit panel.

Declaration

public override sealed void ReleasePanel()

Overrides

AbstractUITestFixture.ReleasePanel()

RemoveTestComponent(UITestComponent)

Removes the component from the test fixture.

Declaration

public override sealed void RemoveTestComponent(UITestComponent component)

Parameters

Type	Name	Description
UITestComponent	component	The UITestComponent to remove from the test fixture.

Overrides

AbstractUITestFixture.RemoveTestComponent(UITestComponent)

Remarks

Removing the component from the test fixture triggers relevant UITestComponent virtual methods based on on the current test state.