You are here

Home » API reference » Drupal 8 » BookTest.php

class BookTest in Drupal 8

Same name in this branch
  1. 8 core/modules/book/tests/src/Functional/BookTest.php \Drupal\Tests\book\Functional\BookTest
  2. 8 core/modules/book/tests/src/Kernel/Plugin/migrate/source/BookTest.php \Drupal\Tests\book\Kernel\Plugin\migrate\source\BookTest
Same name and namespace in other branches
  1. 9 core/modules/book/tests/src/Functional/BookTest.php \Drupal\Tests\book\Functional\BookTest

Create a book, add pages, and test book interface.

@group book

Hierarchy

Expanded class hierarchy of BookTest

File

core/modules/book/tests/src/Functional/BookTest.php, line 15

Namespace

Drupal\Tests\book\Functional
View source 
class BookTest extends BrowserTestBase {
  use BookTestTrait;

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = [
    'content_moderation',
    'book',
    'block',
    'node_access_test',
    'book_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * A user with permission to view a book and access printer-friendly version.
   *
   * @var object
   */
  protected $webUser;

  /**
   * A user with permission to create and edit books and to administer blocks.
   *
   * @var object
   */
  protected $adminUser;

  /**
   * A user without the 'node test view' permission.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $webUserWithoutNodeAccess;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalPlaceBlock('system_breadcrumb_block');
    $this
      ->drupalPlaceBlock('page_title_block');

    // node_access_test requires a node_access_rebuild().
    node_access_rebuild();

    // Create users.
    $this->bookAuthor = $this
      ->drupalCreateUser([
      'create new books',
      'create book content',
      'edit own book content',
      'add content to books',
      'view own unpublished content',
    ]);
    $this->webUser = $this
      ->drupalCreateUser([
      'access printer-friendly version',
      'node test view',
    ]);
    $this->webUserWithoutNodeAccess = $this
      ->drupalCreateUser([
      'access printer-friendly version',
    ]);
    $this->adminUser = $this
      ->drupalCreateUser([
      'create new books',
      'create book content',
      'edit any book content',
      'delete any book content',
      'add content to books',
      'administer blocks',
      'administer permissions',
      'administer book outlines',
      'node test view',
      'administer content types',
      'administer site configuration',
      'view any unpublished content',
    ]);
  }

  /**
   * Tests the book navigation cache context.
   *
   * @see \Drupal\book\Cache\BookNavigationCacheContext
   */
  public function testBookNavigationCacheContext() {

    // Create a page node.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $page = $this
      ->drupalCreateNode();

    // Create a book, consisting of book nodes.
    $book_nodes = $this
      ->createBook();

    // Enable the debug output.
    \Drupal::state()
      ->set('book_test.debug_book_navigation_cache_context', TRUE);
    Cache::invalidateTags([
      'book_test.debug_book_navigation_cache_context',
    ]);
    $this
      ->drupalLogin($this->bookAuthor);

    // On non-node route.
    $this
      ->drupalGet($this->adminUser
      ->toUrl());
    $this
      ->assertRaw('[route.book_navigation]=book.none');

    // On non-book node route.
    $this
      ->drupalGet($page
      ->toUrl());
    $this
      ->assertRaw('[route.book_navigation]=book.none');

    // On book node route.
    $this
      ->drupalGet($book_nodes[0]
      ->toUrl());
    $this
      ->assertRaw('[route.book_navigation]=0|2|3');
    $this
      ->drupalGet($book_nodes[1]
      ->toUrl());
    $this
      ->assertRaw('[route.book_navigation]=0|2|3|4');
    $this
      ->drupalGet($book_nodes[2]
      ->toUrl());
    $this
      ->assertRaw('[route.book_navigation]=0|2|3|5');
    $this
      ->drupalGet($book_nodes[3]
      ->toUrl());
    $this
      ->assertRaw('[route.book_navigation]=0|2|6');
    $this
      ->drupalGet($book_nodes[4]
      ->toUrl());
    $this
      ->assertRaw('[route.book_navigation]=0|2|7');
  }

  /**
   * Tests saving the book outline on an empty book.
   */
  public function testEmptyBook() {

    // Create a new empty book.
    $this
      ->drupalLogin($this->bookAuthor);
    $book = $this
      ->createBookNode('new');
    $this
      ->drupalLogout();

    // Log in as a user with access to the book outline and save the form.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalPostForm('admin/structure/book/' . $book
      ->id(), [], t('Save book pages'));
    $this
      ->assertText(t('Updated book @book.', [
      '@book' => $book
        ->label(),
    ]));
  }

