Separate e2e test utils functions into their own files #11701

nicolad · 2018-11-09T22:21:29Z

Description

Closes #11535.

This PR is related to this issue: #11535

How has this been tested?

I have checked files that have imported methods from utils.js file can import the same methods from utils folder.

Types of changes

Created new files for methods from utils.js file.

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
My code has proper inline documentation.

gziolo

This is a great start, thanks for working on it 👍

I left doc related comments. We didn't do good enough job in the past with documenting this code. It would be great to improve it as we move forward :)

test/e2e/support/utils/mock-or-transform.js

gziolo · 2018-11-12T19:19:38Z

test/e2e/support/utils/new-post.js

+import { addQueryArgs } from '@wordpress/url';
+import { visitAdmin } from './';
+
+export async function newPost( {


Can we add JSDoc here? It wasn't provided but it might be very helpful in the long run. At some point we will need to generate docs based on those code comments to make util methods discovery easier.

On next commit I will add JSDoc. Didn't wanted to clutter current commit, although it has quite few changes. But because there was mainly copy-pastying I think it's not that critical to separate into several commits. Correct me if I am wrong.

We squash and merge at the end of the process so it will become a single commit. I'm not concerned that much as long as all e2e tests are green after refactoring is finished :)

Great, thank you.

JSDoc added here:
568458e

gziolo · 2018-11-13T13:37:05Z

test/e2e/support/utils/login.js

+import { pressWithModifier } from './press-with-modifier';
+import { META_KEY } from './';
+
+const WP_ADMIN_USER = {


Can we move this logic to its own file and export WP_ADMIN_USER, WP_USERNAME and WP_PASSWORD from there to be able to share in all test helpers?

Covered in this commit:
384afa4

gziolo · 2018-11-13T13:47:11Z

test/e2e/support/utils/meta-key.js

+ *
+ * @type {string}
+ */
+export const META_KEY = process.platform === 'darwin' ? 'Meta' : 'Control';


This looks similar to:
https://github.com/WordPress/gutenberg/blob/master/packages/keycodes/src/index.js#L47

I'm wondering if we could use https://github.com/WordPress/gutenberg/blob/master/packages/keycodes/src/index.js#L61
instead or something similar to avoid logic duplication.

I bet it would be easier to perform it in the follow-up PR. For this one, can we consolidate those modifiers in one file? I see that ACCESS_MODIFIER_KEYS is also in their own file. It would read easier if it was colocated with pressWithModifier function.

Yes, placing this into follow-up PR is a good idea. Will use your hints when I will create that.
For now I've colocated them here:
90dec9f

test/e2e/support/utils/get-url.js

…lity/11535-extract-test-utilities

gziolo

This is awesome. Thanks for immensely improving the way code is structured.

I left some comments on what could be tackled in the follow-up PR.

I'm not sure why e2e tests failed in the last commit. We need to ensure they are green before we merge.

gziolo · 2018-11-14T11:13:08Z

test/e2e/support/utils/convert-block.js

@@ -0,0 +1,6 @@
+export async function convertBlock( name ) {


JSDoc is missing.

gziolo · 2018-11-14T11:13:59Z

test/e2e/support/utils/disable-pre-publish-checks.js

+ */
+import { toggleOption } from './toggle-option';
+
+export async function disablePrePublishChecks() {


JSDoc is missing.

It would make sense to consolidate disablePrePublishChecks and enablePrePublishChecks in one file.

gziolo · 2018-11-14T11:14:37Z

test/e2e/support/utils/enable-pre-publish-checks.js

+ */
+import { toggleOption } from './toggle-option';
+
+export async function enablePrePublishChecks() {


The same applies as fo disablePrePublishChecks.

gziolo · 2018-11-14T11:15:44Z

test/e2e/support/utils/get-url.js

+
+import { WP_BASE_URL } from './config';
+
+export function getUrl( WPPath, query = '' ) {


JSDoc is missing.

gziolo · 2018-11-14T11:16:11Z

test/e2e/support/utils/get-url.js

+ */
+import { join } from 'path';
+
+import { WP_BASE_URL } from './config';


Internal dependencies comment is missing.

gziolo · 2018-11-14T11:17:21Z

test/e2e/support/utils/is-wp-path.js

+ */
+import { getUrl } from './get-url';
+
+export function isWPPath( WPPath, query = '' ) {


JSDoc is missing.

gziolo · 2018-11-14T11:17:41Z

test/e2e/support/utils/login.js

+import { META_KEY } from './';
+import { WP_USERNAME, WP_PASSWORD } from './config';
+
+export async function login( username = WP_USERNAME, password = WP_PASSWORD ) {


JSDoc is missing.

gziolo · 2018-11-14T11:21:02Z

test/e2e/support/utils/set-viewport.js

+ */
+import { waitForPageDimensions } from './wait-for-page-dimensions';
+
+export async function setViewport( type ) {


JSDoc is missing.

gziolo · 2018-11-14T11:21:12Z

test/e2e/support/utils/switch-to-editor.js

@@ -0,0 +1,9 @@
+export async function switchToEditor( mode ) {


JSDOc is missing

test/e2e/support/utils/login.js

gziolo · 2018-11-14T11:56:39Z

@vadimnicolai - do you plan to open a follow-up PR and improve this further?

nicolad · 2018-11-14T13:02:48Z

@vadimnicolai - do you plan to open a follow-up PR and improve this further?

@gziolo, here is the follow-up PR: #11855

Extracted some utils methods.

3aee2a9

gziolo reviewed Nov 12, 2018

View reviewed changes

gziolo added [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Type] Code Quality Issues or PRs that relate to code quality labels Nov 12, 2018

gziolo changed the title ~~Extracted some utils methods.~~ Separate e2e test utils functions into their own files Nov 12, 2018

nicolad added 2 commits November 13, 2018 15:07

Created files for all methods and functions from index.js

a718ff0

Added visitAdmin method into index.js

9c8e0ef

gziolo reviewed Nov 13, 2018

View reviewed changes

nicolad and others added 7 commits November 13, 2018 16:06

pressWithModifier exported from index.

5f58b47

Moved WP_ADMIN_USER, WP_USERNAME and WP_PASSWORD into config file.

384afa4

Colocated ACCESS_MODIFIER_KEYS with pressWithModifier.

90dec9f

Moved WP_BASE_URL into config file.

406ff7a

Merge branch 'master' of github.com:WordPress/gutenberg into code-qua…

b858dc7

…lity/11535-extract-test-utilities

Added JSdoc for new post.

568458e

Update login.js

2762a6b

gziolo approved these changes Nov 14, 2018

View reviewed changes

gziolo added this to the 4.4 milestone Nov 14, 2018

gziolo merged commit 3834138 into WordPress:master Nov 14, 2018

nicolad deleted the code-quality/11535-extract-test-utilities branch November 14, 2018 13:02

nicolad self-assigned this Sep 29, 2019


		import { WP_BASE_URL } from './config';

		export function getUrl( WPPath, query = '' ) {

		@@ -0,0 +1,9 @@
		export async function switchToEditor( mode ) {

Separate e2e test utils functions into their own files #11701

Separate e2e test utils functions into their own files #11701

Uh oh!

Conversation

nicolad commented Nov 9, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How has this been tested?

Types of changes

Checklist:

Uh oh!

gziolo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolad Nov 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gziolo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gziolo commented Nov 14, 2018

Uh oh!

nicolad commented Nov 14, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nicolad commented Nov 9, 2018 •

edited

Loading

nicolad Nov 13, 2018 •

edited

Loading