tests/phpunit/includes/site/DBSiteStoreTest.php

   1 <?php
   2
   3 /**
   4  * Tests for the DBSiteStore class.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @since 1.21
  23  *
  24  * @ingroup Site
  25  * @ingroup Test
  26  *
  27  * @group Site
  28  * @group Database
  29  *
  30  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  31  */
  32 class DBSiteStoreTest extends MediaWikiTestCase {
  33
  34         /**
  35          * @return DBSiteStore
  36          */
  37         private function newDBSiteStore() {
  38                 // NOTE: Use the real DB load balancer for now. Eventually, the test framework should
  39                 // provide a LoadBalancer that is safe to use in unit tests.
  40                 return new DBSiteStore( wfGetLB() );
  41         }
  42
  43         /**
  44          * @covers DBSiteStore::getSites
  45          */
  46         public function testGetSites() {
  47                 $expectedSites = TestSites::getSites();
  48                 TestSites::insertIntoDb();
  49
  50                 $store = $this->newDBSiteStore();
  51
  52                 $sites = $store->getSites();
  53
  54                 $this->assertInstanceOf( 'SiteList', $sites );
  55
  56                 /**
  57                  * @var Site $site
  58                  */
  59                 foreach ( $sites as $site ) {
  60                         $this->assertInstanceOf( 'Site', $site );
  61                 }
  62
  63                 foreach ( $expectedSites as $site ) {
  64                         if ( $site->getGlobalId() !== null ) {
  65                                 $this->assertTrue( $sites->hasSite( $site->getGlobalId() ) );
  66                         }
  67                 }
  68         }
  69
  70         /**
  71          * @covers DBSiteStore::getSites
  72          * @covers DBSiteStore::setLanguageCodeMapping
  73          */
  74         public function testLanguageCodeMapping() {
  75                 TestSites::insertIntoDb();
  76
  77                 $store = $this->newDBSiteStore();
  78                 $store->setLanguageCodeMapping( [ 'no' => 'nb' ] );
  79
  80                 $site = $store->getSite( 'nowiki' );
  81                 $this->assertEquals( $site->getLanguageCode(), 'nb' );
  82         }
  83
  84         /**
  85          * @covers DBSiteStore::saveSites
  86          */
  87         public function testSaveSites() {
  88                 $store = $this->newDBSiteStore();
  89
  90                 $sites = [];
  91
  92                 $site = new Site();
  93                 $site->setGlobalId( 'ertrywuutr' );
  94                 $site->setLanguageCode( 'en' );
  95                 $sites[] = $site;
  96
  97                 $site = new MediaWikiSite();
  98                 $site->setGlobalId( 'sdfhxujgkfpth' );
  99                 $site->setLanguageCode( 'nl' );
 100                 $sites[] = $site;
 101
 102                 $this->assertTrue( $store->saveSites( $sites ) );
 103
 104                 $site = $store->getSite( 'ertrywuutr' );
 105                 $this->assertInstanceOf( 'Site', $site );
 106                 $this->assertEquals( 'en', $site->getLanguageCode() );
 107                 $this->assertTrue( is_integer( $site->getInternalId() ) );
 108                 $this->assertTrue( $site->getInternalId() >= 0 );
 109
 110                 $site = $store->getSite( 'sdfhxujgkfpth' );
 111                 $this->assertInstanceOf( 'Site', $site );
 112                 $this->assertEquals( 'nl', $site->getLanguageCode() );
 113                 $this->assertTrue( is_integer( $site->getInternalId() ) );
 114                 $this->assertTrue( $site->getInternalId() >= 0 );
 115         }
 116
 117         /**
 118          * @covers DBSiteStore::reset
 119          */
 120         public function testReset() {
 121                 $store1 = $this->newDBSiteStore();
 122                 $store2 = $this->newDBSiteStore();
 123
 124                 // initialize internal cache
 125                 $this->assertGreaterThan( 0, $store1->getSites()->count() );
 126                 $this->assertGreaterThan( 0, $store2->getSites()->count() );
 127
 128                 // Clear actual data. Will purge the external cache and reset the internal
 129                 // cache in $store1, but not the internal cache in store2.
 130                 $this->assertTrue( $store1->clear() );
 131
 132                 // sanity check: $store2 should have a stale cache now
 133                 $this->assertNotNull( $store2->getSite( 'enwiki' ) );
 134
 135                 // purge cache
 136                 $store2->reset();
 137
 138                 // ...now the internal cache of $store2 should be updated and thus empty.
 139                 $site = $store2->getSite( 'enwiki' );
 140                 $this->assertNull( $site );
 141         }
 142
 143         /**
 144          * @covers DBSiteStore::clear
 145          */
 146         public function testClear() {
 147                 $store = $this->newDBSiteStore();
 148                 $this->assertTrue( $store->clear() );
 149
 150                 $site = $store->getSite( 'enwiki' );
 151                 $this->assertNull( $site );
 152
 153                 $sites = $store->getSites();
 154                 $this->assertEquals( 0, $sites->count() );
 155         }
 156
 157         /**
 158          * @covers DBSiteStore::getSites
 159          */
 160         public function testGetSitesDefaultOrder() {
 161                 $store = $this->newDBSiteStore();
 162                 $siteB = new Site();
 163                 $siteB->setGlobalId( 'B' );
 164                 $siteA = new Site();
 165                 $siteA->setGlobalId( 'A' );
 166                 $store->saveSites( [ $siteB, $siteA ] );
 167
 168                 $sites = $store->getSites();
 169                 $siteIdentifiers = [];
 170                 /** @var Site $site */
 171                 foreach ( $sites as $site ) {
 172                         $siteIdentifiers[] = $site->getGlobalId();
 173                 }
 174                 $this->assertSame( [ 'A', 'B' ], $siteIdentifiers );
 175
 176                 // Note: SiteList::getGlobalIdentifiers uses an other internal state. Iteration must be
 177                 // tested separately.
 178                 $this->assertSame( [ 'A', 'B' ], $sites->getGlobalIdentifiers() );
 179         }
 180 }