Changeset 60137

Timestamp:

04/07/2025 11:13:03 PM (3 weeks ago)

Author:

SergeyBiryukov

Message:

Tests: Simplify the tests for force_ssl_admin().

Includes:

• The $forced static variable is reset to false before each test, and the function always returns the previous value on the first call, so there is no need to pass the same value from the data provider.
• Clarifying data provider keys by removing the “first call” references to avoid confusion, as the test method always calls the function twice for each input value.
• Replacing unnecessarily redundant test method name for consistency with other tests.
• Moving the data provider after the test method for consistency with other tests.
• Adjusting DocBlock formatting as per the documentation standards.

Follow-up to [59830].

See #63167.

File:

• trunk/tests/phpunit/tests/functions/forceSslAdmin.php (modified) (2 diffs)

trunk/tests/phpunit/tests/functions/forceSslAdmin.php

@@ -2 +2 @@
 /**
  * Test cases for the `force_ssl_admin()` function.
- *
- * @package WordPress\UnitTests
  *
  * @since 6.8.0
@@ -13 +11 @@
 class Tests_Functions_ForceSslAdmin extends WP_UnitTestCase {
 
-    public function set_up(): void {
+    public function set_up() {
         parent::set_up();
-        // Reset the static variable before each test
+        // Reset the `$forced` static variable before each test.
         force_ssl_admin( false );
     }
 
     /**
-     * Data provider for testing force_ssl_admin.
+     * Tests that force_ssl_admin() returns expected values based on various inputs.
      *
-     * Provides various inputs and expected outcomes for the function.
+     * @dataProvider data_force_ssl_admin
+     *
+     * @param mixed $input    The input value to test.
+     * @param bool  $expected The expected result for subsequent calls.
+     */
+    public function test_force_ssl_admin( $input, $expected ) {
+        // The first call always returns the previous value.
+        $this->assertFalse( force_ssl_admin( $input ), 'First call did not return the expected value' );
+
+        // Call again to check subsequent behavior.
+        $this->assertSame( $expected, force_ssl_admin( $input ), 'Subsequent call did not return the expected value' );
+    }
+
+    /**
+     * Data provider for testing force_ssl_admin().
      *
      * @return array[]
      */
-    public function data_should_return_expected_value_when_various_inputs_are_passed() {
+    public function data_force_ssl_admin() {
         return array(
-            'default'                     => array( null, false, false ),
-            'first_call_true'             => array( true, false, true ),
-            'first_call_false'            => array( false, false, false ),
-            'first_call_non_empty_string' => array( 'some string', false, true ),
-            'empty_string'                => array( '', false, false ),
-            'first_call_integer_1'        => array( 1, false, true ),
-            'integer_0'                   => array( 0, false, false ),
+            'default'          => array( null, false ),
+            'true'             => array( true, true ),
+            'false'            => array( false, false ),
+            'non-empty string' => array( 'some string', true ),
+            'empty string'     => array( '', false ),
+            'integer 1'        => array( 1, true ),
+            'integer 0'        => array( 0, false ),
         );
     }
-
-    /**
-     * Tests that force_ssl_admin returns expected values based on various inputs.
-     *
-     * @dataProvider data_should_return_expected_value_when_various_inputs_are_passed
-     *
-     * @param mixed $input                   The input value to test.
-     * @param bool $expected_first_call      The expected result for the first call.
-     * @param bool $expected_subsequent_call The expected result for subsequent calls.
-     */
-    public function test_should_return_expected_value_when_various_inputs_are_passed( $input, $expected_first_call, $expected_subsequent_call ) {
-        $this->assertSame( $expected_first_call, force_ssl_admin( $input ), 'First call did not return expected value' );
-
-        // Call again to check subsequent behavior
-        $this->assertSame( $expected_subsequent_call, force_ssl_admin( $input ), 'Subsequent call did not return expected value' );
-    }
 }