Testing: Add integration tests for blocks with deprecations #15268

gziolo · 2019-04-30T14:38:08Z

Description

Inspired by the comment from @ellatrix in #15057 (comment):

It's a bit hard to review this without any tests for deprecated blocks. Would it be possible to add some simple tests to see if deprecated block structures are converted correctly?

This PR adds integration tests for blocks with deprecations:

Gallery block
Image block
Pullquote block
Quote block

Paragraph block was covered previously.

Implementation details

I used #3996 to replicate the example for deprecated Gallery block. I figured out there are two issues:

we use now align hook which filters out none value but injects other values otherwise
images attribute uses a newer definition which makes it useless

I fixed both issues in this PR. You can test it manually by opening Gutenberg's Code Editor and pasting the following snippet used in the test:

<!-- wp:core/gallery {"ids":[null,null],"columns":2} -->
<div class="wp-block-gallery alignnone columns-2 is-cropped">
	<figure class="blocks-gallery-image">
		<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACklEQVR4nGMAAQAABQABDQottAAAAABJRU5ErkJggg==" alt="title" />
	</figure>
	<figure class="blocks-gallery-image">
		<img src="data:image/jpeg;base64,/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k=" alt="title" />
	</figure>
</div>
<!-- /wp:core/gallery -->

How has this been tested?

npm run test-unit

gziolo · 2019-04-30T15:00:10Z

@aduth - I tried to add tests for List and Heading blocks but it looks like deprecated versions left for those blocks don't work anymore. It looks like #7349 was added temporary and wasn't planned to be supported for long. Does it mean we can safely remove them?

ellatrix · 2019-05-01T11:20:48Z

I don't see any code that adds it to the generation of the fixtures. How does it work?

ellatrix · 2019-05-01T11:22:07Z

packages/e2e-tests/fixtures/blocks/core__gallery__deprecated.html

@@ -0,0 +1,10 @@
+<!-- wp:core/gallery {"ids":[null,null],"columns":2} -->


There's multiple deprecations, but I only see one being added here?

Yes, it's time-consuming to backport all those missing fixtures.

gziolo · 2019-05-06T07:41:23Z

I don't see any code that adds it to the generation of the fixtures. How does it work?

It's handled out of the box based on the patterns in the fixtures folder:
https://github.com/WordPress/gutenberg/blob/master/test/integration/full-content/full-content.spec.js#L30
https://github.com/WordPress/gutenberg/blob/master/packages/e2e-tests/fixtures/utils.js#L32-L44

gziolo · 2019-05-06T12:03:25Z

I tried the following code for Quote but it doesn't work as the currently active save handler intercepts it:

<!-- wp:core/quote {"align":"left","style":2} -->
<blockquote class="wp-block-quote is-large" style="text-align:left">
	<p>Testing deprecated quote block...</p>
	<cite>...with a caption</cite>
</blockquote>
<!-- /wp:core/quote -->

gziolo · 2019-05-06T12:08:19Z

I was able to cover all Pullquote deprecations with tests in 4658ef3.

I will look into Image and Gallery blocks tomorrow.

gziolo · 2019-05-07T08:32:26Z

I will look into Image and Gallery blocks tomorrow.

It's now covered with 9e84880 and 4658ef3.

I removed one of the deprecations from Gallery block as it will never catch block definition because of how the newer one builds on top of it. The related change was introduced in: #11540.

gziolo · 2019-05-07T08:34:56Z

test/integration/full-content/server-registered.json

It looks like npm run fixtures:regenerate wasn't executed after Latest Posts block was updated.

gziolo · 2019-05-07T08:45:18Z

packages/block-library/src/gallery/index.js

@@ -95,47 +142,39 @@ export const settings = {
 				);
 			},
 		},
