wp-e2e-webdriver/README.md

Webdriver manager and helper for WP end-to-end tests

wp-e2e-webdriver
================

[![npm version](https://img.shields.io/npm/v/wp-e2e-webdriver.svg?style=flat)](https://www.npmjs.com/package/wp-e2e-webdriver)
[![build status](https://api.travis-ci.org/woocommerce/wp-e2e-webdriver.svg)](http://travis-ci.org/woocommerce/wp-e2e-webdriver)
[![dependency status](https://david-dm.org/woocommerce/wp-e2e-webdriver.svg)](https://david-dm.org/woocommerce/wp-e2e-webdriver)

Webdriver manager and helper for WordPress. Most of the good stuff were shamelessly
copied from [wp-e2e-tests](https://github.com/Automattic/wp-e2e-tests). Thanks to
wp-e2e-tests authors and contributors for providing the foundation!

This package provides WebDriver manager and helper to help you test WordPress
site.

By default, this package uses [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/),
but you can optionally install other drivers such as [geckodriver](https://github.com/mozilla/geckodriver)
or use remote webdriver via [Sauce Labs](https://saucelabs.com/).

## Install

```
npm install wp-e2e-webdriver
```

## Usage

~~~js
import { By } from 'selenium-webdriver';
import { WebDriverManager, WebDriverHelper as helper } from 'wp-e2e-webdriver'

const manager = new WebDriverManager( 'chrome' );
const driver = manager.getDriver();

driver.get( 'https://automattic.com/work-with-us/' );
helper.waitTillPresentAndDisplayed(
	driver,
	By.css( '#content' )
);
~~~

## Docs

* [Tutorials](https://woocommerce.github.io/wp-e2e-webdriver/wp-e2e-webdriver/0.16.0/tutorial-overview.html)
* [API docs](https://woocommerce.github.io/wp-e2e-webdriver/wp-e2e-webdriver/0.16.0/)
* [Contributing](./.github/CONTRIBUTING.md)

## Dependents

The reason we pulled out manager and helper from wp-e2e-tests so that following
dependents can use that:

* [wp-e2e-page-objects](https://github.com/woocommerce/wp-e2e-page-objects) — Repo will be published later. WordPress Page Objects
  package
* [wc-e2e-page-objects](https://github.com/woocommerce/wc-e2e-page-objects) — WooCommerce Page Objects package
* WordPress plugin or WooCommerce extensions that will have e2e tests that use wp-e2e-page-objects or wc-e2e-page-objects.