Page Commands
Last updated
Last updated
Emulates given device metrics and user agent
Defines browser viewport, where the viewport is the user's visible area of a web page
Navigates to a given URL and waits until the page loaded
Makes a screenshot of the page
Emulates mouse click according to given options
Moves mouse to given position
Emulates tap according to given options
Emulates pressing on a key, optionally with modifiers such as ⇧, ⌥, alt, control, ⌘
Scrolls the document in the window by the given amount
Refreshes the page
Sets custom user agent
While running test on < 3.0.1 this method requires adding "--no-sandbox --disable-setuid-sandbox" Chromium arguments in Browser options
Sets cookies on the page
Intercepts to a given URL and replaces it according to provided data
As soon as a matching request intercepted the session gets detached, meaning Puppetry stop listening for mocking. You have to set page.mockRequest before every request that you want to mock.
Waits for a given time before proceeding to the next command
Waits for an element matching a provided CSS selector
Waits until a given event before proceeding to the next command
Waits for HTTP(S) response
Waits for HTTP(S) request
Provide credentials for HTTP authentication.
Evaluates JavaScript code in the page context
Runs custom JavaScript code in the test suite with use of Puppeteer API and Puppetry API. You can access dynamic environment variables via ENV map (e.g. ENV[VAR_NAME])
Stops execution of JavaScript, and calls (if available) the debugging function. During test scenarios may happen many things - DOM changes, pages load. It makes hard to figure out why some test assertions fail in some particular moment. You can use this tool to set a breakpoint. Test flow will stop as soon as it reaches this point. So you will be able to examine the page state with DevTools.
Listen to dialog events and dismiss or accept dialogs (alert, beforeunload, confirm or prompt) as they are called
The step must be defined before the expected dialog event
Assigns template variable dynamically
Polls URL with a given intervals until a response satisfying parserFn function received or a specified timeout exceeded. It can be used, for example, to retrieve a value from an email sent by the application under test