-		{


The previous definition is nearly the same (it only adds one optional attribute in HTML output) making this entry redundant. It can be safely removed.

ellatrix · 2019-05-07T08:50:45Z

It's handled out of the box based on the patterns in the fixtures folder:

Then why weren't they generated before? I also see changes to fixtures. What makes it so that they are now generated in this PR?

gziolo · 2019-05-07T08:58:27Z

Then why weren't they generated before? I also see changes to fixtures. What makes it so that they are now generated in this PR?

You need to manual craft HTML input files yourself. See all details explained in this file: https://github.com/WordPress/gutenberg/blob/master/packages/e2e-tests/fixtures/blocks/README.md

ellatrix · 2019-05-07T09:08:19Z

@gziolo Ah, I see. Is there any way we can error if someone adds a deprecation, but doesn't add a HTML input file to test the deprecated code?

ellatrix

Love that deprecations are now tested!

gziolo · 2019-05-07T09:28:37Z

@gziolo Ah, I see. Is there any way we can error if someone adds a deprecation, but doesn't add a HTML input file to test the deprecated code?

Yes, that would be nice to have. It's now automatically enforced to include one HTML file per block's folder. We probably can expand on that once we have standardized deprecated.js file for blocks.

gziolo added [Feature] Blocks Overall functionality of blocks [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. labels Apr 30, 2019

gziolo requested review from aduth, ajitbohra, jorgefilipecosta, nerrad, noisysocks, notnownikki, ntwb, Soean, talldan and youknowriad as code owners April 30, 2019 14:38

gziolo self-assigned this Apr 30, 2019

gziolo requested a review from ellatrix April 30, 2019 14:38

gziolo mentioned this pull request Apr 30, 2019

Block library: Extract deprecated field to their own files #15057

Merged

ellatrix reviewed May 1, 2019

View reviewed changes

gziolo mentioned this pull request May 6, 2019

Reinstate correct cover block attributes for deprecations #15449

Merged

5 tasks

gziolo force-pushed the add/blocks-depreacated-tests branch from eb25221 to 4658ef3 Compare May 6, 2019 12:07

gziolo added 5 commits May 7, 2019 08:51

Testing: Add integration tests for blocks with deprecations

aae9c9d

Testing: Add integration test covering deprecated version of Image block

dc2ea8f

Add additional test covering deprecated Pullqote block

aa959b2

Tests: Add missing integration tests for Gallery deprecations

0217202

Tests: Add missing integration tests for Image deprecations

bf87e3a

gziolo force-pushed the add/blocks-depreacated-tests branch from 4658ef3 to bf87e3a Compare May 7, 2019 08:12

gziolo commented May 7, 2019

View reviewed changes

gziolo added this to the 5.7 (Gutenberg) milestone May 7, 2019

gziolo mentioned this pull request May 7, 2019

Block library: Extract deprecated field to their own files (p.2) #15071

Merged

ellatrix approved these changes May 7, 2019

View reviewed changes

gziolo merged commit 31e2144 into master May 7, 2019

gziolo deleted the add/blocks-depreacated-tests branch May 7, 2019 09:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Testing: Add integration tests for blocks with deprecations #15268

Testing: Add integration tests for blocks with deprecations #15268

gziolo commented Apr 30, 2019 •

edited

gziolo commented Apr 30, 2019

ellatrix commented May 1, 2019

ellatrix May 1, 2019 •

edited

gziolo May 6, 2019

gziolo commented May 6, 2019

gziolo commented May 6, 2019

gziolo commented May 6, 2019

gziolo commented May 7, 2019

gziolo May 7, 2019

gziolo May 7, 2019

ellatrix commented May 7, 2019

gziolo commented May 7, 2019

ellatrix commented May 7, 2019

ellatrix left a comment

gziolo commented May 7, 2019

		@@ -0,0 +1,10 @@
		<!-- wp:core/gallery {"ids":[null,null],"columns":2} -->

@@ @@ -95,47 +142,39 @@ export const settings = { @@
               				);
               			},
               		},
-              		{

Testing: Add integration tests for blocks with deprecations #15268

Testing: Add integration tests for blocks with deprecations #15268

Conversation

gziolo commented Apr 30, 2019 • edited

Description

Implementation details

How has this been tested?

gziolo commented Apr 30, 2019

ellatrix commented May 1, 2019

ellatrix May 1, 2019 • edited

Choose a reason for hiding this comment

gziolo May 6, 2019

Choose a reason for hiding this comment

gziolo commented May 6, 2019

gziolo commented May 6, 2019

gziolo commented May 6, 2019

gziolo commented May 7, 2019

gziolo May 7, 2019

Choose a reason for hiding this comment

gziolo May 7, 2019

Choose a reason for hiding this comment

ellatrix commented May 7, 2019

gziolo commented May 7, 2019

ellatrix commented May 7, 2019

ellatrix left a comment

Choose a reason for hiding this comment

gziolo commented May 7, 2019

gziolo commented Apr 30, 2019 •

edited

ellatrix May 1, 2019 •

edited