includes/parser/ParserDiffTest.php

   1 <?php
   2 /**
   3  * Fake parser that output the difference of two different parsers
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Parser
  22  */
  23
  24 /**
  25  * @ingroup Parser
  26  */
  27 class ParserDiffTest {
  28         public $parsers;
  29         public $conf;
  30         public $shortOutput = false;
  31
  32         public function __construct( $conf ) {
  33                 if ( !isset( $conf['parsers'] ) ) {
  34                         throw new MWException( __METHOD__ . ': no parsers specified' );
  35                 }
  36                 $this->conf = $conf;
  37         }
  38
  39         public function init() {
  40                 if ( !is_null( $this->parsers ) ) {
  41                         return;
  42                 }
  43                 $this->parsers = [];
  44
  45                 if ( isset( $this->conf['shortOutput'] ) ) {
  46                         $this->shortOutput = $this->conf['shortOutput'];
  47                 }
  48
  49                 foreach ( $this->conf['parsers'] as $i => $parserConf ) {
  50                         if ( !is_array( $parserConf ) ) {
  51                                 $class = $parserConf;
  52                                 $parserConf = [ 'class' => $parserConf ];
  53                         } else {
  54                                 $class = $parserConf['class'];
  55                         }
  56                         $this->parsers[$i] = new $class( $parserConf );
  57                 }
  58         }
  59
  60         public function __call( $name, $args ) {
  61                 $this->init();
  62                 $results = [];
  63                 $mismatch = false;
  64                 $lastResult = null;
  65                 foreach ( $this->parsers as $parser ) {
  66                         $currentResult = $parser->$name( ...$args );
  67                         if ( count( $results ) > 0 ) {
  68                                 if ( is_object( $lastResult ) ) {
  69                                         if ( $lastResult != $currentResult ) {
  70                                                 $mismatch = true;
  71                                         }
  72                                 } else {
  73                                         if ( $lastResult !== $currentResult ) {
  74                                                 $mismatch = true;
  75                                         }
  76                                 }
  77                         }
  78                         $results[] = $currentResult;
  79                         $lastResult = $currentResult;
  80                 }
  81                 if ( $mismatch ) {
  82                         if ( count( $results ) == 2 ) {
  83                                 $resultsList = [];
  84                                 foreach ( $this->parsers as $i => $parser ) {
  85                                         $resultsList[] = var_export( $results[$i], true );
  86                                 }
  87                                 $diff = wfDiff( $resultsList[0], $resultsList[1] );
  88                         } else {
  89                                 $diff = '[too many parsers]';
  90                         }
  91                         $msg = "ParserDiffTest: results mismatch on call to $name\n";
  92                         if ( !$this->shortOutput ) {
  93                                 $msg .= 'Arguments: ' . $this->formatArray( $args ) . "\n";
  94                         }
  95                         $msg .= 'Results: ' . $this->formatArray( $results ) . "\n" .
  96                                 "Diff: $diff\n";
  97                         throw new MWException( $msg );
  98                 }
  99                 return $lastResult;
 100         }
 101
 102         public function formatArray( $array ) {
 103                 if ( $this->shortOutput ) {
 104                         foreach ( $array as $key => $value ) {
 105                                 if ( $value instanceof ParserOutput ) {
 106                                         $array[$key] = "ParserOutput: {$value->getText()}";
 107                                 }
 108                         }
 109                 }
 110                 return var_export( $array, true );
 111         }
 112
 113         public function setFunctionHook( $id, $callback, $flags = 0 ) {
 114                 $this->init();
 115                 foreach ( $this->parsers as $parser ) {
 116                         $parser->setFunctionHook( $id, $callback, $flags );
 117                 }
 118         }
 119 }