wiki.techinc.nl/tests/phpunit/includes/content/JsonContentHandlerIntegrationTest.php
Siddharth VP 3af9036b99 Customise error message for invalid JSON, add hook
When invalid JSON is being saved, change the error message from the
generic "invalid-content-data" to "invalid-json-data" with the specific
error passed as param.

Allow extensions to hook into JSON validation, enabling them to apply
additional validations for specific JSON files such as MediaWiki:*.json
config files. The page identity is passed to the hook.

Bug: T313254
Change-Id: If9590c29ed0b871b03a3db8f13e72ee9cfdd7e2b
2022-08-26 01:22:10 +05:30

105 lines
3.4 KiB
PHP

<?php
use MediaWiki\Content\ValidationParams;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\PageIdentityValue;
class JsonContentHandlerIntegrationTest extends MediaWikiLangTestCase {
public function provideDataAndParserText() {
return [
[
[],
'<table class="mw-json"><tbody><tr><td>' .
'<table class="mw-json"><tbody><tr><td class="mw-json-empty">Empty array</td></tr>'
. '</tbody></table></td></tr></tbody></table>'
],
[
(object)[],
'<table class="mw-json"><tbody><tr><td class="mw-json-empty">Empty object</td></tr>' .
'</tbody></table>'
],
[
(object)[ 'foo' ],
'<table class="mw-json"><tbody><tr><th><span>0</span></th>' .
'<td class="mw-json-value">"foo"</td></tr></tbody></table>'
],
[
(object)[ 'foo', 'bar' ],
'<table class="mw-json"><tbody><tr><th><span>0</span></th>' .
'<td class="mw-json-value">"foo"</td></tr><tr><th><span>1</span></th>' .
'<td class="mw-json-value">"bar"</td></tr></tbody></table>'
],
[
(object)[ 'baz' => 'foo', 'bar' ],
'<table class="mw-json"><tbody><tr><th><span>baz</span></th>' .
'<td class="mw-json-value">"foo"</td></tr><tr><th><span>0</span></th>' .
'<td class="mw-json-value">"bar"</td></tr></tbody></table>'
],
[
(object)[ 'baz' => 1000, 'bar' ],
'<table class="mw-json"><tbody><tr><th><span>baz</span></th>' .
'<td class="mw-json-value">1000</td></tr><tr><th><span>0</span></th>' .
'<td class="mw-json-value">"bar"</td></tr></tbody></table>'
],
[
(object)[ '<script>alert("evil!")</script>' ],
'<table class="mw-json"><tbody><tr><th><span>0</span></th><td class="mw-json-value">"' .
'&lt;script>alert("evil!")&lt;/script>"' .
'</td></tr></tbody></table>',
],
];
}
/**
* @dataProvider provideDataAndParserText
* @covers JsonContentHandler::fillParserOutput
*/
public function testFillParserOutput( $data, $expected ) {
$content = new JsonContent( FormatJson::encode( $data ) );
$contentRenderer = $this->getServiceContainer()->getContentRenderer();
$parserOutput = $contentRenderer->getParserOutput(
$content,
$this->createMock( Title::class ),
null,
null,
true
);
$this->assertInstanceOf( ParserOutput::class, $parserOutput );
$this->assertEquals( $expected, $parserOutput->getText() );
}
/**
* @covers JsonContentHandler::validateSave
*/
public function testValidateSave() {
$handler = new JsonContentHandler();
$validationParams = new ValidationParams(
PageIdentityValue::localIdentity( 123, NS_MEDIAWIKI, 'Config.json' ),
0
);
$validJson = new JsonContent( FormatJson::encode( [ 'test' => 'value' ] ) );
$invalidJson = new JsonContent( '{"key":' );
$this->assertStatusGood( $handler->validateSave( $validJson, $validationParams ) );
$this->assertStatusNotOK( $handler->validateSave( $invalidJson, $validationParams ) );
$this->setTemporaryHook(
'JsonValidateSave',
static function ( JsonContent $content, PageIdentity $pageIdentity, StatusValue $status )
{
if ( $pageIdentity->getDBkey() === 'Config.json' &&
!isset( $content->getData()->getValue()->foo ) ) {
$status->fatal( 'missing-key-foo' );
}
}
);
$this->assertStatusNotOK( $handler->validateSave( $validJson, $validationParams ) );
$this->assertStatusError( 'invalid-json-data',
$handler->validateSave( $invalidJson, $validationParams ) );
$this->assertStatusError( 'missing-key-foo',
$handler->validateSave( $validJson, $validationParams ) );
}
}