litho-testing/com.facebook.litho.testing.api

Package-level declarations

Types

LithoRule

class LithoRule : TestRule, TestNodeSelectionProvider

LithoTestContext

class LithoTestContext(lithoView: LithoView) : TestContext

LithoViewComponentsTraverser

class LithoViewComponentsTraverser

Allows traversing through all the Component that define a hierarchy in a given LithoView.

SelectionResult

class SelectionResult(val nodes: List<TestNode>, selectionError: String? = null)

TestContext

interface TestContext

TestNode

class TestNode(component: Component)

A test node is used to hold all the information needed to represent a given component in the testing tree. This information is be used by testing actions (filter, interaction, assertion) and also to represent them in a visual way (e.g String representation).

TestNodeCollectionSelection

class TestNodeCollectionSelection(testContext: TestContext, selector: TestNodeSelector)

Lazy representation of a collection of test nodes with necessary logic to materialize on-demand.

TestNodeMatcher

class TestNodeMatcher(val description: String, predicate: (TestNode) -> Boolean)

This abstraction allows you to represent any given predicate on a TestNode. This is the base to the mechanism that allows filtering test nodes to perform assertions or the matchers used in the assertions.

TestNodeSelection

class TestNodeSelection(testContext: TestContext, selector: TestNodeSelector)

Lazy representation of a single test node with necessary logic to materialize on-demand.

TestNodeSelectionProvider

interface TestNodeSelectionProvider

This is the entry point through which nodes are discovered for testing.

TestNodeSelector

class TestNodeSelector(val description: String, parentSelector: TestNodeSelector? = null, throwOnSelectionError: Boolean = false, selector: TestNodeSelector.(List<TestNode>) -> SelectionResult)

Transforms a given set of nodes into a new list of TestNode.

TestNodesListResolver

class TestNodesListResolver

Functions

hasAncestor

fun hasAncestor(matcher: TestNodeMatcher): TestNodeMatcher

Returns a TestNodeMatcher that will match TestNodes which have an ancestor that match with the given matcher.

hasAttribute

fun <T> hasAttribute(key: AttributeKey<T>, value: T): TestNodeMatcher

Generic purpose test node filters based on the attributes system. This filter will match all TestNode whose Component has set value for the attribute with key key

hasChild

fun hasChild(matcher: TestNodeMatcher): TestNodeMatcher

Returns a TestNodeMatcher that will match TestNodes which have one child that matches with the given matcher.

hasContentDescription

fun hasContentDescription(description: CharSequence): TestNodeMatcher

Returns a TestNodeMatcher that verifies if the given node has a content description which is an exact match with description.

hasDescendant

fun hasDescendant(matcher: TestNodeMatcher): TestNodeMatcher

Returns a TestNodeMatcher that will match TestNodes which have one descendant that matches the given matcher.

hasParent

fun hasParent(matcher: TestNodeMatcher): TestNodeMatcher

Returns a TestNodeMatcher that verifies if a TestNode has a parent TestNode that matches the given matcher.

hasTestKey

fun hasTestKey(key: String): TestNodeMatcher

hasText

fun hasText(text: CharSequence): TestNodeMatcher

Returns a TestNodeMatcher that verifies if the given node text matches the exact text

hasTextContaining

fun hasTextContaining(text: CharSequence): TestNodeMatcher

Returns a TestNodeMatcher that verifies if the given node contains the given text

hasType

inline fun <T> hasType(): TestNodeMatcher

fun hasType(type: Class<*>): TestNodeMatcher

This filter will match all test nodes that represent a Component with the given class type componentClass.

isEnabled

fun isEnabled(): TestNodeMatcher

isNotEnabled

fun isNotEnabled(): TestNodeMatcher

isRoot

fun isRoot(): TestNodeMatcher

Returns a TestNodeMatcher that verifies if a TestNode is the root of a component tree.

performClick

fun TestNodeSelection.performClick()

Dispatches a click event for the node represented in the given selection.

printTo

fun TestNodeCollectionSelection.printTo(appendable: Appendable, maxDepth: Int = 0)

Prints all the matching nodes in the collection into the given appendable.

fun TestNodeSelection.printTo(appendable: Appendable, maxDepth: Int = Int.MAX_VALUE)

Prints all the available node information into the given appendable.

printToString

fun TestNodeCollectionSelection.printToString(maxDepth: Int = 0): String

Prints all the matching nodes in the collection into a string.

fun TestNodeSelection.printToString(maxDepth: Int = Int.MAX_VALUE): String

Prints all the available node information into a string.