From 94421fc2107e7d8afc85e2779fded340144f80d9 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Mon, 29 Nov 2021 08:45:31 +0000 Subject: [PATCH] Tests: Replace `assertEquals()` with `assertSame()` in block template tests. This ensures that not only the return values match the expected results, but also that their type is the same. Going forward, stricter type checking by using `assertSame()`, `assertSameSets()`, or `assertSameSetsWithIndex()` should generally be preferred, to make the tests more reliable. Follow-up to [51003], [51079], [52062], [52265]. See #53364, #53363, #54335. git-svn-id: https://develop.svn.wordpress.org/trunk@52266 602fd350-edb4-49c9-b593-d223f7449a82 --- tests/phpunit/tests/block-template-utils.php | 144 +++++++++---------- tests/phpunit/tests/block-template.php | 14 +- 2 files changed, 79 insertions(+), 79 deletions(-) diff --git a/tests/phpunit/tests/block-template-utils.php b/tests/phpunit/tests/block-template-utils.php index 58a543a3de..930735c72f 100644 --- a/tests/phpunit/tests/block-template-utils.php +++ b/tests/phpunit/tests/block-template-utils.php @@ -1,8 +1,8 @@ assertNotWPError( $template ); - $this->assertEquals( get_stylesheet() . '//my_template', $template->id ); - $this->assertEquals( get_stylesheet(), $template->theme ); - $this->assertEquals( 'my_template', $template->slug ); - $this->assertEquals( 'publish', $template->status ); - $this->assertEquals( 'custom', $template->source ); - $this->assertEquals( 'My Template', $template->title ); - $this->assertEquals( 'Description of my template', $template->description ); - $this->assertEquals( 'wp_template', $template->type ); + $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 ); // Test template parts. $template_part = _build_block_template_result_from_post( @@ -99,15 +99,15 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { 'wp_template_part' ); $this->assertNotWPError( $template_part ); - $this->assertEquals( get_stylesheet() . '//my_template_part', $template_part->id ); - $this->assertEquals( get_stylesheet(), $template_part->theme ); - $this->assertEquals( 'my_template_part', $template_part->slug ); - $this->assertEquals( 'publish', $template_part->status ); - $this->assertEquals( 'custom', $template_part->source ); - $this->assertEquals( 'My Template Part', $template_part->title ); - $this->assertEquals( 'Description of my template part', $template_part->description ); - $this->assertEquals( 'wp_template_part', $template_part->type ); - $this->assertEquals( WP_TEMPLATE_PART_AREA_HEADER, $template_part->area ); + $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 ); } function test_build_block_template_result_from_file() { @@ -119,14 +119,14 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { 'wp_template' ); - $this->assertEquals( get_stylesheet() . '//single', $template->id ); - $this->assertEquals( get_stylesheet(), $template->theme ); - $this->assertEquals( 'single', $template->slug ); - $this->assertEquals( 'publish', $template->status ); - $this->assertEquals( 'theme', $template->source ); - $this->assertEquals( 'Single Post', $template->title ); - $this->assertEquals( 'Template used to display a single blog post.', $template->description ); - $this->assertEquals( 'wp_template', $template->type ); + $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 Post', $template->title ); + $this->assertSame( 'Template used to display a single blog post.', $template->description ); + $this->assertSame( 'wp_template', $template->type ); // Test template parts. $template_part = _build_block_template_result_from_file( @@ -137,15 +137,15 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { ), 'wp_template_part' ); - $this->assertEquals( get_stylesheet() . '//header', $template_part->id ); - $this->assertEquals( get_stylesheet(), $template_part->theme ); - $this->assertEquals( 'header', $template_part->slug ); - $this->assertEquals( 'publish', $template_part->status ); - $this->assertEquals( 'theme', $template_part->source ); - $this->assertEquals( 'header', $template_part->title ); - $this->assertEquals( '', $template_part->description ); - $this->assertEquals( 'wp_template_part', $template_part->type ); - $this->assertEquals( WP_TEMPLATE_PART_AREA_HEADER, $template_part->area ); + $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 ); } function test_inject_theme_attribute_in_block_template_content() { @@ -159,7 +159,7 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { '', get_stylesheet() ); - $this->assertEquals( $expected, $template_content ); + $this->assertSame( $expected, $template_content ); $content_without_theme_attribute_nested = ''; $template_content = _inject_theme_attribute_in_block_template_content( @@ -170,7 +170,7 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { '', get_stylesheet() ); - $this->assertEquals( $expected, $template_content ); + $this->assertSame( $expected, $template_content ); // Does not inject theme when there is an existing theme attribute. $content_with_existing_theme_attribute = ''; @@ -178,7 +178,7 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { $content_with_existing_theme_attribute, $theme ); - $this->assertEquals( $content_with_existing_theme_attribute, $template_content ); + $this->assertSame( $content_with_existing_theme_attribute, $template_content ); // Does not inject theme when there is no template part. $content_with_no_template_part = ''; @@ -186,7 +186,7 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { $content_with_no_template_part, $theme ); - $this->assertEquals( $content_with_no_template_part, $template_content ); + $this->assertSame( $content_with_no_template_part, $template_content ); } /** @@ -197,23 +197,23 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { // Requires switching to a block theme. /* $id = get_stylesheet() . '//' . 'index'; $template = get_block_template( $id, 'wp_template' ); - $this->assertEquals( $id, $template->id ); - $this->assertEquals( get_stylesheet(), $template->theme ); - $this->assertEquals( 'index', $template->slug ); - $this->assertEquals( 'publish', $template->status ); - $this->assertEquals( 'theme', $template->source ); - $this->assertEquals( 'wp_template', $template->type ); + $this->assertSame( $id, $template->id ); + $this->assertSame( get_stylesheet(), $template->theme ); + $this->assertSame( 'index', $template->slug ); + $this->assertSame( 'publish', $template->status ); + $this->assertSame( 'theme', $template->source ); + $this->assertSame( 'wp_template', $template->type ); // Test template parts. $id = get_stylesheet() . '//' . 'header'; $template = get_block_template( $id, 'wp_template_part' ); - $this->assertEquals( $id, $template->id ); - $this->assertEquals( get_stylesheet(), $template->theme ); - $this->assertEquals( 'header', $template->slug ); - $this->assertEquals( 'publish', $template->status ); - $this->assertEquals( 'theme', $template->source ); - $this->assertEquals( 'wp_template_part', $template->type ); - $this->assertEquals( WP_TEMPLATE_PART_AREA_HEADER, $template->area ); + $this->assertSame( $id, $template->id ); + $this->assertSame( get_stylesheet(), $template->theme ); + $this->assertSame( 'header', $template->slug ); + $this->assertSame( 'publish', $template->status ); + $this->assertSame( 'theme', $template->source ); + $this->assertSame( 'wp_template_part', $template->type ); + $this->assertSame( WP_TEMPLATE_PART_AREA_HEADER, $template->area ); */ } @@ -223,23 +223,23 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { public function test_get_block_template_from_post() { $id = get_stylesheet() . '//' . 'my_template'; $template = get_block_template( $id, 'wp_template' ); - $this->assertEquals( $id, $template->id ); - $this->assertEquals( get_stylesheet(), $template->theme ); - $this->assertEquals( 'my_template', $template->slug ); - $this->assertEquals( 'publish', $template->status ); - $this->assertEquals( 'custom', $template->source ); - $this->assertEquals( 'wp_template', $template->type ); + $this->assertSame( $id, $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( 'wp_template', $template->type ); // Test template parts. $id = get_stylesheet() . '//' . 'my_template_part'; $template = get_block_template( $id, 'wp_template_part' ); - $this->assertEquals( $id, $template->id ); - $this->assertEquals( get_stylesheet(), $template->theme ); - $this->assertEquals( 'my_template_part', $template->slug ); - $this->assertEquals( 'publish', $template->status ); - $this->assertEquals( 'custom', $template->source ); - $this->assertEquals( 'wp_template_part', $template->type ); - $this->assertEquals( WP_TEMPLATE_PART_AREA_HEADER, $template->area ); + $this->assertSame( $id, $template->id ); + $this->assertSame( get_stylesheet(), $template->theme ); + $this->assertSame( 'my_template_part', $template->slug ); + $this->assertSame( 'publish', $template->status ); + $this->assertSame( 'custom', $template->source ); + $this->assertSame( 'wp_template_part', $template->type ); + $this->assertSame( WP_TEMPLATE_PART_AREA_HEADER, $template->area ); } /** @@ -268,18 +268,18 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { // Filter by slug. $templates = get_block_templates( array( 'slug__in' => array( 'my_template' ) ), 'wp_template' ); $template_ids = get_template_ids( $templates ); - $this->assertEquals( array( get_stylesheet() . '//' . 'my_template' ), $template_ids ); + $this->assertSame( array( get_stylesheet() . '//' . 'my_template' ), $template_ids ); // Filter by CPT ID. $templates = get_block_templates( array( 'wp_id' => self::$post->ID ), 'wp_template' ); $template_ids = get_template_ids( $templates ); - $this->assertEquals( array( get_stylesheet() . '//' . 'my_template' ), $template_ids ); + $this->assertSame( array( get_stylesheet() . '//' . 'my_template' ), $template_ids ); // Filter template part by area. // Requires a block theme. /*$templates = get_block_templates( array( 'area' => WP_TEMPLATE_PART_AREA_HEADER ), 'wp_template_part' ); $template_ids = get_template_ids( $templates ); - $this->assertEquals( + $this->assertSame( array( get_stylesheet() . '//' . 'my_template_part', get_stylesheet() . '//' . 'header', @@ -297,18 +297,18 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase { $blocks = parse_blocks( $content_template_part_inside_group ); $actual = _flatten_blocks( $blocks ); $expected = array( $blocks[0], $blocks[0]['innerBlocks'][0] ); - $this->assertEquals( $expected, $actual ); + $this->assertSame( $expected, $actual ); $content_template_part_inside_group_inside_group = ''; $blocks = parse_blocks( $content_template_part_inside_group_inside_group ); $actual = _flatten_blocks( $blocks ); $expected = array( $blocks[0], $blocks[0]['innerBlocks'][0], $blocks[0]['innerBlocks'][0]['innerBlocks'][0] ); - $this->assertEquals( $expected, $actual ); + $this->assertSame( $expected, $actual ); $content_without_inner_blocks = ''; $blocks = parse_blocks( $content_without_inner_blocks ); $actual = _flatten_blocks( $blocks ); $expected = array( $blocks[0] ); - $this->assertEquals( $expected, $actual ); + $this->assertSame( $expected, $actual ); } } diff --git a/tests/phpunit/tests/block-template.php b/tests/phpunit/tests/block-template.php index d659580f7c..94cea83896 100644 --- a/tests/phpunit/tests/block-template.php +++ b/tests/phpunit/tests/block-template.php @@ -1,6 +1,6 @@ assertEquals( self::$template_canvas_path, $resolved_template_path ); + $this->assertSame( self::$template_canvas_path, $resolved_template_path ); $this->assertStringEqualsFile( get_stylesheet_directory() . '/templates/page-home.html', $_wp_current_template_content ); } @@ -49,7 +49,7 @@ class Tests_Block_Template extends WP_UnitTestCase { 'page.php', ); $resolved_template_path = locate_block_template( get_stylesheet_directory() . '/page.php', $type, $templates ); - $this->assertEquals( self::$template_canvas_path, $resolved_template_path ); + $this->assertSame( self::$template_canvas_path, $resolved_template_path ); $this->assertStringEqualsFile( get_stylesheet_directory() . '/templates/page.html', $_wp_current_template_content ); } @@ -60,7 +60,7 @@ class Tests_Block_Template extends WP_UnitTestCase { 'index.php', ); $resolved_template_path = locate_block_template( get_stylesheet_directory() . '/index.php', $type, $templates ); - $this->assertEquals( self::$template_canvas_path, $resolved_template_path ); + $this->assertSame( self::$template_canvas_path, $resolved_template_path ); $this->assertStringEqualsFile( get_stylesheet_directory() . '/templates/index.html', $_wp_current_template_content ); } @@ -80,7 +80,7 @@ class Tests_Block_Template extends WP_UnitTestCase { 'page.php', ); $resolved_template_path = locate_block_template( $page_id_template_path, $type, $templates ); - $this->assertEquals( $page_id_template_path, $resolved_template_path ); + $this->assertSame( $page_id_template_path, $resolved_template_path ); } /** @@ -110,7 +110,7 @@ class Tests_Block_Template extends WP_UnitTestCase { 'page.php', ); $resolved_template_path = locate_block_template( $page_slug_template_path, $type, $templates ); - $this->assertEquals( $page_slug_template_path, $resolved_template_path ); + $this->assertSame( $page_slug_template_path, $resolved_template_path ); } function test_child_theme_block_template_takes_precedence_over_equally_specific_parent_theme_php_template() { @@ -127,7 +127,7 @@ class Tests_Block_Template extends WP_UnitTestCase { 'page.php', ); $resolved_template_path = locate_block_template( $parent_theme_page_template_path, $type, $templates ); - $this->assertEquals( self::$template_canvas_path, $resolved_template_path ); + $this->assertSame( self::$template_canvas_path, $resolved_template_path ); $this->assertStringEqualsFile( get_stylesheet_directory() . '/templates/page-1.html', $_wp_current_template_content ); }