<!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>[56983] trunk/tests/phpunit/tests: Tests: Improve code coverage for _build_block_template_result_from_file</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/56983">56983</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/56983","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>gziolo</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-10-23 05:36:50 +0000 (Mon, 23 Oct 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'>Tests: Improve code coverage for _build_block_template_result_from_file
Props costdev, bernhard-reiter.
See <a href="https://core.trac.wordpress.org/ticket/54335">#54335</a>, <a href="https://core.trac.wordpress.org/ticket/59325">#59325</a>.
Follow-up for <a href="https://core.trac.wordpress.org/changeset/56562">[56562]</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsblocktemplateutilsphp">trunk/tests/phpunit/tests/block-template-utils.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsblocktemplatesbuildBlockTemplateResultFromFilephp">trunk/tests/phpunit/tests/block-templates/buildBlockTemplateResultFromFile.php</a></li>
<li><a href="#trunktestsphpunittestsblocktemplatesbuildBlockTemplateResultFromPostphp">trunk/tests/phpunit/tests/block-templates/buildBlockTemplateResultFromPost.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsblocktemplateutilsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/block-template-utils.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-template-utils.php 2023-10-22 09:03:12 UTC (rev 56982)
+++ trunk/tests/phpunit/tests/block-template-utils.php 2023-10-23 05:36:50 UTC (rev 56983)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -86,140 +86,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> switch_theme( self::TEST_THEME );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_build_block_template_result_from_post() {
- $template = _build_block_template_result_from_post(
- self::$template_post,
- 'wp_template'
- );
-
- $this->assertNotWPError( $template );
- $this->assertSame( get_stylesheet() . '//my_template', $template->id );
- $this->assertSame( get_stylesheet(), $template->theme );
- $this->assertSame( 'my_template', $template->slug );
- $this->assertSame( 'publish', $template->status );
- $this->assertSame( 'custom', $template->source );
- $this->assertSame( 'My Template', $template->title );
- $this->assertSame( 'Description of my template', $template->description );
- $this->assertSame( 'wp_template', $template->type );
- $this->assertSame( self::$template_post->post_modified, $template->modified, 'Template result properties match' );
-
- // Test template parts.
- $template_part = _build_block_template_result_from_post(
- self::$template_part_post,
- 'wp_template_part'
- );
- $this->assertNotWPError( $template_part );
- $this->assertSame( get_stylesheet() . '//my_template_part', $template_part->id );
- $this->assertSame( get_stylesheet(), $template_part->theme );
- $this->assertSame( 'my_template_part', $template_part->slug );
- $this->assertSame( 'publish', $template_part->status );
- $this->assertSame( 'custom', $template_part->source );
- $this->assertSame( 'My Template Part', $template_part->title );
- $this->assertSame( 'Description of my template part', $template_part->description );
- $this->assertSame( 'wp_template_part', $template_part->type );
- $this->assertSame( WP_TEMPLATE_PART_AREA_HEADER, $template_part->area );
- $this->assertSame( self::$template_part_post->post_modified, $template_part->modified, 'Template part result properties match' );
- }
-
- public function test_build_block_template_result_from_file() {
- $template = _build_block_template_result_from_file(
- array(
- 'slug' => 'single',
- 'path' => __DIR__ . '/../data/templates/template.html',
- ),
- 'wp_template'
- );
-
- $this->assertSame( get_stylesheet() . '//single', $template->id );
- $this->assertSame( get_stylesheet(), $template->theme );
- $this->assertSame( 'single', $template->slug );
- $this->assertSame( 'publish', $template->status );
- $this->assertSame( 'theme', $template->source );
- $this->assertSame( 'Single Posts', $template->title );
- $this->assertSame( 'Displays single posts on your website unless a custom template has been applied to that post or a dedicated template exists.', $template->description );
- $this->assertSame( 'wp_template', $template->type );
- $this->assertEmpty( $template->modified );
-
- // Test template parts.
- $template_part = _build_block_template_result_from_file(
- array(
- 'slug' => 'header',
- 'path' => __DIR__ . '/../data/templates/template.html',
- 'area' => WP_TEMPLATE_PART_AREA_HEADER,
- ),
- 'wp_template_part'
- );
- $this->assertSame( get_stylesheet() . '//header', $template_part->id );
- $this->assertSame( get_stylesheet(), $template_part->theme );
- $this->assertSame( 'header', $template_part->slug );
- $this->assertSame( 'publish', $template_part->status );
- $this->assertSame( 'theme', $template_part->source );
- $this->assertSame( 'header', $template_part->title );
- $this->assertSame( '', $template_part->description );
- $this->assertSame( 'wp_template_part', $template_part->type );
- $this->assertSame( WP_TEMPLATE_PART_AREA_HEADER, $template_part->area );
- $this->assertEmpty( $template_part->modified );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @ticket 59325
- *
- * @covers ::_build_block_template_result_from_file
- *
- * @dataProvider data_build_block_template_result_from_file_injects_theme_attribute
- *
- * @param string $filename The template's filename.
- * @param string $expected The expected block markup.
- */
- public function test_build_block_template_result_from_file_injects_theme_attribute( $filename, $expected ) {
- $template = _build_block_template_result_from_file(
- array(
- 'slug' => 'single',
- 'path' => DIR_TESTDATA . "/templates/$filename",
- ),
- 'wp_template'
- );
- $this->assertSame( $expected, $template->content );
- }
-
- /**
- * Data provider.
- *
- * @return array[]
- */
- public function data_build_block_template_result_from_file_injects_theme_attribute() {
- $theme = 'block-theme';
- return array(
- 'a template with a template part block' => array(
- 'filename' => 'template-with-template-part.html',
- 'expected' => sprintf(
- '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->',
- $theme
- ),
- ),
- 'a template with a template part block nested inside another block' => array(
- 'filename' => 'template-with-nested-template-part.html',
- 'expected' => sprintf(
- '<!-- wp:group -->
-<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->
-<!-- /wp:group -->',
- $theme
- ),
- ),
- 'a template with a template part block with an existing theme attribute' => array(
- 'filename' => 'template-with-template-part-with-existing-theme-attribute.html',
- 'expected' => '<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full","tagName":"header","className":"site-header"} /-->',
- ),
- 'a template with no template part block' => array(
- 'filename' => 'template.html',
- 'expected' => '<!-- wp:paragraph -->
-<p>Just a paragraph</p>
-<!-- /wp:paragraph -->',
- ),
- );
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * @ticket 59338
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::_inject_theme_attribute_in_template_part_block
</span></span></pre></div>
<a id="trunktestsphpunittestsblocktemplatesbuildBlockTemplateResultFromFilephp"></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/block-templates/buildBlockTemplateResultFromFile.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-templates/buildBlockTemplateResultFromFile.php (rev 0)
+++ trunk/tests/phpunit/tests/block-templates/buildBlockTemplateResultFromFile.php 2023-10-23 05:36:50 UTC (rev 56983)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,181 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+require_once __DIR__ . '/base.php';
+
+/**
+ * @group block-templates
+ * @covers ::_build_block_template_result_from_file
+ */
+class Tests_Block_Templates_BuildBlockTemplateResultFromFile extends WP_Block_Templates_UnitTestCase {
+
+ /**
+ * @ticket 54335
+ */
+ public function test_should_build_template() {
+ $template = _build_block_template_result_from_file(
+ array(
+ 'slug' => 'single',
+ 'path' => DIR_TESTDATA . '/templates/template.html',
+ ),
+ 'wp_template'
+ );
+
+ $this->assertSame( get_stylesheet() . '//single', $template->id );
+ $this->assertSame( get_stylesheet(), $template->theme );
+ $this->assertSame( 'single', $template->slug );
+ $this->assertSame( 'publish', $template->status );
+ $this->assertSame( 'theme', $template->source );
+ $this->assertSame( 'Single Posts', $template->title );
+ $this->assertSame( 'Displays single posts on your website unless a custom template has been applied to that post or a dedicated template exists.', $template->description );
+ $this->assertSame( 'wp_template', $template->type );
+ $this->assertEmpty( $template->modified );
+ }
+
+ /**
+ * @ticket 59325
+ */
+ public function test_should_build_template_using_custom_properties() {
+ $template = _build_block_template_result_from_file(
+ array(
+ 'slug' => 'custom',
+ 'title' => 'Custom Title',
+ 'path' => DIR_TESTDATA . '/templates/template.html',
+ ),
+ 'wp_template'
+ );
+
+ $this->assertSame( 'custom', $template->slug );
+ $this->assertSame( 'Custom Title', $template->title );
+ $this->assertTrue( $template->is_custom );
+ }
+
+ /**
+ * @ticket 59325
+ */
+ public function test_should_enforce_default_properties_when_building_template() {
+ $template = _build_block_template_result_from_file(
+ array(
+ 'slug' => 'single',
+ 'title' => 'Custom title',
+ 'path' => DIR_TESTDATA . '/templates/template.html',
+ ),
+ 'wp_template'
+ );
+
+ $this->assertSame( 'single', $template->slug );
+ $this->assertSame( 'Single Posts', $template->title );
+ $this->assertSame( 'Displays single posts on your website unless a custom template has been applied to that post or a dedicated template exists.', $template->description );
+ $this->assertFalse( $template->is_custom );
+ }
+
+ /**
+ * @ticket 59325
+ */
+ public function test_should_respect_post_types_property_when_building_template() {
+ $template = _build_block_template_result_from_file(
+ array(
+ 'slug' => 'single',
+ 'postTypes' => array( 'post' ),
+ 'path' => DIR_TESTDATA . '/templates/template.html',
+ ),
+ 'wp_template'
+ );
+
+ $this->assertSameSets( array( 'post' ), $template->post_types );
+ }
+
+ /**
+ * @ticket 59325
+ *
+ * @dataProvider data_build_template_injects_theme_attribute
+ *
+ * @param string $filename The template's filename.
+ * @param string $expected The expected block markup.
+ */
+ public function test_should_build_template_and_inject_theme_attribute( $filename, $expected ) {
+ $template = _build_block_template_result_from_file(
+ array(
+ 'slug' => 'single',
+ 'path' => DIR_TESTDATA . "/templates/$filename",
+ ),
+ 'wp_template'
+ );
+ $this->assertSame( $expected, $template->content );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_build_template_injects_theme_attribute() {
+ return array(
+ 'a template with a template part block' => array(
+ 'filename' => 'template-with-template-part.html',
+ 'expected' => sprintf(
+ '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->',
+ self::TEST_THEME
+ ),
+ ),
+ 'a template with a template part block nested inside another block' => array(
+ 'filename' => 'template-with-nested-template-part.html',
+ 'expected' => sprintf(
+ '<!-- wp:group -->
+<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->
+<!-- /wp:group -->',
+ self::TEST_THEME
+ ),
+ ),
+ 'a template with a template part block with an existing theme attribute' => array(
+ 'filename' => 'template-with-template-part-with-existing-theme-attribute.html',
+ 'expected' => '<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full","tagName":"header","className":"site-header"} /-->',
+ ),
+ 'a template with no template part block' => array(
+ 'filename' => 'template.html',
+ 'expected' => '<!-- wp:paragraph -->
+<p>Just a paragraph</p>
+<!-- /wp:paragraph -->',
+ ),
+ );
+ }
+
+ /**
+ * @ticket 54335
+ */
+ public function test_should_build_template_part() {
+ $template_part = _build_block_template_result_from_file(
+ array(
+ 'slug' => 'header',
+ 'path' => DIR_TESTDATA . '/templates/template.html',
+ 'area' => WP_TEMPLATE_PART_AREA_HEADER,
+ ),
+ 'wp_template_part'
+ );
+ $this->assertSame( get_stylesheet() . '//header', $template_part->id );
+ $this->assertSame( get_stylesheet(), $template_part->theme );
+ $this->assertSame( 'header', $template_part->slug );
+ $this->assertSame( 'publish', $template_part->status );
+ $this->assertSame( 'theme', $template_part->source );
+ $this->assertSame( 'header', $template_part->title );
+ $this->assertSame( '', $template_part->description );
+ $this->assertSame( 'wp_template_part', $template_part->type );
+ $this->assertSame( WP_TEMPLATE_PART_AREA_HEADER, $template_part->area );
+ $this->assertEmpty( $template_part->modified );
+ }
+
+ /**
+ * @ticket 59325
+ */
+ public function test_should_ignore_post_types_property_when_building_template_part() {
+ $template = _build_block_template_result_from_file(
+ array(
+ 'slug' => 'header',
+ 'postTypes' => array( 'post' ),
+ 'path' => DIR_TESTDATA . '/templates/template.html',
+ ),
+ 'wp_template_part'
+ );
+
+ $this->assertEmpty( $template->post_types );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/block-templates/buildBlockTemplateResultFromFile.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsblocktemplatesbuildBlockTemplateResultFromPostphp"></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/block-templates/buildBlockTemplateResultFromPost.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-templates/buildBlockTemplateResultFromPost.php (rev 0)
+++ trunk/tests/phpunit/tests/block-templates/buildBlockTemplateResultFromPost.php 2023-10-23 05:36:50 UTC (rev 56983)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,52 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+require_once __DIR__ . '/base.php';
+
+/**
+ * @group block-templates
+ * @covers ::_build_block_template_result_from_post
+ */
+class Tests_Block_Templates_BuildBlockTemplateResultFromPost extends WP_Block_Templates_UnitTestCase {
+
+ /**
+ * @ticket 54335
+ */
+ public function test_should_build_template() {
+ $template = _build_block_template_result_from_post(
+ self::$template_post,
+ 'wp_template'
+ );
+
+ $this->assertNotWPError( $template );
+ $this->assertSame( get_stylesheet() . '//my_template', $template->id );
+ $this->assertSame( get_stylesheet(), $template->theme );
+ $this->assertSame( 'my_template', $template->slug );
+ $this->assertSame( 'publish', $template->status );
+ $this->assertSame( 'custom', $template->source );
+ $this->assertSame( 'My Template', $template->title );
+ $this->assertSame( 'Description of my template', $template->description );
+ $this->assertSame( 'wp_template', $template->type );
+ $this->assertSame( self::$template_post->post_modified, $template->modified, 'Template result properties match' );
+ }
+
+ /**
+ * @ticket 54335
+ */
+ public function test_should_build_template_part() {
+ $template_part = _build_block_template_result_from_post(
+ self::$template_part_post,
+ 'wp_template_part'
+ );
+ $this->assertNotWPError( $template_part );
+ $this->assertSame( get_stylesheet() . '//my_template_part', $template_part->id );
+ $this->assertSame( get_stylesheet(), $template_part->theme );
+ $this->assertSame( 'my_template_part', $template_part->slug );
+ $this->assertSame( 'publish', $template_part->status );
+ $this->assertSame( 'custom', $template_part->source );
+ $this->assertSame( 'My Template Part', $template_part->title );
+ $this->assertSame( 'Description of my template part', $template_part->description );
+ $this->assertSame( 'wp_template_part', $template_part->type );
+ $this->assertSame( WP_TEMPLATE_PART_AREA_HEADER, $template_part->area );
+ $this->assertSame( self::$template_part_post->post_modified, $template_part->modified, 'Template part result properties match' );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/block-templates/buildBlockTemplateResultFromPost.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>