litho-testing/com.facebook.litho.testing/TestLithoView

TestLithoView

class TestLithoView

Holder class for the result of LithoTestRule.render call, exposing methods to for finding the views/components and assertions

 @RunWith(AndroidJUnit4::class)
 class LithoSampleTest {

 @Rule @JvmField val lithoViewRule = LithoTestRule()
 @Test
 fun test() {
  val testLithoView =  lithoViewRule.render { TestComponent() }

  LithoAssertions.assertThat(testLithoView)
  .willRenderContent()
  .containsComponents(AnotherTestComponent::class)
  .containsContentDescription(R.string.content_descr)

  lithoViewRule.act(testLithoView) { clickOnTag("test_tag") }

  LithoAssertions.assertThat(testLithoView)
  .containsComponents(NewTestComponent::class)

   }
}

Types

InteractionsScope

inner class InteractionsScope

Class which exposes interactions that can take place on a view. Exposing interactions in this class ensures that they are only accessible within act, where the proper threading is taken into account to properly update the components and views.

Properties

committedLayoutState

@get:VisibleForTesting(otherwise = 5)

val committedLayoutState: LayoutState?

componentsConfiguration

val componentsConfiguration: ComponentsConfiguration? = null

val componentTree: ComponentTree

val context: ComponentContext

currentRootNode

@get:VisibleForTesting(otherwise = 5)

val currentRootNode: LithoLayoutResult?

val lithoView: LithoView

val rootComponent: Component?

Functions

fun attachToWindow(): TestLithoView

Explicitly attaches current root LithoView

detachFromWindow

fun detachFromWindow(): TestLithoView

Explicitly detaches current root LithoView

findAllComponents

fun findAllComponents(vararg clazz: Class<out Component?>): List<Component>

fun findAllComponents(vararg clazz: KClass<out Component>): List<Component>

Returns a list of all components of the given classes from the ComponentTree or an empty list if not found

findCollectionComponent

fun findCollectionComponent(): TestCollection?

Returns the first LazyCollection from the ComponentTree, or null if not found.

fun findComponent(clazz: Class<out Component?>): Component?

fun findComponent(clazz: KClass<out Component>): Component?

Returns a component of the given class from the ComponentTree or null if not found

findDirectComponent

fun findDirectComponent(clazz: Class<out Component?>): Component?

fun findDirectComponent(clazz: KClass<out Component>): Component?

Returns a component of the given class only if it is a direct child of the root component

findViewWithContentDescription

fun findViewWithContentDescription(@StringRes resourceId: Int): View

fun findViewWithContentDescription(contentDescription: String): View

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

findViewWithContentDescriptionOrNull

fun findViewWithContentDescriptionOrNull(@StringRes resourceId: Int): View?

fun findViewWithContentDescriptionOrNull(contentDescription: String): View?

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

findViewWithTag

fun findViewWithTag(tag: Any): View

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

findViewWithTagOrNull

fun findViewWithTagOrNull(tag: Any): View?

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

findViewWithText

fun findViewWithText(@StringRes resourceId: Int): View

fun findViewWithText(text: String): View

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

findViewWithTextOrNull

fun findViewWithTextOrNull(@StringRes resourceId: Int): View?

fun findViewWithTextOrNull(text: String): View?

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

fun layout(): TestLithoView

Explicitly calls layout on the current root LithoView. If there are any async events triggered by layout use together with idle

fun measure(): TestLithoView

Explicitly calls measure on the current root LithoView

fun release(): TestLithoView

Explicitly releases current root LithoView

setComponentTree

fun setComponentTree(componentTree: ComponentTree)

fun setRoot(builder: Component.Builder<*>): TestLithoView

Sets the new root Component.Builder to render.

fun setRoot(component: Component?): TestLithoView

Sets the new root Component to render.

setRootAndSizeSpecSync

fun setRootAndSizeSpecSync(component: Component?, widthSpec: Int, heightSpec: Int): TestLithoView

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

fun setRootAsync(builder: Component.Builder<*>): TestLithoView

Sets the new root Component.Builder to render asynchronously.

fun setRootAsync(component: Component?): TestLithoView

Sets the new root Component to render asynchronously.

fun setSizePx(widthPx: Int, heightPx: Int): TestLithoView

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

fun setSizeSpecs(widthSpec: Int, heightSpec: Int): TestLithoView

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

useComponentTree

fun useComponentTree(componentTree: ComponentTree?): TestLithoView

Sets a new ComponentTree which should be used to render.

fun useLithoView(lithoView: LithoView): TestLithoView

Sets a new LithoView which should be used to render.