com.facebook.litho.testing

Class LithoViewRule

java.lang.Object

com.facebook.litho.testing.LithoViewRule

public class LithoViewRule
extends java.lang.Object

This test utility allows clients to test assertion on the view hierarchy rendered by a Litho components. The utility has methods to override the default LithoView, ComponentTree, width, and height specs.

 @RunWith(LithoTestRunner.class)
 public class LithoSampleTest {

   public final @Rule LithoViewRule mLithoViewRule = new LithoViewRule();

   @Test
   public void test() {
     final ComponentContext c = mLithoViewRule.getContext();
     final Component component = MyComponent.create(c).build();

     mLithoViewRule.setRoot(component)
       .attachToWindow()
       .setRoot(component)
       .measure()
       .layout();

     LithoView lithoView = mLithoViewRule.getLithoView();

     // Test your assertions on the litho view.
   }
 }

 }

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEIGHT_SPEC
static int	DEFAULT_WIDTH_SPEC

Constructor Summary

Constructors

Constructor and Description
LithoViewRule()

Method Summary

Modifier and Type	Method and Description
Statement	apply(Statement base, Description description)
LithoViewRule	attachToWindow() Explicitly attaches current root LithoView
LithoViewRule	detachFromWindow() Explicitly detaches current root LithoView
View	findViewWithTag(java.lang.Object tag) Finds the first View with the specified tag in the rendered hierarchy, throwing if it doesn't exist.
View	findViewWithTagOrNull(java.lang.Object tag) Finds the first View with the specified tag in the rendered hierarchy, returning null if is doesn't exist.
protected LayoutState	getCommittedLayoutState()
ComponentTree	getComponentTree() Gets the current ComponentTree; creates a new instance if null.
ComponentContext	getContext() Gets the current ComponentContext.
InternalNode	getCurrentRootNode()
int	getHeightSpec() Gets the current height spec
LithoView	getLithoView() Gets the current LithoView; creates a new instance if null.
int	getWidthSpec() Gets the current width spec
LithoViewRule	layout() Explicitly calls layout on the current root LithoView
LithoViewRule	measure() Explicitly calls measure on the current root LithoView
LithoViewRule	release() Explicitly releases current root LithoView
LithoViewRule	setRoot(Component.Builder builder) Sets the new root Component.Builder to render.
LithoViewRule	setRoot(Component component) Sets the new root Component to render.
LithoViewRule	setRootAndSizeSpec(Component component, int widthSpec, int heightSpec) Sets the new root Component with new size spec to render.
LithoViewRule	setRootAsync(Component.Builder builder) Sets the new root Component.Builder to render asynchronously.
LithoViewRule	setRootAsync(Component component) Sets the new root Component to render asynchronously.
LithoViewRule	setSizePx(int widthPx, int heightPx) Sets a new width and height which should be used to render.
LithoViewRule	setSizeSpecs(int widthSpec, int heightSpec) Sets a new width spec and height spec which should be used to render.
LithoViewRule	setTreeProp(java.lang.Class<?> klass, java.lang.Object instance) Sets a new TreeProp for the next layout pass.
LithoViewRule	useComponentTree(ComponentTree componentTree) Sets a new ComponentTree which should be used to render.
LithoViewRule	useLithoView(LithoView lithoView) Sets a new LithoView which should be used to render.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH_SPEC

public static final int DEFAULT_WIDTH_SPEC

DEFAULT_HEIGHT_SPEC

public static final int DEFAULT_HEIGHT_SPEC

Constructor Detail

LithoViewRule

public LithoViewRule()

Method Detail

apply

public Statement apply(Statement base,
                       Description description)

getContext

public ComponentContext getContext()

Gets the current ComponentContext.

getLithoView

public LithoView getLithoView()

Gets the current LithoView; creates a new instance if null.

useLithoView

public LithoViewRule useLithoView(LithoView lithoView)

Sets a new LithoView which should be used to render.

getComponentTree

public ComponentTree getComponentTree()

Gets the current ComponentTree; creates a new instance if null.

useComponentTree

public LithoViewRule useComponentTree(ComponentTree componentTree)

Sets a new ComponentTree which should be used to render.

setRoot

public LithoViewRule setRoot(Component component)

Sets the new root Component to render.

setRoot

public LithoViewRule setRoot(Component.Builder builder)

Sets the new root Component.Builder to render.

setRootAsync

public LithoViewRule setRootAsync(Component component)

Sets the new root Component to render asynchronously.

setRootAsync

public LithoViewRule setRootAsync(Component.Builder builder)

Sets the new root Component.Builder to render asynchronously.

setRootAndSizeSpec

public LithoViewRule setRootAndSizeSpec(Component component,
                                        int widthSpec,
                                        int heightSpec)

Sets the new root Component with new size spec to render.

setSizePx

public LithoViewRule setSizePx(int widthPx,
                               int heightPx)

Sets a new width and height which should be used to render.

setSizeSpecs

public LithoViewRule setSizeSpecs(int widthSpec,
                                  int heightSpec)

Sets a new width spec and height spec which should be used to render.

setTreeProp

public LithoViewRule setTreeProp(java.lang.Class<?> klass,
                                 java.lang.Object instance)

Sets a new TreeProp for the next layout pass.

measure

public LithoViewRule measure()

Explicitly calls measure on the current root LithoView

layout

public LithoViewRule layout()

Explicitly calls layout on the current root LithoView

attachToWindow

public LithoViewRule attachToWindow()

Explicitly attaches current root LithoView

detachFromWindow

public LithoViewRule detachFromWindow()

Explicitly detaches current root LithoView

release

public LithoViewRule release()

Explicitly releases current root LithoView

getWidthSpec

public int getWidthSpec()

Gets the current width spec

getHeightSpec

public int getHeightSpec()

Gets the current height spec

findViewWithTagOrNull

public View findViewWithTagOrNull(java.lang.Object tag)

Finds the first View with the specified tag in the rendered hierarchy, returning null if is doesn't exist.

findViewWithTag

public View findViewWithTag(java.lang.Object tag)

Finds the first View with the specified tag in the rendered hierarchy, throwing if it doesn't exist.

getCommittedLayoutState

protected LayoutState getCommittedLayoutState()

getCurrentRootNode

public InternalNode getCurrentRootNode()