class DrupalJSONTest

Tests converting PHP variables to JSON strings and back.

Hierarchy

Expanded class hierarchy of DrupalJSONTest

File

modules/simpletest/tests/common.test, line 3089

View source
class DrupalJSONTest extends DrupalUnitTestCase {
    public static function getInfo() {
        return array(
            'name' => 'JSON',
            'description' => 'Perform unit tests on the drupal_json_encode() and drupal_json_decode() functions.',
            'group' => 'System',
        );
    }
    
    /**
     * Tests converting PHP variables to JSON strings and back.
     */
    function testJSON() {
        // Setup a string with the full ASCII table.
        // @todo: Add tests for non-ASCII characters and Unicode.
        $str = '';
        for ($i = 0; $i < 128; $i++) {
            $str .= chr($i);
        }
        // Characters that must be escaped.
        // We check for unescaped " separately.
        $html_unsafe = array(
            '<',
            '>',
            '\'',
            '&',
        );
        // The following are the encoded forms of: < > ' & "
        $html_unsafe_escaped = array(
            '\\u003C',
            '\\u003E',
            '\\u0027',
            '\\u0026',
            '\\u0022',
        );
        // Verify there aren't character encoding problems with the source string.
        $this->assertIdentical(strlen($str), 128, 'A string with the full ASCII table has the correct length.');
        foreach ($html_unsafe as $char) {
            $this->assertTrue(strpos($str, $char) > 0, format_string('A string with the full ASCII table includes @s.', array(
                '@s' => $char,
            )));
        }
        // Verify that JSON encoding produces a string with all of the characters.
        $json = drupal_json_encode($str);
        $this->assertTrue(strlen($json) > strlen($str), 'A JSON encoded string is larger than the source string.');
        // The first and last characters should be ", and no others.
        $this->assertTrue($json[0] == '"', 'A JSON encoded string begins with ".');
        $this->assertTrue($json[strlen($json) - 1] == '"', 'A JSON encoded string ends with ".');
        $this->assertTrue(substr_count($json, '"') == 2, 'A JSON encoded string contains exactly two ".');
        // Verify that encoding/decoding is reversible.
        $json_decoded = drupal_json_decode($json);
        $this->assertIdentical($str, $json_decoded, 'Encoding a string to JSON and decoding back results in the original string.');
        // Verify reversibility for structured data. Also verify that necessary
        // characters are escaped.
        $source = array(
            TRUE,
            FALSE,
            0,
            1,
            '0',
            '1',
            $str,
            array(
                'key1' => $str,
                'key2' => array(
                    'nested' => TRUE,
                ),
            ),
        );
        $json = drupal_json_encode($source);
        foreach ($html_unsafe as $char) {
            $this->assertTrue(strpos($json, $char) === FALSE, format_string('A JSON encoded string does not contain @s.', array(
                '@s' => $char,
            )));
        }
        // Verify that JSON encoding escapes the HTML unsafe characters
        foreach ($html_unsafe_escaped as $char) {
            $this->assertTrue(strpos($json, $char) > 0, format_string('A JSON encoded string contains @s.', array(
                '@s' => $char,
            )));
        }
        $json_decoded = drupal_json_decode($json);
        $this->assertNotIdentical($source, $json, 'An array encoded in JSON is not identical to the source.');
        $this->assertIdentical($source, $json_decoded, 'Encoding structured data to JSON and decoding back results in the original data.');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DrupalJSONTest::getInfo public static function
DrupalJSONTest::testJSON function Tests converting PHP variables to JSON strings and back.
DrupalTestCase::$assertions protected property Assertions thrown in that test case.
DrupalTestCase::$databasePrefix protected property The database prefix of this test run.
DrupalTestCase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
DrupalTestCase::$originalLanguage protected property The original language.
DrupalTestCase::$originalLanguageDefault protected property The original default language.
DrupalTestCase::$originalTheme protected property The original theme.
DrupalTestCase::$originalThemeKey protected property The original theme key.
DrupalTestCase::$originalThemePath protected property The original theme path.
DrupalTestCase::$results public property Current results of this test case.
DrupalTestCase::$setup protected property Flag to indicate whether the test has been set up.
DrupalTestCase::$setupDatabasePrefix protected property
DrupalTestCase::$setupEnvironment protected property
DrupalTestCase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
DrupalTestCase::$testId protected property The test run ID.
DrupalTestCase::$timeLimit protected property Time limit for the test.
DrupalTestCase::$useSetupInstallationCache public property Whether to cache the installation part of the setUp() method.
DrupalTestCase::$useSetupModulesCache public property Whether to cache the modules installation part of the setUp() method.
DrupalTestCase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
DrupalTestCase::assert protected function Internal helper: stores the assert.
DrupalTestCase::assertEqual protected function Check to see if two values are equal.
DrupalTestCase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdentical protected function Check to see if two values are identical.
DrupalTestCase::assertNotEqual protected function Check to see if two values are not equal.
DrupalTestCase::assertNotIdentical protected function Check to see if two values are not identical.
DrupalTestCase::assertNotNull protected function Check to see if a value is not NULL.
DrupalTestCase::assertNull protected function Check to see if a value is NULL.
DrupalTestCase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssert public static function Delete an assertion record by message ID.
DrupalTestCase::error protected function Fire an error assertion. 1
DrupalTestCase::errorHandler public function Handle errors during test runs. 1
DrupalTestCase::exceptionHandler protected function Handle exceptions.
DrupalTestCase::fail protected function Fire an assertion that is always negative.
DrupalTestCase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
DrupalTestCase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
DrupalTestCase::insertAssert public static function Store an assertion from outside the testing context.
DrupalTestCase::pass protected function Fire an assertion that is always positive.
DrupalTestCase::randomName public static function Generates a random string containing letters and numbers.
DrupalTestCase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::run public function Run all tests in this class.
DrupalTestCase::verbose protected function Logs a verbose message in a text file.
DrupalUnitTestCase::setUp protected function Sets up unit test environment. 10
DrupalUnitTestCase::tearDown protected function 1
DrupalUnitTestCase::__construct function Constructor for DrupalUnitTestCase. Overrides DrupalTestCase::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.