<!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>[4724] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/tests/phpunit/tests/wporg-plugin-api.php: Plugin directory tests: update the unit tests to run on both the old and new APIs.</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="http://meta.trac.wordpress.org/changeset/4724">4724</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/4724","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tellyworth</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-01-18 22:01:01 +0000 (Wed, 18 Jan 2017)</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'>Plugin directory tests: update the unit tests to run on both the old and new APIs.
Fix a few stubborn issues and account for differences between the two.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorytestsphpunittestswporgpluginapiphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/tests/phpunit/tests/wporg-plugin-api.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorytestsphpunittestswporgpluginapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/tests/phpunit/tests/wporg-plugin-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/tests/phpunit/tests/wporg-plugin-api.php 2017-01-18 19:30:21 UTC (rev 4723)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/tests/phpunit/tests/wporg-plugin-api.php 2017-01-18 22:01:01 UTC (rev 4724)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,6 +8,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Plugins_API extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $api_endpoint_1_0 = 'http://api.wordpress.org/plugins/info/1.0/';
+ public $api_endpoint_1_1 = 'http://api.wordpress.org/plugins/info/1.1/';
+ public $api_endpoint_plugin_php = 'http://api.wordpress.org/plugins/info/1.0/jetpack.php';
+ public $api_endpoint_plugin_xml = 'http://api.wordpress.org/plugins/info/1.0/jetpack.xml';
+ public $api_endpoint_plugin_json = 'http://api.wordpress.org/plugins/info/1.0/jetpack.json';
+
+ public $user_agent = 'WordPress/4.8'; // Tell the API to use the v3 back-end
+ public $require_tested_value = true;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public $fields = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'short_description' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => true,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,32 +40,60 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'icons' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'active_installs' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'contributors' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'donate_link' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_wporg_plugin_api_serialize_php() {
- $response = wp_remote_post( 'http://api.wordpress.org/plugins/info/1.0/', array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function setUp() {
+ parent::setUp();
+ add_filter( 'http_headers_useragent', array( $this, 'filter_http_headers_useragent' ) );
+ }
+
+ function tearDown() {
+ remove_filter( 'http_headers_useragent', array( $this, 'filter_http_headers_useragent' ) );
+ parent::tearDown();
+ }
+
+ // Override the user-agent header in plugins_api() requests to force the API to use the new WP codebase.
+ function filter_http_headers_useragent( $user_agent ) {
+ return $this->user_agent;
+ }
+
+ function api_remote_post( $url, $action, $request ) {
+ return wp_remote_post( $url, array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'timeout' => 15,
</span><span class="cx" style="display: block; padding: 0 10px"> 'body' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'action' => 'plugin_information',
- 'request' => serialize( (object) array( 'slug' => 'jetpack', 'fields' => $this->fields ) ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'action' => $action,
+ 'request' => serialize( (object) $request ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'headers' => array( 'Host', 'api.wordpress.org' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
+
+ function api_remote_get( $url ) {
+ return wp_remote_get( $url, array(
+ 'timeout' => 15,
+ 'headers' => array( 'Host', 'api.wordpress.org' ),
+ ) );
+ }
+
+ function test_wporg_plugin_api_serialize_php() {
+ $response = $this->api_remote_post( $this->api_endpoint_1_0, 'plugin_information', array( 'slug' => 'jetpack', 'fields' => $this->fields ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugins = maybe_unserialize( wp_remote_retrieve_body( $response ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_check_response_attributes( $plugins );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wporg_plugin_api_serialize_php_get() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $url = add_query_arg( 'fields', implode( ',' , array_keys( $this->fields ) ), 'http://api.wordpress.org/plugins/info/1.0/jetpack.php' );
- $response = wp_remote_get( $url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = add_query_arg( 'fields', implode( ',' , array_keys( $this->fields ) ), $this->api_endpoint_plugin_php );
+ $response = $this->api_remote_get( $url );
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugins = maybe_unserialize( wp_remote_retrieve_body( $response ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_check_response_attributes( $plugins );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wporg_plugin_api_xml() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $url = add_query_arg( 'fields', implode( ',' , array_keys( $this->fields ) ), 'http://api.wordpress.org/plugins/info/1.0/jetpack.xml' );
- $response = wp_remote_get( $url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = add_query_arg( 'fields', implode( ',' , array_keys( $this->fields ) ), $this->api_endpoint_plugin_xml );
+ $response = $this->api_remote_get( $url );
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugins = wp_remote_retrieve_body( $response );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // TODO: validate XML response.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,23 +102,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wporg_plugin_api_json() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $url = add_query_arg( 'fields', implode( ',' , array_keys( $this->fields ) ), 'http://api.wordpress.org/plugins/info/1.0/jetpack.json' );
- $response = wp_remote_get( $url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = add_query_arg( 'fields', implode( ',' , array_keys( $this->fields ) ), $this->api_endpoint_plugin_json );
+ $response = $this->api_remote_get( $url );
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugins = (object) json_decode( wp_remote_retrieve_body( $response ), true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_check_response_attributes( $plugins );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wporg_plugin_api_1_1_json() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = wp_remote_post( 'http://api.wordpress.org/plugins/info/1.1/', array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $response = wp_remote_post( $this->api_endpoint_1_1, array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'timeout' => 15,
</span><span class="cx" style="display: block; padding: 0 10px"> 'body' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'action' => 'plugin_information',
</span><span class="cx" style="display: block; padding: 0 10px"> 'request' => (object) array( 'slug' => 'jetpack', 'fields' => $this->fields ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'headers' => array( 'Host', 'api.wordpress.org' ),
+
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugins = (object) json_decode( wp_remote_retrieve_body( $response ), true );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->_check_response_attributes( $plugins );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,7 +181,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_plugins_api_function_action_query_plugins_installed_plugins() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $plugins = plugins_api( 'query_plugins', array( 'installed_plugins' => array( 'jetpack' ), 'fields' => $this->fields ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $plugins = plugins_api( 'query_plugins', array( 'browse' => 'recommended', 'installed_plugins' => array( 'jetpack' ), 'fields' => $this->fields ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->_check_response_plugin_query( $plugins, 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -198,8 +237,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertObjectHasAttribute( 'contributors', $plugin_info, 'Contributors exists' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertAttributeInternalType( 'array', 'contributors', $plugin_info, 'Contributors should be an array' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertObjectHasAttribute( 'requires', $plugin_info, 'Requires exists' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertObjectHasAttribute( 'tested', $plugin_info, 'Tested exists' );
- $this->assertAttributeInternalType( 'string', 'tested', $plugin_info, 'Tested should be a string' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $this->require_tested_value || isset( $plugin_info->tested ) ) {
+ $this->assertObjectHasAttribute( 'tested', $plugin_info, 'Tested exists' );
+ $this->assertAttributeInternalType( 'string', 'tested', $plugin_info, 'Tested should be a string' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertObjectHasAttribute( 'compatibility', $plugin_info, 'Compatibility exists' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertAttributeInternalType( 'array', 'compatibility', $plugin_info, 'Compatibility should be an array' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,7 +265,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertAttributeInternalType( 'string', 'last_updated', $plugin_info, 'Last Updated should be a string' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertObjectHasAttribute( 'added', $plugin_info, 'Added exists' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertAttributeInternalType( 'string', 'short_description', $plugin_info, 'Added should be a string' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'date_create_from_format' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $last_updated_date = DateTime::createFromFormat( 'Y-m-d g:ia \G\M\T', $plugin_info->last_updated );
</span><span class="cx" style="display: block; padding: 0 10px"> $date_time_errors = DateTime::getLastErrors();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -269,3 +309,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertAttributeInternalType( 'array', 'icons', $plugin_info, 'Icons should be an array' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ *
+ * @group plugins-api
+ */
+
+class Tests_Plugins_API_Old extends Tests_Plugins_API {
+ public $user_agent = 'WordPress/4.7'; // Tell the API to use the old back-end
+ public $require_tested_value = false; // Old API omits 'tested' if its value is empty
+
+
+}
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>