Skip to content

Latest commit

 

History

History
520 lines (415 loc) · 26.3 KB

README.md

File metadata and controls

520 lines (415 loc) · 26.3 KB
Raw

npm version Synpress CI CodeQL Release CI synpress Discord Twitter Follow

We're Hiring 🎉 — Think you have what it takes? We're looking for Software Engineer, find out more.

Synpress is E2E testing framework
based on Cypress and Playwright with support for MetaMask.

Sponsored & used by:

Synthetix Optimism

Power users:

Phantom Ethereum Name Service (ENS) Kwenta
Panther Protocol Guild Aragon Delvtech
Offchain Labs Snapshot Labs Hedera

Synpress Demo

Synpress makes sure to always use latest version of metamask and puts a lot of effort to make sure that dapp tests are stable and trustful.

It also provides an easy way to use and access metamask straight from your e2e tests with all features of cypress and playwright.

🔥 Synpress works out-of-the-box with other frameworks! There is no need to use it directly. Check usage examples for more details.

♨️ New release

⚠️ This branch showcases the current stable release of Synpress which will receive only critical hotfixes. ⚠️

Active development of the upcoming version of Synpress is happening on this branch. The new release is a full rewrite of Synpress and will feature major breaking changes, and multitude of new features and improvements across the board such as:

  • ⭐ Full TypeScript support
  • ⭐ Multi-wallet support
  • ⭐ Full parallelism support
  • ⭐ Test runtime speed faster than any other Web3 alternative, and equal to native Web2 frameworks

Curious and want to learn more? 🤓

Read this Twitter thread 🧵 and do not forget to check out the attached document there!

Table of content

🧑‍🤝‍🧑 Community

  • Discord => for live support and direct chat with devs.
  • Twitter => for updates and announcements.

🖥️ Install

# with pnpm
pnpm add --save-dev @synthetixio/synpress
# with npm
npm install --save-dev @synthetixio/synpress
# with yarn
yarn add -D @synthetixio/synpress

⚙️ Supported frameworks

👝 Supported wallets

✍️ Usage examples:

For full Synpress commands and their examples, check here.

To see in which direction Synpress is headed to, take a look at planning board.

🌟 Features

  • Added support for metamask 🦊
  • Supports headless mode 🤖 (synpress run --headless)
    • Recommended for local development (but not for CI yet as it's new and experimental)
  • Integrated with Docker 🐳
    • Recommended for CI
    • Includes VNC and noVNC
    • Integrated video recording 🎥 (full screen)
    • Exposes noVNC with ngrok (optional)
  • Easy to debug 🐛
    • Improved error handling
    • Supports cypress and playwright debuggers
    • noVNC allows for interactions through browser 🌐
    • Debug remote machines on CI with ngrok
  • Blazingly-fast ⚡
  • Extensible ⚙️ (add own custom commands and plugins)
  • Can be used in existing Cypress setup
  • Supports dotenv
    • Loads all env vars from your .env file automatically (from project root folder)
  • Ability to use latest metamask or lock it's version to avoid unexpected failures related to metamask updates
  • Supports multi-lang of metamask, it doesn't depend on any labels
  • Synpress is fully tested
  • Waits for XHR requests, navigations and animations automatically
  • Ability to fail test run if there are any browser console errors found
  • Types support for all additional custom commands
  • The best possible options set up in place to avoid flakiness
  • Etherscan API helpers in place which for ex. allows to compare your transaction results with etherscan and check tx status
  • Synthetix helpers in place which allows to interact with synthetix protocol programmatically
  • Supports codespaces
    • Run your tests in docker
    • Get your feedback remotely thanks to ngrok
    • Use mpeg-4 preview plugin to watch videos from inside codespaces :) ...

👷 Example setup for eslint and tsconfig

Project structure:

project_dir
└── src
└── tests
    └── e2e
        └── .eslintrc.js
        └── support.js
        └── tsconfig.json
        └── specs
            └── example-spec.js
        └── pages
            └── example-page.js
  1. Create .eslintrc.js inside your tests folder (/project_dir/tests/e2e):
const path = require('path');
const synpressPath = path.join(
  process.cwd(),
  '/node_modules/@synthetixio/synpress',
);

module.exports = {
  extends: `${synpressPath}/.eslintrc.js`,
};
  1. Create support.js inside your tests folder (/project_dir/tests/e2e):
import '@synthetixio/synpress/support/index';

^ hint: you can also use this file to extend synpress - add custom commands, and more..

  1. Create tsconfig.json inside your tests folder (/project_dir/tests/e2e):
{
  "compilerOptions": {
    "allowJs": true,
    "baseUrl": "../../node_modules",
    "types": [
      "cypress",
      "@synthetixio/synpress/support",
      "cypress-wait-until",
      "@testing-library/cypress"
    ],
    "outDir": "./output"
  },
  "include": ["**/*.*"]
}
  1. You're done! 🎉

