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