Add unit tests for the gutenberg_render_block_core_post_title() function #42435

akasunil · 2022-07-14T14:20:57Z

What?

Added unit test for Post title core block render function.

akasunil · 2022-07-14T14:21:42Z

@draganescu Can you please review this PR ?

akasunil · 2022-08-20T05:19:56Z

waiting for PR review

draganescu

Tested the test and the test passes and it's a great addition. Thank you 👏🏻

akasunil · 2022-11-11T05:17:38Z

Thank you @draganescu. @Mamaduka can we merge this PR ?

spacedmonkey · 2022-11-15T13:10:40Z

phpunit/blocks/render-block-post-title-test.php

+	public static function wpSetUpBeforeClass() {
+		self::$post = self::factory()->post->create_and_get( array( 'post_title' => 'Post title block Unit Test' ) );


Suggested change

public static function wpSetUpBeforeClass() {

self::$post = self::factory()->post->create_and_get( array( 'post_title' => 'Post title block Unit Test' ) );

public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {

self::$post = $factory->post->create_and_get( array( 'post_title' => 'Post title block Unit Test' ) );

Thank you for your review @spacedmonkey. I have updated the code according to your suggestion.

akasunil · 2023-01-02T05:23:14Z

waiting for PR review

anton-vlasenko

Please find my notes below.
Thanks.

phpunit/blocks/render-block-post-title-test.php

New review

akasunil · 2023-04-27T11:49:15Z

@anton-vlasenko Feedback addressed. Can you please review again.

github-actions · 2024-02-26T05:26:17Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: akasunil <[email protected]>
Co-authored-by: draganescu <[email protected]>
Co-authored-by: spacedmonkey <[email protected]>
Co-authored-by: anton-vlasenko <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

anton-vlasenko

https://make.wordpress.org/core/handbook/testing/automated-testing/writing-phpunit-tests/#test-classes:

Test files should be named using camelCase.

Could the test file be renamed to renderBlockCorePostTitle.php?

anton-vlasenko · 2024-03-01T18:20:34Z

phpunit/blocks/render-block-post-title-test.php

+<?php
+/**
+ * Post Title rendering tests.
+ *
+ * @package WordPress
+ * @subpackage Blocks
+ * @covers ::gutenberg_render_block_core_post_title
+ */
+
+/**
+ * Tests for the  Post Title block.
+ *
+ * @group blocks
+ */


I'd make this a single docblock for simplicity.

Suggested change

<?php

/**

* Post Title rendering tests.

*

* @package WordPress

* @subpackage Blocks

* @covers ::gutenberg_render_block_core_post_title

*/

/**

* Tests for the Post Title block.

*

* @group blocks

*/

<?php

/**

* Tests for the gutenberg_render_block_core_post_title() function.

*

* @package WordPress

* @subpackage Blocks

*

* @group blocks

*

* @covers ::gutenberg_render_block_core_post_title

*/

anton-vlasenko · 2024-03-01T18:22:11Z

phpunit/blocks/render-block-post-title-test.php

+	/**
+	 * Test gutenberg_render_block_core_post_title() method.
+	 *
+	 * @covers ::gutenberg_render_block_core_post_title
+	 */


You don't have to use the @Covers tag for individual test methods if you have it defined in the header.

Suggested change

/**

* Test gutenberg_render_block_core_post_title() method.

*

* @covers ::gutenberg_render_block_core_post_title

*/

/**

* Test gutenberg_render_block_core_post_title() method.

*/

anton-vlasenko · 2024-03-01T18:26:57Z

phpunit/blocks/render-block-post-title-test.php

+ *
+ * @group blocks
+ */
+class Tests_Blocks_GutenbergRenderBlockCorePostTitle extends WP_UnitTestCase {


Suggested change

class Tests_Blocks_GutenbergRenderBlockCorePostTitle extends WP_UnitTestCase {

class Tests_Blocks_RenderBlockCorePostTitle extends WP_UnitTestCase {

As per the standards you mentioned above, shouldn't we use the function name which is gutenberg_render_block_core_post_title() in title case?

I don't have a strong preference on this one.
It's up to you.
If the code is going to be merged into WordPress Core at some point, I'd suggest aligning it with WordPress Core standards to ease the backporting efforts (and increase the chances of acceptance).

akasunil · 2024-03-02T06:01:30Z

Could the test file be renamed to renderBlockCorePostTitle.php?

Is this the new standards that we are going to follow from now on for test file name? because all other files are named in kebab-case.

anton-vlasenko · 2024-03-04T18:01:00Z

Could the test file be renamed to renderBlockCorePostTitle.php?

Is this the new standards that we are going to follow from now on for test file name? because all other files are named in kebab-case.

No, this is not a new standard, but I agree, it might seem new. There are (mostly) old tests that don't follow this naming convention, and the newer ones that adhere to it, e.g.: https://github.com/WordPress/wordpress-develop/tree/trunk/tests/phpunit/tests/option

akasunil · 2024-03-08T08:57:30Z

@anton-vlasenko To follow the standard for file name of unit tests, It required to update phpunit config file first.

akasunil · 2024-04-28T08:35:20Z

I have updated phpunit config temporary until we change all filenames to camel case as per wordpress core standard. And Addressed all feedback provided by reviewer.

akasunil · 2024-05-10T04:57:50Z

@anton-vlasenko can you please review this PR?

anton-vlasenko · 2024-06-05T21:31:21Z

phpunit/blocks/renderBlockCorePostTitle.php

+	/**
+	 * Test gutenberg_render_block_core_post_title() method.
+	 */
+	public function test_should_render_empty_string_when_title_is_empty() {
+
+		// call render method with block context.
+		$rendered = gutenberg_render_block_core_post_title( self::$attributes, '', self::$block );
+		$this->assertEmpty( $rendered );
+
+		self::$block->context = array( 'postId' => 0 );
+		$rendered             = gutenberg_render_block_core_post_title( self::$attributes, '', self::$block );
+		$this->assertEmpty( $rendered );
+	}


I think a data provider could be utilized here.

Suggested change

/**

* Test gutenberg_render_block_core_post_title() method.

*/

public function test_should_render_empty_string_when_title_is_empty() {

// call render method with block context.

$rendered = gutenberg_render_block_core_post_title( self::$attributes, '', self::$block );

$this->assertEmpty( $rendered );

self::$block->context = array( 'postId' => 0 );

$rendered = gutenberg_render_block_core_post_title( self::$attributes, '', self::$block );

$this->assertEmpty( $rendered );

}

/**

* Test if the function returns an empty string when the post title is empty.

*

* @dataProvider data_should_render_empty_string_when_title_is_empty

*/

public function test_should_render_empty_string_when_title_is_empty( $context, $failure_message ) {

if ( $context ) {

self::$block->context = $context;

}

$rendered = gutenberg_render_block_core_post_title( self::$attributes, '', self::$block );

$this->assertSame( '', $rendered, $failure_message );

}

/**

* Data provider.

*

* @return array

*/

public function data_should_render_empty_string_when_title_is_empty() {

return array(

'empty block context' => array( null, 'Failed asserting that rendering result is an empty string when block context is not set.' ),

'incorrect post ID' => array( array( 'postId' => 0 ), 'Failed asserting that rendering result is an empty string when post ID is incorrect.' ),

);

}

anton-vlasenko · 2024-06-05T21:50:05Z

phpunit/blocks/renderBlockCorePostTitle.php

+	}
+
+	/**
+	 * Test gutenberg_render_block_core_post_title() method.


gutenberg_render_block_core_post_title() is not a method.

Suggested change

* Test gutenberg_render_block_core_post_title() method.

* Test if the function returns correct titles.

anton-vlasenko · 2024-06-05T21:50:39Z

phpunit/blocks/renderBlockCorePostTitle.php

+	/**
+	 * Array of attributes.
+	 *
+	 * @var int


Suggested change

* @var int

* @var array

anton-vlasenko · 2024-06-05T21:50:58Z

phpunit/blocks/renderBlockCorePostTitle.php

+	/**
+	 * Post object.
+	 *
+	 * @var array


Suggested change

* @var array

* @var WP_Term

akasunil · 2024-07-03T04:39:10Z

@anton-vlasenko Can you please review this PR again?

anton-vlasenko

LGTM.

ntsekouras added the [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. label Jul 15, 2022

ntsekouras requested review from spacedmonkey and TimothyBJacobs July 15, 2022 08:18

draganescu previously approved these changes Nov 10, 2022

View reviewed changes

spacedmonkey reviewed Nov 15, 2022

View reviewed changes

anton-vlasenko reviewed Jan 4, 2023

View reviewed changes

phpunit/blocks/render-block-post-title-test.php Outdated Show resolved Hide resolved

phpunit/blocks/render-block-post-title-test.php Outdated Show resolved Hide resolved

phpunit/blocks/render-block-post-title-test.php Outdated Show resolved Hide resolved

draganescu changed the title ~~Add Unitest for post title block render function~~ Add unit test for post title block render function Jan 6, 2023

akasunil requested review from anton-vlasenko and removed request for TimothyBJacobs January 28, 2023 15:57

akasunil requested review from draganescu and spacedmonkey February 26, 2024 07:01

anton-vlasenko reviewed Mar 1, 2024

View reviewed changes

akasunil marked this pull request as draft April 19, 2024 08:55

akasunil marked this pull request as ready for review April 28, 2024 08:21

akasunil mentioned this pull request May 24, 2024

Added unit test for post excerpt block render function #43451

Merged

anton-vlasenko reviewed Jun 5, 2024

View reviewed changes

akasunil self-assigned this Jun 25, 2024

akasunil requested a review from anton-vlasenko June 25, 2024 11:04

anton-vlasenko approved these changes Jul 23, 2024

View reviewed changes

akasunil added 11 commits July 23, 2024 16:16

Added unit test for core post title block render function

95cb71f

Added assertion for link attributes

4862691

Calling render method from build

e8c396f

Updated wpSetUpBeforeClass method with argument

e63b5d9

Addressed feedbacks

b61cc66

fix unit test failure

616991c

Addressed feedback

ef7407e

Updated file name as per core standard

6a01ad2

Update assertion comments and formatting

534116b

Update assertion comments

016685b

Addressed feedback

dca1332

anton-vlasenko force-pushed the add-test-for-post-title-block-render branch from 0d0c1e7 to dca1332 Compare July 23, 2024 14:17

anton-vlasenko changed the title ~~Add unit test for post title block render function~~ Add unit tests for the gutenberg_render_block_core_post_title() function Jul 23, 2024

anton-vlasenko enabled auto-merge (squash) July 23, 2024 14:59

anton-vlasenko merged commit ae50345 into WordPress:trunk Jul 23, 2024
58 checks passed

akasunil deleted the add-test-for-post-title-block-render branch July 23, 2024 15:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add unit tests for the gutenberg_render_block_core_post_title() function #42435

Add unit tests for the gutenberg_render_block_core_post_title() function #42435

akasunil commented Jul 14, 2022

akasunil commented Jul 14, 2022

akasunil commented Aug 20, 2022

draganescu left a comment

akasunil commented Nov 11, 2022

spacedmonkey Nov 15, 2022

akasunil Nov 17, 2022

akasunil commented Jan 2, 2023

anton-vlasenko left a comment

akasunil commented Apr 27, 2023

github-actions bot commented Feb 26, 2024 •

edited

Loading

anton-vlasenko left a comment

anton-vlasenko Mar 1, 2024

anton-vlasenko Mar 1, 2024

anton-vlasenko Mar 1, 2024 •

edited

Loading

akasunil Mar 2, 2024

anton-vlasenko Mar 4, 2024 •

edited

Loading

akasunil commented Mar 2, 2024

anton-vlasenko commented Mar 4, 2024 •

edited

Loading

akasunil commented Mar 8, 2024

akasunil commented Apr 28, 2024

akasunil commented May 10, 2024

anton-vlasenko Jun 5, 2024 •

edited

Loading

anton-vlasenko Jun 5, 2024 •

edited

Loading

anton-vlasenko Jun 5, 2024

anton-vlasenko Jun 5, 2024

akasunil commented Jul 3, 2024

anton-vlasenko left a comment

		public static function wpSetUpBeforeClass() {
		self::$post = self::factory()->post->create_and_get( array( 'post_title' => 'Post title block Unit Test' ) );

	class Tests_Blocks_GutenbergRenderBlockCorePostTitle extends WP_UnitTestCase {
	class Tests_Blocks_RenderBlockCorePostTitle extends WP_UnitTestCase {

-	/**
-	 * Test gutenberg_render_block_core_post_title() method.
-	 */
-	public function test_should_render_empty_string_when_title_is_empty() {
-		// call render method with block context.
-		$rendered = gutenberg_render_block_core_post_title( self::$attributes, '', self::$block );
-		$this->assertEmpty( $rendered );
-		self::$block->context = array( 'postId' => 0 );
-		$rendered             = gutenberg_render_block_core_post_title( self::$attributes, '', self::$block );
-		$this->assertEmpty( $rendered );
-	}
+	/**
+	 * Test if the function returns an empty string when the post title is empty.
+	 *
+	 * @dataProvider data_should_render_empty_string_when_title_is_empty
+	 */
+	public function test_should_render_empty_string_when_title_is_empty( $context, $failure_message ) {
+		if ( $context ) {
+			self::$block->context = $context;
+		}
+		$rendered = gutenberg_render_block_core_post_title( self::$attributes, '', self::$block );
+		$this->assertSame( '', $rendered, $failure_message );
+	}
+	/**
+	 * Data provider.
+	 *
+	 * @return array
+	 */
+	public function data_should_render_empty_string_when_title_is_empty() {
+		return array(
+			'empty block context' => array( null, 'Failed asserting that rendering result is an empty string when block context is not set.' ),
+			'incorrect post ID'   => array( array( 'postId' => 0 ), 'Failed asserting that rendering result is an empty string when post ID is incorrect.' ),
+		);
+	}

	* Test gutenberg_render_block_core_post_title() method.
	* Test if the function returns correct titles.

Add unit tests for the gutenberg_render_block_core_post_title() function #42435

Add unit tests for the gutenberg_render_block_core_post_title() function #42435

Conversation

akasunil commented Jul 14, 2022

What?

akasunil commented Jul 14, 2022

akasunil commented Aug 20, 2022

draganescu left a comment

Choose a reason for hiding this comment

akasunil commented Nov 11, 2022

spacedmonkey Nov 15, 2022

Choose a reason for hiding this comment

akasunil Nov 17, 2022

Choose a reason for hiding this comment

akasunil commented Jan 2, 2023

anton-vlasenko left a comment

Choose a reason for hiding this comment

akasunil commented Apr 27, 2023

github-actions bot commented Feb 26, 2024 • edited Loading

anton-vlasenko left a comment

Choose a reason for hiding this comment

anton-vlasenko Mar 1, 2024

Choose a reason for hiding this comment

anton-vlasenko Mar 1, 2024

Choose a reason for hiding this comment

anton-vlasenko Mar 1, 2024 • edited Loading

Choose a reason for hiding this comment

akasunil Mar 2, 2024

Choose a reason for hiding this comment

anton-vlasenko Mar 4, 2024 • edited Loading

Choose a reason for hiding this comment

akasunil commented Mar 2, 2024

anton-vlasenko commented Mar 4, 2024 • edited Loading

akasunil commented Mar 8, 2024

akasunil commented Apr 28, 2024

akasunil commented May 10, 2024

anton-vlasenko Jun 5, 2024 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Jun 5, 2024 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Jun 5, 2024

Choose a reason for hiding this comment

anton-vlasenko Jun 5, 2024

Choose a reason for hiding this comment

akasunil commented Jul 3, 2024

anton-vlasenko left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 26, 2024 •

edited

Loading

anton-vlasenko Mar 1, 2024 •

edited

Loading

anton-vlasenko Mar 4, 2024 •

edited

Loading

anton-vlasenko commented Mar 4, 2024 •

edited

Loading

anton-vlasenko Jun 5, 2024 •

edited

Loading

anton-vlasenko Jun 5, 2024 •

edited

Loading