Changeset 53773

Timestamp:

07/25/2022 01:31:24 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Tests: Add failure messages for site icon and custom logo tests.

This makes the assertions more helpful, as per the ​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.

File:

• trunk/tests/phpunit/tests/general/template.php (modified) (6 diffs)

trunk/tests/phpunit/tests/general/template.php

@@ -39 +39 @@
          */
         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.' );
         }
 
@@ -68 +68 @@
          */
         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.' );
         }
 
@@ -262 +262 @@
          */
         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.' );
         }
 
@@ -305 +305 @@
          */
         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.' );
         }
 
@@ -403 +403 @@
 
         /**
-         * Sets a site icon in options for testing.
+         * Sets a custom logo in options for testing.
          *
          * @since 4.5.0
@@ -416 +416 @@
 
         /**
-         * Removes the site icon from options.
+         * Removes the custom logo from options.
          *
          * @since 4.5.0