diff --git a/core/modules/node/lib/Drupal/node/Tests/NodeTokenReplaceTest.php b/core/modules/node/lib/Drupal/node/Tests/NodeTokenReplaceTest.php index 0834116..11d69b2 100644 --- a/core/modules/node/lib/Drupal/node/Tests/NodeTokenReplaceTest.php +++ b/core/modules/node/lib/Drupal/node/Tests/NodeTokenReplaceTest.php @@ -7,12 +7,21 @@ namespace Drupal\node\Tests; -use Drupal\Core\Language\Language; +use Drupal\system\Tests\System\TokenReplaceUnitTestBase; +use Drupal\Component\Utility\String; /** * Test node token replacement in strings. */ -class NodeTokenReplaceTest extends NodeTestBase { +class NodeTokenReplaceTest extends TokenReplaceUnitTestBase { + + /** + * Modules to enable. + * + * @var array + */ + public static $modules = array('node', 'filter'); + public static function getInfo() { return array( 'name' => 'Node token replacement', @@ -21,30 +30,35 @@ public static function getInfo() { ); } + public function setUp() { + parent::setUp(); + $this->installSchema('node', array('node', 'node_field_revision', 'node_field_data')); + $this->installConfig(array('filter')); + + $node_type = entity_create('node_type', array('type' => 'article', 'name' => 'Article')); + $node_type->save(); + node_add_body_field($node_type); + } + /** * Creates a node, then tests the tokens generated from it. */ function testNodeTokenReplacement() { - $token_service = \Drupal::token(); - $language_interface = language(Language::TYPE_INTERFACE); $url_options = array( 'absolute' => TRUE, - 'language' => $language_interface, + 'language' => $this->languageInterface, ); // Create a user and a node. - $account = $this->drupalCreateUser(); - $settings = array( + $account = $this->createUser(); + $node = entity_create('node', array( 'type' => 'article', + 'tnid' => 0, 'uid' => $account->id(), 'title' => 'Blinking Text', - 'body' => array(array('value' => $this->randomName(32), 'summary' => $this->randomName(16))), - ); - $node = $this->drupalCreateNode($settings); - - // Load node so that the body and summary fields are structured properly. - $node = node_load($node->id()); - $instance = field_info_instance('node', 'body', $node->getType()); + 'body' => array(array('value' => $this->randomName(32), 'summary' => $this->randomName(16), 'format' => 'plain_text')), + )); + $node->save(); // Generate and test sanitized tokens. $tests = array(); @@ -58,41 +72,40 @@ function testNodeTokenReplacement() { $tests['[node:langcode]'] = check_plain($node->language()->id); $tests['[node:url]'] = url('node/' . $node->id(), $url_options); $tests['[node:edit-url]'] = url('node/' . $node->id() . '/edit', $url_options); - $tests['[node:author]'] = check_plain(user_format_name($account)); + $tests['[node:author]'] = String::checkPlain($account->getUsername()); $tests['[node:author:uid]'] = $node->getAuthorId(); - $tests['[node:author:name]'] = check_plain(user_format_name($account)); - $tests['[node:created:since]'] = format_interval(REQUEST_TIME - $node->getCreatedTime(), 2, $language_interface->id); - $tests['[node:changed:since]'] = format_interval(REQUEST_TIME - $node->getChangedTime(), 2, $language_interface->id); + $tests['[node:author:name]'] = String::checkPlain($account->getUsername()); + $tests['[node:created:since]'] = format_interval(REQUEST_TIME - $node->getCreatedTime(), 2, $this->languageInterface->id); + $tests['[node:changed:since]'] = format_interval(REQUEST_TIME - $node->getChangedTime(), 2, $this->languageInterface->id); // Test to make sure that we generated something for each token. $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.'); foreach ($tests as $input => $expected) { - $output = $token_service->replace($input, array('node' => $node), array('langcode' => $language_interface->id)); + $output = $this->tokenService->replace($input, array('node' => $node->getBCEntity()), array('langcode' => $this->languageInterface->id)); $this->assertEqual($output, $expected, format_string('Sanitized node token %token replaced.', array('%token' => $input))); } // Generate and test unsanitized tokens. $tests['[node:title]'] = $node->getTitle(); - $tests['[node:title]'] = $node->label(); $tests['[node:body]'] = $node->body->value; $tests['[node:summary]'] = $node->body->summary; $tests['[node:langcode]'] = $node->language()->id; - $tests['[node:author:name]'] = user_format_name($account); + $tests['[node:author:name]'] = $account->getUsername(); foreach ($tests as $input => $expected) { - $output = $token_service->replace($input, array('node' => $node), array('langcode' => $language_interface->id, 'sanitize' => FALSE)); + $output = $this->tokenService->replace($input, array('node' => $node->getBCEntity()), array('langcode' => $this->languageInterface->id, 'sanitize' => FALSE)); $this->assertEqual($output, $expected, format_string('Unsanitized node token %token replaced.', array('%token' => $input))); } // Repeat for a node without a summary. - $settings['body'] = array(array('value' => $this->randomName(32), 'summary' => '')); - $node = $this->drupalCreateNode($settings); - - // Load node (without summary) so that the body and summary fields are - // structured properly. - $node = node_load($node->id()); - $instance = field_info_instance('node', 'body', $node->getType()); + $node = entity_create('node', array( + 'type' => 'article', + 'uid' => $account->id(), + 'title' => 'Blinking Text', + 'body' => array(array('value' => $this->randomName(32), 'format' => 'plain_text')), + )); + $node->save(); // Generate and test sanitized token - use full body as expected value. $tests = array(); @@ -102,7 +115,7 @@ function testNodeTokenReplacement() { $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated for node without a summary.'); foreach ($tests as $input => $expected) { - $output = $token_service->replace($input, array('node' => $node), array('language' => $language_interface)); + $output = $this->tokenService->replace($input, array('node' => $node->getBCEntity()), array('language' => $this->languageInterface)); $this->assertEqual($output, $expected, format_string('Sanitized node token %token replaced for node without a summary.', array('%token' => $input))); } @@ -110,7 +123,7 @@ function testNodeTokenReplacement() { $tests['[node:summary]'] = $node->body->value; foreach ($tests as $input => $expected) { - $output = $token_service->replace($input, array('node' => $node), array('language' => $language_interface, 'sanitize' => FALSE)); + $output = $this->tokenService->replace($input, array('node' => $node->getBCEntity()), array('language' => $this->languageInterface, 'sanitize' => FALSE)); $this->assertEqual($output, $expected, format_string('Unsanitized node token %token replaced for node without a summary.', array('%token' => $input))); } } diff --git a/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceTest.php b/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceTest.php deleted file mode 100644 index 4344801..0000000 --- a/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceTest.php +++ /dev/null @@ -1,178 +0,0 @@ - 'Token replacement', - 'description' => 'Generates text using placeholders for dummy content to check token replacement.', - 'group' => 'System', - ); - } - - /** - * Creates a user and a node, then tests the tokens generated from them. - */ - function testTokenReplacement() { - $token_service = \Drupal::token(); - - // Create the initial objects. - $account = $this->drupalCreateUser(); - $node = $this->drupalCreateNode(array('uid' => $account->id())); - $node->title = 'Blinking Text'; - global $user; - $language_interface = language(Language::TYPE_INTERFACE); - - $source = '[node:title]'; // Title of the node we passed in - $source .= '[node:author:name]'; // Node author's name - $source .= '[node:created:since]'; // Time since the node was created - $source .= '[current-user:name]'; // Current user's name - $source .= '[date:short]'; // Short date format of REQUEST_TIME - $source .= '[user:name]'; // No user passed in, should be untouched - $source .= '[bogus:token]'; // Non-existent token - - $target = check_plain($node->getTitle()); - $target .= check_plain($account->getUsername()); - $target .= format_interval(REQUEST_TIME - $node->getCreatedTime(), 2, $language_interface->id); - $target .= check_plain($user->getUsername()); - $target .= format_date(REQUEST_TIME, 'short', '', NULL, $language_interface->id); - - // Test that the clear parameter cleans out non-existent tokens. - $result = $token_service->replace($source, array('node' => $node), array('langcode' => $language_interface->id, 'clear' => TRUE)); - $this->assertEqual($target, $result, 'Valid tokens replaced while invalid tokens cleared out.'); - - // Test without using the clear parameter (non-existent token untouched). - $target .= '[user:name]'; - $target .= '[bogus:token]'; - $result = $token_service->replace($source, array('node' => $node), array('langcode' => $language_interface->id)); - $this->assertEqual($target, $result, 'Valid tokens replaced while invalid tokens ignored.'); - - // Check that the results of Token::generate are sanitized properly. This - // does NOT test the cleanliness of every token -- just that the $sanitize - // flag is being passed properly through the call stack and being handled - // correctly by a 'known' token, [node:title]. - $raw_tokens = array('title' => '[node:title]'); - $generated = $token_service->generate('node', $raw_tokens, array('node' => $node)); - $this->assertEqual($generated['[node:title]'], check_plain($node->getTitle()), 'Token sanitized.'); - - $generated = $token_service->generate('node', $raw_tokens, array('node' => $node), array('sanitize' => FALSE)); - $this->assertEqual($generated['[node:title]'], $node->getTitle(), 'Unsanitized token generated properly.'); - - // Test token replacement when the string contains no tokens. - $this->assertEqual($token_service->replace('No tokens here.'), 'No tokens here.'); - } - - /** - * Test whether token-replacement works in various contexts. - */ - function testSystemTokenRecognition() { - $token_service = \Drupal::token(); - $language_interface = language(Language::TYPE_INTERFACE); - - // Generate prefixes and suffixes for the token context. - $tests = array( - array('prefix' => 'this is the ', 'suffix' => ' site'), - array('prefix' => 'this is the', 'suffix' => 'site'), - array('prefix' => '[', 'suffix' => ']'), - array('prefix' => '', 'suffix' => ']]]'), - array('prefix' => '[[[', 'suffix' => ''), - array('prefix' => ':[:', 'suffix' => '--]'), - array('prefix' => '-[-', 'suffix' => ':]:'), - array('prefix' => '[:', 'suffix' => ']'), - array('prefix' => '[site:', 'suffix' => ':name]'), - array('prefix' => '[site:', 'suffix' => ']'), - ); - - // Check if the token is recognized in each of the contexts. - foreach ($tests as $test) { - $input = $test['prefix'] . '[site:name]' . $test['suffix']; - $expected = $test['prefix'] . 'Drupal' . $test['suffix']; - $output = $token_service->replace($input, array(), array('langcode' => $language_interface->id)); - $this->assertTrue($output == $expected, format_string('Token recognized in string %string', array('%string' => $input))); - } - } - - /** - * Tests the generation of all system site information tokens. - */ - function testSystemSiteTokenReplacement() { - $token_service = \Drupal::token(); - $language_interface = language(Language::TYPE_INTERFACE); - $url_options = array( - 'absolute' => TRUE, - 'language' => $language_interface, - ); - - // Set a few site variables. - \Drupal::config('system.site') - ->set('name', 'Drupal') - ->set('slogan', 'Slogan') - ->save(); - - // Generate and test sanitized tokens. - $tests = array(); - $tests['[site:name]'] = check_plain(\Drupal::config('system.site')->get('name')); - $tests['[site:slogan]'] = filter_xss_admin(\Drupal::config('system.site')->get('slogan')); - $tests['[site:mail]'] = 'simpletest@example.com'; - $tests['[site:url]'] = url('', $url_options); - $tests['[site:url-brief]'] = preg_replace(array('!^https?://!', '!/$!'), '', url('', $url_options)); - $tests['[site:login-url]'] = url('user', $url_options); - - // Test to make sure that we generated something for each token. - $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.'); - - foreach ($tests as $input => $expected) { - $output = $token_service->replace($input, array(), array('langcode' => $language_interface->id)); - $this->assertEqual($output, $expected, format_string('Sanitized system site information token %token replaced.', array('%token' => $input))); - } - - // Generate and test unsanitized tokens. - $tests['[site:name]'] = \Drupal::config('system.site')->get('name'); - $tests['[site:slogan]'] = \Drupal::config('system.site')->get('slogan'); - - foreach ($tests as $input => $expected) { - $output = $token_service->replace($input, array(), array('langcode' => $language_interface->id, 'sanitize' => FALSE)); - $this->assertEqual($output, $expected, format_string('Unsanitized system site information token %token replaced.', array('%token' => $input))); - } - } - - /** - * Tests the generation of all system date tokens. - */ - function testSystemDateTokenReplacement() { - $token_service = \Drupal::token(); - $language_interface = language(Language::TYPE_INTERFACE); - - // Set time to one hour before request. - $date = REQUEST_TIME - 3600; - - // Generate and test tokens. - $tests = array(); - $tests['[date:short]'] = format_date($date, 'short', '', NULL, $language_interface->id); - $tests['[date:medium]'] = format_date($date, 'medium', '', NULL, $language_interface->id); - $tests['[date:long]'] = format_date($date, 'long', '', NULL, $language_interface->id); - $tests['[date:custom:m/j/Y]'] = format_date($date, 'custom', 'm/j/Y', NULL, $language_interface->id); - $tests['[date:since]'] = format_interval((REQUEST_TIME - $date), 2, $language_interface->id); - $tests['[date:raw]'] = filter_xss($date); - - // Test to make sure that we generated something for each token. - $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.'); - - foreach ($tests as $input => $expected) { - $output = $token_service->replace($input, array('date' => $date), array('langcode' => $language_interface->id)); - $this->assertEqual($output, $expected, format_string('Date token %token replaced.', array('%token' => $input))); - } - } -} diff --git a/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceUnitTest.php b/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceUnitTest.php new file mode 100644 index 0000000..d3f26f5 --- /dev/null +++ b/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceUnitTest.php @@ -0,0 +1,163 @@ + 'Token replacement unit test', + 'description' => 'Generates text using placeholders for dummy content to check token replacement.', + 'group' => 'System', + ); + } + + /** + * Test whether token-replacement works in various contexts. + */ + public function testSystemTokenRecognition() { + // Generate prefixes and suffixes for the token context. + $tests = array( + array('prefix' => 'this is the ', 'suffix' => ' site'), + array('prefix' => 'this is the', 'suffix' => 'site'), + array('prefix' => '[', 'suffix' => ']'), + array('prefix' => '', 'suffix' => ']]]'), + array('prefix' => '[[[', 'suffix' => ''), + array('prefix' => ':[:', 'suffix' => '--]'), + array('prefix' => '-[-', 'suffix' => ':]:'), + array('prefix' => '[:', 'suffix' => ']'), + array('prefix' => '[site:', 'suffix' => ':name]'), + array('prefix' => '[site:', 'suffix' => ']'), + ); + + // Check if the token is recognized in each of the contexts. + foreach ($tests as $test) { + $input = $test['prefix'] . '[site:name]' . $test['suffix']; + $expected = $test['prefix'] . 'Drupal' . $test['suffix']; + $output = $this->tokenService->replace($input, array(), array('langcode' => $this->languageInterface->id)); + $this->assertTrue($output == $expected, format_string('Token recognized in string %string', array('%string' => $input))); + } + + // Test token replacement when the string contains no tokens. + $this->assertEqual($this->tokenService->replace('No tokens here.'), 'No tokens here.'); + } + + /** + * Tests the clear parameter. + */ + public function testClear() { + // Valid token. + $source = '[site:name]'; + // No user passed in, should be untouched. + $source .= '[user:name]'; + // Non-existing token. + $source .= '[bogus:token]'; + + // Replace with with the clear parameter, only the valid token should remain. + $target = String::checkPlain(config('system.site')->get('name')); + $result = $this->tokenService->replace($source, array(), array('langcode' => $this->languageInterface->id, 'clear' => TRUE)); + $this->assertEqual($target, $result, 'Valid tokens replaced while invalid tokens ignored.'); + + $target .= '[user:name]'; + $target .= '[bogus:token]'; + $result = $this->tokenService->replace($source, array(), array('langcode' => $this->languageInterface->id)); + $this->assertEqual($target, $result, 'Valid tokens replaced while invalid tokens ignored.'); + } + + /** + * Tests the generation of all system site information tokens. + */ + public function testSystemSiteTokenReplacement() { + // The use of the url() function requires the url_alias table to exist. + $this->installSchema('system', 'url_alias'); + $url_options = array( + 'absolute' => TRUE, + 'language' => $this->languageInterface, + ); + + $slogan = 'Slogan'; + $safe_slogan = Xss::filterAdmin($slogan); + + // Set a few site variables. + $config = $this->container->get('config.factory')->get('system.site'); + $config + ->set('name', 'Drupal') + ->set('slogan', $slogan) + ->set('mail', 'simpletest@example.com') + ->save(); + + + // Generate and test sanitized tokens. + $tests = array(); + $tests['[site:name]'] = String::checkPlain($config->get('name')); + $tests['[site:slogan]'] = $safe_slogan; + $tests['[site:mail]'] = $config->get('mail'); + $tests['[site:url]'] = url('', $url_options); + $tests['[site:url-brief]'] = preg_replace(array('!^https?://!', '!/$!'), '', url('', $url_options)); + $tests['[site:login-url]'] = url('user', $url_options); + + // Test to make sure that we generated something for each token. + $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.'); + + foreach ($tests as $input => $expected) { + $output = $this->tokenService->replace($input, array(), array('langcode' => $this->languageInterface->id)); + $this->assertEqual($output, $expected, format_string('Sanitized system site information token %token replaced.', array('%token' => $input))); + } + + // Generate and test unsanitized tokens. + $tests['[site:name]'] = $config->get('name'); + $tests['[site:slogan]'] = $config->get('slogan'); + + foreach ($tests as $input => $expected) { + $output = $this->tokenService->replace($input, array(), array('langcode' => $this->languageInterface->id, 'sanitize' => FALSE)); + $this->assertEqual($output, $expected, format_string('Unsanitized system site information token %token replaced.', array('%token' => $input))); + } + + // Check that the results of Token::generate are sanitized properly. This + // does NOT test the cleanliness of every token -- just that the $sanitize + // flag is being passed properly through the call stack and being handled + // correctly by a 'known' token, [site:slogan]. + $raw_tokens = array('slogan' => '[site:slogan]'); + $generated = $this->tokenService->generate('site', $raw_tokens); + $this->assertEqual($generated['[site:slogan]'], $safe_slogan, 'Token sanitized.'); + + $generated = $this->tokenService->generate('site', $raw_tokens, array(), array('sanitize' => FALSE)); + $this->assertEqual($generated['[site:slogan]'], $slogan, 'Unsanitized token generated properly.'); + } + + /** + * Tests the generation of all system date tokens. + */ + public function testSystemDateTokenReplacement() { + // Set time to one hour before request. + $date = REQUEST_TIME - 3600; + + // Generate and test tokens. + $tests = array(); + $tests['[date:short]'] = format_date($date, 'short', '', NULL, $this->languageInterface->id); + $tests['[date:medium]'] = format_date($date, 'medium', '', NULL, $this->languageInterface->id); + $tests['[date:long]'] = format_date($date, 'long', '', NULL, $this->languageInterface->id); + $tests['[date:custom:m/j/Y]'] = format_date($date, 'custom', 'm/j/Y', NULL, $this->languageInterface->id); + $tests['[date:since]'] = format_interval((REQUEST_TIME - $date), 2, $this->languageInterface->id); + $tests['[date:raw]'] = Xss::filter($date); + + // Test to make sure that we generated something for each token. + $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.'); + + foreach ($tests as $input => $expected) { + $output = $this->tokenService->replace($input, array('date' => $date), array('langcode' => $this->languageInterface->id)); + $this->assertEqual($output, $expected, format_string('Date token %token replaced.', array('%token' => $input))); + } + } +} diff --git a/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceUnitTestBase.php b/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceUnitTestBase.php new file mode 100644 index 0000000..4b28c9e --- /dev/null +++ b/core/modules/system/lib/Drupal/system/Tests/System/TokenReplaceUnitTestBase.php @@ -0,0 +1,48 @@ +installConfig(array('system')); + + $this->languageInterface = language(Language::TYPE_INTERFACE); + $this->tokenService = \Drupal::token(); + } + +}