To change specific values in default config, you can use --config flag. For example, to change path for support.js file, you can use synpress run --config "supportFile=__tests__/e2e/supportFile.js"

If you would like to use custom paths for your tests and configs, you should mirror (full) default synpress config and then modify it for your needs. Then you can direct synpress to use it with --configFile flag.

For example: synpress run --configFile __tests__/e2e/customConfig.config.js

⚡ Important notes

Synpress doesn't seem to communicate with metamask properly if "chromeWebSecurity": false flag is set. More about it here.

Thanks to new headless mode in Chrome, tests are now working in headless mode 🤖 (synpress run --headless). However, I recommend to use it only for local development as this feature is new and experimental and may cause issues on CI (UNIX). So please, stick to non-headless mode on CI.

In the past, tests worked only in non-headless mode because extensions were not supported in headless mode by playwright and Cypress. As a workaround, we've provided Docker 🐳 containers. They solved this issue and it's an alternative.

You have to setup xvfb and window manager (like fluxbox or xfce4) to run tests without issues on CI (together with DISPLAY env var). Take a look at CI tips & tricks for working examples.

There is a global before() which runs metamask setup before all tests:

  • passes welcome page
  • imports wallet
  • changes network (defaults to goerli) or creates custom network and changes to it (depending on your setup)
  • switches back to Cypress window and starts testing

It requires environmental variable called SECRET_WORDS to be present in following format => 'word1 word2 word3 ..' (delimited with spaces) or private key in an environmental variable called PRIVATE_KEY.

To change default network (goerli), you can use NETWORK_NAME environmental variable, for example: NETWORK_NAME=sepolia.

Available choices are: mainnet, goerli, sepolia and localhost.

To create and switch to custom network at metamask setup phase, use these:

  1. NETWORK_NAME => ex: synthetix
  2. RPC_URL => ex: https://synthetix-node.io
  3. CHAIN_ID => ex: 123
  4. SYMBOL => ex: SNX
  5. BLOCK_EXPLORER (optional) => ex: https://synthetix-explorer.io
  6. IS_TESTNET (optional) => ex: false

Metamask version is hardcoded and frequently updated under supervision to avoid a case when e2e tests break because of CSS classes changes in new version, so all you need is to keep synpress updated in your project. However, you can still override metamask with METAMASK_VERSION environmental variable, for example: METAMASK_VERSION=10.21.0 or METAMASK_VERSION=latest.

If you don't want to use environmental variables, you can modify setupMetamask() to following:

setupMetamask(secretWordsOrPrivateKey, network, password), for example: setupMetamask('word1 word2 word3 ..', 'mainnet', 'password') (delimited with spaces).

You can also add and switch to custom network by passing an object instead of string inside setupMetamask(secretWordsOrPrivateKey, network, password) function for network parameter.

If you want to use Etherscan API helpers, you will have to provide Etherscan API key using ETHERSCAN_KEY environmental variable.

To fail a test if there are any browser console errors, set FAIL_ON_ERROR to 1 or true.

Automatic waiting for XHR requests to finish before tests start can be turned on with CYPRESS_RESOURCES_WAIT environmental variable, set it to 1 or true.

If you want to skip metamask extension installation or metamask setup, you can use SKIP_METAMASK_INSTALL and SKIP_METAMASK_SETUP separately. Both variables accept 1 or true.

Synpress is blazingly-fast ⚡ by default! If you want to change that, you can use STABLE_MODE=true (which will introduce delays only between main actions, 300ms by default) / STABLE_MODE=<value> or SLOW_MODE=true (which will introduce delay between every action, 50ms by default) / SLOW_MODE=<value>.

DEBUG=synpress:* is very useful while debugging your tests. It enables following features:

You may encounter 403 errors (on shared IPs & CI) related to rate limiting while fetching metamask releases from GitHub REST API. This should never happen at all, but it's good to mention. To prevent it from happening, you can create new private access token on GitHub (without any additional access) and specify GH_USERNAME & GH_PAT environmental variables.

🐳 Using with Docker

Docker is awesome for CI. Give it a try.

Requirements

Some neat features

  • based on docker-e2e ❤
  • full screen video recording 🎥 (together with metamask extension)
  • VNC & noVNC support 🖥️ (very easy to debug with browser)
  • ngrok 🔌 integration (exposes noVNC for everyone)
    • remote: https://.ngrok.io/vnc.html?autoconnect=true (check logs for url)

