<!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>[37662] trunk/tests/phpunit/tests/multisite/wpGetSites.php: Tests: User a data provider for `wp_get_sites()` tests.</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/37662">37662</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/37662","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jeremyfelt</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-06-09 00:27:46 +0000 (Thu, 09 Jun 2016)</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'>Tests: User a data provider for `wp_get_sites()` tests.

* Convert existing tests into a data provider and clarify expectations.
* Add shared test fixtures in preparation for future tests.

This passes with the `wp_get_sites()` from 4.5 and the deprecated version in trunk.

See <a href="https://core.trac.wordpress.org/ticket/36566">#36566</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsmultisitewpGetSitesphp">trunk/tests/phpunit/tests/multisite/wpGetSites.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsmultisitewpGetSitesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/multisite/wpGetSites.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/wpGetSites.php        2016-06-09 00:24:56 UTC (rev 37661)
+++ trunk/tests/phpunit/tests/multisite/wpGetSites.php  2016-06-09 00:27:46 UTC (rev 37662)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,113 +7,62 @@
</span><span class="cx" style="display: block; padding: 0 10px">  * @group multisite
</span><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Multisite_WP_Get_Sites extends WP_UnitTestCase {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        protected static $site_ids;
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /**
-        * Test the default arguments for wp_get_sites, which should return only
-        * public sites from the current network.
-        *
-        * @ticket 14511
-        * @expectedDeprecated wp_get_sites
-        */
-       function test_wp_get_sites_with_default_arguments() {
-               self::factory()->blog->create( array( 'site_id' => 2 ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function wpSetUpBeforeClass( $factory ) {
+               self::$site_ids = array(
+                       'w.org/'      => array( 'domain' => 'w.org',  'path' => '/',     'site_id' => 2 ),
+                       'wp.org/'     => array( 'domain' => 'wp.org', 'path' => '/',     'site_id' => 2, 'meta' => array( 'public' => 0 ) ),
+                       'wp.org/foo/' => array( 'domain' => 'wp.org', 'path' => '/foo/', 'site_id' => 1, 'meta' => array( 'public' => 0 ) ),
+                       'wp.org/oof/' => array( 'domain' => 'wp.org', 'path' => '/oof/' ),
+               );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $this->assertCount( 1, wp_get_sites() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         foreach ( self::$site_ids as &$id ) {
+                       $id = $factory->blog->create( $id );
+               }
+               unset( $id );
</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">-        /**
-        * No sites should match a query that specifies an invalid network ID.
-        *
-        * @expectedDeprecated wp_get_sites
-        */
-       function test_wp_get_sites_with_invalid_network_id() {
-               $this->assertcount( 0, wp_get_sites( array( 'network_id' => 999 ) ) );
-       }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function wpTearDownAfterClass() {
+               foreach( self::$site_ids as $id ) {
+                       wpmu_delete_blog( $id, true );
+               }
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /**
-        * A network ID of null should query for all public sites on all networks.
-        *
-        * @expectedDeprecated wp_get_sites
-        */
-       function test_wp_get_sites_with_network_id_null() {
-               self::factory()->blog->create( array( 'site_id' => 2 ) );
-
-               $this->assertCount( 2, wp_get_sites( array( 'network_id' => null ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         wp_update_network_site_counts();
</ins><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">        /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Expect only sites on the specified network ID to be returned.
-        *
</del><span class="cx" style="display: block; padding: 0 10px">          * @expectedDeprecated wp_get_sites
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         */
-       function test_wp_get_sites_with_specific_network_id() {
-               self::factory()->blog->create( array( 'site_id' => 2 ) );
-
-               $this->assertCount( 1, wp_get_sites( array( 'network_id' => 2 ) ) );
-       }
-
-       /**
-        * Expect sites from both networks if both network IDs are specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @dataProvider data_wp_get_sites
</ins><span class="cx" style="display: block; padding: 0 10px">          *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @expectedDeprecated wp_get_sites
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param $expected
+        * @param $args
+        * @param $error
</ins><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_wp_get_sites_with_multiple_network_ids() {
-               self::factory()->blog->create( array( 'site_id' => 2 ) );
-
-               $this->assertCount( 2, wp_get_sites( array( 'network_id' => array( 1, 2 ) ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_wp_get_sites( $expected, $args, $error ) {
+               $this->assertCount( $expected, wp_get_sites( $args ), $error );
</ins><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">        /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Queries for public or non public sites should work across all networks if network ID is null.
-        *
-        * @expectedDeprecated wp_get_sites
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return array
</ins><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_wp_get_sites_with_public_meta_on_all_networks() {
-               self::factory()->blog->create( array( 'site_id' => 2, 'meta' => array( 'public' => 0 ) ) );
-
-               $this->assertCount( 1, wp_get_sites( array( 'public' => 1, 'network_id' => null ) ) );
-               $this->assertcount( 1, wp_get_sites( array( 'public' => 0, 'network_id' => null ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function data_wp_get_sites() {
+               return array(
+                       array( 3, array(), 'Default arguments should return all sites from the current network.' ),
+                       array( 0, array( 'network_id' => 999 ), 'No sites should match a query with an invalid network ID.' ),
+                       array( 5, array( 'network_id' => null ), 'A network ID of null should return all sites on all networks.' ),
+                       array( 2, array( 'network_id' => 2 ), 'Only sites on a specified network ID should be returned.' ),
+                       array( 5, array( 'network_id' => array( 1, 2 ) ), 'If multiple network IDs are specified, sites from both should be returned.' ),
+                       array( 3, array( 'public' => 1, 'network_id' => null ), 'Public sites on all networks.' ),
+                       array( 2, array( 'public' => 0, 'network_id' => null ), 'Non public sites on all networks.' ),
+                       array( 2, array( 'public' => 1, 'network_id' => 1 ), 'Public sites on a single network.' ),
+                       array( 1, array( 'public' => 1, 'network_id' => 2 ), 'Public sites on a second network.' ),
+                       array( 2, array( 'limit' => 2 ), 'Provide only a limit argument.' ),
+                       array( 1, array( 'limit' => 2, 'offset' => 2 ), 'Provide both limit and offset arguments.' ),
+                       array( 2, array( 'offset' => 1 ), 'Provide only an offset argument.' ),
+                       array( 0, array( 'offset' => 20 ), 'Expect 0 sites when using an offset larger than the total number of sites.' ),
+               );
</ins><span class="cx" style="display: block; padding: 0 10px">         }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-       /**
-        * If a network ID is specified, queries for public sites should be restricted to that network.
-        *
-        * @expectedDeprecated wp_get_sites
-        */
-       function test_wp_get_sites_with_public_meta_restrict_to_one_network() {
-               self::factory()->blog->create( array( 'site_id' => 1, 'meta' => array( 'public' => 0 ) ) );
-
-               $this->assertCount( 1, wp_get_sites( array( 'public' => 1, 'network_id' => 1 ) ) );
-               $this->assertCount( 0, wp_get_sites( array( 'public' => 1, 'network_id' => 2 ) ) );
-       }
-
-       /**
-        * Test the limit and offset arguments for wp_get_sites when multiple sites are available.
-        *
-        * @expectedDeprecated wp_get_sites
-        */
-       function test_wp_get_sites_limit_offset() {
-               // Create 2 more sites (in addition to the default one)
-               self::factory()->blog->create_many( 2 );
-
-               // Expect first 2 sites when using limit
-               $this->assertCount( 2, wp_get_sites( array( 'limit' => 2 ) ) );
-
-               // Expect only the last 2 sites when using offset of 1 (limit will default to 100)
-               $this->assertCount( 2, wp_get_sites( array( 'offset' => 1 ) ) );
-
-               // Expect only the last 1 site when using offset of 2 and limit of 2
-               $this->assertCount( 1, wp_get_sites( array( 'limit' => 2, 'offset' => 2 ) ) );
-       }
-
-       /**
-        * Expect 0 sites when using an offset larger than the total number of sites.
-        *
-        * @expectedDeprecated wp_get_sites
-        */
-       function test_wp_get_sites_offset_greater_than_available_sites() {
-               $this->assertCount( 0, wp_get_sites( array( 'offset' => 20 ) ) );
-       }
</del><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"> endif;
</span></span></pre>
</div>
</div>

</body>
</html>