  /**
   * Tests book functionality through node interfaces.
   */
  public function testBook() {

    // Create new book.
    $nodes = $this
      ->createBook();
    $book = $this->book;
    $this
      ->drupalLogin($this->webUser);

    // Check that book pages display along with the correct outlines and
    // previous/next links.
    $this
      ->checkBookNode($book, [
      $nodes[0],
      $nodes[3],
      $nodes[4],
    ], FALSE, FALSE, $nodes[0], []);
    $this
      ->checkBookNode($nodes[0], [
      $nodes[1],
      $nodes[2],
    ], $book, $book, $nodes[1], [
      $book,
    ]);
    $this
      ->checkBookNode($nodes[1], NULL, $nodes[0], $nodes[0], $nodes[2], [
      $book,
      $nodes[0],
    ]);
    $this
      ->checkBookNode($nodes[2], NULL, $nodes[1], $nodes[0], $nodes[3], [
      $book,
      $nodes[0],
    ]);
    $this
      ->checkBookNode($nodes[3], NULL, $nodes[2], $book, $nodes[4], [
      $book,
    ]);
    $this
      ->checkBookNode($nodes[4], NULL, $nodes[3], $book, FALSE, [
      $book,
    ]);
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->bookAuthor);

    // Check the presence of expected cache tags.
    $this
      ->drupalGet('node/add/book');
    $this
      ->assertCacheTag('config:book.settings');

    /*
     * Add Node 5 under Node 3.
     * Book
     *  |- Node 0
     *   |- Node 1
     *   |- Node 2
     *  |- Node 3
     *   |- Node 5
     *  |- Node 4
     */