How to run e2e tests for Synpress using Docker

  1. git clone [email protected]:Synthetixio/synpress.git
  2. cd synpress
  3. (optional) Fill env vars inside .env file
  4. (with foundry; preferred) docker-compose --profile synpress --profile foundry up --build --exit-code-from synpress or ./start-tests.sh
    • (without foundry) docker-compose up --profile synpress --build --exit-code-from synpress
  5. (with foundry and ngrok) docker-compose --profile synpress --profile foundry --profile ngrok up --build --exit-code-from synpress

All examples of setup are present in this repository. Just take a look around.

💁‍♂️ CI tips & tricks

🧪 Usage & commands

  • synpress run to run tests
  • synpress open to open Cypress UI (may be bugged in some cases because it doesn't clear metamask state before each e2e test, please use synpress run)

Command line interface (synpress help):

Usage: synpress run [options]

launch tests

Options:
  -b, --browser <name>               run on specified browser (default: "chrome")
  -c, --config <config>              set configuration values, separate multiple values with a comma
  -cf, --configFile <path>          specify a path to *.js file where configuration values are set
  -e, --env <env=val>                set environment variables, separate multiple values with comma
  -s, --spec <path or glob>          run only provided spec files
  -ne, --noExit                     keep runner open after tests finish
  -pr, --project <path>              run with specific project path
  -q, --quiet                        only test runner output in console
  -r, --reporter <reporter>          specify mocha reporter
  -ro, --reporterOptions <options>  specify mocha reporter options, separate multiple values with comma
  -r, --record                       [dashboard] record video of tests running after setting up your project to record
  -k, --key <key>                    [dashboard] set record key
  -p, --parallel                     [dashboard] run recorded specs in parallel across multiple machines
  -g, --group [name]                 [dashboard] group recorded tests together under a single run
  -t, --tag <name>                   [dashboard] add tags to dashboard for test run
  -h, --help                         display help for command

Usage: synpress open [options]

launch test runner UI

Options:
  -cf, --configFile <path>  specify a path to *.js file where configuration values are set
  -h, --help                display help for command

👨‍⚕️ Known problems with MetaMask

If your MetaMask is stuck on the loading screen, check what's happening under the hood in the console. You can find vital information about why it's stuck on this step.

⭐ Sentry.io HTTP error 499 (Request has been forbidden by antivirus)

  • Kaspersky antivirus sometimes blocks encrypted requests to Sentry.io. You can disable this feature in Kaspersky advanced settings by toggling on "Do not scan encrypted connections".

📃 Environmental variables

Variable Description
SECRET_WORDS Space separated words for the test wallet recovery phrase (mnemonic; 12 words)
PRIVATE_KEY Test wallet private key
NETWORK_NAME Network name (eg NETWORK_NAME=Optimism)
RPC_URL Network RPC (egRPC_URL=https://mainnet.optimism.io)
CHAIN_ID Network ID (egCHAIN_ID=10)
SYMBOL Native chain token ticker (eg SYMBOL=OP)
IS_TESTNET boolean indicates that the added network is testnet
BLOCK_EXPLORER Blockchain explorer (eg BLOCK_EXPLORER=https://optimistic.etherscan.io/)
SYNDEBUG Set debugging mode to be on
STABLE_MODE Introduce delay between main actions, 300ms by default (eg STABLE_MODE=300ms, STABLE_MODE=true)
SLOW_MODE Introduce delay between every action, 50ms by default (eg SLOW_MODE=true, SLOW_MODE=200ms)
METAMASK_VERSION Metamask version to be installed
SKIP_METAMASK_INSTALL Will skip MetaMask installation
SKIP_METAMASK_SETUP Will skip MetaMask initial setup
GH_USERNAME GitHub username (used to avoid rate-limit issues while downloading Metamask)
GH_PAT GitHub personal access token (used to avoid rate-limit issue while downloading metamask)
ETHERSCAN_KEY Etherscan key (used only for etherscan-related commands)
FAIL_ON_ERROR Fail a test if there are any browser console errors
CYPRESS_GROUP Group tests
CI Boolean value indicates that tests are running from CI/CD pipeline

🚢 Release process

  1. Create PR from dev branch to master branch
  2. Merge it (new -beta version is automatically released)
  3. Run GitHub Action workflow named Release CI with patch|minor|major depending on your needs to promote your build.

Alternatively, instead of running GitHub Action for release, you can move on with manual release process:

  1. Switch to master branch and pull latest changes
  2. Run pnpm release:patch/minor/major command
  3. Keep dev branch up to date with master

Above actions will lead to:

  • New npm node module release
  • New GitHub packages node module release
  • New GitHub release (tagged) created with changelog from commit messages

📝 More resources