Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/HuddleEng/puppeteer-extensions

Convenience functions for the Puppeteer
https://github.com/HuddleEng/puppeteer-extensions

puppeteer testing ui utilities

Last synced: about 2 months ago
JSON representation

Convenience functions for the Puppeteer

Host: GitHub
URL: https://github.com/HuddleEng/puppeteer-extensions
Owner: HuddleEng
License: mit
Created: 2018-02-27T15:26:27.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2023-03-04T02:35:30.000Z (almost 2 years ago)
Last Synced: 2024-09-26T14:37:44.843Z (3 months ago)
Topics: puppeteer, testing, ui, utilities
Language: JavaScript
Homepage:
Size: 1.45 MB
Stars: 25
Watchers: 2
Forks: 5
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# puppeteer-extensions
[![Build Status](https://travis-ci.org/HuddleEng/puppeteer-extensions.svg?branch=master)](https://travis-ci.org/HuddleEng/puppeteer-extensions)

This library exposes a number of convenience functions to extend Puppeteer's API, in order to make writing tests easier.
The idea is that many of these functions (or similar ones) will eventually make their way into Puppeteer's own API, but
this allows us to experiment with new ways of improving UI testing.

## Usage
- `page` Puppeteer page instance
- `timeout` [Optional] Timeout for waits in milliseconds (default: 5000 ms)

```javascript
const extensions = require('puppeteer-extensions')(page);
```

```javascript
(async() {
const listItem = '.todo-list li';
...
await extensions.waitForNthSelectorAttributeValue(listItem, 1, 'class', 'completed');
})();

```

## API
The API is split into categories to better organise the extension functions. This currently includes:

- [Waits](#waits)
- [Retrieval](#retrieval)
- [Miscellaneous](#miscellaneous)

**resetRequests()**

Resets the requests cache used by the `waits` API. This should be called when you are going to navigate to another page,
in order to track the new requests correctly.

## Waits
**waitForResource(resource, timeout=defaultTimeout)**
- `resource` \ The URL of the resource (or a substring of it)
- `timeout` \ Timeout for the check

Wait for a resource request to be responded to

**waitForLoadedWebFontCountToBe(count, timeout=defaultTimeout)**
- `count` \ The number of web fonts to expect
- `timeout` \ Timeout for the check

Wait for a specific number of web fonts to be loaded and ready on the page

**waitForFunction(fn, options, ...args)**
- `fn` \ The function to execute on the page
- `options` \ Optional waiting parameters
- `args` \<...args> Arguments to be passed into the function

Wait for function to execute on the page (see [waitForFunction](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitforfunctionpagefunction-options-args))

**waitUntilExistsAndVisible(selector)**
- `selector` \ The selector for the element on the page

Wait until an element exists on the page and is visible (i.e. not transparent) (see [waitForSelector](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitforselectorselector-options))

**waitWhileExistsAndVisible(selector)**
- `selector` \ The selector for the element on the page

Wait while an element still exists on the page and is visible (i.e. not transparent) (see [waitForSelector](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitforselectorselector-options))

**waitUntilSelectorHasVisibleContent(selector)**
- `selector` \ The selector for the element on the page

Wait until the selector has visible content (i.e. the element takes up some width and height on the page) (i.e. not transparent)

**waitWhileSelectorHasVisibleContent(selector)**
- `selector` \ The selector for the element on the page

Wait while the selector has visible content (i.e. the element takes up some width and height on the page) (i.e. not transparent)

**waitForNthSelectorAttribute(selector, nth, attributeName)**
- `selector` \ The selector for the element on the page
- `nth` \ The nth element found by the selector
- `attributeName` \ The attribute name to look for

Wait for the nth element found from the selector has a particular attribute

**waitForSelectorAttribute(selector, attributeName)**
- `selector` \ The selector for the element on the page
- `attributeName` \ The attribute name to look for

Wait for the element found from the selector has a particular attribute

**waitForNthSelectorAttributeValue(selector, nth, attributeName, attributeValue)**
- `selector` \ The selector for the element on the page
- `nth` \ The nth element found by the selector
- `attributeName` \ The attribute name to look for
- `attributeValue` \ The attribute value to match the attributeName

Wait for the nth element found from the selector has a particular attribute value pair

**waitForSelectorAttributeValue(selector, attributeName, attributeValue)**
- `selector` \ The selector for the element on the page
- `attributeName` \ The attribute name to look for
- `attributeValue` \ The attribute value to match the attributeName

Wait for the element found from the selector has a particular attribute value pair

**waitForElementCount(selector, expectedCount)**
- `selector` \ The selector for the element on the page
- `expectedCount` \ The number of elements to expect

Wait for the element count to be a particular value

**waitForDocumentTitle(title)**
- `title` \ The expected title of the document

Wait for the document title to be a particular string

**waitForUrl(regex)**
- `regex` \ The regular expression to match the URL on

Wait for the current window location to match a particular regular expression

**waitFor(milliseconds)**
- `milliseconds` \ The number of milliseconds to wait for

Wait for a given number of milliseconds

## Retrieval

**getValue(selector)**
- `selector` \ The selector for the element to get the value for
- **returns** \ The value property value for the element

Get the value property value for a particular element

**getText(selector)**
- `selector` \ The selector for the element to get the text for
- **returns** \ The text property value for the element

Get the text property value for a particular element

**getPropertyValue(selector, property)**
- `selector` \ The selector for the element to get the property value for
- `property` \ The property to look for
- **returns** \ The property value for the element

Get the value of a particular property for a particular element

**isElementFocused(selector)**
- `selector` \ The selector of the element to check for focus state
- **returns** \ Whether the element is focused or not

Check if element is focused

## Miscellaneous

**turnOffAnimations()**

Turn off CSS animations on the page to help avoid flaky visual comparisons

**fastForwardTime(milliseconds)**
- `milliseconds` \ The number of milliseconds to fast forward

Fast forward the current time by a given number of milliseconds

**evaluate(fn, ...args)**
- `fn` \ The function to execute on the page
- `args` \<...args> Arguments to be passed into the function

Runs a function on the page