<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[25408] trunk/tests/phpunit/includes/testcase.php: Test framework: Introduce the annotation @expectedDeprecated, modeled after PHPUnit's @expectedException.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25408">25408</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2013-09-12 18:37:00 +0000 (Thu, 12 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Test framework: Introduce the annotation @expectedDeprecated, modeled after PHPUnit's @expectedException.
It works for both functions and arguments (using the value of the first argument passed to _deprecated_function() or _deprecated_argument(), which is typically the function name). It asserts both ways:
* If specified, those deprecated notices must be caught, or the test fails.
* If not specified, any other deprecated notices cause the test to fail.
Works regardless of WP_DEBUG.
see <a href="http://core.trac.wordpress.org/ticket/25282">#25282</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludestestcasephp">trunk/tests/phpunit/includes/testcase.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunitincludestestcasephp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/includes/testcase.php (25407 => 25408)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/includes/testcase.php 2013-09-12 17:47:40 UTC (rev 25407)
+++ trunk/tests/phpunit/includes/testcase.php 2013-09-12 18:37:00 UTC (rev 25408)
</span><span class="lines">@@ -6,7 +6,8 @@
</span><span class="cx"> class WP_UnitTestCase extends PHPUnit_Framework_TestCase {
</span><span class="cx">
</span><span class="cx"> protected static $forced_tickets = array();
</span><del>- protected $deprecated_functions = array();
</del><ins>+ protected $expected_deprecated = array();
+ protected $caught_deprecated = array();
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * @var WP_UnitTest_Factory
</span><span class="lines">@@ -24,32 +25,19 @@
</span><span class="cx"> $this->factory = new WP_UnitTest_Factory;
</span><span class="cx"> $this->clean_up_global_scope();
</span><span class="cx"> $this->start_transaction();
</span><ins>+ $this->expectDeprecated();
</ins><span class="cx"> add_filter( 'wp_die_handler', array( $this, 'get_wp_die_handler' ) );
</span><del>-
- if ( ! empty( $this->deprecated_functions ) )
- add_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ) );
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function tearDown() {
</span><span class="cx"> global $wpdb;
</span><ins>+ $this->expectedDeprecated();
</ins><span class="cx"> $wpdb->query( 'ROLLBACK' );
</span><span class="cx"> remove_filter( 'dbdelta_create_queries', array( $this, '_create_temporary_tables' ) );
</span><span class="cx"> remove_filter( 'query', array( $this, '_drop_temporary_tables' ) );
</span><span class="cx"> remove_filter( 'wp_die_handler', array( $this, 'get_wp_die_handler' ) );
</span><del>- if ( ! empty( $this->deprecated_functions ) )
- remove_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ) );
</del><span class="cx"> }
</span><span class="cx">
</span><del>- function deprecated_function_run( $function ) {
- if ( in_array( $function, $this->deprecated_functions ) )
- add_filter( 'deprecated_function_trigger_error', array( $this, 'deprecated_function_trigger_error' ) );
- }
-
- function deprecated_function_trigger_error() {
- remove_filter( 'deprecated_function_trigger_error', array( $this, 'deprecated_function_trigger_error' ) );
- return false;
- }
-
</del><span class="cx"> function clean_up_global_scope() {
</span><span class="cx"> $_GET = array();
</span><span class="cx"> $_POST = array();
</span><span class="lines">@@ -96,6 +84,35 @@
</span><span class="cx"> throw new WPDieException( $message );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ function expectDeprecated() {
+ $annotations = $this->getAnnotations();
+ foreach ( array( 'class', 'method' ) as $depth ) {
+ if ( ! empty( $annotations[ $depth ]['expectedDeprecated'] ) )
+ $this->expected_deprecated = array_merge( $this->expected_deprecated, $annotations[ $depth ]['expectedDeprecated'] );
+ }
+ add_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ) );
+ add_action( 'deprecated_argument_run', array( $this, 'deprecated_function_run' ) );
+ add_action( 'deprecated_function_trigger_error', '__return_false' );
+ add_action( 'deprecated_argument_trigger_error', '__return_false' );
+ }
+
+ function expectedDeprecated() {
+ $not_caught_deprecated = array_diff( $this->expected_deprecated, $this->caught_deprecated );
+ foreach ( $not_caught_deprecated as $not_caught ) {
+ $this->fail( "Failed to assert that $not_caught triggered a deprecated notice" );
+ }
+
+ $unexpected_deprecated = array_diff( $this->caught_deprecated, $this->expected_deprecated );
+ foreach ( $unexpected_deprecated as $unexpected ) {
+ $this->fail( "Unexpected deprecated notice for $unexpected" );
+ }
+ }
+
+ function deprecated_function_run( $function ) {
+ if ( ! in_array( $function, $this->caught_deprecated ) )
+ $this->caught_deprecated[] = $function;
+ }
+
</ins><span class="cx"> function assertWPError( $actual, $message = '' ) {
</span><span class="cx"> $this->assertInstanceOf( 'WP_Error', $actual, $message );
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>