litho-testing/com.facebook.litho.testing/LegacyLithoTestRule

LegacyLithoTestRule

class ~~LegacyLithoTestRule~~ @JvmOverloads constructor(val componentsConfiguration: ComponentsConfiguration? = null, val themeResId: Int? = null) : TestRule

Deprecated

Please use LithoTestRule and TestLithoView instead

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 {@link LithoView}, {@link ComponentTree}, width, and height specs.

 @RunWith(AndroidJUnit4::class)
 class LithoSampleTest {

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

   // or you can use setRoot/measure/layout for more fine-grained control
   val lithoViewTest = lithoViewRule.attachToWindow().setRoot(TestComponent()).measure().layout()
   // Test your assertions on the litho view.
   }
}

Constructors

LegacyLithoTestRule

@JvmOverloads

constructor(componentsConfiguration: ComponentsConfiguration? = null, themeResId: Int? = null)

Types

Companion

object Companion

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

componentTree

val componentTree: ComponentTree

context

lateinit var context: ComponentContext

currentRootNode

val currentRootNode: LithoLayoutResult?

heightSpec

var heightSpec: Int

lithoView

val lithoView: LithoView

stateHandler

lateinit var stateHandler: StateHandler

themeResId

val themeResId: Int? = null

widthSpec

var widthSpec: Int

Functions

act

fun act(action: LegacyLithoTestRule.InteractionsScope.() -> Unit): LegacyLithoTestRule

Perform any interactions defined in the InteractionScope or on the LegacyLithoTestRule.

apply

open override fun apply(base: Statement, description: Description): Statement

attachToWindow

fun attachToWindow(): LegacyLithoTestRule

Explicitly attaches current root LithoView

detachFromWindow

fun detachFromWindow(): LegacyLithoTestRule

Explicitly detaches current root LithoView

dispatchGlobalLayout

fun dispatchGlobalLayout(): LegacyLithoTestRule

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

findComponent

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.

idle

fun idle()

Runs through all tasks on the background thread and main lopper, blocking until it completes. Use if there are any async events triggered by layout ( ie visibility events) to manually drain the queue

layout

fun layout(): LegacyLithoTestRule

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

measure

fun measure(): LegacyLithoTestRule

Explicitly calls measure on the current root LithoView

release

fun release(): LegacyLithoTestRule

Explicitly releases current root LithoView

render