diff options
Diffstat (limited to 'plugins/API/tests/Unit/JsonRendererTest.php')
| -rw-r--r-- | plugins/API/tests/Unit/JsonRendererTest.php | 385 |
1 files changed, 385 insertions, 0 deletions
diff --git a/plugins/API/tests/Unit/JsonRendererTest.php b/plugins/API/tests/Unit/JsonRendererTest.php new file mode 100644 index 0000000000..c4fa076483 --- /dev/null +++ b/plugins/API/tests/Unit/JsonRendererTest.php @@ -0,0 +1,385 @@ +<?php +/** + * Piwik - free/libre analytics platform + * + * @link http://piwik.org + * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later + */ + +namespace Piwik\Plugins\API\tests\Unit; + +use Piwik\DataTable; +use Piwik\Plugins\API\Renderer\Json; +use Piwik\Plugins\API\Renderer\Json2; + +/** + * @group Plugin + * @group API + * @group API_JsonRendererTest + */ +class JsonRendererTest extends \PHPUnit_Framework_TestCase +{ + /** + * @var Json + */ + private $jsonBuilder; + + public function setUp() + { + $this->jsonBuilder = $this->makeBuilder(array()); + DataTable\Manager::getInstance()->deleteAll(); + } + + public function test_renderSuccess_shouldIncludeMessage() + { + $response = $this->jsonBuilder->renderSuccess('ok'); + + $this->assertEquals('{"result":"success","message":"ok"}', $response); + $this->assertEquals((array) array('result' => 'success', 'message' => 'ok'), json_decode($response, true)); + $this->assertNoJsonError($response); + } + + public function test_renderSuccess_shouldWrapIfEnabledAndCallbackShouldBePreferred() + { + $builder = $this->makeBuilder(array('callback' => 'myName', 'jsoncallback' => 'myOther')); + $response = $builder->renderSuccess('ok'); + + $this->assertEquals('myName({"result":"success","message":"ok"})', $response); + $this->assertNoJsonError($response); + } + + public function test_renderSuccess_shouldWrapIfEnabledAndFallbackToJsonCallbackIfCallbackNotSet() + { + $builder = $this->makeBuilder(array('jsoncallback' => 'myOther')); + $response = $builder->renderSuccess('ok'); + + $this->assertEquals('myOther({"result":"success","message":"ok"})', $response); + $this->assertNoJsonError($response); + } + + public function test_renderSuccess_shouldNotWrapIfCallbackContainsInvalidCharacters() + { + $builder = $this->makeBuilder(array('callback' => 'myOther#?._kek')); + $response = $builder->renderSuccess('ok'); + + $this->assertEquals('{"result":"success","message":"ok"}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderException_shouldIncludeTheMessageAndNotExceptionMessage() + { + $response = $this->jsonBuilder->renderException("The error message", new \Exception('The other message')); + + $this->assertEquals('{"result":"error","message":"The error message"}', $response); + $this->assertEquals((array) array('result' => 'error', 'message' => 'The error message'), json_decode($response, true)); + $this->assertNoJsonError($response); + } + + public function test_renderException_shouldRemoveWhitespace() + { + $response = $this->jsonBuilder->renderException("The\nerror\r\nmessage", new \Exception()); + + $this->assertEquals('{"result":"error","message":"Theerrormessage"}', $response); + $this->assertEquals((array) array('result' => 'error', 'message' => 'Theerrormessage'), json_decode($response, true)); + $this->assertNoJsonError($response); + } + + public function test_renderException_shouldWrapIfEnabled() + { + $builder = $this->makeBuilder(array('callback' => 'myName')); + $response = $builder->renderException('error', new \Exception()); + + $this->assertEquals('myName({"result":"error","message":"error"})', $response); + $this->assertNoJsonError($response); + } + + public function test_renderObject_shouldReturAnError() + { + $response = $this->jsonBuilder->renderObject(new \stdClass()); + + $this->assertEquals('{"result":"error","message":"The API cannot handle this data structure."}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderResource_shouldReturAnError() + { + $response = $this->jsonBuilder->renderResource(new \stdClass()); + + $this->assertEquals('{"result":"error","message":"The API cannot handle this data structure."}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderScalar_shouldReturnABooleanWrappedInValue() + { + $response = $this->jsonBuilder->renderScalar(true); + + $this->assertEquals('{"value":true}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderScalar_shouldReturnAnIntegerWrappedInValue() + { + $response = $this->jsonBuilder->renderScalar(5); + + $this->assertEquals('{"value":5}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderScalar_shouldReturnAStringWrappedInValue() + { + $response = $this->jsonBuilder->renderScalar('The Output'); + + $this->assertEquals('{"value":"The Output"}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderScalar_shouldNotRemoveLineBreaks() + { + $response = $this->jsonBuilder->renderScalar('The\nOutput'); + + $this->assertEquals('{"value":"The\\\\nOutput"}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderScalar_shouldWrapJsonIfNeeded() + { + $builder = $this->makeBuilder(array('callback' => 'myName')); + $response = $builder->renderScalar(true); + + $this->assertEquals('myName({"value":true})', $response); + $this->assertNoJsonError($response); + } + + public function test_renderDataTable_shouldRenderABasicDataTable() + { + $dataTable = new DataTable(); + $dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => 10)); + + $response = $this->jsonBuilder->renderDataTable($dataTable); + + $this->assertEquals('[{"nb_visits":5,"nb_random":10}]', $response); + $this->assertNoJsonError($response); + } + + public function test_renderDataTable_shouldRenderSubtables() + { + $subtable = new DataTable(); + $subtable->addRowFromSimpleArray(array('nb_visits' => 2, 'nb_random' => 6)); + + $dataTable = new DataTable(); + $dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => 10)); + $dataTable->getFirstRow()->setSubtable($subtable); + + $response = $this->jsonBuilder->renderDataTable($dataTable); + + $this->assertEquals('[{"nb_visits":5,"nb_random":10,"idsubdatatable":1}]', $response); + $this->assertNoJsonError($response); + } + + public function test_renderDataTable_shouldRenderDataTableMaps() + { + $map = new DataTable\Map(); + + $dataTable = new DataTable(); + $dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => 10)); + + $dataTable2 = new DataTable(); + $dataTable2->addRowFromSimpleArray(array('nb_visits' => 3, 'nb_random' => 6)); + + $map->addTable($dataTable, 'table1'); + $map->addTable($dataTable2, 'table2'); + + $response = $this->jsonBuilder->renderDataTable($map); + + $this->assertEquals('{"table1":[{"nb_visits":5,"nb_random":10}],"table2":[{"nb_visits":3,"nb_random":6}]}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderDataTable_shouldRenderSimpleDataTable() + { + $dataTable = new DataTable\Simple(); + $dataTable->addRowsFromArray(array('nb_visits' => 3, 'nb_random' => 6)); + + $response = $this->jsonBuilder->renderDataTable($dataTable); + + $this->assertEquals('{"nb_visits":3,"nb_random":6}', $response); + $this->assertNoJsonError($response); + } + + public function test_renderDataTable_shouldWrapADataTable() + { + $builder = $this->makeBuilder(array('callback' => 'myName')); + $dataTable = new DataTable(); + $dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => 10)); + + $response = $builder->renderDataTable($dataTable); + + $this->assertEquals('myName([{"nb_visits":5,"nb_random":10}])', $response); + $this->assertNoJsonError($response); + } + + public function test_renderArray_ShouldConvertSimpleArrayToJson() + { + $input = array(1, 2, 5, 'string', 10); + + $response = $this->jsonBuilder->renderArray($input); + + $this->assertEquals('[1,2,5,"string",10]', $response); + $this->assertNoJsonError($response); + } + + public function test_renderArray_ShouldWrapJsonIfRequested() + { + $input = array(1, 2, 5, 'string', 10); + + $builder = $this->makeBuilder(array('jsoncallback' => 'myName')); + $response = $builder->renderArray($input); + + $this->assertEquals('myName([1,2,5,"string",10])', $response); + } + + public function test_renderArray_ShouldRenderAnEmptyArray() + { + $response = $this->jsonBuilder->renderArray(array()); + + $this->assertEquals('[]', $response); + $this->assertNoJsonError($response); + } + + public function test_renderArray_ShouldConvertAssociativeArrayToJson() + { + $input = array('nb_visits' => 6, 'nb_random' => 8); + + $response = $this->jsonBuilder->renderArray($input); + $expected = json_encode($input); + + $this->assertEquals($expected, $response); + $this->assertNoJsonError($response); + } + + public function test_renderArray_ShouldConvertsIndexedAssociativeArrayToJson() + { + $input = array( + array('nb_visits' => 6, 'nb_random' => 8), + array('nb_visits' => 3, 'nb_random' => 4) + ); + + $response = $this->jsonBuilder->renderArray($input); + $expected = json_encode($input); + + $this->assertEquals($expected, $response); + $this->assertNoJsonError($response); + } + + public function test_renderArray_ShouldConvertMultiDimensionalStandardArrayToJson() + { + $input = array("firstElement", + array( + "firstElement", + "secondElement", + ), + "thirdElement"); + + $expected = json_encode($input); + + $actual = $this->jsonBuilder->renderArray($input); + $this->assertEquals($expected, $actual); + $this->assertNoJsonError($actual); + } + + public function test_renderArray_ShouldConvertMultiDimensionalAssociativeArrayToJson() + { + $input = array( + "firstElement" => "isFirst", + "secondElement" => array( + "firstElement" => "isFirst", + "secondElement" => "isSecond", + ), + "thirdElement" => "isThird"); + + $expected = json_encode($input); + + $actual = $this->jsonBuilder->renderArray($input); + $this->assertEquals($expected, $actual); + $this->assertNoJsonError($actual); + } + + public function test_renderArray_ShouldConvertSingleDimensionalAssociativeArrayToJson() + { + $input = array( + "fistElement" => "isFirst", + "secondElement" => "isSecond" + ); + + $expected = json_encode($input); + + $actual = $this->jsonBuilder->renderArray($input); + $this->assertEquals($expected, $actual); + $this->assertNoJsonError($actual); + } + + public function test_renderArray_ShouldConvertMultiDimensionalIndexArrayToJson() + { + $input = array(array("firstElement", + array( + "firstElement", + "secondElement", + ), + "thirdElement")); + + $expected = json_encode($input); + + $actual = $this->jsonBuilder->renderArray($input); + $this->assertEquals($expected, $actual); + $this->assertNoJsonError($actual); + } + + public function test_renderArray_ShouldConvertMultiDimensionalMixedArrayToJson() + { + $input = array( + "firstElement" => "isFirst", + array( + "firstElement", + "secondElement", + ), + "thirdElement" => array( + "firstElement" => "isFirst", + "secondElement" => "isSecond", + ) + ); + + $expected = json_encode($input); + + $actual = $this->jsonBuilder->renderArray($input); + $this->assertEquals($expected, $actual); + $this->assertNoJsonError($actual); + } + + /** + * backwards compatibility test + */ + public function test_oldJson_renderArray_ShouldConvertSingleDimensionalAssociativeArray() + { + $input = array( + "firstElement" => "isFirst", + "secondElement" => "isSecond" + ); + + $expected = '[{"firstElement":"isFirst","secondElement":"isSecond"}]'; + + $oldJsonBuilder = new Json($input); + $actual = $oldJsonBuilder->renderArray($input); + $this->assertEquals($expected, $actual); + $this->assertNoJsonError($actual); + } + + private function makeBuilder($request) + { + return new Json2($request); + } + + private function assertNoJsonError($response) + { + return null !== json_decode($response); + } +} |