MediaWiki  master
FormatJsonTest Class Reference

FormatJson. More...

Inheritance diagram for FormatJsonTest:
Collaboration diagram for FormatJsonTest:

Public Member Functions

 provideParseStripComments ()
 provideStripComments ()
 testDecodeReturnType ()
 testEncodeAllOk ($from, $to)
 provideEncodeAllOk More...
 testEncodeDefault ($from, $to)
 provideEncodeDefault More...
 testEncodePhpBug46944 ()
 testEncoderPrettyPrinting ($pretty, $expectedIndent)
 provideEncoderPrettyPrinting More...
 testEncodeUtf8 ($from, $to)
 provideEncodeUtf8 More...
 testEncodeXmlMeta ($from, $to)
 provideEncodeXmlMeta More...
 testParse ($value)
 provideParse More...
 testParseErrors ($value)
 provideParseErrors More...
 testParseStripComments ($json, $expect)
 FormatJson::parse FormatJson::stripComments provideParseStripComments. More...
 testParseTryFixing ($value, $expected, $jsoncParses=true, $expectedJsonc=null)
 provideParseTryFixing More...
 testStripComments ($json, $expect)
 FormatJson::stripComments provideStripComments. More...
- Public Member Functions inherited from MediaWikiTestCase
 __call ($func, $args)
 __construct ($name=null, array $data=[], $dataName= '')
 __destruct ()
 addDBData ()
 Stub. More...
 addDBDataOnce ()
 Stub. More...
 dbPrefix ()
 getCliArg ($offset)
 hideDeprecated ($function)
 Don't throw a warning if $function is deprecated and called later. More...
 needsDB ()
 run (PHPUnit_Framework_TestResult $result=null)
 setCliArg ($offset, $value)
 setContentLang ($lang)
 setupAllTestDBs ()
 Set up all test DBs. More...
 setUserLang ($lang)
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method. More...
 usesTemporaryTables ()

Static Public Member Functions

static provideEncodeAllOk ()
static provideEncodeDefault ()
static provideEncoderPrettyPrinting ()
static provideEncodeUtf8 ()
static provideEncodeXmlMeta ()
static provideParse ()
static provideParseErrors ()
static provideParseTryFixing ()
 Test data for testParseTryFixing. More...
static toObject ($value)
 Recursively convert arrays into stdClass. More...
- Static Public Member Functions inherited from MediaWikiTestCase
static assertNotTag ($matcher, $actual, $message= '', $isHtml=true)
static assertTag ($matcher, $actual, $message= '', $isHtml=true)
 Note: we are overriding this method to remove the deprecated error. More...
static getMutableTestUser ($groups=[])
 Convenience method for getting a mutable test user. More...
static getTestSysop ()
 Convenience method for getting an immutable admin test user. More...
static getTestUser ($groups=[])
 Convenience method for getting an immutable test user. More...
static listTables (IMaintainableDatabase $db)
static prepareServices (Config $bootstrapConfig)
 Prepare service configuration for unit testing. More...
static setUpBeforeClass ()
static setupTestDB (Database $db, $prefix)
 Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using the given $prefix. More...
static teardownTestDB ()
 Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called. More...
static wfResetOutputBuffersBarrier ($buffer)
 Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit. More...

Static Private Member Functions

static getEncodeTestCases (array $unescapedGroups)
 Generate a set of test cases for a particular combination of encoder options. More...

Additional Inherited Members

- Public Attributes inherited from MediaWikiTestCase
const DB_PREFIX = 'unittest_'
 Table name prefixes. More...
