woocommerce/tests/e2e/env
Marcus 3201a99995 fix: only use customInitFile in e2e if it's a string
in WSL2 the second argument is an instance of Command and can not be used with path.resolve
2021-02-23 20:12:51 +01:00
..
bin fix: only use customInitFile in e2e if it's a string 2021-02-23 20:12:51 +01:00
config allow env default.json to be untracked in git 2021-02-08 16:12:10 -04:00
docker/wp-cli merge master 2020-09-11 14:35:27 -03:00
src/setup eliminate repeated missing resource messages in E2E 2021-01-26 11:42:51 -04:00
utils Merge pull request #29060 from woocommerce/packages/ignore-default-json 2021-02-08 15:58:04 -07:00
.env add admin user E2E config support (#28656) 2021-01-19 16:02:08 +01:00
.eslintrc.js update folder structure, use WordPress 5.4 2020-04-28 19:09:39 -03:00
.npmrc update folder structure, use WordPress 5.4 2020-04-28 19:09:39 -03:00
CHANGELOG.md Return jest error for Travis (#28929) 2021-01-26 21:59:40 +01:00
README.md update e2e-environment readme 2020-10-15 14:53:21 -03:00
babel.config.js update folder structure, use WordPress 5.4 2020-04-28 19:09:39 -03:00
builtin.md update built-in readme with shorthand script 2021-02-04 15:52:18 -04:00
docker-compose.yaml use consistent MySQL configuration values 2020-08-04 16:17:00 -03:00
external.md update e2e readmes 2020-08-05 16:58:38 -03:00
index.js simplify e2e-environment exports 2020-10-21 16:17:10 -03:00
package-lock.json package lock maintenance 2021-02-01 13:03:13 -04:00
package.json bump version in E2E packages (#28823) 2021-01-22 14:22:33 +01:00

README.md

End to End Testing Environment

A reusable and extendable E2E testing environment for WooCommerce extensions.

Installation

npm install @woocommerce/e2e-environment --save
npm install jest --global

Configuration

The @woocommerce/e2e-environment package exports configuration objects that can be consumed in JavaScript config files in your project. Additionally, it includes a hosting container for running tests and includes instructions for creating your Travis CI setup.

Babel Config

Make sure you npm install @babel/preset-env --save if you have not already done so. Afterwards, extend your project's babel.config.js to contain the expected presets for E2E testing.

const { useE2EBabelConfig } = require( '@woocommerce/e2e-environment' );

module.exports = function( api ) {
	api.cache( true );

	return useE2EBabelConfig( {
		presets: [
			'@wordpress/babel-preset-default',
		],
	} );
};

ES Lint Config

The E2E environment uses Puppeteer for headless browser testing, which uses certain globals variables. Avoid ES Lint errors by extending the config.

const { useE2EEsLintConfig } = require( '@woocommerce/e2e-environment' );

module.exports = useE2EEsLintConfig( {
	root: true,
	env: {
		browser: true,
		es6: true,
		node: true
	},
	globals: {
		wp: true,
		wpApiSettings: true,
		wcSettings: true,
		es6: true
	},
} );

Jest Config

The E2E environment uses Jest as a test runner. Extending the base config is needed in order for Jest to run your project's test files.

const path = require( 'path' );
const { useE2EJestConfig } = require( '@woocommerce/e2e-environment' );

const jestConfig = useE2EJestConfig( {
	roots: [ path.resolve( __dirname, '../specs' ) ],
} );

module.exports = jestConfig;

NOTE: Your project's Jest config file is expected to be: tests/e2e/config/jest.config.js.

Jest Puppeteer Config

The test sequencer uses the following default Puppeteer configuration:

// headless
	puppeteerConfig = {
		launch: {
			// Required for the logged out and logged in tests so they don't share app state/token.
			browserContext: 'incognito',
		},
	};
// dev mode
	puppeteerConfig = {
		launch: {
			...jestPuppeteerConfig.launch, // @automattic/puppeteer-utils
			ignoreHTTPSErrors: true,
			headless: false,
			args: [ '--window-size=1920,1080', '--user-agent=chrome' ],
			devtools: true,
			defaultViewport: {
				width: 1280,
				height: 800,
			},
		},
	};

You can customize the configuration in tests/e2e/config/jest-puppeteer.config.js

const { useE2EJestPuppeteerConfig } = require( '@woocommerce/e2e-environment' );

const puppeteerConfig = useE2EJestPuppeteerConfig( {
	launch: {
		headless: false,
	}
} );

module.exports = puppeteerConfig;

Jest Setup

Jest provides setup and teardown functions similar to PHPUnit. The default setup and teardown is in tests/e2e/env/src/setup/jest.setup.js. Additional setup and teardown functions can be added to tests/e2e/config/jest.setup.js

Container Setup

Depending on the project and testing scenario, the built in testing environment container might not be the best solution for testing. This could be local testing where there is already a testing container, a repository that isn't a plugin or theme and there are multiple folders mapped into the container, or similar. The e2e-environment container supports using either the built in container or an external container. See the the appropriate readme for details:

Additional information

Refer to tests/e2e/core-tests for some test examples, and tests/e2e for general information on e2e tests.