tests/phpunit/includes/site/DBSiteStoreTest.php

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