Add: End 2 end test to InnerBlocks allowed block restrictions by jorgefilipecosta · Pull Request #14054 · WordPress/gutenberg

jorgefilipecosta · 2019-02-22T12:07:22Z

Description

This PR adds an end to end tests to the global inserter.
It verifies that:

The inserter opens and shows all the blocks by default.
On "Media & Text" block, the inserter items are restricted to a small set.
Inside columns block, no item appears on the inserter.

Catches the bug being addressed in #14020. So currently the tests fail.

gziolo · 2019-03-12T08:49:55Z

+		expect( await getAllInserterItemTitles() ).toMatchSnapshot();
+	} );
+
+	it( 'media & text block should restrict allowed blocks', async () => {


This test is very specific to the Media & Text block. It's fine to start with but I would personally prefer to see this kind of tests inside blocks/media-text.spec.js file. It's faster to start with such verification but ideally, we use some custom block registered for testing purpose.

gziolo · 2019-03-12T08:51:23Z

+	} );
+
+	it( 'no blocks should be allowed inside columns', async () => {
+		await insertBlock( 'Columns' );


The same applies as above. Those two test cases should be documented with the explanation of why those blocks are used and what characteristics they have.

Example, if we would change the behavior of Columns blocks to allow some blocks we should rather remove this test from the test suite rather than update it.

jorgefilipecosta · 2019-03-12T18:15:28Z

Hi @gziolo,
Thank you for the review, this PR was updated taking into account your feedback.
We now have block specific tests and a test that specifically tests the allowed block restrictions using a custom block.

gziolo

Awesome work @jorgefilipecosta. I thought you would handle my comments in a separate PR :)

This looks great, I left a couple of minor things to address before merging. Overall, I'm impressed with how e2e testing infrastructure and coverage grows thanks to your numerous contributions. 🥇

BTW, I ✅ this PR, if you feel you need another review when typos are fixed, let me know.

gziolo · 2019-03-13T08:34:42Z

+		plugins_url( 'inner-blocks-allowed-blocks/index.js', __FILE__ ),
+		array(
+			'wp-blocks',
+			'wp-components',


wp-components and wp-hooks are never used so can be safely removed.

gziolo · 2019-03-13T08:35:34Z

+ */
+function enqueue_block_icons_plugin_script() {
+	wp_enqueue_script(
+		'gutenberg-test-block-icons',


This name was copied over from another file, it should be updated.

gziolo · 2019-03-13T08:36:20Z

+	);
+}
+
+add_action( 'init', 'enqueue_block_icons_plugin_script' );


The same issue with the function name, needs to be synced with the name of the file/plugin.

gziolo · 2019-03-13T08:37:02Z

+	openGlobalBlockInserter,
+} from '@wordpress/e2e-test-utils';
+
+describe( 'Collumns', () => {


Typo here:

Suggested change

describe( 'Collumns', () => {

describe( 'Columns', () => {

and in the name of the file.

gziolo · 2019-03-13T08:41:14Z

 export { ensureSidebarOpened } from './ensure-sidebar-opened';
 export { findSidebarPanelToggleButtonWithTitle } from './find-sidebar-panel-toggle-button-with-title';
 export { findSidebarPanelWithTitle } from './find-sidebar-panel-with-title';
+export { getAllBlockInserterItemTitles } from './get-all-block-inserter-item-titles';


Can we also update CHANGELOG file? This package is public and is already being explored by external projects. This is going to be minor version bump as we add new features 🎉

jorgefilipecosta · 2019-03-13T19:46:11Z

Thank you for the feedback @gziolo, it was applied before the merge.

aduth · 2019-03-15T13:33:24Z

I received an intermittent failure from these tests in #14128

Summary of all failing tests
FAIL specs/plugins/inner-blocks-allowed-blocks.test.js (8.254s)
  ● Allowed Blocks Setting on InnerBlocks  › allows all blocks if the allowed blocks setting was not set
    Node is detached from document
      at ElementHandle._scrollIntoViewIfNeeded (../../node_modules/puppeteer/lib/ElementHandle.js:75:13)

aduth · 2019-03-15T13:38:08Z

I note #14450 has a failed build as well due to the same error.

aduth · 2019-03-15T13:40:25Z

Specifically, the error occurs here in Puppeteer. _scrollIntoViewIfNeeded is called by various interactions like clicking.

https://github.com/GoogleChrome/puppeteer/blob/v1.6.2/lib/ElementHandle.js#L60

Also worth noting the file doesn't exist in more recent versions of Puppeteer (unsure if that may have an impact).

jorgefilipecosta added [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Feature] Inserter The main way to insert blocks using the + button in the editing interface labels Feb 22, 2019

jorgefilipecosta force-pushed the add/end-to-end-test-global-block-inserter-restrictions branch from f7ffd84 to 30c6a49 Compare March 5, 2019 16:23

jorgefilipecosta marked this pull request as ready for review March 5, 2019 16:31

jorgefilipecosta requested review from aduth, ajitbohra, gziolo, nerrad, ntwb, talldan and youknowriad as code owners March 5, 2019 16:31

jorgefilipecosta force-pushed the add/end-to-end-test-global-block-inserter-restrictions branch from 30c6a49 to 546b667 Compare March 5, 2019 17:16

jorgefilipecosta mentioned this pull request Mar 5, 2019

Fix: Global inserter does not validates block insert restrictions #14020

Merged

gziolo added this to the 5.3 (Gutenberg) milestone Mar 12, 2019

gziolo reviewed Mar 12, 2019

View reviewed changes

jorgefilipecosta force-pushed the add/end-to-end-test-global-block-inserter-restrictions branch 2 times, most recently from 72bda4a to 50e9ef4 Compare March 12, 2019 18:12

jorgefilipecosta changed the title ~~Add: End 2 end test global block inserter restrictions~~ Add: End 2 end test to InnerBlock allowed block restrictions Mar 12, 2019

jorgefilipecosta changed the title ~~Add: End 2 end test to InnerBlock allowed block restrictions~~ Add: End 2 end test to InnerBlocks allowed block restrictions Mar 12, 2019

gziolo approved these changes Mar 13, 2019

View reviewed changes

Add: End 2 end tests to allowedBlocks restrictions

65dea0c

jorgefilipecosta force-pushed the add/end-to-end-test-global-block-inserter-restrictions branch from 50e9ef4 to 65dea0c Compare March 13, 2019 19:18

jorgefilipecosta merged commit cd456f6 into master Mar 13, 2019

jorgefilipecosta deleted the add/end-to-end-test-global-block-inserter-restrictions branch March 13, 2019 19:45

jorgefilipecosta mentioned this pull request Mar 18, 2019

Bump plugin version to 5.3.0-rc.1 #14489

Merged

This was referenced Mar 20, 2019

Update plugin version to 5.3 #14523

Merged

Update plugin version to 5.3 #14524

Closed

Update WordPress trunk to Gutenberg 5.3 #14532

Closed

youknowriad pushed a commit that referenced this pull request Mar 20, 2019

Add: end to end test to InnerBlocks allowed block restriction (#14054)

6692179

youknowriad pushed a commit that referenced this pull request Mar 20, 2019

Add: end to end test to InnerBlocks allowed block restriction (#14054)

9c27717

Conversation

jorgefilipecosta commented Feb 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

gziolo Mar 12, 2019

Choose a reason for hiding this comment

Uh oh!

gziolo Mar 12, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jorgefilipecosta commented Mar 12, 2019

Uh oh!

gziolo left a comment • 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!

gziolo Mar 13, 2019

Choose a reason for hiding this comment

Uh oh!

gziolo Mar 13, 2019

Choose a reason for hiding this comment

Uh oh!

gziolo Mar 13, 2019

Choose a reason for hiding this comment

Uh oh!

gziolo Mar 13, 2019

Choose a reason for hiding this comment

Uh oh!

gziolo Mar 13, 2019

Choose a reason for hiding this comment

Uh oh!

jorgefilipecosta commented Mar 13, 2019

Uh oh!

aduth commented Mar 15, 2019

Uh oh!

aduth commented Mar 15, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aduth commented Mar 15, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jorgefilipecosta commented Feb 22, 2019 •

edited

Loading

gziolo left a comment •

edited

Loading

aduth commented Mar 15, 2019 •

edited

Loading