tests/phpunit/includes/logging/LogFormatterTestCase.php

   1 <?php
   2 use MediaWiki\Linker\LinkTarget;
   3
   4 /**
   5  * @since 1.26
   6  */
   7 abstract class LogFormatterTestCase extends MediaWikiLangTestCase {
   8
   9         public function doTestLogFormatter( $row, $extra, $userGroups = [] ) {
  10                 RequestContext::resetMain();
  11                 $row = $this->expandDatabaseRow( $row, $this->isLegacy( $extra ) );
  12
  13                 $context = new RequestContext();
  14                 $context->setUser( $this->getTestUser( $userGroups )->getUser() );
  15
  16                 $formatter = LogFormatter::newFromRow( $row );
  17                 $formatter->setContext( $context );
  18
  19                 $this->assertEquals(
  20                         $extra['text'],
  21                         self::removeSomeHtml( $formatter->getActionText() ),
  22                         'Action text is equal to expected text'
  23                 );
  24
  25                 $this->assertSame( // ensure types and array key order
  26                         $extra['api'],
  27                         self::removeApiMetaData( $formatter->formatParametersForApi() ),
  28                         'Api log params is equal to expected array'
  29                 );
  30
  31                 if ( isset( $extra['preload'] ) ) {
  32                         $this->assertArrayEquals(
  33                                 $this->getLinkTargetsAsStrings( $extra['preload'] ),
  34                                 $this->getLinkTargetsAsStrings(
  35                                         $formatter->getPreloadTitles()
  36                                 )
  37                         );
  38                 }
  39         }
  40
  41         private function getLinkTargetsAsStrings( array $linkTargets ) {
  42                 return array_map( function ( LinkTarget $t ) {
  43                         return $t->getInterwiki() . ':' . $t->getNamespace() . ':'
  44                                 . $t->getDBkey() . '#' . $t->getFragment();
  45                 }, $linkTargets );
  46         }
  47
  48         protected function isLegacy( $extra ) {
  49                 return isset( $extra['legacy'] ) && $extra['legacy'];
  50         }
  51
  52         protected function expandDatabaseRow( $data, $legacy ) {
  53                 return [
  54                         // no log_id because no insert in database
  55                         'log_type' => $data['type'],
  56                         'log_action' => $data['action'],
  57                         'log_timestamp' => $data['timestamp'] ?? wfTimestampNow(),
  58                         'log_user' => $data['user'] ?? 0,
  59                         'log_user_text' => $data['user_text'] ?? 'User',
  60                         'log_actor' => $data['actor'] ?? 0,
  61                         'log_namespace' => $data['namespace'] ?? NS_MAIN,
  62                         'log_title' => $data['title'] ?? 'Main_Page',
  63                         'log_page' => $data['page'] ?? 0,
  64                         'log_comment_text' => $data['comment'] ?? '',
  65                         'log_comment_data' => null,
  66                         'log_params' => $legacy
  67                                 ? LogPage::makeParamBlob( $data['params'] )
  68                                 : LogEntryBase::makeParamBlob( $data['params'] ),
  69                         'log_deleted' => $data['deleted'] ?? 0,
  70                 ];
  71         }
  72
  73         private static function removeSomeHtml( $html ) {
  74                 $html = str_replace( '&quot;', '"', $html );
  75                 $html = preg_replace( '/\xE2\x80[\x8E\x8F]/', '', $html ); // Strip lrm/rlm
  76                 return trim( strip_tags( $html ) );
  77         }
  78
  79         private static function removeApiMetaData( $val ) {
  80                 if ( is_array( $val ) ) {
  81                         unset( $val['_element'] );
  82                         unset( $val['_type'] );
  83                         foreach ( $val as $key => $value ) {
  84                                 $val[$key] = self::removeApiMetaData( $value );
  85                         }
  86                 }
  87                 return $val;
  88         }
  89 }