classicvalues / replayweb

ReplayWeb is a collection of tools to accelerate building and maintaining functional tests for user interfaces.

ReplayWeb

All-in-one toolbox for generating browser automation

ReplayWeb is a all-in-one toolbox that allows developers to focus on writing and maintaining application code, not test code. It is comprised of a Chrome extension that you install in your Chrome browser that allows you to record test scripts and saved and played back later. Once you have recorded scripts you can play them back from within the extension or on the command line. The command line execution uses the ReplayWeb Test Runner to automatically convert tests to WebDriverIO scripts that can be played back across different browsers.

Feature highlights

🚀 Easy script recording via a Chrome extension

🚀 Ability to execute recorded tests locally via Chrome extension or command line

🚀 Integration with source code repositories to enable running tests during CI/CD

Getting Started with ReplayWeb

Installing the Chrome Extension

1. Grab the latest release from the releases; the packaged Chrome extension is a .crx file
2. In Chrome navigate to the extension management page (chrome://extensions)
3. Drag and drop the .crx file over the page to install
4. In a terminal, run one of the following commands based on how you authenticate with github:
   • Personal Access Token: curl -L https://raw.githubusercontent.com/intuit/replayweb/master/packages/host/src/static/setup.sh | bash
   • SSH Keys: curl -L https://raw.githubusercontent.com/intuit/replayweb/master/packages/host/src/static/setup-ssh.sh | bash

For additional details see the readme for the Chrome Extension.

Installing the Test Runner

Available through npm, @replayweb/testrunner converts your JSON tests recorded from the Chrome extension into webdriverio tests. To get started, install the required dependencies into your project:

If you're using npm 5+

npx install-peerdeps --dev @replayweb/testrunner

If using yarn, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly.

If you're using npm <5 intall the deps listed from the following command

npm info "eslint-config-airbnb@latest" peerDependencies

And add a simple wdio.conf.js:

const { getDefaults, loadFromConfig } = require('@replayweb/testrunner');
exports.config = { ...getDefaults(), ...loadFromConfig() };

This will read the replay.config.json from your repository, that was created by the Chrome extension and load all of your tests and suites. To execute the tests in your shell you can do npx wdio, or add a script to package.json that just executes wdio.

For additional details see the readme for the Test Runner package.

Documentation

The documentation is divided into several sections:

• Chrome Extension
• Test Runner
• See full list of documentation here

Contributing

Read below to learn how you can take part in improving ReplayWeb.

Code of Conduct

Intuit has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Thanks for your interest! Please see the CONTRIBUTING.md file for more information on how to develop and test your changes before contributing bug fixes and enhancements for ReplayWeb.

Good First Issues

To help you get your feet wet with our contribution process, we have a list of good first issues that have a relatively limited scope. This is a great place to get started.

License

This project is licensed under AGPL 3.