class BookMultilingualTest in Drupal 9
Tests multilingual books.
@group book
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\book\Kernel\BookMultilingualTest uses UserCreationTrait
Expanded class hierarchy of BookMultilingualTest
File
- core/
modules/ book/ tests/ src/ Kernel/ BookMultilingualTest.php, line 24
Namespace
Drupal\Tests\book\KernelView source
class BookMultilingualTest extends KernelTestBase {
use UserCreationTrait;
/**
* The translation langcode.
*/
const LANGCODE = 'de';
/**
* {@inheritdoc}
*/
protected static $modules = [
'system',
'user',
'node',
'field',
'text',
'book',
'language',
'content_translation',
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
// Create the translation language.
$this
->installConfig([
'language',
]);
ConfigurableLanguage::create([
'id' => self::LANGCODE,
])
->save();
// Set up language negotiation.
$config = $this
->config('language.types');
$config
->set('configurable', [
LanguageInterface::TYPE_INTERFACE,
LanguageInterface::TYPE_CONTENT,
]);
// The language being tested should only be available as the content
// language so subsequent tests catch errors where the interface language
// is used instead of the content language. For this, the interface
// language is set to the user language and ::setCurrentLanguage() will
// set the user language to the language not being tested.
$config
->set('negotiation', [
LanguageInterface::TYPE_INTERFACE => [
'enabled' => [
LanguageNegotiationUser::METHOD_ID => 0,
],
],
LanguageInterface::TYPE_CONTENT => [
'enabled' => [
LanguageNegotiationUrl::METHOD_ID => 0,
],
],
]);
$config
->save();
$config = $this
->config('language.negotiation');
$config
->set('url.source', LanguageNegotiationUrl::CONFIG_DOMAIN);
$config
->set('url.domains', [
'en' => 'en.book.test.domain',
self::LANGCODE => self::LANGCODE . '.book.test.domain',
]);
$config
->save();
$this->container
->get('kernel')
->rebuildContainer();
$this
->installEntitySchema('node');
$this
->installEntitySchema('user');
$this
->installSchema('book', [
'book',
]);
$this
->installSchema('node', [
'node_access',
]);
$this
->installSchema('system', [
'sequences',
]);
$this
->installConfig([
'node',
'book',
'field',
]);
$node_type = NodeType::create([
'type' => $this
->randomMachineName(),
'name' => $this
->randomString(),
]);
$node_type
->save();
$this->container
->get('content_translation.manager')
->setEnabled('node', $node_type
->id(), TRUE);
$book_config = $this
->config('book.settings');
$allowed_types = $book_config
->get('allowed_types');
$allowed_types[] = $node_type
->id();
$book_config
->set('allowed_types', $allowed_types)
->save();
// To test every possible combination of root-child / child-child, two
// trees are needed. The first level below the root needs to have two
// leaves and similarly a second level is needed with two-two leaves each:
//
// 1
// / \
// / \
// 2 3
// / \ / \
// / \ / \
// 4 5 6 7
//
// These are the actual node IDs, these are enforced as auto increment is
// not reliable.
//
// Similarly, the second tree root is node 8, the first two leaves are
// 9 and 10, the third level is 11, 12, 13, 14.
for ($root = 1; $root <= 8; $root += 7) {
for ($i = 0; $i <= 6; $i++) {
/** @var \Drupal\node\NodeInterface $node */
$node = Node::create([
'title' => $this
->randomString(),
'type' => $node_type
->id(),
]);
$node
->addTranslation(self::LANGCODE, [
'title' => $this
->randomString(),
]);
switch ($i) {
case 0:
$node->book['bid'] = 'new';
$node->book['pid'] = 0;
$node->book['depth'] = 1;
break;
case 1:
case 2:
$node->book['bid'] = $root;
$node->book['pid'] = $root;
$node->book['depth'] = 2;
break;
case 3:
case 4:
$node->book['bid'] = $root;
$node->book['pid'] = $root + 1;
$node->book['depth'] = 3;
break;
case 5:
case 6:
$node->book['bid'] = $root;
$node->book['pid'] = $root + 2;
$node->book['depth'] = 3;
break;
}
// This is necessary to make the table of contents consistent across
// test runs.
$node->book['weight'] = $i;
$node->nid->value = $root + $i;
$node
->enforceIsNew();
$node
->save();
}
}
\Drupal::currentUser()
->setAccount($this
->createUser([
'access content',
]));
}
/**
* Tests various book manager methods return correct translations.
*
* @dataProvider langcodesProvider
*/
public function testMultilingualBookManager(string $langcode) {
$this
->setCurrentLanguage($langcode);
/** @var \Drupal\book\BookManagerInterface $bm */
$bm = $this->container
->get('book.manager');
$books = $bm
->getAllBooks();
$this
->assertNotEmpty($books);
foreach ($books as $book) {
$bid = $book['bid'];
$build = $bm
->bookTreeOutput($bm
->bookTreeAllData($bid));
$items = $build['#items'];
$this
->assertBookItemIsCorrectlyTranslated($items[$bid], $langcode);
$this
->assertBookItemIsCorrectlyTranslated($items[$bid]['below'][$bid + 1], $langcode);
$this
->assertBookItemIsCorrectlyTranslated($items[$bid]['below'][$bid + 1]['below'][$bid + 3], $langcode);
$this
->assertBookItemIsCorrectlyTranslated($items[$bid]['below'][$bid + 1]['below'][$bid + 4], $langcode);
$this
->assertBookItemIsCorrectlyTranslated($items[$bid]['below'][$bid + 2], $langcode);
$this
->assertBookItemIsCorrectlyTranslated($items[$bid]['below'][$bid + 2]['below'][$bid + 5], $langcode);
$this
->assertBookItemIsCorrectlyTranslated($items[$bid]['below'][$bid + 2]['below'][$bid + 6], $langcode);
$toc = $bm
->getTableOfContents($bid, 4);
// Root entry does not have an indent.
$this
->assertToCEntryIsCorrectlyTranslated($toc, $langcode, $bid, '');
// The direct children of the root have one indent.
$this
->assertToCEntryIsCorrectlyTranslated($toc, $langcode, $bid + 1, '--');
$this
->assertToCEntryIsCorrectlyTranslated($toc, $langcode, $bid + 2, '--');
// Their children have two indents.
$this
->assertToCEntryIsCorrectlyTranslated($toc, $langcode, $bid + 3, '----');
$this
->assertToCEntryIsCorrectlyTranslated($toc, $langcode, $bid + 4, '----');
$this
->assertToCEntryIsCorrectlyTranslated($toc, $langcode, $bid + 5, '----');
$this
->assertToCEntryIsCorrectlyTranslated($toc, $langcode, $bid + 6, '----');
// $bid might be a string.
$this
->assertSame([
$bid + 0,
$bid + 1,
$bid + 3,
$bid + 4,
$bid + 2,
$bid + 5,
$bid + 6,
], array_keys($toc));
}
}
/**
* Tests various book breadcrumb builder methods return correct translations.
*
* @dataProvider langcodesProvider
*/
public function testMultilingualBookBreadcrumbBuilder(string $langcode) {
$this
->setCurrentLanguage($langcode);
// Test a level 3 node.
$nid = 7;
/** @var \Drupal\node\NodeInterface $node */
$node = Node::load($nid);
$route = new Route('/node/{node}');
$route_match = new RouteMatch('entity.node.canonical', $route, [
'node' => $node,
], [
'node' => $nid,
]);
/** @var \Drupal\book\BookBreadcrumbBuilder $bbb */
$bbb = $this->container
->get('book.breadcrumb');
$links = $bbb
->build($route_match)
->getLinks();
$link = array_shift($links);
$rendered_link = Link::fromTextAndUrl($link
->getText(), $link
->getUrl())
->toString();
$this
->assertStringContainsString("http://{$langcode}.book.test.domain/", $rendered_link);
$link = array_shift($links);
$this
->assertNodeLinkIsCorrectlyTranslated(1, $link
->getText(), $link
->getUrl(), $langcode);
$link = array_shift($links);
$this
->assertNodeLinkIsCorrectlyTranslated(3, $link
->getText(), $link
->getUrl(), $langcode);
$this
->assertEmpty($links);
}
/**
* Tests the book export returns correct translations.
*
* @dataProvider langcodesProvider
*/
public function testMultilingualBookExport(string $langcode) {
$this
->setCurrentLanguage($langcode);
/** @var \Drupal\book\BookExport $be */
$be = $this->container
->get('book.export');
/** @var \Drupal\book\BookManagerInterface $bm */
$bm = $this->container
->get('book.manager');
$books = $bm
->getAllBooks();
$this
->assertNotEmpty($books);
foreach ($books as $book) {
$contents = $be
->bookExportHtml(Node::load($book['bid']))['#contents'][0];
$this
->assertSame($contents["#node"]
->language()
->getId(), $langcode);
$this
->assertSame($contents["#children"][0]["#node"]
->language()
->getId(), $langcode);
$this
->assertSame($contents["#children"][1]["#node"]
->language()
->getId(), $langcode);
$this
->assertSame($contents["#children"][0]["#children"][0]["#node"]
->language()
->getId(), $langcode);
$this
->assertSame($contents["#children"][0]["#children"][1]["#node"]
->language()
->getId(), $langcode);
$this
->assertSame($contents["#children"][1]["#children"][0]["#node"]
->language()
->getId(), $langcode);
$this
->assertSame($contents["#children"][1]["#children"][1]["#node"]
->language()
->getId(), $langcode);
}
}
/**
* Data provider for ::testMultilingualBooks().
*/
public function langcodesProvider() {
return [
[
self::LANGCODE,
],
[
'en',
],
];
}
/**
* Sets the current language.
*
* @param string $langcode
* The langcode. The content language will be set to this using the
* appropriate domain while the user language will be set to something
* else so subsequent tests catch errors where the interface language
* is used instead of the content language.
*/
protected function setCurrentLanguage(string $langcode) : void {
\Drupal::requestStack()
->push(Request::create("http://{$langcode}.book.test.domain/"));
$language_manager = $this->container
->get('language_manager');
$language_manager
->reset();
$current_user = \Drupal::currentUser();
$languages = $language_manager
->getLanguages();
unset($languages[$langcode]);
$current_user
->getAccount()
->set('preferred_langcode', reset($languages)
->getId());
$this
->assertNotSame($current_user
->getPreferredLangcode(), $langcode);
}
/**
* Asserts a book item is correctly translated.
*
* @param array $item
* A book tree item.
* @param string $langcode
* The language code for the requested translation.
*/
protected function assertBookItemIsCorrectlyTranslated(array $item, string $langcode) : void {
$this
->assertNodeLinkIsCorrectlyTranslated($item['original_link']['nid'], $item['title'], $item['url'], $langcode);
}
/**
* Asserts a node link is correctly translated.
*
* @param int $nid
* The node id.
* @param string $title
* The expected title.
* @param \Drupal\Core\Url $url
* The URL being tested.
* @param string $langcode
* The language code.
*/
protected function assertNodeLinkIsCorrectlyTranslated(int $nid, string $title, Url $url, string $langcode) : void {
$node = Node::load($nid);
$this
->assertSame($node
->getTranslation($langcode)
->label(), $title);
$rendered_link = Link::fromTextAndUrl($title, $url)
->toString();
$this
->assertStringContainsString("http://{$langcode}.book.test.domain/node/{$nid}", $rendered_link);
}
/**
* Asserts one entry in the table of contents is correct.
*
* @param array $toc
* The entire table of contents array.
* @param string $langcode
* The language code for the requested translation.
* @param int $nid
* The node ID.
* @param string $indent
* The indentation before the actual table of contents label.
*/
protected function assertToCEntryIsCorrectlyTranslated(array $toc, string $langcode, int $nid, string $indent) {
$node = Node::load($nid);
$node_label = $node
->getTranslation($langcode)
->label();
$this
->assertSame($indent . ' ' . $node_label, $toc[$nid]);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
BookMultilingualTest:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
BookMultilingualTest:: |
protected | function | Asserts a book item is correctly translated. | |
BookMultilingualTest:: |
protected | function | Asserts a node link is correctly translated. | |
BookMultilingualTest:: |
protected | function | Asserts one entry in the table of contents is correct. | |
BookMultilingualTest:: |
constant | The translation langcode. | ||
BookMultilingualTest:: |
public | function | Data provider for ::testMultilingualBooks(). | |
BookMultilingualTest:: |
protected | function | Sets the current language. | |
BookMultilingualTest:: |
protected | function |
Overrides KernelTestBase:: |
|
BookMultilingualTest:: |
public | function | Tests various book breadcrumb builder methods return correct translations. | |
BookMultilingualTest:: |
public | function | Tests the book export returns correct translations. | |
BookMultilingualTest:: |
public | function | Tests various book manager methods return correct translations. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. |