sudharsan-selvaraj / react-webdriver

Library to locate react elements by component, props and state using Selenium Webdriver.

react-webdriver

An idea inspired by @Paul Hammant 's ngWebdriver project, react-webdriver help you to locate web elements in your REACT app using components, props and states for Selenium java tests. It works with Firefox, Chrome and all the other Selenium-WebDriver browsers.

How it works

react-webdriver make use of resq(React Element Selector Query) which does most of the heavy lifting in finding react elements from the DOM.

Usage

ChromeDriver driver = new ChromeDriver();
/* #root is the selector for root element where the react app is rendered */
ReactWebDriver reactWebdriver = new ReactWebDriver((JavascriptExecutor) driver, "#root");

Locator

/* Filter just by component name */
ByReact.component("NavLink")

/* Filter by component name and prop */
ByReact.component("NavLink").props("{ \"name\" : \"home\" }")

/* Filter by component name and state */
ByReact.component("NavLink").state("{ \"title\" : \"Go to home\" }")

/* Filter by component name and both prop & state */
ByReact.component("NavLink").props("{ \"name\" : \"home\" }")state("{ \"title\" : \"Go to home\" }")

Using Page Objects

This work in the same way as WebDriver's page object technology, there is a custom FindBy annotations for ReactWebDriver:

@ByReactComponent.FindBy(
        name = "NavLink",
        props = "{\"name\": \"home\"}"
)
public WebElement homeNavLink;

Example App

Consider the below React App:

class MyComponent extends React.Component {

    constructor(props) {
        super(props);
        this.state = {
            id: props.id
        };
    }

    render() {
        return ( 
            <div> Name: { this.props.name} </div> 
            <div> Id: { this.props.id} </div>    
        )
    }

}

const App = () => ( <
    <div>
    	<MyComponent name = "java" id = "1" />
    	<MyComponent name = "javascript" id = "2" />
    </div>
)

ReactDOM.render( <App/> , document.getElementById('root'))

To select all MyComponent

 driver.findElements(ByReact.component("MyComponent"))

or using a wildcard selector:

driver.findElements(ByReact.component("*Component"))
or
driver.findElements(ByReact.component("My*"))

Filtering by props

 driver.findElement(ByReact.component("MyComponent").props("{ \"name\": \"java\" }"))

will return the first MyComponent.

Filtering by state

 driver.findElement(ByReact.component("MyComponent").state("{ \"id\": \"1\" }"))

Filtering by both props and state

 driver.findElement(ByReact.component("MyComponent").props("{ \"name\": \"java\" }").state("{ \"id\": \"1\" }"))

Retrieve React Properties from element

Create a ReactDriver instance

ChromeDriver driver = new ChromeDriver();
ReactWebDriver reactWebdriver = new ReactWebDriver((JavascriptExecutor) driver, "#root");

Using the reactDriver, we will find the required ReactComponent using

ReactComponent component = reactWebDriver.getComponent(ByReact.component("MyComponent"));

By default, getComponent method will return the first matching node from the DOM if more than one node present for the given selector. We can also find a specific node by passing the index as below

ReactComponent component = reactWebDriver.getComponent(ByReact.component("MyComponent"), 1);

This will fetch the 2nd element from the list of matched elements. Index starts from 0. Now using the react component, we can fetch the props and state of the element

assertEquals(component.getProp("name"), "java");
assertEquals(component.getProp("id"), "1");

and to retrieve the state

assertEquals(component.getState("id"), 1);

Installation

Maven

<dependency>
  <groupId>io.github.sudharsan-selvaraj</groupId>
  <artifactId>react-webdriver</artifactId>
  <version>1.0</version>
</dependency>

Gradle

implementation group: 'io.github.sudharsan-selvaraj', name: 'react-webdriver', version: '1.0'

react-webdriver's Issues

Javascripterror

Showing an error could not locate react instance for given element in React 18