com.facebook.litho

Class LithoViewTestHelper

java.lang.Object

com.facebook.litho.LithoViewTestHelper

public class LithoViewTestHelper
extends java.lang.Object

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LithoViewTestHelper.InternalNodeRef Holds an opaque reference to an LithoNode without giving the holder any access to it.

Constructor Summary

Constructors

Constructor and Description
LithoViewTestHelper()

Method Summary

Modifier and Type	Method and Description
static TestItem	findTestItem(LithoView lithoView, java.lang.String testKey)
static java.util.Deque<TestItem>	findTestItems(LithoView lithoView, java.lang.String testKey) Finds a TestItem given a LithoView based on the test key it was assigned during construction.
static LithoViewTestHelper.InternalNodeRef	getRootLayoutRef(LithoView view) Obtain a reference to a LithoView's internal layout root, if present.
static java.lang.String	rootInstanceToString(DebugComponent root, boolean embedded, int startingDepth) Provides a nested string representation of a DebugComponent and its nested components for debugging.
static void	setRootLayoutRef(LithoView view, LithoViewTestHelper.InternalNodeRef rootLayoutNode) Restore a previously saved root layout reference.
static java.lang.String	toDebugString(LithoView lithoView)
static java.lang.String	viewToString(LithoView view)
static java.lang.String	viewToString(LithoView view, boolean embedded) Provide a nested string representation of a LithoView and its nested components for debugging purposes.
static java.lang.String	viewToStringForE2E(View view, int depth, boolean withProps)
static java.lang.String	viewToStringForE2E(View view, int depth, boolean withProps, DebugComponentDescriptionHelper.ExtraDescription extraDescription) Provide a nested string representation of a LithoView and its nested components for E2E testing purposes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LithoViewTestHelper

public LithoViewTestHelper()

Method Detail

findTestItem

public static TestItem findTestItem(LithoView lithoView,
                                    java.lang.String testKey)

Parameters:

lithoView - The component view the component is mounted to.

testKey - The unique identifier the component was constructed with.

Returns:

Test item if found, null otherwise.

Throws:

java.lang.UnsupportedOperationException - If the e2e flag is not enabled in the configuration.

See Also:

Note: If there is more than one element mounted under the given key, the last one to render will be returned.

findTestItems

public static java.util.Deque<TestItem> findTestItems(LithoView lithoView,
                                                      java.lang.String testKey)

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

Example use:

{@code
 final LithoView lithoView = ComponentTestHelper.mountComponent(
     mContext,
     new InlineLayoutSpec() {

Parameters:

lithoView - The component view the component is mounted to.

testKey - The unique identifier the component was constructed with.

Returns:

Queue of mounted items in order by mount time.

Throws:

java.lang.UnsupportedOperationException - If the e2e flag is not enabled in the configuration.

viewToString

public static java.lang.String viewToString(LithoView view)

viewToStringForE2E

public static java.lang.String viewToStringForE2E(View view,
                                                  int depth,
                                                  boolean withProps)

viewToStringForE2E

public static java.lang.String viewToStringForE2E(View view,
                                                  int depth,
                                                  boolean withProps,
                                                  DebugComponentDescriptionHelper.ExtraDescription extraDescription)

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.

Parameters:

depth - the offset to set on the litho nodes

withProps - if to dump extra properties

viewToString

public static java.lang.String viewToString(LithoView view,
                                            boolean embedded)

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

Parameters:

view - A Litho view with mounted components.

embedded - if the call is embedded in "adb dumpsys activity"

rootInstanceToString

public static java.lang.String rootInstanceToString(DebugComponent root,
                                                    boolean embedded,
                                                    int startingDepth)

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

Parameters:

root - A root DebugComponent

embedded - if the call is embedded in "adb dumpsys activity"

startingDepth - the starting depth of the true for printing components (normally defaults to 0)

toDebugString

public static java.lang.String toDebugString(LithoView lithoView)

getRootLayoutRef

public static LithoViewTestHelper.InternalNodeRef getRootLayoutRef(LithoView view)

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.

See Also:

setRootLayoutRef(LithoView, InternalNodeRef)

setRootLayoutRef

public static void setRootLayoutRef(LithoView view,
                                    LithoViewTestHelper.InternalNodeRef rootLayoutNode)

Restore a previously saved root layout reference.

See Also:

getRootLayoutRef(LithoView)