From 4ed912c8c31e35f2944421df7441fa3fc1fe63fa Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov@git.wordpress.org>
Date: Mon, 25 Jul 2022 13:31:24 +0000
Subject: [PATCH] Tests: Add failure messages for site icon and custom logo
 tests.

This makes the assertions more helpful, as per the [https://make.wordpress.org/core/handbook/testing/automated-testing/writing-phpunit-tests/#using-assertions Writing PHP Tests] guidelines:
> All PHPUnit assertions, as well as all WordPress custom assertions, allow for a `$message` parameter to be passed. This message will be displayed when the assertion fails and can help immensely when debugging a test. This parameter should always be used if more than one assertion is used in a test method.

Follow-up to [33181], [36905].

See #55652.

git-svn-id: https://develop.svn.wordpress.org/trunk@53773 602fd350-edb4-49c9-b593-d223f7449a82
---
 tests/phpunit/tests/general/template.php | 30 ++++++++++++------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/tests/phpunit/tests/general/template.php b/tests/phpunit/tests/general/template.php
index ca2e6063a1..4e412fd077 100644
--- a/tests/phpunit/tests/general/template.php
+++ b/tests/phpunit/tests/general/template.php
@@ -38,13 +38,13 @@ class Tests_General_Template extends WP_UnitTestCase {
 	 * @requires function imagejpeg
 	 */
 	public function test_get_site_icon_url() {
-		$this->assertEmpty( get_site_icon_url() );
+		$this->assertEmpty( get_site_icon_url(), 'Site icon URL should not be set initially.' );
 
 		$this->set_site_icon();
-		$this->assertSame( $this->site_icon_url, get_site_icon_url() );
+		$this->assertSame( $this->site_icon_url, get_site_icon_url(), 'Site icon URL should be set.' );
 
 		$this->remove_site_icon();
-		$this->assertEmpty( get_site_icon_url() );
+		$this->assertEmpty( get_site_icon_url(), 'Site icon URL should not be set after removal.' );
 	}
 
 	/**
@@ -67,13 +67,13 @@ class Tests_General_Template extends WP_UnitTestCase {
 	 * @requires function imagejpeg
 	 */
 	public function test_has_site_icon() {
-		$this->assertFalse( has_site_icon() );
+		$this->assertFalse( has_site_icon(), 'Site icon should not be set initially.' );
 
 		$this->set_site_icon();
-		$this->assertTrue( has_site_icon() );
+		$this->assertTrue( has_site_icon(), 'Site icon should be set.' );
 
 		$this->remove_site_icon();
-		$this->assertFalse( has_site_icon() );
+		$this->assertFalse( has_site_icon(), 'Site icon should not be set after removal.' );
 	}
 
 	/**
@@ -261,13 +261,13 @@ class Tests_General_Template extends WP_UnitTestCase {
 	 * @since 4.5.0
 	 */
 	public function test_has_custom_logo() {
-		$this->assertFalse( has_custom_logo() );
+		$this->assertFalse( has_custom_logo(), 'Custom logo should not be set initially.' );
 
 		$this->set_custom_logo();
-		$this->assertTrue( has_custom_logo() );
+		$this->assertTrue( has_custom_logo(), 'Custom logo should be set.' );
 
 		$this->remove_custom_logo();
-		$this->assertFalse( has_custom_logo() );
+		$this->assertFalse( has_custom_logo(), 'Custom logo should not be set after removal.' );
 	}
 
 	/**
@@ -304,15 +304,15 @@ class Tests_General_Template extends WP_UnitTestCase {
 	 * @since 4.5.0
 	 */
 	public function test_get_custom_logo() {
-		$this->assertEmpty( get_custom_logo() );
+		$this->assertEmpty( get_custom_logo(), 'Custom logo should not be set initially.' );
 
 		$this->set_custom_logo();
 		$custom_logo = get_custom_logo();
-		$this->assertNotEmpty( $custom_logo );
-		$this->assertIsString( $custom_logo );
+		$this->assertNotEmpty( $custom_logo, 'Custom logo markup should not be empty.' );
+		$this->assertIsString( $custom_logo, 'Custom logo markup should be a string.' );
 
 		$this->remove_custom_logo();
-		$this->assertEmpty( get_custom_logo() );
+		$this->assertEmpty( get_custom_logo(), 'Custom logo should not be set after removal.' );
 	}
 
 	/**
@@ -402,7 +402,7 @@ class Tests_General_Template extends WP_UnitTestCase {
 	}
 
 	/**
-	 * Sets a site icon in options for testing.
+	 * Sets a custom logo in options for testing.
 	 *
 	 * @since 4.5.0
 	 */
@@ -415,7 +415,7 @@ class Tests_General_Template extends WP_UnitTestCase {
 	}
 
 	/**
-	 * Removes the site icon from options.
+	 * Removes the custom logo from options.
 	 *
 	 * @since 4.5.0
 	 */