<!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>[25785] trunk/tests/phpunit: Test runner: Add @expectedIncorrectUsage to trap _doing_it_wrong() calls.</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/25785">25785</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2013-10-15 14:30:02 +0000 (Tue, 15 Oct 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Test runner: Add @expectedIncorrectUsage to trap _doing_it_wrong() calls.

see <a href="http://core.trac.wordpress.org/ticket/24813">#24813</a>, <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>
<li><a href="#trunktestsphpunittestsdependenciesjqueryphp">trunk/tests/phpunit/tests/dependencies/jquery.php</a></li>
<li><a href="#trunktestsphpunitteststhemesupportphp">trunk/tests/phpunit/tests/theme/support.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 (25784 => 25785)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/includes/testcase.php        2013-10-15 05:07:55 UTC (rev 25784)
+++ trunk/tests/phpunit/includes/testcase.php   2013-10-15 14:30:02 UTC (rev 25785)
</span><span class="lines">@@ -8,6 +8,8 @@
</span><span class="cx">  protected static $forced_tickets = array();
</span><span class="cx">  protected $expected_deprecated = array();
</span><span class="cx">  protected $caught_deprecated = array();
</span><ins>+       protected $expected_doing_it_wrong = array();
+       protected $caught_doing_it_wrong = array();
</ins><span class="cx"> 
</span><span class="cx">  /**
</span><span class="cx">   * @var WP_UnitTest_Factory
</span><span class="lines">@@ -89,11 +91,15 @@
</span><span class="cx">          foreach ( array( 'class', 'method' ) as $depth ) {
</span><span class="cx">                  if ( ! empty( $annotations[ $depth ]['expectedDeprecated'] ) )
</span><span class="cx">                          $this->expected_deprecated = array_merge( $this->expected_deprecated, $annotations[ $depth ]['expectedDeprecated'] );
</span><ins>+                       if ( ! empty( $annotations[ $depth ]['expectedIncorrectUsage'] ) )
+                               $this->expected_doing_it_wrong = array_merge( $this->expected_doing_it_wrong, $annotations[ $depth ]['expectedIncorrectUsage'] );
</ins><span class="cx">           }
</span><span class="cx">          add_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ) );
</span><span class="cx">          add_action( 'deprecated_argument_run', array( $this, 'deprecated_function_run' ) );
</span><ins>+               add_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ) );
</ins><span class="cx">           add_action( 'deprecated_function_trigger_error', '__return_false' );
</span><span class="cx">          add_action( 'deprecated_argument_trigger_error', '__return_false' );
</span><ins>+               add_action( 'doing_it_wrong_trigger_error',      '__return_false' );
</ins><span class="cx">   }
</span><span class="cx"> 
</span><span class="cx">  function expectedDeprecated() {
</span><span class="lines">@@ -106,6 +112,16 @@
</span><span class="cx">          foreach ( $unexpected_deprecated as $unexpected ) {
</span><span class="cx">                  $this->fail( "Unexpected deprecated notice for $unexpected" );
</span><span class="cx">          }
</span><ins>+
+               $not_caught_doing_it_wrong = array_diff( $this->expected_doing_it_wrong, $this->caught_doing_it_wrong );
+               foreach ( $not_caught_doing_it_wrong as $not_caught ) {
+                       $this->fail( "Failed to assert that $not_caught triggered an incorrect usage notice" );
+               }
+
+               $unexpected_doing_it_wrong = array_diff( $this->caught_doing_it_wrong, $this->expected_doing_it_wrong );
+               foreach ( $unexpected_doing_it_wrong as $unexpected ) {
+                       $this->fail( "Unexpected incorrect usage notice for $unexpected" );
+               }
</ins><span class="cx">   }
</span><span class="cx"> 
</span><span class="cx">  function deprecated_function_run( $function ) {
</span><span class="lines">@@ -113,6 +129,11 @@
</span><span class="cx">                  $this->caught_deprecated[] = $function;
</span><span class="cx">  }
</span><span class="cx"> 
</span><ins>+       function doing_it_wrong_run( $function ) {
+               if ( ! in_array( $function, $this->caught_doing_it_wrong ) )
+                       $this->caught_doing_it_wrong[] = $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>
<a id="trunktestsphpunittestsdependenciesjqueryphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/dependencies/jquery.php (25784 => 25785)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/dependencies/jquery.php        2013-10-15 05:07:55 UTC (rev 25784)
+++ trunk/tests/phpunit/tests/dependencies/jquery.php   2013-10-15 14:30:02 UTC (rev 25785)
</span><span class="lines">@@ -38,6 +38,8 @@
</span><span class="cx"> 
</span><span class="cx">  /**
</span><span class="cx">   * @ticket 22896
</span><ins>+        *
+        * @expectedIncorrectUsage wp_deregister_script
</ins><span class="cx">    */
</span><span class="cx">  function test_dont_allow_deregister_core_scripts_in_admin() {
</span><span class="cx">          set_current_screen( 'edit.php' );
</span><span class="lines">@@ -51,28 +53,15 @@
</span><span class="cx">                  'jquery-ui-tooltip', 'jquery-ui-widget', 'backbone', 'underscore',
</span><span class="cx">          );
</span><span class="cx"> 
</span><del>-               add_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ) );
-
</del><span class="cx">           foreach ( $libraries as $library ) {
</span><span class="cx">                  // Try to deregister the script, which should fail.
</span><span class="cx">                  wp_deregister_script( $library );
</span><span class="cx">                  $this->assertTrue( wp_script_is( $library, 'registered' ) );
</span><span class="cx">          }
</span><span class="cx"> 
</span><del>-               remove_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ) );
-
</del><span class="cx">           set_current_screen( 'front' );
</span><span class="cx">  }
</span><span class="cx"> 
</span><del>-       function doing_it_wrong_run() {
-               add_filter( 'doing_it_wrong_trigger_error', array( $this, 'doing_it_wrong_trigger_error' ) );
-       }
-
-       function doing_it_wrong_trigger_error() {
-               remove_filter( 'doing_it_wrong_trigger_error', array( $this, 'doing_it_wrong_trigger_error' ) );
-               return false;
-       }
-
</del><span class="cx">   /**
</span><span class="cx">   * @ticket 24994
</span><span class="cx">   */
</span></span></pre></div>
<a id="trunktestsphpunitteststhemesupportphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/theme/support.php (25784 => 25785)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/theme/support.php      2013-10-15 05:07:55 UTC (rev 25784)
+++ trunk/tests/phpunit/tests/theme/support.php 2013-10-15 14:30:02 UTC (rev 25785)
</span><span class="lines">@@ -5,26 +5,6 @@
</span><span class="cx">  */
</span><span class="cx"> class Tests_Theme_Support extends WP_UnitTestCase {
</span><span class="cx"> 
</span><del>-       function setUp() {
-               parent::setUp();
-               add_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ) );
-       }
-
-       function tearDown() {
-               parent::tearDown();
-               remove_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ) );
-       }
-
-       function doing_it_wrong_run( $function ) {
-               if ( in_array( $function, array( "add_theme_support( 'html5' )" ) ) )
-                       add_filter( 'doing_it_wrong_trigger_error', array( $this, 'doing_it_wrong_trigger_error' ) );
-       }
-
-       function doing_it_wrong_trigger_error() {
-               remove_filter( 'doing_it_wrong_trigger_error', array( $this, 'doing_it_wrong_trigger_error' ) );
-               return false;
-       }
-
</del><span class="cx">   function test_the_basics() {
</span><span class="cx">          add_theme_support( 'automatic-feed-links' );
</span><span class="cx">          $this->assertTrue( current_theme_supports( 'automatic-feed-links' ) );
</span><span class="lines">@@ -115,6 +95,8 @@
</span><span class="cx"> 
</span><span class="cx">  /**
</span><span class="cx">   * @ticket 24932
</span><ins>+        *
+        * @expectedIncorrectUsage add_theme_support( 'html5' )
</ins><span class="cx">    */
</span><span class="cx">  function test_supports_html5_subset() {
</span><span class="cx">          remove_theme_support( 'html5' );
</span><span class="lines">@@ -144,6 +126,8 @@
</span><span class="cx"> 
</span><span class="cx">  /**
</span><span class="cx">   * @ticket 24932
</span><ins>+        *
+        * @expectedIncorrectUsage add_theme_support( 'html5' )
</ins><span class="cx">    */
</span><span class="cx">  function test_supports_html5_invalid() {
</span><span class="cx">          remove_theme_support( 'html5' );
</span></span></pre>
</div>
</div>

</body>
</html>