Tests: Extract e2e test utils to their own package (WordPress#13228)

* Tests: Move e2e tests dependent on plugins to their own folder

* Tests: Extract e2e test utils to their own package

Author: gziolo

.eslintignore

@@ -1,6 +1,6 @@
 build
 build-module
 node_modules
-packages/tests-e2e/plugins
+packages/e2e-tests/plugins
 vendor
 packages/block-serialization-spec-parser/parser.js

.eslintrc.js

@@ -182,7 +182,7 @@ module.exports = {
 	},
 	overrides: [
 		{
-			files: [ 'packages/tests-e2e/**/*.js' ],
+			files: [ 'packages/e2e-test*/**/*.js' ],
 			env: {
 				browser: true,
 			},

.travis.yml

@@ -67,29 +67,29 @@ jobs:
       install:
         - ./bin/setup-local-env.sh
       script:
-        - $( npm bin )/wp-scripts test-e2e --testPathPattern=/packages/tests-e2e/specs/ --listTests > ~/.jest-e2e-tests
+        - $( npm bin )/wp-scripts test-e2e --config=./packages/e2e-tests/jest.config.js --listTests > ~/.jest-e2e-tests
         - npm run test-e2e -- --ci --cacheDirectory="$HOME/.jest-cache" --runTestsByPath $( awk 'NR % 2 == 0' < ~/.jest-e2e-tests )
 
     - name: E2E tests (Admin with plugins) (2/2)
       env: WP_VERSION=latest POPULAR_PLUGINS=true
       install:
         - ./bin/setup-local-env.sh
       script:
-        - $( npm bin )/wp-scripts test-e2e --testPathPattern=/packages/tests-e2e/specs/ --listTests > ~/.jest-e2e-tests
+        - $( npm bin )/wp-scripts test-e2e --config=./packages/e2e-tests/jest.config.js --listTests > ~/.jest-e2e-tests
         - npm run test-e2e -- --ci --cacheDirectory="$HOME/.jest-cache" --runTestsByPath $( awk 'NR % 2 == 1' < ~/.jest-e2e-tests )
 
     - name: E2E tests (Author without plugins) (1/2)
       env: WP_VERSION=latest E2E_ROLE=author
       install:
         - ./bin/setup-local-env.sh
       script:
-        - $( npm bin )/wp-scripts test-e2e --testPathPattern=/packages/tests-e2e/specs/ --listTests > ~/.jest-e2e-tests
+        - $( npm bin )/wp-scripts test-e2e --config=./packages/e2e-tests/jest.config.js --listTests > ~/.jest-e2e-tests
         - npm run test-e2e -- --ci --cacheDirectory="$HOME/.jest-cache" --runTestsByPath $( awk 'NR % 2 == 0' < ~/.jest-e2e-tests )
 
     - name: E2E tests (Author without plugins) (2/2)
       env: WP_VERSION=latest E2E_ROLE=author
       install:
         - ./bin/setup-local-env.sh
       script:
-        - $( npm bin )/wp-scripts test-e2e --testPathPattern=/packages/tests-e2e/specs/ --listTests > ~/.jest-e2e-tests
+        - $( npm bin )/wp-scripts test-e2e --config=./packages/e2e-tests/jest.config.js --listTests > ~/.jest-e2e-tests
         - npm run test-e2e -- --ci --cacheDirectory="$HOME/.jest-cache" --runTestsByPath $( awk 'NR % 2 == 1' < ~/.jest-e2e-tests )

docker-compose.yml

@@ -12,8 +12,8 @@ services:
     volumes:
       - wordpress:/var/www/html
       - .:/var/www/html/wp-content/plugins/gutenberg
-      - ./packages/tests-e2e/plugins:/var/www/html/wp-content/plugins/gutenberg-test-plugins
-      - ./packages/tests-e2e/mu-plugins:/var/www/html/wp-content/mu-plugins
+      - ./packages/e2e-tests/plugins:/var/www/html/wp-content/plugins/gutenberg-test-plugins
+      - ./packages/e2e-tests/mu-plugins:/var/www/html/wp-content/mu-plugins
     depends_on:
       - mysql
 
@@ -59,8 +59,8 @@ services:
     volumes:
       - wordpress_e2e_tests:/var/www/html
       - .:/var/www/html/wp-content/plugins/gutenberg
-      - ./packages/tests-e2e/plugins:/var/www/html/wp-content/plugins/gutenberg-test-plugins
-      - ./test/e2e/mu-plugins:/var/www/html/wp-content/mu-plugins
+      - ./packages/e2e-tests/plugins:/var/www/html/wp-content/plugins/gutenberg-test-plugins
+      - ./packages/e2e-tests/mu-plugins:/var/www/html/wp-content/mu-plugins
 
   cli_e2e_tests:
     image: wordpress:cli

docs/manifest.json

@@ -593,6 +593,18 @@
 		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/dom/README.md",
 		"parent": "packages"
 	},
+	{
+		"title": "@wordpress/e2e-test-utils",
+		"slug": "packages-e2e-test-utils",
+		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/e2e-test-utils/README.md",
+		"parent": "packages"
+	},
+	{
+		"title": "@wordpress/e2e-tests",
+		"slug": "packages-e2e-tests",
+		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/e2e-tests/README.md",
+		"parent": "packages"
+	},
 	{
 		"title": "@wordpress/edit-post",
 		"slug": "packages-edit-post",
@@ -737,12 +749,6 @@
 		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/shortcode/README.md",
 		"parent": "packages"
 	},
-	{
-		"title": "@wordpress/tests-e2e",
-		"slug": "packages-tests-e2e",
-		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/tests-e2e/README.md",
-		"parent": "packages"
-	},
 	{
 		"title": "@wordpress/token-list",
 		"slug": "packages-token-list",

jsconfig.json

@@ -9,7 +9,7 @@
 		"build",
 		"build-module",
 		"node_modules",
-		"packages/tests-e2e/plugins",
+		"packages/e2e-tests/plugins",
 		"vendor"
 	]
 }

package-lock.json

@@ -60,14 +60,15 @@
 		"@wordpress/babel-preset-default": "file:packages/babel-preset-default",
 		"@wordpress/browserslist-config": "file:packages/browserslist-config",
 		"@wordpress/custom-templated-path-webpack-plugin": "file:packages/custom-templated-path-webpack-plugin",
+		"@wordpress/e2e-test-utils": "file:packages/e2e-test-utils",
+		"@wordpress/e2e-tests": "file:packages/e2e-tests",
 		"@wordpress/eslint-plugin": "file:packages/eslint-plugin",
 		"@wordpress/jest-console": "file:packages/jest-console",
 		"@wordpress/jest-preset-default": "file:packages/jest-preset-default",
 		"@wordpress/library-export-default-webpack-plugin": "file:packages/library-export-default-webpack-plugin",
 		"@wordpress/npm-package-json-lint-config": "file:packages/npm-package-json-lint-config",
 		"@wordpress/postcss-themes": "file:packages/postcss-themes",
 		"@wordpress/scripts": "file:packages/scripts",
-		"@wordpress/tests-e2e": "file:packages/tests-e2e",
 		"babel-loader": "8.0.0",
 		"benchmark": "2.1.4",
 		"browserslist": "3.2.8",
@@ -176,7 +177,7 @@
 		"publish:prod": "npm run build:packages && lerna publish",
 		"test": "npm run lint && npm run test-unit",
 		"pretest-e2e": "concurrently \"./bin/reset-e2e-tests.sh\" \"npm run build\"",
-		"test-e2e": "wp-scripts test-e2e --setupTestFrameworkScriptFile=./packages/tests-e2e/support/setup-test-framework.js --testPathPattern=/packages/tests-e2e/specs/",
+		"test-e2e": "wp-scripts test-e2e --config packages/e2e-tests/jest.config.js",
 		"test-e2e:watch": "npm run test-e2e -- --watch",
 		"test-php": "npm run lint-php && npm run test-unit-php",
 		"test-unit": "wp-scripts test-unit-js --config test/unit/jest.config.json",

package.json

@@ -0,0 +1,39 @@
+{
+	"name": "@wordpress/e2e-test-utils",
+	"version": "1.0.0-alpha.0",
+	"description": "End-To-End (E2E) test utils for WordPress.",
+	"author": "The WordPress Contributors",
+	"license": "GPL-2.0-or-later",
+	"keywords": [
+		"wordpress",
+		"e2e",
+		"utils"
+	],
+	"homepage": "https://github.com/WordPress/gutenberg/tree/master/packages/e2e-test-utils/README.md",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/WordPress/gutenberg.git"
+	},
+	"bugs": {
+		"url": "https://github.com/WordPress/gutenberg/issues"
+	},
+	"files": [
+		"build",
+		"build-module"
+	],
+	"main": "build/index.js",
+	"module": "build-module/index.js",
+	"dependencies": {
+		"@wordpress/keycodes": "file:../keycodes",
+		"@wordpress/url": "file:../url",
+		"lodash": "^4.17.10",
+		"node-fetch": "^1.7.3"
+	},
+	"peerDependencies": {
+		"jest": ">=23.0.0",
+		"puppeteer": ">=1.6.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

packages/tests-e2e/.npmrc packages/e2e-test-utils/.npmrc

@@ -0,0 +1 @@
+package-lock=false

packages/e2e-test-utils/CHANGELOG.md

@@ -8,16 +8,12 @@ import { get } from 'lodash';
  * WordPress dependencies
  */
 import '@wordpress/jest-console';
-
-/**
- * Internal dependencies
- */
 import {
 	clearLocalStorage,
 	enablePageDialogAccept,
 	setBrowserViewport,
 	visitAdminPage,
-} from './utils';
+} from '@wordpress/e2e-test-utils';
 
 /**
  * Environment variables

packages/e2e-test-utils/README.md

@@ -0,0 +1,4 @@
+module.exports = {
+	...require( '@wordpress/scripts/config/jest-e2e.config' ),
+	setupTestFrameworkScriptFile: '<rootDir>/config/setup-test-framework.js',
+};

packages/e2e-test-utils/package.json

@@ -1,16 +1,15 @@
 {
-	"name": "@wordpress/tests-e2e",
-	"private": true,
+	"name": "@wordpress/e2e-tests",
 	"version": "1.0.0-alpha.0",
 	"description": "End-To-End (E2E) tests for WordPress.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
 	"keywords": [
 		"wordpress",
-		"tests",
-		"e2e"
+		"e2e",
+		"tests"
 	],
-	"homepage": "https://github.com/WordPress/gutenberg/tree/master/packages/tests-e2e/README.md",
+	"homepage": "https://github.com/WordPress/gutenberg/tree/master/packages/e2e-tests/README.md",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/WordPress/gutenberg.git"
@@ -19,12 +18,11 @@
 		"url": "https://github.com/WordPress/gutenberg/issues"
 	},
 	"dependencies": {
+		"@wordpress/e2e-test-utils": "file:../e2e-test-utils",
 		"@wordpress/jest-console": "file:../jest-console",
-		"@wordpress/keycodes": "file:../keycodes",
-		"@wordpress/url": "file:../url",
+		"@wordpress/scripts": "file:../scripts",
 		"expect-puppeteer": "^3.2.0",
-		"lodash": "^4.17.10",
-		"node-fetch": "^1.7.3"
+		"lodash": "^4.17.10"
 	},
 	"peerDependencies": {
 		"jest": ">=23.0.0",

packages/tests-e2e/support/utils/activate-plugin.js packages/e2e-test-utils/src/activate-plugin.js

@@ -1,10 +1,10 @@
 /**
- * Internal dependencies
+ * WordPress dependencies
  */
 import {
 	createNewPost,
 	pressKeyWithModifier,
-} from '../support/utils';
+} from '@wordpress/e2e-test-utils';
 
 function isCloseButtonFocused() {
 	return page.$eval( ':focus', ( focusedElement ) => {

packages/tests-e2e/support/utils/are-pre-publish-checks-enabled.js packages/e2e-test-utils/src/are-pre-publish-checks-enabled.js

@@ -1,12 +1,12 @@
 /**
- * Internal dependencies
+ * WordPress dependencies
  */
 import {
 	createNewPost,
 	insertBlock,
 	getEditedPostContent,
 	pressKeyTimes,
-} from '../support/utils';
+} from '@wordpress/e2e-test-utils';
 
 describe( 'adding blocks', () => {
 	beforeEach( async () => {

packages/tests-e2e/support/utils/clear-local-storage.js packages/e2e-test-utils/src/clear-local-storage.js

@@ -7,14 +7,14 @@ import os from 'os';
 import uuid from 'uuid/v4';
 
 /**
- * Internal dependencies
+ * WordPress dependencies
  */
 import {
 	clickBlockAppender,
 	getEditedPostContent,
 	insertBlock,
 	createNewPost,
-} from '../support/utils';
+} from '@wordpress/e2e-test-utils';
 
 describe( 'adding inline tokens', () => {
 	beforeAll( async () => {

packages/tests-e2e/support/utils/click-block-appender.js packages/e2e-test-utils/src/click-block-appender.js

@@ -1,12 +1,12 @@
 /**
- * Internal dependencies
+ * WordPress dependencies
  */
 import {
 	clickBlockAppender,
 	getEditedPostContent,
 	createNewPost,
 	pressKeyWithModifier,
-} from '../support/utils';
+} from '@wordpress/e2e-test-utils';
 
 const addThreeParagraphsToNewPost = async () => {
 	await createNewPost();