tests/phpunit/includes/api/format/ApiFormatWddxTest.php

   1 <?php
   2
   3 /**
   4  * @group API
   5  * @covers ApiFormatWddx
   6  */
   7 class ApiFormatWddxTest extends ApiFormatTestBase {
   8
   9         protected $printerName = 'wddx';
  10
  11         public static function provideGeneralEncoding() {
  12                 if ( ApiFormatWddx::useSlowPrinter() ) {
  13                         return array(
  14                                 array( array(), 'Fast Wddx printer is unavailable', array( 'SKIP' => true ) )
  15                         );
  16                 }
  17                 return self::provideEncoding();
  18         }
  19
  20         public static function provideEncoding() {
  21                 $p = '<wddxPacket version=\'1.0\'><header/><data><struct><var name=\'warnings\'><struct><var name=\'wddx\'><struct><var name=\'*\'><string>format=wddx has been deprecated. Please use format=json instead.</string></var></struct></var></struct></var>';
  22                 $s = '</struct></data></wddxPacket>';
  23
  24                 return array(
  25                         // Basic types
  26                         array( array( null ), "{$p}<var name='0'><null/></var>{$s}" ),
  27                         array( array( true ), "{$p}<var name='0'><string></string></var>{$s}" ),
  28                         array( array( false ), "{$p}{$s}" ),
  29                         array( array( true, ApiResult::META_BC_BOOLS => array( 0 ) ),
  30                                 "{$p}<var name='0'><boolean value='true'/></var>{$s}" ),
  31                         array( array( false, ApiResult::META_BC_BOOLS => array( 0 ) ),
  32                                 "{$p}<var name='0'><boolean value='false'/></var>{$s}" ),
  33                         array( array( 42 ), "{$p}<var name='0'><number>42</number></var>{$s}" ),
  34                         array( array( 42.5 ), "{$p}<var name='0'><number>42.5</number></var>{$s}" ),
  35                         array( array( 1e42 ), "{$p}<var name='0'><number>1.0E+42</number></var>{$s}" ),
  36                         array( array( 'foo' ), "{$p}<var name='0'><string>foo</string></var>{$s}" ),
  37                         array( array( 'fóo' ), "{$p}<var name='0'><string>fóo</string></var>{$s}" ),
  38
  39                         // Arrays and objects
  40                         array( array( array() ), "{$p}<var name='0'><array length='0'></array></var>{$s}" ),
  41                         array( array( array( 1 ) ), "{$p}<var name='0'><array length='1'><number>1</number></array></var>{$s}" ),
  42                         array( array( array( 'x' => 1 ) ), "{$p}<var name='0'><struct><var name='x'><number>1</number></var></struct></var>{$s}" ),
  43                         array( array( array( 2 => 1 ) ), "{$p}<var name='0'><struct><var name='2'><number>1</number></var></struct></var>{$s}" ),
  44                         array( array( (object)array() ), "{$p}<var name='0'><struct></struct></var>{$s}" ),
  45                         array( array( array( 1, ApiResult::META_TYPE => 'assoc' ) ), "{$p}<var name='0'><struct><var name='0'><number>1</number></var></struct></var>{$s}" ),
  46                         array( array( array( 'x' => 1, ApiResult::META_TYPE => 'array' ) ), "{$p}<var name='0'><array length='1'><number>1</number></array></var>{$s}" ),
  47                         array( array( array( 'x' => 1, ApiResult::META_TYPE => 'kvp' ) ), "{$p}<var name='0'><struct><var name='x'><number>1</number></var></struct></var>{$s}" ),
  48                         array( array( array( 'x' => 1, ApiResult::META_TYPE => 'BCkvp', ApiResult::META_KVP_KEY_NAME => 'key' ) ),
  49                                 "{$p}<var name='0'><array length='1'><struct><var name='key'><string>x</string></var><var name='*'><number>1</number></var></struct></array></var>{$s}" ),
  50                         array( array( array( 'x' => 1, ApiResult::META_TYPE => 'BCarray' ) ), "{$p}<var name='0'><struct><var name='x'><number>1</number></var></struct></var>{$s}" ),
  51                         array( array( array( 'a', 'b', ApiResult::META_TYPE => 'BCassoc' ) ), "{$p}<var name='0'><array length='2'><string>a</string><string>b</string></array></var>{$s}" ),
  52
  53                         // Content
  54                         array( array( 'content' => 'foo', ApiResult::META_CONTENT => 'content' ),
  55                                 "{$p}<var name='*'><string>foo</string></var>{$s}" ),
  56
  57                         // BC Subelements
  58                         array( array( 'foo' => 'foo', ApiResult::META_BC_SUBELEMENTS => array( 'foo' ) ),
  59                                 "{$p}<var name='foo'><struct><var name='*'><string>foo</string></var></struct></var>{$s}" ),
  60                 );
  61         }
  62
  63         /**
  64          * @dataProvider provideEncoding
  65          */
  66         public function testSlowEncoding( array $data, $expect, array $params = array() ) {
  67                 // Adjust expectation for differences between fast and slow printers.
  68                 $expect = str_replace( '\'', '"', $expect );
  69                 $expect = str_replace( '/>', ' />', $expect );
  70                 $expect = '<?xml version="1.0"?>' . $expect;
  71
  72                 $this->assertSame( $expect, $this->encodeData( $params, $data, 'ApiFormatWddxTest_SlowWddx' ) );
  73         }
  74 }
  75
  76 class ApiFormatWddxTest_SlowWddx extends ApiFormatWddx {
  77         public static function useSlowPrinter() {
  78                 return true;
  79         }
  80 }