    // Node 5.
    $nodes[] = $this
      ->createBookNode($book
      ->id(), $nodes[3]->book['nid']);
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->webUser);

    // Verify the new outline - make sure we don't get stale cached data.
    $this
      ->checkBookNode($nodes[3], [
      $nodes[5],
    ], $nodes[2], $book, $nodes[5], [
      $book,
    ]);
    $this
      ->checkBookNode($nodes[4], NULL, $nodes[5], $book, FALSE, [
      $book,
    ]);
    $this
      ->drupalLogout();

    // Create a second book, and move an existing book page into it.
    $this
      ->drupalLogin($this->bookAuthor);
    $other_book = $this
      ->createBookNode('new');
    $node = $this
      ->createBookNode($book
      ->id());
    $edit = [
      'book[bid]' => $other_book
        ->id(),
    ];
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, t('Save'));
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->webUser);

    // Check that the nodes in the second book are displayed correctly.
    // First we must set $this->book to the second book, so that the
    // correct regex will be generated for testing the outline.
    $this->book = $other_book;
    $this
      ->checkBookNode($other_book, [
      $node,
    ], FALSE, FALSE, $node, []);
    $this
      ->checkBookNode($node, NULL, $other_book, $other_book, FALSE, [
      $other_book,
    ]);

    // Test that we can save a book programmatically.
    $this
      ->drupalLogin($this->bookAuthor);
    $book = $this
      ->createBookNode('new');
    $book
      ->save();
  }

  /**
   * Tests book export ("printer-friendly version") functionality.
   */
  public function testBookExport() {

    // Create a book.
    $nodes = $this
      ->createBook();

    // Log in as web user and view printer-friendly version.
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet('node/' . $this->book
      ->id());
    $this
      ->clickLink(t('Printer-friendly version'));

    // Make sure each part of the book is there.
    foreach ($nodes as $node) {
      $this
        ->assertText($node
        ->label(), 'Node title found in printer friendly version.');
      $this
        ->assertRaw($node->body->processed, 'Node body found in printer friendly version.');
    }

    // Make sure we can't export an unsupported format.
    $this
      ->drupalGet('book/export/foobar/' . $this->book
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals(404);

    // Make sure we get a 404 on a not existing book node.
    $this
      ->drupalGet('book/export/html/123');
    $this
      ->assertSession()
      ->statusCodeEquals(404);

    // Make sure an anonymous user cannot view printer-friendly version.
    $this
      ->drupalLogout();

    // Load the book and verify there is no printer-friendly version link.
    $this
      ->drupalGet('node/' . $this->book
      ->id());
    $this
      ->assertSession()
      ->linkNotExists(t('Printer-friendly version'), 'Anonymous user is not shown link to printer-friendly version.');

    // Try getting the URL directly, and verify it fails.
    $this
      ->drupalGet('book/export/html/' . $this->book
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Now grant anonymous users permission to view the printer-friendly
    // version and verify that node access restrictions still prevent them from
    // seeing it.
    user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
      'access printer-friendly version',
    ]);
    $this
      ->drupalGet('book/export/html/' . $this->book
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals(403);
  }

  /**
   * Tests the functionality of the book navigation block.
   */
  public function testBookNavigationBlock() {
    $this
      ->drupalLogin($this->adminUser);

    // Enable the block.
    $block = $this
      ->drupalPlaceBlock('book_navigation');

    // Give anonymous users the permission 'node test view'.
    $edit = [];
    $edit[RoleInterface::ANONYMOUS_ID . '[node test view]'] = TRUE;
    $this
      ->drupalPostForm('admin/people/permissions/' . RoleInterface::ANONYMOUS_ID, $edit, t('Save permissions'));
    $this
      ->assertText(t('The changes have been saved.'), "Permission 'node test view' successfully assigned to anonymous users.");

    // Test correct display of the block.
    $nodes = $this
      ->createBook();
    $this
      ->drupalGet('<front>');
    $this
      ->assertText($block
      ->label(), 'Book navigation block is displayed.');
    $this
      ->assertText($this->book
      ->label(), new FormattableMarkup('Link to book root (@title) is displayed.', [
      '@title' => $nodes[0]
        ->label(),
    ]));
    $this
      ->assertNoText($nodes[0]
      ->label(), 'No links to individual book pages are displayed.');
  }

  /**
   * Tests BookManager::getTableOfContents().
   */
  public function testGetTableOfContents() {

    // Create new book.
    $nodes = $this
      ->createBook();
    $book = $this->book;
    $this
      ->drupalLogin($this->bookAuthor);

    /*
     * Add Node 5 under Node 2.
     * Add Node 6, 7, 8, 9, 10, 11 under Node 3.
     * Book
     *  |- Node 0
     *   |- Node 1
     *   |- Node 2
     *    |- Node 5
     *  |- Node 3
     *   |- Node 6
     *    |- Node 7
     *     |- Node 8
     *      |- Node 9
     *       |- Node 10
     *        |- Node 11
     *  |- Node 4
     */
    foreach ([
      5 => 2,
      6 => 3,
      7 => 6,
      8 => 7,
      9 => 8,
      10 => 9,
      11 => 10,
    ] as $child => $parent) {
      $nodes[$child] = $this
        ->createBookNode($book
        ->id(), $nodes[$parent]
        ->id());
    }
    $this
      ->drupalGet($nodes[0]
      ->toUrl('edit-form'));

    // Since Node 0 has children 2 levels deep, nodes 10 and 11 should not
    // appear in the selector.
    $this
      ->assertNoOption('edit-book-pid', $nodes[10]
      ->id());
    $this
      ->assertNoOption('edit-book-pid', $nodes[11]
      ->id());

    // Node 9 should be available as an option.
    $this
      ->assertOption('edit-book-pid', $nodes[9]
      ->id());

    // Get a shallow set of options.

    /** @var \Drupal\book\BookManagerInterface $manager */
    $manager = $this->container
      ->get('book.manager');
    $options = $manager
      ->getTableOfContents($book
      ->id(), 3);
    $expected_nids = [
      $book
        ->id(),
      $nodes[0]
        ->id(),
      $nodes[1]
        ->id(),
      $nodes[2]
        ->id(),
      $nodes[3]
        ->id(),
      $nodes[6]
        ->id(),
      $nodes[4]
        ->id(),
    ];
    $this
      ->assertEqual(count($options), count($expected_nids));
    $diff = array_diff($expected_nids, array_keys($options));
    $this
      ->assertTrue(empty($diff), 'Found all expected option keys');

    // Exclude Node 3.
    $options = $manager
      ->getTableOfContents($book
      ->id(), 3, [
      $nodes[3]
        ->id(),
    ]);
    $expected_nids = [
      $book
        ->id(),
      $nodes[0]
        ->id(),
      $nodes[1]
        ->id(),
      $nodes[2]
        ->id(),
      $nodes[4]
        ->id(),
    ];
    $this
      ->assertEqual(count($options), count($expected_nids));
    $diff = array_diff($expected_nids, array_keys($options));
    $this
      ->assertTrue(empty($diff), 'Found all expected option keys after excluding Node 3');
  }

  /**
   * Tests the book navigation block when an access module is installed.
   */
  public function testNavigationBlockOnAccessModuleInstalled() {
    $this
      ->drupalLogin($this->adminUser);
    $block = $this
      ->drupalPlaceBlock('book_navigation', [
      'block_mode' => 'book pages',
    ]);

    // Give anonymous users the permission 'node test view'.
    $edit = [];
    $edit[RoleInterface::ANONYMOUS_ID . '[node test view]'] = TRUE;
    $this
      ->drupalPostForm('admin/people/permissions/' . RoleInterface::ANONYMOUS_ID, $edit, t('Save permissions'));
    $this
      ->assertText(t('The changes have been saved.'), "Permission 'node test view' successfully assigned to anonymous users.");

    // Create a book.
    $this
      ->createBook();

    // Test correct display of the block to registered users.
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet('node/' . $this->book
      ->id());
    $this
      ->assertText($block
      ->label(), 'Book navigation block is displayed to registered users.');
    $this
      ->drupalLogout();

    // Test correct display of the block to anonymous users.
    $this
      ->drupalGet('node/' . $this->book
      ->id());
    $this
      ->assertText($block
      ->label(), 'Book navigation block is displayed to anonymous users.');

    // Test the 'book pages' block_mode setting.
    $this
      ->drupalGet('<front>');
    $this
      ->assertNoText($block
      ->label(), 'Book navigation block is not shown on non-book pages.');
  }

  /**
   * Tests the access for deleting top-level book nodes.
   */
  public function testBookDelete() {
    $node_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('node');
    $nodes = $this
      ->createBook();
    $this
      ->drupalLogin($this->adminUser);
    $edit = [];

    // Ensure that the top-level book node cannot be deleted.
    $this
      ->drupalGet('node/' . $this->book
      ->id() . '/outline/remove');
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Ensure that a child book node can be deleted.
    $this
      ->drupalPostForm('node/' . $nodes[4]
      ->id() . '/outline/remove', $edit, t('Remove'));
    $node_storage
      ->resetCache([
      $nodes[4]
        ->id(),
    ]);
    $node4 = $node_storage
      ->load($nodes[4]
      ->id());
    $this
      ->assertTrue(empty($node4->book), 'Deleting child book node properly allowed.');

    // $nodes[4] is stale, trying to delete it directly will cause an error.
    $node4
      ->delete();
    unset($nodes[4]);

    // Delete all child book nodes and retest top-level node deletion.
    $node_storage
      ->delete($nodes);
    $this
      ->drupalPostForm('node/' . $this->book
      ->id() . '/outline/remove', $edit, t('Remove'));
    $node_storage
      ->resetCache([
      $this->book
        ->id(),
    ]);
    $node = $node_storage
      ->load($this->book
      ->id());
    $this
      ->assertTrue(empty($node->book), 'Deleting childless top-level book node properly allowed.');

    // Tests directly deleting a book parent.
    $nodes = $this
      ->createBook();
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet($this->book
      ->toUrl('delete-form'));
    $this
      ->assertRaw(t('%title is part of a book outline, and has associated child pages. If you proceed with deletion, the child pages will be relocated automatically.', [
      '%title' => $this->book
        ->label(),
    ]));

    // Delete parent, and visit a child page.
    $this
      ->drupalPostForm($this->book
      ->toUrl('delete-form'), [], t('Delete'));
    $this
      ->drupalGet($nodes[0]
      ->toUrl());
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertText($nodes[0]
      ->label());

    // The book parents should be updated.
    $node_storage = \Drupal::entityTypeManager()
      ->getStorage('node');
    $node_storage
      ->resetCache();
    $child = $node_storage
      ->load($nodes[0]
      ->id());
    $this
      ->assertEqual($child
      ->id(), $child->book['bid'], 'Child node book ID updated when parent is deleted.');

    // 3rd-level children should now be 2nd-level.
    $second = $node_storage
      ->load($nodes[1]
      ->id());
    $this
      ->assertEqual($child
      ->id(), $second->book['bid'], '3rd-level child node is now second level when top-level node is deleted.');
  }

  /**
   * Tests outline of a book.
   */
  public function testBookOutline() {
    $this
      ->drupalLogin($this->bookAuthor);

    // Create new node not yet a book.
    $empty_book = $this
      ->drupalCreateNode([
      'type' => 'book',
    ]);
    $this
      ->drupalGet('node/' . $empty_book
      ->id() . '/outline');
    $this
      ->assertSession()
      ->linkNotExists(t('Book outline'), 'Book Author is not allowed to outline');
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('node/' . $empty_book
      ->id() . '/outline');
    $this
      ->assertRaw(t('Book outline'));
    $this
      ->assertOptionSelected('edit-book-bid', 0, 'Node does not belong to a book');
    $this
      ->assertSession()
      ->linkNotExists(t('Remove from book outline'));
    $edit = [];
    $edit['book[bid]'] = '1';
    $this
      ->drupalPostForm('node/' . $empty_book
      ->id() . '/outline', $edit, t('Add to book outline'));
    $node = \Drupal::entityTypeManager()
      ->getStorage('node')
      ->load($empty_book
      ->id());

    // Test the book array.
    $this
      ->assertEqual($node->book['nid'], $empty_book
      ->id());
    $this
      ->assertEqual($node->book['bid'], $empty_book
      ->id());
    $this
      ->assertEqual($node->book['depth'], 1);
    $this
      ->assertEqual($node->book['p1'], $empty_book
      ->id());
    $this
      ->assertEqual($node->book['pid'], '0');

    // Create new book.
    $this
      ->drupalLogin($this->bookAuthor);
    $book = $this
      ->createBookNode('new');
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('node/' . $book
      ->id() . '/outline');
    $this
      ->assertRaw(t('Book outline'));
    $this
      ->clickLink(t('Remove from book outline'));
    $this
      ->assertRaw(t('Are you sure you want to remove %title from the book hierarchy?', [
      '%title' => $book
        ->label(),
    ]));

    // Create a new node and set the book after the node was created.
    $node = $this
      ->drupalCreateNode([
      'type' => 'book',
    ]);
    $edit = [];
    $edit['book[bid]'] = $node
      ->id();
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, t('Save'));
    $node = \Drupal::entityTypeManager()
      ->getStorage('node')
      ->load($node
      ->id());

    // Test the book array.
    $this
      ->assertEqual($node->book['nid'], $node
      ->id());
    $this
      ->assertEqual($node->book['bid'], $node
      ->id());
    $this
      ->assertEqual($node->book['depth'], 1);
    $this
      ->assertEqual($node->book['p1'], $node
      ->id());
    $this
      ->assertEqual($node->book['pid'], '0');

    // Test the form itself.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertOptionSelected('edit-book-bid', $node
      ->id());
  }

  /**
   * Tests that saveBookLink() returns something.
   */
  public function testSaveBookLink() {
    $book_manager = \Drupal::service('book.manager');

    // Mock a link for a new book.
    $link = [
      'nid' => 1,
      'has_children' => 0,
      'original_bid' => 0,
      'parent_depth_limit' => 8,
      'pid' => 0,
      'weight' => 0,
      'bid' => 1,
    ];
    $new = TRUE;

    // Save the link.
    $return = $book_manager
      ->saveBookLink($link, $new);

    // Add the link defaults to $link so we have something to compare to the return from saveBookLink().
    $link += $book_manager
      ->getLinkDefaults($link['nid']);

    // Test the return from saveBookLink.
    $this
      ->assertEqual($return, $link);
  }

  /**
   * Tests the listing of all books.
   */
  public function testBookListing() {

    // Uninstall 'node_access_test' as this interferes with the test.
    \Drupal::service('module_installer')
      ->uninstall([
      'node_access_test',
    ]);

    // Create a new book.
    $nodes = $this
      ->createBook();

    // Load the book page and assert the created book title is displayed.
    $this
      ->drupalGet('book');
    $this
      ->assertText($this->book
      ->label(), 'The book title is displayed on the book listing page.');

    // Unpublish the top book page and confirm that the created book title is
    // not displayed for anonymous.
    $this->book
      ->setUnpublished();
    $this->book
      ->save();
    $this
      ->drupalGet('book');
    $this
      ->assertSession()
      ->pageTextNotContains($this->book
      ->label());

    // Publish the top book page and unpublish a page in the book and confirm
    // that the created book title is displayed for anonymous.
    $this->book
      ->setPublished();
    $this->book
      ->save();
    $nodes[0]
      ->setUnpublished();
    $nodes[0]
      ->save();
    $this
      ->drupalGet('book');
    $this
      ->assertSession()
      ->pageTextContains($this->book
      ->label());

    // Unpublish the top book page and confirm that the created book title is
    // displayed for user which has 'view own unpublished content' permission.
    $this
      ->drupalLogin($this->bookAuthor);
    $this->book
      ->setUnpublished();
    $this->book
      ->save();
    $this
      ->drupalGet('book');
    $this
      ->assertSession()
      ->pageTextContains($this->book
      ->label());

    // Ensure the user doesn't see the book if they don't own it.
    $this->book
      ->setOwner($this->webUser)
      ->save();
    $this
      ->drupalGet('book');
    $this
      ->assertSession()
      ->pageTextNotContains($this->book
      ->label());

    // Confirm that the created book title is displayed for user which has
    // 'view any unpublished content' permission.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('book');
    $this
      ->assertSession()
      ->pageTextContains($this->book
      ->label());
  }

  /**
   * Tests the administrative listing of all books.
   */
  public function testAdminBookListing() {

    // Create a new book.
    $this
      ->createBook();

    // Load the book page and assert the created book title is displayed.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('admin/structure/book');
    $this
      ->assertText($this->book
      ->label(), 'The book title is displayed on the administrative book listing page.');
  }

  /**
   * Tests the administrative listing of all book pages in a book.
   */
  public function testAdminBookNodeListing() {

    // Create a new book.
    $this
      ->createBook();
    $this
      ->drupalLogin($this->adminUser);

    // Load the book page list and assert the created book title is displayed
    // and action links are shown on list items.
    $this
      ->drupalGet('admin/structure/book/' . $this->book
      ->id());
    $this
      ->assertText($this->book
      ->label(), 'The book title is displayed on the administrative book listing page.');
    $elements = $this
      ->xpath('//table//ul[@class="dropbutton"]/li/a');
    $this
      ->assertEqual($elements[0]
      ->getText(), 'View', 'View link is found from the list.');
  }

  /**
   * Ensure the loaded book in hook_node_load() does not depend on the user.
   */
  public function testHookNodeLoadAccess() {
    \Drupal::service('module_installer')
      ->install([
      'node_access_test',
    ]);

    // Ensure that the loaded book in hook_node_load() does NOT depend on the
    // current user.
    $this
      ->drupalLogin($this->bookAuthor);
    $this->book = $this
      ->createBookNode('new');

    // Reset any internal static caching.
    $node_storage = \Drupal::entityTypeManager()
      ->getStorage('node');
    $node_storage
      ->resetCache();

    // Log in as user without access to the book node, so no 'node test view'
    // permission.
    // @see node_access_test_node_grants().
    $this
      ->drupalLogin($this->webUserWithoutNodeAccess);
    $book_node = $node_storage
      ->load($this->book
      ->id());
    $this
      ->assertTrue(!empty($book_node->book));
    $this
      ->assertEqual($book_node->book['bid'], $this->book
      ->id());

    // Reset the internal cache to retrigger the hook_node_load() call.
    $node_storage
      ->resetCache();
    $this
      ->drupalLogin($this->webUser);
    $book_node = $node_storage
      ->load($this->book
      ->id());
    $this
      ->assertTrue(!empty($book_node->book));
    $this
      ->assertEqual($book_node->book['bid'], $this->book
      ->id());
  }

  /**
   * Tests the book navigation block when book is unpublished.
   *
   * There was a fatal error with "Show block only on book pages" block mode.
   */
  public function testBookNavigationBlockOnUnpublishedBook() {

    // Create a new book.
    $this
      ->createBook();

    // Create administrator user.
    $administratorUser = $this
      ->drupalCreateUser([
      'administer blocks',
      'administer nodes',
      'bypass node access',
    ]);
    $this
      ->drupalLogin($administratorUser);

    // Enable the block with "Show block only on book pages" mode.
    $this
      ->drupalPlaceBlock('book_navigation', [
      'block_mode' => 'book pages',
    ]);

    // Unpublish book node.
    $edit = [
      'status[value]' => FALSE,
    ];
    $this
      ->drupalPostForm('node/' . $this->book
      ->id() . '/edit', $edit, t('Save'));

    // Test node page.
    $this
      ->drupalGet('node/' . $this->book
      ->id());
    $this
      ->assertText($this->book
      ->label(), 'Unpublished book with "Show block only on book pages" book navigation settings.');
  }

  /**
   * Tests that the book settings form can be saved without error.
   */
  public function testSettingsForm() {
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalPostForm('admin/structure/book/settings', [], 'Save configuration');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BookTest::$adminUser protected property A user with permission to create and edit books and to administer blocks.
BookTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
BookTest::$modules public static property Modules to install. Overrides BrowserTestBase::$modules
BookTest::$webUser protected property A user with permission to view a book and access printer-friendly version.
BookTest::$webUserWithoutNodeAccess protected property A user without the 'node test view' permission.
BookTest::setUp protected function Overrides BrowserTestBase::setUp
BookTest::testAdminBookListing public function Tests the administrative listing of all books.
BookTest::testAdminBookNodeListing public function Tests the administrative listing of all book pages in a book.
BookTest::testBook public function Tests book functionality through node interfaces.
BookTest::testBookDelete public function Tests the access for deleting top-level book nodes.
BookTest::testBookExport public function Tests book export ("printer-friendly version") functionality.
BookTest::testBookListing public function Tests the listing of all books.
BookTest::testBookNavigationBlock public function Tests the functionality of the book navigation block.
BookTest::testBookNavigationBlockOnUnpublishedBook public function Tests the book navigation block when book is unpublished.
BookTest::testBookNavigationCacheContext public function Tests the book navigation cache context.
BookTest::testBookOutline public function Tests outline of a book.
BookTest::testEmptyBook public function Tests saving the book outline on an empty book.
BookTest::testGetTableOfContents public function Tests BookManager::getTableOfContents().
BookTest::testHookNodeLoadAccess public function Ensure the loaded book in hook_node_load() does not depend on the user.
BookTest::testNavigationBlockOnAccessModuleInstalled public function Tests the book navigation block when an access module is installed.
BookTest::testSaveBookLink public function Tests that saveBookLink() returns something.
BookTest::testSettingsForm public function Tests that the book settings form can be saved without error.
BookTestTrait::$book protected property A book node.
BookTestTrait::$bookAuthor protected property A user with permission to create and edit books.
BookTestTrait::checkBookNode public function Checks the outline of sub-pages; previous, up, and next.
BookTestTrait::createBook public function Creates a new book with a page hierarchy.
BookTestTrait::createBookNode public function Creates a book node.
BookTestTrait::generateOutlinePattern public function Creates a regular expression to check for the sub-nodes in the outline.
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.