b99dcc23bc
Why: - ParsoidRenderID::newFromKey() validates incoming keys and throws an InvalidArgumentException if a required key component was missing. - It does so by eagerly destructuring the return value of explode(), which causes a PHP Notice for invalid inputs as the expected offsets won't exist then. What: - Check the count of key parts before destructuring. - Add unit tests. Bug: T385567 Change-Id: I1d936ae038f85ffa2e5d1d3d8a75fdc75e4c8ef8 (cherry picked from commit eec130925c081c2da1c475f9a9ce719e6838ca51)
102 lines
2.8 KiB
PHP
102 lines
2.8 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Tests\Unit\Edit;
|
|
|
|
use InvalidArgumentException;
|
|
use MediaWiki\Edit\ParsoidRenderID;
|
|
use MediaWikiUnitTestCase;
|
|
|
|
class ParsoidRenderIdTest extends MediaWikiUnitTestCase {
|
|
|
|
/**
|
|
* @covers \MediaWiki\Edit\ParsoidRenderID
|
|
*/
|
|
public function testConstruction() {
|
|
$renderID = new ParsoidRenderID( 1, '123-abc' );
|
|
$this->assertSame( 1, $renderID->getRevisionID() );
|
|
$this->assertEquals( '123-abc', $renderID->getUniqueID() );
|
|
$this->assertEquals( '1/123-abc', $renderID->__toString() );
|
|
}
|
|
|
|
/**
|
|
* @covers \MediaWiki\Edit\ParsoidRenderID::newFromKey
|
|
*/
|
|
public function testRoundTrip() {
|
|
$renderID = new ParsoidRenderID( 1, '123-abc' );
|
|
$stringRenderID = $renderID->__toString();
|
|
$backToRenderID = $renderID::newFromKey( $stringRenderID );
|
|
$this->assertSame( $stringRenderID, $backToRenderID->__toString() );
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideETags
|
|
*
|
|
* @param string $eTag
|
|
* @param \MediaWiki\Edit\ParsoidRenderID $renderId
|
|
*
|
|
* @covers \MediaWiki\Edit\ParsoidRenderID::newFromETag
|
|
*/
|
|
public function testNewFromETag( $eTag, $renderId ) {
|
|
$actual = ParsoidRenderID::newFromETag( $eTag );
|
|
$this->assertSame( $renderId->getKey(), $actual->getKey() );
|
|
}
|
|
|
|
public static function provideETags() {
|
|
yield [ '"1/abc/stash"', new ParsoidRenderID( 1, 'abc' ) ];
|
|
yield [ '"1/abc"', new ParsoidRenderID( 1, 'abc' ) ];
|
|
yield [ '"1/abc/stash/stash"', new ParsoidRenderID( 1, 'abc' ) ];
|
|
yield [ 'W/"1/abc"', new ParsoidRenderID( 1, 'abc' ) ];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideBadETags
|
|
*
|
|
* @param string $eTag
|
|
*
|
|
* @covers \MediaWiki\Edit\ParsoidRenderID::newFromETag
|
|
*/
|
|
public function testNewFromBadETag( $eTag ) {
|
|
// make sure it doesn't explode
|
|
$this->assertNull( ParsoidRenderID::newFromETag( $eTag ) );
|
|
}
|
|
|
|
public static function provideBadETags() {
|
|
yield [ '' ];
|
|
yield [ '0' ];
|
|
yield [ '""' ];
|
|
yield [ '"/"' ];
|
|
yield [ '"x/y"' ];
|
|
yield [ '"1/foo"XXX' ];
|
|
yield [ 'XXX"1/foo"' ];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideNewFromKey
|
|
* @covers \MediaWiki\Edit\ParsoidRenderID::newFromKey
|
|
*/
|
|
public function testNewFromKey( string $key, ParsoidRenderID $expected ): void {
|
|
$actual = ParsoidRenderID::newFromKey( $key );
|
|
$this->assertSame( $expected->getKey(), $actual->getKey() );
|
|
}
|
|
|
|
public static function provideNewFromKey(): iterable {
|
|
yield [ '1/abc', new ParsoidRenderID( 1, 'abc' ) ];
|
|
yield [ '2/bar', new ParsoidRenderID( 2, 'bar' ) ];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideBadKeys
|
|
* @covers \MediaWiki\Edit\ParsoidRenderID::newFromKey
|
|
*/
|
|
public function testBadNewFromKey( $key ): void {
|
|
$this->expectException( InvalidArgumentException::class );
|
|
$this->expectExceptionMessage( "Bad key: $key" );
|
|
|
|
ParsoidRenderID::newFromKey( $key );
|
|
}
|
|
|
|
public static function provideBadKeys(): iterable {
|
|
yield [ '' ];
|
|
yield [ '1' ];
|
|
}
|
|
}
|