<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56733] trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php: Blocks: Add unit test coverage for Patterns registry.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56733">56733</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56733","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>Bernhard Reiter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-27 13:08:35 +0000 (Wed, 27 Sep 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Blocks: Add unit test coverage for Patterns registry.
Prior to this changeset, we did not seem to have any unit test coverage for the Patterns registry (`WP_Block_Patterns_Registry`).
With Block Hooks logic recently added (<a href="https://core.trac.wordpress.org/changeset/56649">[56649]</a>), it is particularly advisable to add some unit tests to the `get_registered()` and `get_all_registered()` methods to guard hooked block insertion against regressions.
Fixes <a href="https://core.trac.wordpress.org/ticket/59476">#59476</a>.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsblockswpBlockPatternsRegistryphp">trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsblockswpBlockPatternsRegistryphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php (rev 0)
+++ trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php 2023-09-27 13:08:35 UTC (rev 56733)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,439 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Tests for WP_Block_Patterns_Registry.
+ *
+ * @package WordPress
+ * @subpackage Blocks
+ * @since 6.4.0
+ *
+ * @group blocks
+ *
+ * @coversDefaultClass WP_Block_Patterns_Registry
+ */
+class Tests_Blocks_wpBlockPattersRegistry extends WP_UnitTestCase {
+
+ /**
+ * Fake block patterns registry.
+ *
+ * @since 6.4.0
+ * @var WP_Block_Patterns_Registry
+ */
+ private $registry = null;
+
+ /**
+ * Set up each test method.
+ *
+ * @since 6.4.0
+ */
+ public function set_up() {
+ parent::set_up();
+
+ $this->registry = new WP_Block_Patterns_Registry();
+ }
+
+ /**
+ * Tear down each test method.
+ *
+ * @since 6.4.0
+ */
+ public function tear_down() {
+ $this->registry = null;
+
+ $registry = WP_Block_Type_Registry::get_instance();
+
+ if ( $registry->is_registered( 'tests/my-block' ) ) {
+ $registry->unregister( 'tests/my-block' );
+ }
+
+ parent::tear_down();
+ }
+
+ /**
+ * Should reject missing pattern name.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ *
+ * @expectedIncorrectUsage WP_Block_Patterns_Registry::register
+ */
+ public function test_missing_name() {
+ $name = null;
+ $settings = array(
+ 'title' => 'Test Pattern',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+
+ $success = $this->registry->register( $name, $settings );
+ $this->assertFalse( $success );
+ }
+
+ /**
+ * Should reject non-string name.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ *
+ * @expectedIncorrectUsage WP_Block_Patterns_Registry::register
+ */
+ public function test_invalid_non_string_name() {
+ $name = 123;
+ $settings = array(
+ 'title' => 'Test Pattern',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+
+ $success = $this->registry->register( $name, $settings );
+ $this->assertFalse( $success );
+ }
+
+ /**
+ * Should missing title.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ *
+ * @expectedIncorrectUsage WP_Block_Patterns_Registry::register
+ */
+ public function test_missing_title() {
+ $name = 'test/pattern';
+ $settings = array(
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+
+ $success = $this->registry->register( $name, $settings );
+ $this->assertFalse( $success );
+ }
+
+ /**
+ * Should reject non-string title.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ *
+ * @expectedIncorrectUsage WP_Block_Patterns_Registry::register
+ */
+ public function test_invalid_non_string_title() {
+ $name = 'test/pattern';
+ $settings = array(
+ 'title' => 456,
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+
+ $success = $this->registry->register( $name, $settings );
+ $this->assertFalse( $success );
+ }
+
+ /**
+ * Should reject missing content.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ *
+ * @expectedIncorrectUsage WP_Block_Patterns_Registry::register
+ */
+ public function test_missing_content() {
+ $name = 'Test Pattern';
+ $settings = array(
+ 'title' => 'Test Pattern',
+ );
+
+ $success = $this->registry->register( $name, $settings );
+ $this->assertFalse( $success );
+ }
+
+ /**
+ * Should reject non-string content.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ *
+ * @expectedIncorrectUsage WP_Block_Patterns_Registry::register
+ */
+ public function test_invalid_non_string_content() {
+ $name = 'Test Pattern';
+ $settings = array(
+ 'title' => 'Test Pattern',
+ 'content' => 789,
+ );
+
+ $success = $this->registry->register( $name, $settings );
+ $this->assertFalse( $success );
+ }
+
+ /**
+ * Should accept valid pattern.
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ *
+ * @ticket 59476
+ */
+ public function test_register_block_pattern() {
+ $name = 'test/pattern';
+ $settings = array(
+ 'title' => 'Pattern One',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+
+ $success = $this->registry->register( $name, $settings );
+ $this->assertTrue( $success );
+ }
+
+ /**
+ * Unregistering should fail if a pattern is not registered.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::unregister
+ *
+ * @expectedIncorrectUsage WP_Block_Patterns_Registry::unregister
+ */
+ public function test_unregister_not_registered_block() {
+ $success = $this->registry->unregister( 'test/unregistered' );
+ $this->assertFalse( $success );
+ }
+
+ /**
+ * Should unregister existing patterns.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::unregister
+ */
+ public function test_unregister_block_pattern() {
+ $name = 'test/pattern';
+ $settings = array(
+ 'title' => 'Pattern One',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+
+ $this->registry->register( $name, $settings );
+ $success = $this->registry->unregister( $name );
+ $this->assertTrue( $success );
+ }
+
+ /**
+ * Should find all registered patterns.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ * @covers WP_Block_Patterns_Registry::get_all_registered
+ */
+ public function test_get_all_registered() {
+ $pattern_one = array(
+ 'title' => 'Pattern One',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+ $this->registry->register( 'test/one', $pattern_one );
+
+ $pattern_two = array(
+ 'title' => 'Pattern Two',
+ 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+ );
+ $this->registry->register( 'test/two', $pattern_two );
+
+ $pattern_three = array(
+ 'title' => 'Pattern Three',
+ 'content' => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
+ );
+ $this->registry->register( 'test/three', $pattern_three );
+
+ $pattern_one['name'] = 'test/one';
+ $pattern_two['name'] = 'test/two';
+ $pattern_three['name'] = 'test/three';
+
+ $expected = array(
+ $pattern_one,
+ $pattern_two,
+ $pattern_three,
+ );
+
+ $registered = $this->registry->get_all_registered();
+ $this->assertSame( $expected, $registered );
+ }
+
+ /**
+ * Should not find pattern that's not registered.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ * @covers WP_Block_Patterns_Registry::get_registered
+ */
+ public function test_get_registered_rejects_unknown_pattern_name() {
+ $pattern_one = array(
+ 'title' => 'Pattern One',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+ $this->registry->register( 'test/one', $pattern_one );
+
+ $pattern_two = array(
+ 'title' => 'Pattern Two',
+ 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+ );
+ $this->registry->register( 'test/two', $pattern_two );
+
+ $pattern = $this->registry->get_registered( 'test/three' );
+ $this->assertNull( $pattern );
+ }
+
+ /**
+ * Should find registered pattern by name.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ * @covers WP_Block_Patterns_Registry::get_registered
+ */
+ public function test_get_registered() {
+ $pattern_one = array(
+ 'title' => 'Pattern One',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+ $this->registry->register( 'test/one', $pattern_one );
+
+ $pattern_two = array(
+ 'title' => 'Pattern Two',
+ 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+ );
+ $this->registry->register( 'test/two', $pattern_two );
+
+ $pattern_three = array(
+ 'title' => 'Pattern Three',
+ 'content' => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
+ );
+ $this->registry->register( 'test/three', $pattern_three );
+
+ $pattern_two['name'] = 'test/two';
+
+ $pattern = $this->registry->get_registered( 'test/two' );
+ $this->assertSame( $pattern_two, $pattern );
+ }
+
+ /**
+ * Should insert hooked blocks into registered patterns.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ * @covers WP_Block_Patterns_Registry::get_all_registered
+ */
+ public function test_get_all_registered_includes_hooked_blocks() {
+ register_block_type(
+ 'tests/my-block',
+ array(
+ 'block_hooks' => array(
+ 'core/paragraph' => 'after',
+ ),
+ )
+ );
+
+ $pattern_one = array(
+ 'title' => 'Pattern One',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+ $this->registry->register( 'test/one', $pattern_one );
+
+ $pattern_two = array(
+ 'title' => 'Pattern Two',
+ 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+ );
+ $this->registry->register( 'test/two', $pattern_two );
+
+ $pattern_three = array(
+ 'title' => 'Pattern Three',
+ 'content' => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
+ );
+ $this->registry->register( 'test/three', $pattern_three );
+
+ $pattern_one['name'] = 'test/one';
+ $pattern_two['name'] = 'test/two';
+ $pattern_two['content'] .= '<!-- wp:tests/my-block /-->';
+ $pattern_three['name'] = 'test/three';
+ $pattern_three['content'] .= '<!-- wp:tests/my-block /-->';
+
+ $expected = array(
+ $pattern_one,
+ $pattern_two,
+ $pattern_three,
+ );
+
+ $registered = $this->registry->get_all_registered();
+ $this->assertSame( $expected, $registered );
+ }
+
+ /**
+ * Should insert hooked blocks into registered patterns.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ * @covers WP_Block_Patterns_Registry::get_registered
+ */
+ public function test_get_registered_includes_hooked_blocks() {
+ register_block_type(
+ 'tests/my-block',
+ array(
+ 'block_hooks' => array(
+ 'core/heading' => 'before',
+ ),
+ )
+ );
+
+ $pattern_one = array(
+ 'title' => 'Pattern One',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+ $this->registry->register( 'test/one', $pattern_one );
+
+ $pattern_two = array(
+ 'title' => 'Pattern Two',
+ 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+ );
+ $this->registry->register( 'test/two', $pattern_two );
+
+ $pattern_one['name'] = 'test/one';
+ $pattern_one['content'] = '<!-- wp:tests/my-block /-->' . $pattern_one['content'];
+
+ $pattern = $this->registry->get_registered( 'test/one' );
+ $this->assertSame( $pattern_one, $pattern );
+ }
+
+ /**
+ * Should return false for pattern that's not registered.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ * @covers WP_Block_Patterns_Registry::is_registered
+ */
+ public function test_is_registered_for_unknown_pattern() {
+ $pattern = $this->registry->is_registered( 'test/one' );
+ $this->assertFalse( $pattern );
+ }
+
+ /**
+ * Should return true if pattern is registered.
+ *
+ * @ticket 59476
+ *
+ * @covers WP_Block_Patterns_Registry::register
+ * @covers WP_Block_Patterns_Registry::is_registered
+ */
+ public function test_is_registered_for_known_pattern() {
+ $pattern_one = array(
+ 'title' => 'Pattern One',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ );
+ $this->registry->register( 'test/one', $pattern_one );
+
+ $result = $this->registry->is_registered( 'test/one' );
+ $this->assertTrue( $result );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>