litho-core/com.facebook.litho/LithoViewTestHelper

LithoViewTestHelper

object LithoViewTestHelper

Helper class to access metadata from LithoView that is relevant during end to end tests. In order for the data to be collected, ComponentsConfiguration#isEndToEndTestRun must be enabled.

Types

Link copied to clipboard
class InternalNodeRef(val internalNodeRef: LithoLayoutResult)

Holds an opaque reference to an LithoNode without giving the holder any access to it.

Functions

Link copied to clipboard
@JvmStatic
fun findTestItem(lithoView: LithoView, testKey: String?): TestItem?
Link copied to clipboard
@JvmStatic
fun findTestItems(lithoView: LithoView, testKey: String): Deque<TestItem>

Finds a TestItem given a LithoView based on the test key it was assigned during construction.

Link copied to clipboard
@JvmStatic
fun getRootLayoutRef(view: LithoView): LithoViewTestHelper.InternalNodeRef?

Obtain a reference to a LithoView's internal layout root, if present. This is used to restore a view's root after it has been freed for testing purposes.

Link copied to clipboard
@JvmStatic
fun rootInstanceToString(root: DebugComponent?, embedded: Boolean, startingDepth: Int): String

Provides a nested string representation of a DebugComponent and its nested components for debugging.

Link copied to clipboard
@JvmStatic
fun setRootLayoutRef(view: LithoView, rootLayoutNode: LithoViewTestHelper.InternalNodeRef)

Restore a previously saved root layout reference.

Link copied to clipboard
@JvmStatic
fun toDebugString(baseMountingView: BaseMountingView?): String
Link copied to clipboard
@JvmStatic
fun viewToString(view: BaseMountingView): String

@JvmStatic
fun viewToString(view: BaseMountingView, embedded: Boolean): String

Provide a nested string representation of a LithoView and its nested components for debugging purposes.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun viewToStringForE2E(view: View, depth: Int, withProps: Boolean, extraDescription: DebugComponentDescriptionHelper.ExtraDescription? = null): String

Provide a nested string representation of a LithoView and its nested components for E2E testing purposes. Note: this method is called via reflection to prevent direct or shared dependencies. DO NOT CHANGE the method signature.