<!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>[34126] trunk/tests/phpunit/tests/pluggable.php: Implement unit tests which use reflection to test functions in pluggable.php.</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34126">34126</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34126","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-14 19:14:38 +0000 (Mon, 14 Sep 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Implement unit tests which use reflection to test functions in pluggable.php. This means any changes to these functions will need explicit changes to their corresponding tests, which helps prevent unintentional breakage.
Fixes <a href="https://core.trac.wordpress.org/ticket/33867">#33867</a></pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestspluggablephp">trunk/tests/phpunit/tests/pluggable.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestspluggablephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/pluggable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/pluggable.php (rev 0)
+++ trunk/tests/phpunit/tests/pluggable.php 2015-09-14 19:14:38 UTC (rev 34126)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,142 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group pluggable
+ */
+class Tests_Pluggable extends WP_UnitTestCase {
+
+ /**
+ * Tests that the signatures of all functions in pluggable.php match their expected signature.
+ *
+ * @ticket 33654
+ * @ticket 33867
+ *
+ * @dataProvider getDefinedPluggableFunctions
+ */
+ public function testPluggableFunctionSignaturesMatch( $function ) {
+
+ $signatures = $this->getPluggableFunctionSignatures();
+
+ $this->assertTrue( function_exists( $function ) );
+ $this->assertArrayHasKey( $function, $signatures );
+
+ $function_ref = new ReflectionFunction( $function );
+ $param_refs = $function_ref->getParameters();
+
+ $this->assertSame( count( $signatures[ $function ] ), count( $param_refs ) );
+
+ $i = 0;
+
+ foreach ( $signatures[ $function ] as $name => $value ) {
+
+ $param_ref = $param_refs[ $i ];
+ $msg = 'Parameter: ' . $param_ref->getName();
+
+ if ( is_numeric( $name ) ) {
+ $name = $value;
+ $this->assertFalse( $param_ref->isOptional(), $msg );
+ } else {
+ $this->assertTrue( $param_ref->isOptional(), $msg );
+ $this->assertSame( $value, $param_ref->getDefaultValue(), $msg );
+ }
+
+ $this->assertSame( $name, $param_ref->getName(), $msg );
+
+ $i++;
+
+ }
+
+ }
+
+ /**
+ * Test the tests. Makes sure all the expected pluggable functions exist and that they live in pluggable.php.
+ *
+ * @ticket 33654
+ * @ticket 33867
+ */
+ public function testAllPluggableFunctionsExist() {
+
+ $defined = wp_list_pluck( $this->getDefinedPluggableFunctions(), 0 );
+ $expected = $this->getPluggableFunctionSignatures();
+
+ foreach ( $expected as $function => $sig ) {
+ $msg = 'Function: ' . $function . '()';
+ $this->assertTrue( function_exists( $function ), $msg );
+ $this->assertTrue( in_array( $function, $defined, true ), $msg );
+ }
+
+ }
+
+ /**
+ * Data provider for our pluggable function signature tests.
+ *
+ * @return array Data provider array of pluggable function names.
+ */
+ public function getDefinedPluggableFunctions() {
+
+ preg_match_all( '#^function (\w+)#m', file_get_contents( ABSPATH . '/wp-includes/pluggable.php' ), $functions );
+
+ $data = array();
+
+ foreach ( $functions[1] as $function ) {
+ $data[] = array(
+ $function,
+ );
+ }
+
+ return $data;
+
+ }
+
+ /**
+ * Expected pluggable function signatures.
+ *
+ * @return array Array of signatures keyed by their function name.
+ */
+ public function getPluggableFunctionSignatures() {
+
+ return array(
+ 'wp_set_current_user' => array( 'id', 'name' => '' ),
+ 'wp_get_current_user' => array(),
+ 'get_currentuserinfo' => array(),
+ 'get_userdata' => array( 'user_id' ),
+ 'get_user_by' => array( 'field', 'value' ),
+ 'cache_users' => array( 'user_ids' ),
+ 'wp_mail' => array( 'to', 'subject', 'message', 'headers' => '', 'attachments' => array() ),
+ 'wp_authenticate' => array( 'username', 'password' ),
+ 'wp_logout' => array(),
+ 'wp_validate_auth_cookie' => array( 'cookie' => '', 'scheme' => '' ),
+ 'wp_generate_auth_cookie' => array( 'user_id', 'expiration', 'scheme' => 'auth', 'token' => '' ),
+ 'wp_parse_auth_cookie' => array( 'cookie' => '', 'scheme' => '' ),
+ 'wp_set_auth_cookie' => array( 'user_id', 'remember' => false, 'secure' => '', 'token' => '' ),
+ 'wp_clear_auth_cookie' => array(),
+ 'is_user_logged_in' => array(),
+ 'auth_redirect' => array(),
+ 'check_admin_referer' => array( 'action' => -1, 'query_arg' => '_wpnonce' ),
+ 'check_ajax_referer' => array( 'action' => -1, 'query_arg' => false, 'die' => true ),
+ 'wp_redirect' => array( 'location', 'status' => 302 ),
+ 'wp_sanitize_redirect' => array( 'location' ),
+ '_wp_sanitize_utf8_in_redirect' => array( 'matches' ),
+ 'wp_safe_redirect' => array( 'location', 'status' => 302 ),
+ 'wp_validate_redirect' => array( 'location', 'default' => '' ),
+ 'wp_notify_postauthor' => array( 'comment_id', 'deprecated' => null ),
+ 'wp_notify_moderator' => array( 'comment_id' ),
+ 'wp_password_change_notification' => array( 'user' ),
+ 'wp_new_user_notification' => array( 'user_id', 'deprecated' => null, 'notify' => '' ),
+ 'wp_nonce_tick' => array(),
+ 'wp_verify_nonce' => array( 'nonce', 'action' => -1 ),
+ 'wp_create_nonce' => array( 'action' => -1 ),
+ 'wp_salt' => array( 'scheme' => 'auth' ),
+ 'wp_hash' => array( 'data', 'scheme' => 'auth' ),
+ 'wp_hash_password' => array( 'password' ),
+ 'wp_check_password' => array( 'password', 'hash', 'user_id' => '' ),
+ 'wp_generate_password' => array( 'length' => 12, 'special_chars' => true, 'extra_special_chars' => false ),
+ 'wp_rand' => array( 'min' => 0, 'max' => 0 ),
+ 'wp_set_password' => array( 'password', 'user_id' ),
+ 'get_avatar' => array( 'id_or_email', 'size' => 96, 'default' => '', 'alt' => '', 'args' => null ),
+ 'wp_text_diff' => array( 'left_string', 'right_string', 'args' => null ),
+ );
+
+ }
+
+}
</ins></span></pre>
</div>
</div>
</body>
</html>