Changeset 53638

Timestamp:

07/03/2022 05:28:12 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add @since tags for _doing_it_wrong() and deprecation notice handlers in the PHPUnit test suite.

This affects methods in the WP_UnitTestCase_Base class:

• ::expectDeprecated()
• ::expectedDeprecated()
• ::setExpectedException()
• ::deprecated_function_run()
• ::doing_it_wrong_run()

Follow-up to [25402], [25408], [25785], [37861], [40536], [40539], [40872], [51872], [53637].

See #55652, #55646.

File:

• trunk/tests/phpunit/includes/abstract-testcase.php (modified) (11 diffs)

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -488 +488 @@
         /**
          * Sets up the expectations for testing a deprecated call.
+         *
+         * @since 3.7.0
          */
         public function expectDeprecated() {
@@ -534 +536 @@
          *
          * The DocBlock should contain `@expectedDeprecated` to trigger this.
+         *
+         * @since 3.7.0
+         * @since 6.1.0 Includes the actual unexpected `_doing_it_wrong()` message
+         *              or deprecation notice in the output if one is encountered.
          */
         public function expectedDeprecated() {
@@ -544 +550 @@
 
                 foreach ( $not_caught_deprecated as $not_caught ) {
-                        $errors[] = "Failed to assert that $not_caught triggered a deprecation notice";
+                        $errors[] = "Failed to assert that $not_caught triggered a deprecation notice.";
                 }
 
@@ -553 +559 @@
 
                 foreach ( $unexpected_deprecated as $unexpected ) {
-                        $errors[] = "Unexpected deprecation notice for $unexpected";
+                        $errors[] = "Unexpected deprecation notice for $unexpected.";
                         $errors[] = $this->caught_deprecated[ $unexpected ];
                 }
@@ -563 +569 @@
 
                 foreach ( $not_caught_doing_it_wrong as $not_caught ) {
-                        $errors[] = "Failed to assert that $not_caught triggered an incorrect usage notice";
+                        $errors[] = "Failed to assert that $not_caught triggered an incorrect usage notice.";
                 }
 
@@ -572 +578 @@
 
                 foreach ( $unexpected_doing_it_wrong as $unexpected ) {
-                        $errors[] = "Unexpected incorrect usage notice for $unexpected";
+                        $errors[] = "Unexpected incorrect usage notice for $unexpected.";
                         $errors[] = $this->caught_doing_it_wrong[ $unexpected ];
                 }
@@ -601 +607 @@
          * @since 4.2.0
          *
-         * @param string $deprecated Name of the function, method, class, or argument that is deprecated. Must match
-         *                           the first parameter of the `_deprecated_function()` or `_deprecated_argument()` call.
+         * @param string $deprecated Name of the function, method, class, or argument that is deprecated.
+         *                           Must match the first parameter of the `_deprecated_function()`
+         *                           or `_deprecated_argument()` call.
          */
         public function setExpectedDeprecated( $deprecated ) {
@@ -613 +620 @@
          * @since 4.2.0
          *
-         * @param string $doing_it_wrong Name of the function, method, or class that appears in the first argument
-         *                               of the source `_doing_it_wrong()` call.
+         * @param string $doing_it_wrong Name of the function, method, or class that appears in
+         *                               the first argument of the source `_doing_it_wrong()` call.
          */
         public function setExpectedIncorrectUsage( $doing_it_wrong ) {
@@ -625 +632 @@
          * This method is only left in place for backward compatibility reasons.
          *
+         * @since 4.8.0
          * @deprecated 5.9.0 Use the PHPUnit native expectException*() methods directly.
          *
@@ -645 +653 @@
         /**
          * Adds a deprecated function to the list of caught deprecated calls.
+         *
+         * @since 3.7.0
+         * @since 6.1.0 Added the `$replacement`, `$version`, and `$message` parameters.
          *
          * @param string $function    The deprecated function.
@@ -729 +740 @@
         /**
          * Adds a function called in a wrong way to the list of `_doing_it_wrong()` calls.
+         *
+         * @since 3.7.0
+         * @since 6.1.0 Added the `$message` and `$version` parameters.
          *
          * @param string $function The function to add.