3 * Performs fuzz-style testing of MediaWiki's preprocessor.
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.
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.
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
21 * @ingroup Maintenance
24 use MediaWiki\MediaWikiServices
;
26 $optionsWithoutArgs = [ 'verbose' ];
27 require_once __DIR__
. '/commandLine.inc';
29 $wgHooks['BeforeParserFetchTemplateAndtitle'][] = 'PPFuzzTester::templateHook';
33 '[[', ']]', '{{', '{{', '}}', '}}', '{{{', '}}}',
34 '<', '>', '<nowiki', '<gallery', '</nowiki>', '</gallery>', '<nOwIkI>', '</NoWiKi>',
37 '|', '=', "\n", ' ', "\t", "\x7f",
38 '~~', '~~~', '~~~~', 'subst:',
39 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j',
40 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't',
43 // '<ref>', '</ref>', '<references/>',
45 public $minLength = 0;
46 public $maxLength = 20;
47 public $maxTemplates = 5;
48 // public $outputTypes = [ 'OT_HTML', 'OT_WIKI', 'OT_PREPROCESS' ];
49 public $entryPoints = [ 'testSrvus', 'testPst', 'testPreprocess' ];
50 public $verbose = false;
53 * @var bool|PPFuzzTest
55 private static $currentTest = false;
58 if ( !file_exists( 'results' ) ) {
61 if ( !is_dir( 'results' ) ) {
62 echo "Unable to create 'results' directory\n";
65 $overallStart = microtime( true );
66 $reportInterval = 1000;
67 for ( $i = 1; true; $i++
) {
68 $t = -microtime( true );
70 self
::$currentTest = new PPFuzzTest( $this );
71 self
::$currentTest->execute();
73 } catch ( Exception
$e ) {
74 $testReport = self
::$currentTest->getReport();
75 $exceptionReport = $e instanceof MWException ?
$e->getText() : (string)$e;
76 $hash = md5( $testReport );
77 file_put_contents( "results/ppft-$hash.in", serialize( self
::$currentTest ) );
78 file_put_contents( "results/ppft-$hash.fail",
79 "Input:\n$testReport\n\nException report:\n$exceptionReport\n" );
80 print "Test $hash failed\n";
83 $t +
= microtime( true );
85 if ( $this->verbose
) {
86 printf( "Test $passed in %.3f seconds\n", $t );
87 print self
::$currentTest->getReport();
90 $reportMetric = ( microtime( true ) - $overallStart ) / $i * $reportInterval;
91 if ( $reportMetric > 25 ) {
92 if ( substr( $reportInterval, 0, 1 ) === '1' ) {
97 } elseif ( $reportMetric < 4 ) {
98 if ( substr( $reportInterval, 0, 1 ) === '1' ) {
101 $reportInterval *= 2;
104 if ( $i %
$reportInterval == 0 ) {
105 print "$i tests done\n";
107 $testReport = self::$currentTest->getReport();
108 $filename = 'results/ppft-' . md5( $testReport ) . '.pass';
109 file_put_contents( $filename, "Input:\n$testReport\n" );*/
114 function makeInputText( $max = false ) {
115 if ( $max === false ) {
116 $max = $this->maxLength
;
118 $length = mt_rand( $this->minLength
, $max );
120 for ( $i = 0; $i < $length; $i++
) {
121 $hairIndex = mt_rand( 0, count( $this->hairs
) - 1 );
122 $s .= $this->hairs
[$hairIndex];
124 // Send through the UTF-8 normaliser
125 // This resolves a few differences between the old preprocessor and the
126 // XML-based one, which doesn't like illegals and converts line endings.
127 // It's done by the MW UI, so it's a reasonably legitimate thing to do.
128 $s = MediaWikiServices
::getInstance()->getContentLanguage()->normalize( $s );
133 function makeTitle() {
134 return Title
::newFromText( mt_rand( 0, 1000000 ), mt_rand( 0, 10 ) );
138 function pickOutputType() {
139 $count = count( $this->outputTypes );
140 return $this->outputTypes[ mt_rand( 0, $count - 1 ) ];
143 function pickEntryPoint() {
144 $count = count( $this->entryPoints
);
146 return $this->entryPoints
[mt_rand( 0, $count - 1 )];
151 public $templates, $mainText, $title, $entryPoint, $output;
154 * @param PPFuzzTester $tester
156 function __construct( $tester ) {
157 global $wgMaxSigChars;
158 $this->parent
= $tester;
159 $this->mainText
= $tester->makeInputText();
160 $this->title
= $tester->makeTitle();
161 // $this->outputType = $tester->pickOutputType();
162 $this->entryPoint
= $tester->pickEntryPoint();
163 $this->nickname
= $tester->makeInputText( $wgMaxSigChars +
10 );
164 $this->fancySig
= (bool)mt_rand( 0, 1 );
165 $this->templates
= [];
169 * @param Title $title
172 function templateHook( $title ) {
173 $titleText = $title->getPrefixedDBkey();
175 if ( !isset( $this->templates
[$titleText] ) ) {
176 $finalTitle = $title;
177 if ( count( $this->templates
) >= $this->parent
->maxTemplates
) {
178 // Too many templates
181 if ( !mt_rand( 0, 1 ) ) {
183 $finalTitle = $this->parent
->makeTitle();
185 if ( !mt_rand( 0, 5 ) ) {
189 $text = $this->parent
->makeInputText();
192 $this->templates
[$titleText] = [
194 'finalTitle' => $finalTitle ];
197 return $this->templates
[$titleText];
203 $wgUser = new PPFuzzUser
;
204 $wgUser->mName
= 'Fuzz';
205 $wgUser->mFrom
= 'name';
206 $wgUser->ppfz_test
= $this;
208 $options = ParserOptions
::newFromUser( $wgUser );
209 $options->setTemplateCallback( [ $this, 'templateHook' ] );
210 $options->setTimestamp( wfTimestampNow() );
211 $this->output
= call_user_func(
212 [ MediaWikiServices
::getInstance()->getParser(), $this->entryPoint
],
218 return $this->output
;
221 function getReport() {
222 $s = "Title: " . $this->title
->getPrefixedDBkey() . "\n" .
223 // "Output type: {$this->outputType}\n" .
224 "Entry point: {$this->entryPoint}\n" .
225 "User: " . ( $this->fancySig ?
'fancy' : 'no-fancy' ) .
226 ' ' . var_export( $this->nickname
, true ) . "\n" .
227 "Main text: " . var_export( $this->mainText
, true ) . "\n";
228 foreach ( $this->templates
as $titleText => $template ) {
229 $finalTitle = $template['finalTitle'];
230 if ( $finalTitle != $titleText ) {
231 $s .= "[[$titleText]] -> [[$finalTitle]]: " . var_export( $template['text'], true ) . "\n";
233 $s .= "[[$titleText]]: " . var_export( $template['text'], true ) . "\n";
236 $s .= "Output: " . var_export( $this->output
, true ) . "\n";
242 class PPFuzzUser
extends User
{
243 public $ppfz_test, $mDataLoaded;
245 function load( $flags = null ) {
246 if ( $this->mDataLoaded
) {
249 $this->mDataLoaded
= true;
250 $this->loadDefaults( $this->mName
);
253 function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
254 if ( $oname === 'fancysig' ) {
255 return $this->ppfz_test
->fancySig
;
256 } elseif ( $oname === 'nickname' ) {
257 return $this->ppfz_test
->nickname
;
259 return parent
::getOption( $oname, $defaultOverride, $ignoreHidden );
264 ini_set( 'memory_limit', '50M' );
265 if ( isset( $args[0] ) ) {
266 $testText = file_get_contents( $args[0] );
268 print "File not found\n";
271 $test = unserialize( $testText );
272 $result = $test->execute();
273 print "Test passed.\n";
275 $tester = new PPFuzzTester
;
276 $tester->verbose
= isset( $options['verbose'] );