tests/phpunit/includes/site/SiteExporterTest.php

   1 <?php
   2
   3 /**
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  * http://www.gnu.org/copyleft/gpl.html
  18  *
  19  * @file
  20  *
  21  * @ingroup Site
  22  * @ingroup Test
  23  *
  24  * @group Site
  25  *
  26  * @covers SiteExporter
  27  *
  28  * @author Daniel Kinzler
  29  */
  30 class SiteExporterTest extends PHPUnit\Framework\TestCase {
  31
  32         use MediaWikiCoversValidator;
  33         use PHPUnit4And6Compat;
  34
  35         public function testConstructor_InvalidArgument() {
  36                 $this->setExpectedException( InvalidArgumentException::class );
  37
  38                 new SiteExporter( 'Foo' );
  39         }
  40
  41         public function testExportSites() {
  42                 $foo = Site::newForType( Site::TYPE_UNKNOWN );
  43                 $foo->setGlobalId( 'Foo' );
  44
  45                 $acme = Site::newForType( Site::TYPE_UNKNOWN );
  46                 $acme->setGlobalId( 'acme.com' );
  47                 $acme->setGroup( 'Test' );
  48                 $acme->addLocalId( Site::ID_INTERWIKI, 'acme' );
  49                 $acme->setPath( Site::PATH_LINK, 'http://acme.com/' );
  50
  51                 $tmp = tmpfile();
  52                 $exporter = new SiteExporter( $tmp );
  53
  54                 $exporter->exportSites( [ $foo, $acme ] );
  55
  56                 fseek( $tmp, 0 );
  57                 $xml = fread( $tmp, 16 * 1024 );
  58
  59                 $this->assertContains( '<sites ', $xml );
  60                 $this->assertContains( '<site>', $xml );
  61                 $this->assertContains( '<globalid>Foo</globalid>', $xml );
  62                 $this->assertContains( '</site>', $xml );
  63                 $this->assertContains( '<globalid>acme.com</globalid>', $xml );
  64                 $this->assertContains( '<group>Test</group>', $xml );
  65                 $this->assertContains( '<localid type="interwiki">acme</localid>', $xml );
  66                 $this->assertContains( '<path type="link">http://acme.com/</path>', $xml );
  67                 $this->assertContains( '</sites>', $xml );
  68
  69                 // NOTE: HHVM (at least on wmf Jenkins) doesn't like file URLs.
  70                 $xsdFile = __DIR__ . '/../../../../docs/sitelist-1.0.xsd';
  71                 $xsdData = file_get_contents( $xsdFile );
  72
  73                 $document = new DOMDocument();
  74                 $document->loadXML( $xml, LIBXML_NONET );
  75                 $document->schemaValidateSource( $xsdData );
  76         }
  77
  78         private function newSiteStore( SiteList $sites ) {
  79                 $store = $this->getMockBuilder( SiteStore::class )->getMock();
  80
  81                 $store->expects( $this->once() )
  82                         ->method( 'saveSites' )
  83                         ->will( $this->returnCallback( function ( $moreSites ) use ( $sites ) {
  84                                 foreach ( $moreSites as $site ) {
  85                                         $sites->setSite( $site );
  86                                 }
  87                         } ) );
  88
  89                 $store->expects( $this->any() )
  90                         ->method( 'getSites' )
  91                         ->will( $this->returnValue( new SiteList() ) );
  92
  93                 return $store;
  94         }
  95
  96         public function provideRoundTrip() {
  97                 $foo = Site::newForType( Site::TYPE_UNKNOWN );
  98                 $foo->setGlobalId( 'Foo' );
  99
 100                 $acme = Site::newForType( Site::TYPE_UNKNOWN );
 101                 $acme->setGlobalId( 'acme.com' );
 102                 $acme->setGroup( 'Test' );
 103                 $acme->addLocalId( Site::ID_INTERWIKI, 'acme' );
 104                 $acme->setPath( Site::PATH_LINK, 'http://acme.com/' );
 105
 106                 $dewiki = Site::newForType( Site::TYPE_MEDIAWIKI );
 107                 $dewiki->setGlobalId( 'dewiki' );
 108                 $dewiki->setGroup( 'wikipedia' );
 109                 $dewiki->setForward( true );
 110                 $dewiki->addLocalId( Site::ID_INTERWIKI, 'wikipedia' );
 111                 $dewiki->addLocalId( Site::ID_EQUIVALENT, 'de' );
 112                 $dewiki->setPath( Site::PATH_LINK, 'http://de.wikipedia.org/w/' );
 113                 $dewiki->setPath( MediaWikiSite::PATH_PAGE, 'http://de.wikipedia.org/wiki/' );
 114                 $dewiki->setSource( 'meta.wikimedia.org' );
 115
 116                 return [
 117                         'empty' => [
 118                                 new SiteList()
 119                         ],
 120
 121                         'some' => [
 122                                 new SiteList( [ $foo, $acme, $dewiki ] ),
 123                         ],
 124                 ];
 125         }
 126
 127         /**
 128          * @dataProvider provideRoundTrip()
 129          */
 130         public function testRoundTrip( SiteList $sites ) {
 131                 $tmp = tmpfile();
 132                 $exporter = new SiteExporter( $tmp );
 133
 134                 $exporter->exportSites( $sites );
 135
 136                 fseek( $tmp, 0 );
 137                 $xml = fread( $tmp, 16 * 1024 );
 138
 139                 $actualSites = new SiteList();
 140                 $store = $this->newSiteStore( $actualSites );
 141
 142                 $importer = new SiteImporter( $store );
 143                 $importer->importFromXML( $xml );
 144
 145                 $this->assertEquals( $sites, $actualSites );
 146         }
 147
 148 }