PortableInfobox/tests/PortableInfoboxRenderServiceHelperTest.php

468 lines
12 KiB
PHP

<?php
use Wikia\PortableInfobox\Helpers\PortableInfoboxRenderServiceHelper;
class PortableInfoboxRenderServiceHelperTest extends WikiaBaseTest {
private $helper;
protected function setUp() {
$this->setupFile = dirname( __FILE__ ) . '/../PortableInfobox.setup.php';
parent::setUp();
$this->helper = new PortableInfoboxRenderServiceHelper();
}
/**
* @desc mocks WikiaFileHelper methods
* @param array $input
* @return \PHPUnit_Framework_MockObject_MockObject
*/
public function createWikiaFileHelperMock( $input ) {
$fileWidth = isset( $input[ 'fileWidth' ] ) ? $input[ 'fileWidth' ] : null;
$fileHeight = isset( $input[ 'fileHeight' ] ) ? $input[ 'fileHeight' ] : null;
$fileMock = $this->getMockBuilder( 'File' )
->setConstructorArgs( [ 'TestFile' ] )
->setMethods( [ 'getWidth', 'getHeight' ] )
->getMock();
$fileMock->expects( $this->any() )
->method( 'getWidth' )
->will( $this->returnValue( $fileWidth ) );
$fileMock->expects( $this->any() )
->method( 'getHeight' )
->will( $this->returnValue( $fileHeight ) );
$this->mockStaticMethod( 'WikiaFileHelper', 'getFileFromTitle', $fileMock );
return $fileMock;
}
private function getThumbnailMock( $thumbnailSizes ) {
$thumbnailWidth = isset( $thumbnailSizes[ 'width' ] ) ? $thumbnailSizes[ 'width' ] : null;
$thumbnailHeight = isset( $thumbnailSizes[ 'height' ] ) ? $thumbnailSizes[ 'height' ] : null;
$thumbnailMock = $this->getMockBuilder( 'ThumbnailImage' )
->setMethods( [ 'getWidth', 'getHeight' ] )
->getMock();
$thumbnailMock->expects( $this->any() )
->method( 'getWidth' )
->will( $this->returnValue( $thumbnailWidth ) );
$thumbnailMock->expects( $this->any() )
->method( 'getHeight' )
->will( $this->returnValue( $thumbnailHeight ) );
return $thumbnailMock;
}
/**
* @param array $input
* @param array $expectedOutput
* @param string $description
* @dataProvider testCreateHorizontalGroupDataDataProvider
*/
public function testCreateHorizontalGroupData( $input, $expectedOutput, $description ) {
$this->assertEquals(
$expectedOutput,
$this->helper->createHorizontalGroupData( $input ),
$description
);
}
public function testCreateHorizontalGroupDataDataProvider() {
return [
[
'input' => [
[
'type' => 'header',
'data' => [
'value' => 'test header'
]
],
[
'type' => 'data',
'data' => [
'label' => 'test label 1',
'value' => 'test value 1'
]
],
[
'type' => 'data',
'data' => [
'label' => 'test label 2',
'value' => 'test value 2'
]
]
],
'output' => [
'header' => 'test header',
'labels' => [ 'test label 1', 'test label 2' ],
'values' => [ 'test value 1', 'test value 2' ],
'renderLabels' => true
],
'description' => 'Horizontal group data with header and two data tags'
],
[
'input' => [
[
'type' => 'data',
'data' => [
'label' => 'test label 1',
'value' => 'test value 1'
]
],
[
'type' => 'data',
'data' => [
'label' => 'test label 2',
'value' => 'test value 2'
]
]
],
'output' => [
'labels' => [ 'test label 1', 'test label 2' ],
'values' => [ 'test value 1', 'test value 2' ],
'renderLabels' => true
],
'description' => 'Horizontal group data without header'
],
[
'input' => [
[
'type' => 'header',
'data' => [
'value' => 'test header'
]
],
[
'type' => 'data',
'data' => [
'label' => '',
'value' => 'test value 1'
]
],
[
'type' => 'data',
'data' => [
'label' => 'test label 2',
'value' => 'test value 2'
]
]
],
'output' => [
'header' => 'test header',
'labels' => [ '', 'test label 2' ],
'values' => [ 'test value 1', 'test value 2' ],
'renderLabels' => true
],
'description' => 'Horizontal group data with empty label'
],
[
'input' => [
[
'type' => 'data',
'data' => [
'label' => '',
'value' => 'test value 1'
]
],
[
'type' => 'data',
'data' => [
'label' => '',
'value' => 'test value 2'
]
]
],
'output' => [
'labels' => [ '', '' ],
'values' => [ 'test value 1', 'test value 2' ],
'renderLabels' => false
],
'description' => 'Horizontal group data without labels'
],
];
}
/**
* @param array $item
* @param array $heroData
* @param boolean $result
* @param string $description
* @param array $mockParams
* @dataProvider testIsValidHeroDataItemDataProvider
*/
public function testIsValidHeroDataItem( $item, $heroData, $result, $description, $mockParams ) {
$this->createWikiaFileHelperMock( $mockParams );
$this->assertEquals(
$result,
$this->helper->isValidHeroDataItem( $item, $heroData ),
$description
);
}
public function testIsValidHeroDataItemDataProvider() {
return [
[
'item' => [
'type' => 'title'
],
'heroData' => [ ],
'result' => true,
'description' => 'First title in infobox',
'mockParams' => [ ]
],
[
'item' => [
'type' => 'title'
],
'heroData' => [
'title' => 'first infobox title'
],
'result' => false,
'description' => 'not first title in infobox',
'mockParams' => [ ]
],
[
'item' => [
'type' => 'image',
'data' => array( null )
],
'heroData' => [ ],
'result' => true,
'description' => 'first image in infobox',
'mockParams' => [
'fileWidth' => 300
]
],
[
'item' => [
'type' => 'image'
],
'heroData' => [
'image' => 'first infobox image'
],
'result' => false,
'description' => 'not first image in infobox',
'mockParams' => [
'fileWidth' => 300
]
],
[
'item' => [
'type' => 'image'
],
'heroData' => [ ],
'result' => false,
'description' => 'too small image',
'mockParams' => [
'fileWidth' => 299
]
]
];
}
/**
* @param string $type
* @param boolean $result
* @param string $description
* @dataProvider testIsTypeSupportedInTemplatesDataProvider
*/
public function testIsTypeSupportedInTemplates( $type, $result, $description ) {
$templates = [
'testType' => 'testType.mustache'
];
$this->assertEquals(
$result,
$this->helper->isTypeSupportedInTemplates( $type, $templates ),
$description
);
}
public function testIsTypeSupportedInTemplatesDataProvider() {
return [
[
'type' => 'testType',
'result' => true,
'description' => 'valid data type'
],
[
'type' => 'invalidTestType',
'result' => false,
'description' => 'invalid data type'
]
];
}
/**
* @param $width
* @param $max
* @param $imageWidth
* @param $imageHeight
* @param $expected
* @dataProvider thumbnailSizesDataProvider
*/
public function testGetThumbnailSizes( $width, $max, $imageWidth, $imageHeight, $expected ) {
$helper = new PortableInfoboxRenderServiceHelper();
$result = $helper->getThumbnailSizes( $width, $max, $imageWidth, $imageHeight );
$this->assertEquals( $expected, $result );
}
public function thumbnailSizesDataProvider() {
return [
[
'preferredWidth' => 270,
'maxHeight' => 500,
'originalWidth' => 270,
'originalHeight' => 250,
'expected' => [ 'width' => 270, 'height' => 250 ]
],
[
'preferredWidth' => 300,
'maxHeight' => 500,
'originalWidth' => 350,
'originalHeight' => 250,
'expected' => [ 'width' => 300, 'height' => 214 ]
],
[
'preferredWidth' => 300,
'maxHeight' => 500,
'originalWidth' => 300,
'originalHeight' => 550,
'expected' => [ 'width' => 273, 'height' => 500 ]
],
[
'preferredWidth' => 200,
'maxHeight' => 500,
'originalWidth' => 300,
'originalHeight' => 400,
'expected' => [ 'width' => 200, 'height' => 267 ]
],
[
'preferredWidth' => 270,
'maxHeight' => 500,
'originalWidth' => 100,
'originalHeight' => 300,
'expected' => [ 'width' => 100, 'height' => 300 ]
],
[
'preferredWidth' => 270,
'maxHeight' => 500,
'originalWidth' => 800,
'originalHeight' => 600,
'expected' => [ 'width' => 270, 'height' => 203 ]
],
];
}
/**
* @param $customWidth
* @param $preferredWidth
* @param $resultDimensions
* @param $thumbnailDimensions
* @param $thumbnail2xDimensions
* @param $originalDimension
* @dataProvider customWidthProvider
*/
public function testCustomWidthLogic( $customWidth, $preferredWidth, $resultDimensions, $thumbnailDimensions, $thumbnail2xDimensions, $originalDimension ) {
$expected = [
'name' => 'test',
'ref' => null,
'thumbnail' => null,
'thumbnail2x' => null,
'key' => '',
'media-type' => 'image',
'mercuryComponentAttrs' => '{"itemContext":"portable-infobox","ref":null}',
'width' => $resultDimensions[ 'width' ],
'height' => $resultDimensions[ 'height' ]
];
$thumb = $this->getMockBuilder( 'ThumbnailImage' )
->disableOriginalConstructor()
->setMethods( [ 'isError', 'getUrl' ] )
->getMock();
$file = $this->getMockBuilder( 'File' )
->disableOriginalConstructor()
->setMethods( [ 'exists', 'transform', 'getWidth', 'getHeight', 'getMediaType' ] )
->getMock();
$file->expects( $this->once() )->method( 'exists' )->will( $this->returnValue( true ) );
$file->expects( $this->once() )->method( 'getWidth' )->will( $this->returnValue( $originalDimension[ 'width' ] ) );
$file->expects( $this->once() )->method( 'getHeight' )->will( $this->returnValue( $originalDimension[ 'height' ] ) );
$file->expects( $this->once() )->method( 'getMediaType' )->will( $this->returnValue( MEDIATYPE_BITMAP ) );
$file->expects( $this->any() )
->method( 'transform' )
->with( $this->logicalOr ( $this->equalTo( $thumbnailDimensions ), $this->equalTo( $thumbnail2xDimensions ) ) )
->will( $this->returnValue( $thumb ) );
$this->mockStaticMethod( 'WikiaFileHelper', 'getFileFromTitle', $file );
$this->mockGlobalFunction( 'wfRunHooks', true );
$globals = new \Wikia\Util\GlobalStateWrapper( [
'wgPortableInfoboxCustomImageWidth' => $customWidth
] );
$helper = new PortableInfoboxRenderServiceHelper();
$result = $globals->wrap( function () use ( $helper, $preferredWidth ) {
return $helper->extendImageData( [ 'name' => 'test' ], $preferredWidth );
} );
$this->assertEquals( $expected, $result );
}
public function customWidthProvider() {
return [
[
'custom' => false,
'preferred' => 300,
'result' => [ 'width' => 300, 'height' => 200 ],
'thumbnail' => [ 'width' => 300, 'height' => 200 ],
'thumbnail2x' => [ 'width' => 600, 'height' => 400 ],
'original' => [ 'width' => 300, 'height' => 200 ]
],
[
'custom' => 400,
'preferred' => 300,
'result' => [ 'width' => 300, 'height' => 200 ],
'thumbnail' => [ 'width' => 300, 'height' => 200 ],
'thumbnail2x' => [ 'width' => 600, 'height' => 400 ],
'original' => [ 'width' => 300, 'height' => 200 ]
],
[
'custom' => 400,
'preferred' => 300,
'result' => [ 'width' => 300, 'height' => 180 ],
'thumbnail' => [ 'width' => 400, 'height' => 240 ],
'thumbnail2x' => [ 'width' => 800, 'height' => 480 ],
'original' => [ 'width' => 500, 'height' => 300 ]
],
[
'custom' => 600,
'preferred' => 300,
'result' => [ 'width' => 300, 'height' => 500 ],
'thumbnail' => [ 'width' => 300, 'height' => 500 ],
'thumbnail2x' => [ 'width' => 600, 'height' => 1000 ],
'original' => [ 'width' => 300, 'height' => 500 ]
],
[
'custom' => 600,
'preferred' => 300,
'result' => [ 'width' => 188, 'height' => 500 ],
'thumbnail' => [ 'width' => 188, 'height' => 500 ],
'thumbnail2x' => [ 'width' => 376, 'height' => 1000 ],
'original' => [ 'width' => 300, 'height' => 800 ]
],
[
'custom' => 600,
'preferred' => 300,
'result' => [ 'width' => 300, 'height' => 375 ],
'thumbnail' => [ 'width' => 600, 'height' => 750 ],
'thumbnail2x' => [ 'width' => 1200, 'height' => 1500 ],
'original' => [ 'width' => 1200, 'height' => 1500 ]
],
];
}
}