const ORA_DB_PREFIX = 'ut_'
- Static Public Attributes inherited from MediaWikiTestCase
static TestUser[] $users
- Protected Member Functions inherited from MediaWikiTestCase
 addTmpFiles ($files)
 arrayWrap (array $elements)
 Utility method taking an array of elements and wrapping each element in its own array. More...
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal. More...
 assertHTMLEquals ($expected, $actual, $msg= '')
 Put each HTML element on its own line and then equals() the results. More...
 assertSelect ($table, $fields, $condition, array $expectedRows)
 Asserts that the given database query yields the rows given by $expectedRows. More...
 assertType ($type, $actual, $message= '')
 Asserts the type of the provided value. More...
 assertTypeOrValue ($type, $actual, $value=false, $message= '')
 Asserts that the provided variable is of the specified internal type or equals the $value argument. More...
 assertValidHtmlDocument ($html)
 Asserts that the given string is valid HTML document. More...
 assertValidHtmlSnippet ($html)
 Asserts that the given string is a valid HTML snippet. More...
 checkDbIsSupported ()
 checkPHPExtension ($extName)
 Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded. More...
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext. More...
 getNewTempDirectory ()
 obtains a new temporary directory More...
 getNewTempFile ()
 Obtains a new temporary file name. More...
 insertPage ($pageName, $text= 'Sample page for unit test.', $namespace=null)
 Insert a new page. More...
 isWikitextNS ($ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. More...
 markTestSkippedIfNoDiff3 ()
 Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready. More...
 mergeMwGlobalArrayValue ($name, $values)
 Merges the given values into a MW global array variable. More...
 objectAssociativeSort (array &$array)
 Does an associative sort that works for objects. More...
 overrideMwServices (Config $configOverrides=null, array $services=[])
 Stashes the global instance of MediaWikiServices, and installs a new one, allowing test cases to override settings and services. More...
 setLogger ($channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test. More...
 setMwGlobals ($pairs, $value=null)
 setService ($name, $object)
 Sets a service, maintaining a stashed version of the previous service to be restored in tearDown. More...
 setTemporaryHook ($hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown. More...
 setUp ()
 stashMwGlobals ($globalKeys)
 Stashes the global, will be restored in tearDown() More...
 tearDown ()
- Static Protected Member Functions inherited from MediaWikiTestCase
static getExternalStoreDatabaseConnections ()
 Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore. More...
static isUsingExternalStoreDB ()
 Check whether ExternalStoreDB is being used. More...
static resetGlobalServices (Config $bootstrapConfig=null)
 Reset global services, and install testing environment. More...
static setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix)
 Setups a database with the given prefix. More...
static setupExternalStoreTestDBs ($testPrefix)
 Clones the External Store database(s) for testing. More...
static stripStringKeys (&$r)
 Utility function for eliminating all string keys from an array. More...
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database. More...
array $supportedDBs
array $tablesUsed = []

Detailed Description


Definition at line 6 of file FormatJsonTest.php.

Member Function Documentation

static FormatJsonTest::getEncodeTestCases ( array  $unescapedGroups)

Generate a set of test cases for a particular combination of encoder options.

array$unescapedGroupsList of character groups to leave unescaped
array Arrays of unencoded strings and corresponding encoded strings

Definition at line 327 of file FormatJsonTest.php.

References $name, and as.

static FormatJsonTest::provideEncodeAllOk ( )

Definition at line 93 of file FormatJsonTest.php.

static FormatJsonTest::provideEncodeDefault ( )

Definition at line 60 of file FormatJsonTest.php.

static FormatJsonTest::provideEncoderPrettyPrinting ( )

Definition at line 8 of file FormatJsonTest.php.

static FormatJsonTest::provideEncodeUtf8 ( )

Definition at line 71 of file FormatJsonTest.php.

static FormatJsonTest::provideEncodeXmlMeta ( )

Definition at line 82 of file FormatJsonTest.php.

static FormatJsonTest::provideParse ( )

Definition at line 126 of file FormatJsonTest.php.

References false, and true.

static FormatJsonTest::provideParseErrors ( )

Definition at line 246 of file FormatJsonTest.php.

FormatJsonTest::provideParseStripComments ( )

Definition at line 299 of file FormatJsonTest.php.

References true.

static FormatJsonTest::provideParseTryFixing ( )

Test data for testParseTryFixing.

Some PHP interpreters use json-c rather than the cannonical parser to avoid being encumbered by the "shall be used for Good, not Evil" clause of the parser's license. By default, json-c parses in a non-strict mode which allows trailing commas for array and object delarations among other things, so our JSON_ERROR_SYNTAX rescue block is not always triggered. It however isn't lenient in exactly the same ways as our TRY_FIXING mode, so the assertions in this test are a bit more complicated than they ideally would be:

Optional third argument: true if json-c parses the value without intervention, false otherwise. Defaults to true.

Optional fourth argument: expected cannonical JSON serialization of json-c parsed result. Defaults to the second argument's value.

Definition at line 190 of file FormatJsonTest.php.

References false.

FormatJsonTest::provideStripComments ( )

Definition at line 263 of file FormatJsonTest.php.

FormatJsonTest::testDecodeReturnType ( )

Definition at line 112 of file FormatJsonTest.php.

References FormatJson\decode().

FormatJsonTest::testEncodeAllOk (   $from,


Definition at line 100 of file FormatJsonTest.php.

References FormatJson\ALL_OK, and FormatJson\encode().

FormatJsonTest::testEncodeDefault (   $from,


Definition at line 67 of file FormatJsonTest.php.

References FormatJson\encode().

FormatJsonTest::testEncodePhpBug46944 ( )

Definition at line 104 of file FormatJsonTest.php.

References FormatJson\encode().

FormatJsonTest::testEncoderPrettyPrinting (   $pretty,


Definition at line 23 of file FormatJsonTest.php.

References FormatJson\encode().

FormatJsonTest::testEncodeUtf8 (   $from,


Definition at line 78 of file FormatJsonTest.php.

References FormatJson\encode(), and FormatJson\UTF8_OK.

FormatJsonTest::testEncodeXmlMeta (   $from,


Definition at line 89 of file FormatJsonTest.php.

References FormatJson\encode(), and FormatJson\XMLMETA_OK.

FormatJsonTest::testParse (   $value)



Definition at line 156 of file FormatJsonTest.php.

References $value, FormatJson\ALL_OK, FormatJson\encode(), FormatJson\FORCE_ASSOC, and FormatJson\parse().

FormatJsonTest::testParseErrors (   $value)



Definition at line 257 of file FormatJsonTest.php.

References $value, and FormatJson\parse().

FormatJsonTest::testParseStripComments (   $json,

FormatJson::parse FormatJson::stripComments provideParseStripComments.


Definition at line 314 of file FormatJsonTest.php.

References FormatJson\parse(), and FormatJson\STRIP_COMMENTS.

FormatJsonTest::testParseTryFixing (   $value,
  $jsoncParses = true,
  $expectedJsonc = null 


string | bool$expectedExpected result with strict parser
bool$jsoncParsesWill json-c parse this value without TRY_FIXING?
string | bool$expectedJsoncExpected result with lenient parser if different from the strict expectation

Definition at line 217 of file FormatJsonTest.php.

References $value, FormatJson\ALL_OK, FormatJson\encode(), FormatJson\parse(), and FormatJson\TRY_FIXING.

FormatJsonTest::testStripComments (   $json,

FormatJson::stripComments provideStripComments.


Definition at line 295 of file FormatJsonTest.php.

References FormatJson\stripComments().

static FormatJsonTest::toObject (   $value)

Recursively convert arrays into stdClass.

array | string | bool | int | float | null$value

Definition at line 148 of file FormatJsonTest.php.

References $value, and object.

The documentation for this class was generated from the following file: