tests/phpunit/maintenance/PageDumpTestDataTrait.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\Maintenance;
   4
   5 use Exception;
   6 use MediaWiki\Content\WikitextContent;
   7 use MediaWiki\Context\DerivativeContext;
   8 use MediaWiki\Context\RequestContext;
   9 use MediaWiki\MainConfigNames;
  10 use MediaWiki\Revision\RevisionRecord;
  11 use MediaWiki\Revision\SlotRecord;
  12 use MediaWiki\Title\Title;
  13 use MediaWiki\User\User;
  14 use RevisionDeleter;
  15 use RuntimeException;
  16 use Wikimedia\Rdbms\IDatabase;
  17
  18 /**
  19  * Trait for creating a know set of test pages in the database,
  20  * corresponding to the XML data files in tests/phpunit/data/dumps,
  21  * to be used used with DumpAsserter::assertDOM().
  22  */
  23 trait PageDumpTestDataTrait {
  24
  25         // We'll add several pages, revision and texts. The following variables hold the
  26         // corresponding ids.
  27
  28         // phpcs:ignore MediaWiki.Commenting.PropertyDocumentation.WrongStyle
  29         private int $pageId1;
  30         private int $pageId2;
  31         private int $pageId3;
  32         private int $pageId4;
  33         private int $pageId5;
  34
  35         private Title $pageTitle1;
  36         private Title $pageTitle2;
  37         private Title $pageTitle3;
  38         private Title $pageTitle4;
  39         private Title $pageTitle5;
  40
  41         /** @var int */
  42         private static $numOfPages = 4;
  43         /** @var int */
  44         private static $numOfRevs = 8;
  45
  46         private RevisionRecord $rev1_1;
  47         private RevisionRecord $rev2_1;
  48         private RevisionRecord $rev2_2;
  49         private RevisionRecord $rev2_3;
  50         private RevisionRecord $rev2_4;
  51         private RevisionRecord $rev3_1;
  52         private RevisionRecord $rev3_2;
  53         private RevisionRecord $rev4_1;
  54         private RevisionRecord $rev5_1;
  55
  56         private int $namespace;
  57         private int $talk_namespace;
  58
  59         protected function addTestPages( User $sysopUser ) {
  60                 // be sure, titles created here using english namespace names
  61                 $this->setContentLang( 'en' );
  62
  63                 try {
  64                         $this->namespace = $this->getDefaultWikitextNS();
  65                         $this->talk_namespace = NS_TALK;
  66
  67                         if ( $this->namespace === $this->talk_namespace ) {
  68                                 // @todo work around this.
  69                                 throw new RuntimeException( "The default wikitext namespace is the talk namespace. "
  70                                         . " We can't currently deal with that." );
  71                         }
  72
  73                         $wikiPageFactory = $this->getServiceContainer()->getWikiPageFactory();
  74                         $this->pageTitle1 = Title::makeTitle( $this->namespace, 'BackupDumperTestP1' );
  75                         $page = $wikiPageFactory->newFromTitle( $this->pageTitle1 );
  76                         $this->rev1_1 = $this->addMultiSlotRevision(
  77                                 $page,
  78                                 [
  79                                         SlotRecord::MAIN => new WikitextContent( 'BackupDumperTestP1Text1' ),
  80                                         'aux' => new WikitextContent( 'BackupDumperTestP1Text1/aux' ),
  81                                 ],
  82                                 "BackupDumperTestP1Summary1"
  83                         );
  84                         $this->pageId1 = $page->getId();
  85
  86                         $this->pageTitle2 = Title::makeTitle( $this->namespace, 'BackupDumperTestP2' );
  87                         $page = $wikiPageFactory->newFromTitle( $this->pageTitle2 );
  88                         [ , , $this->rev2_1 ] = $this->addRevision( $page,
  89                                 "BackupDumperTestP2Text1", "BackupDumperTestP2Summary1" );
  90                         [ , , $this->rev2_2 ] = $this->addRevision( $page,
  91                                 "BackupDumperTestP2Text2", "BackupDumperTestP2Summary2" );
  92                         [ , , $this->rev2_3 ] = $this->addRevision( $page,
  93                                 "BackupDumperTestP2Text3", "BackupDumperTestP2Summary3" );
  94                         [ , , $this->rev2_4 ] = $this->addRevision( $page,
  95                                 "BackupDumperTestP2Text4 some additional Text  ",
  96                                 "BackupDumperTestP2Summary4 extra " );
  97                         $this->pageId2 = $page->getId();
  98
  99                         $context = new DerivativeContext( RequestContext::getMain() );
 100                         $context->setUser( $sysopUser );
 101
 102                         $revDel = RevisionDeleter::createList(
 103                                 'revision',
 104                                 $context,
 105                                 $this->pageTitle2,
 106                                 [ $this->rev2_2->getId() ]
 107                         );
 108                         $revDel->setVisibility( [
 109                                 'value' => [ RevisionRecord::DELETED_TEXT => 1 ],
 110                                 'comment' => 'testing!'
 111                         ] );
 112
 113                         // re-load from database, with correct deletion status
 114                         $this->rev2_2 = $this->getServiceContainer()->getRevisionLookup()->getRevisionById(
 115                                 $this->rev2_2->getId()
 116                         );
 117
 118                         $this->pageTitle3 = Title::makeTitle( $this->namespace, 'BackupDumperTestP3' );
 119                         $page = $wikiPageFactory->newFromTitle( $this->pageTitle3 );
 120                         [ , , $this->rev3_1 ] = $this->addRevision( $page,
 121                                 "BackupDumperTestP3Text1", "BackupDumperTestP2Summary1" );
 122                         [ , , $this->rev3_2 ] = $this->addRevision( $page,
 123                                 "BackupDumperTestP3Text2", "BackupDumperTestP2Summary2" );
 124                         $this->pageId3 = $page->getId();
 125                         $this->getServiceContainer()->getDeletePageFactory()
 126                                 ->newDeletePage( $page, $context->getAuthority() )
 127                                 ->deleteUnsafe( "Testing" );
 128
 129                         $this->pageTitle4 = Title::makeTitle( $this->talk_namespace, 'BackupDumperTestP1' );
 130                         $page = $wikiPageFactory->newFromTitle( $this->pageTitle4 );
 131                         [ , , $this->rev4_1 ] = $this->addRevision( $page,
 132                                 "Talk about BackupDumperTestP1 Text1",
 133                                 "Talk BackupDumperTestP1 Summary1" );
 134                         $this->pageId4 = $page->getId();
 135
 136                         $this->pageTitle5 = Title::makeTitle( NS_MAIN, 'BackupDumperTestP5' );
 137                         $page = $wikiPageFactory->newFromTitle( $this->pageTitle5 );
 138                         [ , , $this->rev5_1 ] = $this->addRevision( $page,
 139                                 "BackupDumperTestP5 Text1",
 140                                 "BackupDumperTestP5 Summary1" );
 141                         $this->pageId5 = $page->getId();
 142
 143                         $this->rev5_1 = $this->corruptRevisionData( $this->getDb(), $this->rev5_1 );
 144                 } catch ( Exception $e ) {
 145                         // We'd love to pass $e directly. However, ... see
 146                         // documentation of exceptionFromAddDBData in
 147                         // DumpTestCase
 148                         $this->exceptionFromAddDBData = $e;
 149                 }
 150
 151                 // Since we will restrict dumping by page ranges (to allow
 152                 // working tests, even if the db gets prepopulated by a base
 153                 // class), we have to assert, that the page id are consecutively
 154                 // increasing
 155                 $this->assertEquals(
 156                         [ $this->pageId1 + 1, $this->pageId1 + 2, $this->pageId1 + 3 ],
 157                         [ $this->pageId2, $this->pageId3, $this->pageId4 ],
 158                         "Page ids increasing without holes" );
 159         }
 160
 161         /**
 162          * @param string $name
 163          * @param string $schemaVersion
 164          *
 165          * @return string path of the dump file
 166          */
 167         protected function getDumpTemplatePath( $name, $schemaVersion ) {
 168                 return __DIR__ . "/../data/dumps/$name.$schemaVersion.xml";
 169         }
 170
 171         /**
 172          * Corrupt the information about the given revision in the database.
 173          *
 174          * @param IDatabase $db
 175          * @param RevisionRecord $revision
 176          *
 177          * @return RevisionRecord
 178          */
 179         protected function corruptRevisionData( IDatabase $db, RevisionRecord $revision ) {
 180                 $db->newUpdateQueryBuilder()
 181                         ->update( 'content' )
 182                         ->set( [ 'content_address' => 'tt:0' ] )
 183                         ->where( [ 'content_id' => $revision->getSlot( SlotRecord::MAIN )->getContentId() ] )
 184                         ->execute();
 185
 186                 $revision = $this->getServiceContainer()->getRevisionLookup()->getRevisionById(
 187                         $revision->getId()
 188                 );
 189                 return $revision;
 190         }
 191
 192         /**
 193          * Register variables for use with DumpAsserter::assertDOM().
 194          *
 195          * @param string $prefix
 196          * @param RevisionRecord $rev
 197          * @param DumpAsserter $asserter
 198          */
 199         protected function setRevisionVarMappings( $prefix, RevisionRecord $rev, DumpAsserter $asserter ) {
 200                 $ts = wfTimestamp( TS_ISO_8601, $rev->getTimestamp() );
 201                 $title = $this->getServiceContainer()->getTitleFormatter()->getPrefixedText(
 202                         $rev->getPageAsLinkTarget()
 203                 );
 204
 205                 $asserter->setVarMapping( $prefix . 'pageid', $rev->getPageId() );
 206                 $asserter->setVarMapping( $prefix . 'title', $title );
 207                 $asserter->setVarMapping( $prefix . 'namespace', $rev->getPageAsLinkTarget()->getNamespace() );
 208
 209                 $asserter->setVarMapping( $prefix . 'id', $rev->getId() );
 210                 $asserter->setVarMapping( $prefix . 'parentid', $rev->getParentId() );
 211                 $asserter->setVarMapping( $prefix . 'timestamp', $ts );
 212                 $asserter->setVarMapping( $prefix . 'sha1', $rev->getSha1() );
 213                 $asserter->setVarMapping( $prefix . 'username', $rev->getUser()->getName() );
 214                 $asserter->setVarMapping( $prefix . 'userid', $rev->getUser()->getId() );
 215                 $asserter->setVarMapping( $prefix . 'comment', $rev->getComment()->text );
 216
 217                 foreach ( $rev->getSlotRoles() as $role ) {
 218                         $slot = $rev->getSlot( $role );
 219
 220                         $asserter->setVarMapping( $prefix . $role . '_textid', $this->getSlotTextId( $slot ) );
 221                         $asserter->setVarMapping( $prefix . $role . '_location', $slot->getAddress() );
 222                         $asserter->setVarMapping( $prefix . $role . '_text', $this->getSlotText( $slot ) );
 223                         $asserter->setVarMapping( $prefix . $role . '_size', $slot->getSize() );
 224                         $asserter->setVarMapping( $prefix . $role . '_sha1', $slot->getSha1() );
 225                         $asserter->setVarMapping( $prefix . $role . '_origin', $slot->getOrigin() );
 226                         $asserter->setVarMapping( $prefix . $role . '_model', $slot->getModel() );
 227                         $asserter->setVarMapping( $prefix . $role . '_format', $this->getSlotFormat( $slot ) );
 228                         $asserter->setVarMapping( $prefix . $role . '_role', $slot->getRole() );
 229                 }
 230         }
 231
 232         /**
 233          * Register variables for use with DumpAsserter::assertDOM().
 234          *
 235          * @param DumpAsserter $asserter
 236          */
 237         protected function setCurrentRevisionsVarMappings( DumpAsserter $asserter ) {
 238                 $this->setRevisionVarMappings( 'rev1_1_', $this->rev1_1, $asserter );
 239                 $this->setRevisionVarMappings( 'rev2_4_', $this->rev2_4, $asserter );
 240                 // skip page 3, since it's deleted
 241                 $this->setRevisionVarMappings( 'rev4_1_', $this->rev4_1, $asserter );
 242                 $this->setRevisionVarMappings( 'rev5_1_', $this->rev5_1, $asserter );
 243         }
 244
 245         /**
 246          * Register variables for use with DumpAsserter::assertDOM().
 247          *
 248          * @param DumpAsserter $asserter
 249          */
 250         protected function setAllRevisionsVarMappings( DumpAsserter $asserter ) {
 251                 $this->setRevisionVarMappings( 'rev1_1_', $this->rev1_1, $asserter );
 252                 $this->setRevisionVarMappings( 'rev2_1_', $this->rev2_1, $asserter );
 253                 $this->setRevisionVarMappings( 'rev2_2_', $this->rev2_2, $asserter );
 254                 $this->setRevisionVarMappings( 'rev2_3_', $this->rev2_3, $asserter );
 255                 $this->setRevisionVarMappings( 'rev2_4_', $this->rev2_4, $asserter );
 256                 // skip page 3, since it's deleted
 257                 $this->setRevisionVarMappings( 'rev4_1_', $this->rev4_1, $asserter );
 258                 $this->setRevisionVarMappings( 'rev5_1_', $this->rev5_1, $asserter );
 259         }
 260
 261         private function setSiteVarMappings( DumpAsserter $asserter ) {
 262                 $config = $this->getServiceContainer()->getMainConfig();
 263
 264                 $asserter->setVarMapping( 'mw_version', MW_VERSION );
 265                 $asserter->setVarMapping( 'schema_version', $asserter->getSchemaVersion() );
 266
 267                 $asserter->setVarMapping( 'site_name', $config->get( MainConfigNames::Sitename ) );
 268                 $asserter->setVarMapping(
 269                         'project_namespace',
 270                         $this->getServiceContainer()->getTitleFormatter()->getNamespaceName(
 271                                 NS_PROJECT,
 272                                 'Dummy'
 273                         )
 274                 );
 275                 $asserter->setVarMapping( 'site_db', $config->get( MainConfigNames::DBname ) );
 276                 $asserter->setVarMapping(
 277                         'site_case',
 278                         $config->get( MainConfigNames::CapitalLinks ) ? 'first-letter' : 'case-sensitive'
 279                 );
 280                 $asserter->setVarMapping(
 281                         'site_base',
 282                         Title::newMainPage()->getCanonicalURL()
 283                 );
 284                 $asserter->setVarMapping(
 285                         'site_language',
 286                         $this->getServiceContainer()->getContentLanguage()->getHtmlCode()
 287                 );
 288         }
 289 }