You are here

Home » API reference » Drupal 8 » PagePreviewTest.php

class PagePreviewTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/node/tests/src/Functional/PagePreviewTest.php \Drupal\Tests\node\Functional\PagePreviewTest

Tests the node entity preview functionality.

@group node

Hierarchy

Expanded class hierarchy of PagePreviewTest

File

core/modules/node/tests/src/Functional/PagePreviewTest.php, line 22

Namespace

Drupal\Tests\node\Functional
View source 
class PagePreviewTest extends NodeTestBase {
  use EntityReferenceTestTrait;
  use CommentTestTrait;
  use TestFileCreationTrait {
    getTestFiles as drupalGetTestFiles;
  }

  /**
   * Enable the comment, node and taxonomy modules to test on the preview.
   *
   * @var array
   */
  public static $modules = [
    'node',
    'taxonomy',
    'comment',
    'image',
    'file',
    'text',
    'node_test',
    'menu_ui',
  ];

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

  /**
   * The name of the created field.
   *
   * @var string
   */
  protected $fieldName;
  protected function setUp() {
    parent::setUp();
    $this
      ->addDefaultCommentField('node', 'page');
    $web_user = $this
      ->drupalCreateUser([
      'edit own page content',
      'create page content',
      'administer menu',
    ]);
    $this
      ->drupalLogin($web_user);

    // Add a vocabulary so we can test different view modes.
    $vocabulary = Vocabulary::create([
      'name' => $this
        ->randomMachineName(),
      'description' => $this
        ->randomMachineName(),
      'vid' => $this
        ->randomMachineName(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
      'help' => '',
    ]);
    $vocabulary
      ->save();
    $this->vocabulary = $vocabulary;

    // Add a term to the vocabulary.
    $term = Term::create([
      'name' => $this
        ->randomMachineName(),
      'description' => $this
        ->randomMachineName(),
      'vid' => $this->vocabulary
        ->id(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ]);
    $term
      ->save();
    $this->term = $term;

    // Create an image field.
    FieldStorageConfig::create([
      'field_name' => 'field_image',
      'entity_type' => 'node',
      'type' => 'image',
      'settings' => [],
      'cardinality' => FieldStorageConfig::CARDINALITY_UNLIMITED,
    ])
      ->save();
    $field_config = FieldConfig::create([
      'field_name' => 'field_image',
      'label' => 'Images',
      'entity_type' => 'node',
      'bundle' => 'page',
      'required' => FALSE,
      'settings' => [],
    ]);
    $field_config
      ->save();

    // Create a field.
    $this->fieldName = mb_strtolower($this
      ->randomMachineName());
    $handler_settings = [
      'target_bundles' => [
        $this->vocabulary
          ->id() => $this->vocabulary
          ->id(),
      ],
      'auto_create' => TRUE,
    ];
    $this
      ->createEntityReferenceField('node', 'page', $this->fieldName, 'Tags', 'taxonomy_term', 'default', $handler_settings, FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);

    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
    $display_repository = \Drupal::service('entity_display.repository');
    $display_repository
      ->getFormDisplay('node', 'page')
      ->setComponent($this->fieldName, [
      'type' => 'entity_reference_autocomplete_tags',
    ])
      ->save();

    // Show on default display and teaser.
    $display_repository
      ->getViewDisplay('node', 'page')
      ->setComponent($this->fieldName, [
      'type' => 'entity_reference_label',
    ])
      ->save();
    $display_repository
      ->getViewDisplay('node', 'page', 'teaser')
      ->setComponent($this->fieldName, [
      'type' => 'entity_reference_label',
    ])
      ->save();
    $display_repository
      ->getFormDisplay('node', 'page')
      ->setComponent('field_image', [
      'type' => 'image_image',
      'settings' => [],
    ])
      ->save();
    $display_repository
      ->getViewDisplay('node', 'page')
      ->setComponent('field_image')
      ->save();

    // Create a multi-value text field.
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'field_test_multi',
      'entity_type' => 'node',
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
      'type' => 'text',
      'settings' => [
        'max_length' => 50,
      ],
    ]);
    $field_storage
      ->save();
    FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'page',
    ])
      ->save();
    $display_repository
      ->getFormDisplay('node', 'page')
      ->setComponent('field_test_multi', [
      'type' => 'text_textfield',
    ])
      ->save();
    $display_repository
      ->getViewDisplay('node', 'page')
      ->setComponent('field_test_multi', [
      'type' => 'string',
    ])
      ->save();
  }

  /**
   * Checks the node preview functionality.
   */
  public function testPagePreview() {
    $title_key = 'title[0][value]';
    $body_key = 'body[0][value]';
    $term_key = $this->fieldName . '[target_id]';

    // Fill in node creation form and preview node.
    $edit = [];
    $edit[$title_key] = '<em>' . $this
      ->randomMachineName(8) . '</em>';
    $edit[$body_key] = $this
      ->randomMachineName(16);
    $edit[$term_key] = $this->term
      ->getName();

    // Upload an image.
    $test_image = current($this
      ->drupalGetTestFiles('image', 39325));
    $edit['files[field_image_0][]'] = \Drupal::service('file_system')
      ->realpath($test_image->uri);
    $this
      ->drupalPostForm('node/add/page', $edit, t('Upload'));

    // Add an alt tag and preview the node.
    $this
      ->drupalPostForm(NULL, [
      'field_image[0][alt]' => 'Picture of llamas',
    ], t('Preview'));

    // Check that the preview is displaying the title, body and term.
    $expected_title = $edit[$title_key] . ' | Drupal';
    $this
      ->assertSession()
      ->titleEquals($expected_title);
    $this
      ->assertEscaped($edit[$title_key]);
    $this
      ->assertText($edit[$body_key], 'Body displayed.');
    $this
      ->assertText($edit[$term_key], 'Term displayed.');
    $this
      ->assertSession()
      ->linkExists(t('Back to content editing'));

    // Check that we see the class of the node type on the body element.
    $body_class_element = $this
      ->xpath("//body[contains(@class, 'page-node-type-page')]");
    $this
      ->assertTrue(!empty($body_class_element), 'Node type body class found.');

    // Get the UUID.
    $url = parse_url($this
      ->getUrl());
    $paths = explode('/', $url['path']);
    $view_mode = array_pop($paths);
    $uuid = array_pop($paths);

    // Switch view mode. We'll remove the body from the teaser view mode.
    \Drupal::service('entity_display.repository')
      ->getViewDisplay('node', 'page', 'teaser')
      ->removeComponent('body')
      ->save();
    $view_mode_edit = [
      'view_mode' => 'teaser',
    ];
    $this
      ->drupalPostForm('node/preview/' . $uuid . '/full', $view_mode_edit, t('Switch'));
    $this
      ->assertRaw('view-mode-teaser', 'View mode teaser class found.');
    $this
      ->assertNoText($edit[$body_key], 'Body not displayed.');

    // Check that the title, body and term fields are displayed with the
    // values after going back to the content edit page.
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->assertFieldByName($title_key, $edit[$title_key], 'Title field displayed.');
    $this
      ->assertFieldByName($body_key, $edit[$body_key], 'Body field displayed.');
    $this
      ->assertFieldByName($term_key, $edit[$term_key], 'Term field displayed.');
    $this
      ->assertFieldByName('field_image[0][alt]', 'Picture of llamas');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Add another item');
    $this
      ->assertFieldByName('field_test_multi[0][value]');
    $this
      ->assertFieldByName('field_test_multi[1][value]');

    // Return to page preview to check everything is as expected.
    $this
      ->drupalPostForm(NULL, [], t('Preview'));
    $this
      ->assertSession()
      ->titleEquals($expected_title);
    $this
      ->assertEscaped($edit[$title_key]);
    $this
      ->assertText($edit[$body_key], 'Body displayed.');
    $this
      ->assertText($edit[$term_key], 'Term displayed.');
    $this
      ->assertSession()
      ->linkExists(t('Back to content editing'));

    // Assert the content is kept when reloading the page.
    $this
      ->drupalGet('node/add/page', [
      'query' => [
        'uuid' => $uuid,
      ],
    ]);
    $this
      ->assertFieldByName($title_key, $edit[$title_key], 'Title field displayed.');
    $this
      ->assertFieldByName($body_key, $edit[$body_key], 'Body field displayed.');
    $this
      ->assertFieldByName($term_key, $edit[$term_key], 'Term field displayed.');

    // Save the node - this is a new POST, so we need to upload the image.
    $this
      ->drupalPostForm('node/add/page', $edit, t('Upload'));
    $this
      ->drupalPostForm(NULL, [
      'field_image[0][alt]' => 'Picture of llamas',
    ], t('Save'));
    $node = $this
      ->drupalGetNodeByTitle($edit[$title_key]);

    // Check the term was displayed on the saved node.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertText($edit[$term_key], 'Term displayed.');

    // Check the term appears again on the edit form.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertFieldByName($term_key, $edit[$term_key] . ' (' . $this->term
      ->id() . ')', 'Term field displayed.');

    // Check with two new terms on the edit form, additionally to the existing
    // one.
    $edit = [];
    $newterm1 = $this
      ->randomMachineName(8);
    $newterm2 = $this
      ->randomMachineName(8);
    $edit[$term_key] = $this->term
      ->getName() . ', ' . $newterm1 . ', ' . $newterm2;
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, t('Preview'));
    $this
      ->assertRaw('>' . $newterm1 . '<', 'First new term displayed.');
    $this
      ->assertRaw('>' . $newterm2 . '<', 'Second new term displayed.');

    // The first term should be displayed as link, the others not.
    $this
      ->assertSession()
      ->linkExists($this->term
      ->getName());
    $this
      ->assertSession()
      ->linkNotExists($newterm1);
    $this
      ->assertSession()
      ->linkNotExists($newterm2);
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, t('Save'));

    // Check with one more new term, keeping old terms, removing the existing
    // one.
    $edit = [];
    $newterm3 = $this
      ->randomMachineName(8);
    $edit[$term_key] = $newterm1 . ', ' . $newterm3 . ', ' . $newterm2;
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, t('Preview'));
    $this
      ->assertRaw('>' . $newterm1 . '<', 'First existing term displayed.');
    $this
      ->assertRaw('>' . $newterm2 . '<', 'Second existing term displayed.');
    $this
      ->assertRaw('>' . $newterm3 . '<', 'Third new term displayed.');
    $this
      ->assertNoText($this->term
      ->getName());
    $this
      ->assertSession()
      ->linkExists($newterm1);
    $this
      ->assertSession()
      ->linkExists($newterm2);
    $this
      ->assertSession()
      ->linkNotExists($newterm3);

    // Check that editing an existing node after it has been previewed and not
    // saved doesn't remember the previous changes.
    $edit = [
      $title_key => $this
        ->randomMachineName(8),
    ];
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, t('Preview'));
    $this
      ->assertText($edit[$title_key], 'New title displayed.');
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->assertFieldByName($title_key, $edit[$title_key], 'New title value displayed.');

    // Navigate away from the node without saving.
    $this
      ->drupalGet('<front>');

    // Go back to the edit form, the title should have its initial value.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertFieldByName($title_key, $node
      ->label(), 'Correct title value displayed.');

    // Check with required preview.
    $node_type = NodeType::load('page');
    $node_type
      ->setPreviewMode(DRUPAL_REQUIRED);
    $node_type
      ->save();
    $this
      ->drupalGet('node/add/page');
    $this
      ->assertNoRaw('edit-submit');
    $this
      ->drupalPostForm('node/add/page', [
      $title_key => 'Preview',
    ], t('Preview'));
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->assertRaw('edit-submit');

    // Check that destination is remembered when clicking on preview. When going
    // back to the edit form and clicking save, we should go back to the
    // original destination, if set.
    $destination = 'node';
    $this
      ->drupalPostForm($node
      ->toUrl('edit-form'), [], t('Preview'), [
      'query' => [
        'destination' => $destination,
      ],
    ]);
    $parameters = [
      'node_preview' => $node
        ->uuid(),
      'view_mode_id' => 'full',
    ];
    $options = [
      'absolute' => TRUE,
      'query' => [
        'destination' => $destination,
      ],
    ];
    $this
      ->assertUrl(Url::fromRoute('entity.node.preview', $parameters, $options));
    $this
      ->drupalPostForm(NULL, [
      'view_mode' => 'teaser',
    ], t('Switch'));
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->drupalPostForm(NULL, [], t('Save'));
    $this
      ->assertUrl($destination);

    // Check that preview page works as expected without a destination set.
    $this
      ->drupalPostForm($node
      ->toUrl('edit-form'), [], t('Preview'));
    $parameters = [
      'node_preview' => $node
        ->uuid(),
      'view_mode_id' => 'full',
    ];
    $this
      ->assertUrl(Url::fromRoute('entity.node.preview', $parameters, [
      'absolute' => TRUE,
    ]));
    $this
      ->drupalPostForm(NULL, [
      'view_mode' => 'teaser',
    ], t('Switch'));
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->drupalPostForm(NULL, [], t('Save'));
    $this
      ->assertUrl($node
      ->toUrl());
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');

    // Assert multiple items can be added and are not lost when previewing.
    $test_image_1 = current($this
      ->drupalGetTestFiles('image', 39325));
    $edit_image_1['files[field_image_0][]'] = $file_system
      ->realpath($test_image_1->uri);
    $test_image_2 = current($this
      ->drupalGetTestFiles('image', 39325));
    $edit_image_2['files[field_image_1][]'] = $file_system
      ->realpath($test_image_2->uri);
    $edit['field_image[0][alt]'] = 'Alt 1';
    $this
      ->drupalPostForm('node/add/page', $edit_image_1, t('Upload'));
    $this
      ->drupalPostForm(NULL, $edit, t('Preview'));
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->assertFieldByName('files[field_image_1][]');
    $this
      ->drupalPostForm(NULL, $edit_image_2, t('Upload'));
    $this
      ->assertNoFieldByName('files[field_image_1][]');
    $title = 'node_test_title';
    $example_text_1 = 'example_text_preview_1';
    $example_text_2 = 'example_text_preview_2';
    $example_text_3 = 'example_text_preview_3';
    $this
      ->drupalGet('node/add/page');
    $edit = [
      'title[0][value]' => $title,
      'field_test_multi[0][value]' => $example_text_1,
    ];
    $this
      ->assertRaw('Storage is not set');
    $this
      ->drupalPostForm(NULL, $edit, t('Preview'));
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->assertRaw('Storage is set');
    $this
      ->assertFieldByName('field_test_multi[0][value]');
    $this
      ->drupalPostForm(NULL, [], t('Save'));
    $this
      ->assertText('Basic page ' . $title . ' has been created.');
    $node = $this
      ->drupalGetNodeByTitle($title);
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Add another item');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Add another item');
    $edit = [
      'field_test_multi[1][value]' => $example_text_2,
      'field_test_multi[2][value]' => $example_text_3,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Preview'));
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->drupalPostForm(NULL, $edit, t('Preview'));
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->assertFieldByName('field_test_multi[0][value]', $example_text_1);
    $this
      ->assertFieldByName('field_test_multi[1][value]', $example_text_2);
    $this
      ->assertFieldByName('field_test_multi[2][value]', $example_text_3);

    // Now save the node and make sure all values got saved.
    $this
      ->drupalPostForm(NULL, [], t('Save'));
    $this
      ->assertText($example_text_1);
    $this
      ->assertText($example_text_2);
    $this
      ->assertText($example_text_3);

    // Edit again, change the menu_ui settings and click on preview.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $edit = [
      'menu[enabled]' => TRUE,
      'menu[title]' => 'Changed title',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Preview'));
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->assertFieldChecked('edit-menu-enabled', 'Menu option is still checked');
    $this
      ->assertFieldByName('menu[title]', 'Changed title', 'Menu link title is correct after preview');

    // Save, change the title while saving and make sure that it is correctly
    // saved.
    $edit = [
      'menu[enabled]' => TRUE,
      'menu[title]' => 'Second title change',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertFieldByName('menu[title]', 'Second title change', 'Menu link title is correct after saving');
  }

  /**
   * Checks the node preview functionality, when using revisions.
   */
  public function testPagePreviewWithRevisions() {
    $title_key = 'title[0][value]';
    $body_key = 'body[0][value]';
    $term_key = $this->fieldName . '[target_id]';

    // Force revision on "Basic page" content.
    $node_type = NodeType::load('page');
    $node_type
      ->setNewRevision(TRUE);
    $node_type
      ->save();

    // Fill in node creation form and preview node.
    $edit = [];
    $edit[$title_key] = $this
      ->randomMachineName(8);
    $edit[$body_key] = $this
      ->randomMachineName(16);
    $edit[$term_key] = $this->term
      ->id();
    $edit['revision_log[0][value]'] = $this
      ->randomString(32);
    $this
      ->drupalPostForm('node/add/page', $edit, t('Preview'));

    // Check that the preview is displaying the title, body and term.
    $this
      ->assertTitle($edit[$title_key] . ' | Drupal');
    $this
      ->assertText($edit[$title_key], 'Title displayed.');
    $this
      ->assertText($edit[$body_key], 'Body displayed.');
    $this
      ->assertText($edit[$term_key], 'Term displayed.');

    // Check that the title and body fields are displayed with the correct
    // values after going back to the content edit page.
    $this
      ->clickLink(t('Back to content editing'));
    $this
      ->assertFieldByName($title_key, $edit[$title_key], 'Title field displayed.');
    $this
      ->assertFieldByName($body_key, $edit[$body_key], 'Body field displayed.');
    $this
      ->assertFieldByName($term_key, $edit[$term_key], 'Term field displayed.');

    // Check that the revision log field has the correct value.
    $this
      ->assertFieldByName('revision_log[0][value]', $edit['revision_log[0][value]'], 'Revision log field displayed.');

    // Save the node after coming back from the preview page so we can create a
    // pending revision for it.
    $this
      ->drupalPostForm(NULL, [], t('Save'));
    $node = $this
      ->drupalGetNodeByTitle($edit[$title_key]);

    // Check that previewing a pending revision of a node works. This can not be
    // accomplished through the UI so we have to use API calls.
    // @todo Change this test to use the UI when we will be able to create
    // pending revisions in core.
    // @see https://www.drupal.org/node/2725533
    $node
      ->setNewRevision(TRUE);
    $node
      ->isDefaultRevision(FALSE);

    /** @var \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver */
    $controller_resolver = \Drupal::service('controller_resolver');
    $node_preview_controller = $controller_resolver
      ->getControllerFromDefinition('\\Drupal\\node\\Controller\\NodePreviewController::view');
    $node_preview_controller($node, 'full');
  }

  /**
   * Checks the node preview accessible for simultaneous node editing.
   */
  public function testSimultaneousPreview() {
    $title_key = 'title[0][value]';
    $node = $this
      ->drupalCreateNode([]);
    $edit = [
      $title_key => 'New page title',
    ];
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, t('Preview'));
    $this
      ->assertText($edit[$title_key]);
    $user2 = $this
      ->drupalCreateUser([
      'edit any page content',
    ]);
    $this
      ->drupalLogin($user2);
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertFieldByName($title_key, $node
      ->label(), 'No title leaked from previous user.');
    $edit2 = [
      $title_key => 'Another page title',
    ];
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit2, t('Preview'));
    $this
      ->assertUrl(Url::fromRoute('entity.node.preview', [
      'node_preview' => $node
        ->uuid(),
      'view_mode_id' => 'full',
    ], [
      'absolute' => TRUE,
    ])
      ->toString());
    $this
      ->assertText($edit2[$title_key]);
  }

}

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
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.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
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
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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
NodeTestBase::$accessHandler protected property The node access control handler.
NodeTestBase::assertNodeAccess public function Asserts that node access correctly grants or denies access.
NodeTestBase::assertNodeCreateAccess public function Asserts that node create access correctly grants or denies access.
NodeTestBase::nodeAccessAssertMessage public function Constructs an assert message to display which node access was tested.
PagePreviewTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PagePreviewTest::$fieldName protected property The name of the created field.
PagePreviewTest::$modules public static property Enable the comment, node and taxonomy modules to test on the preview. Overrides NodeTestBase::$modules
PagePreviewTest::setUp protected function Overrides NodeTestBase::setUp
PagePreviewTest::testPagePreview public function Checks the node preview functionality.
PagePreviewTest::testPagePreviewWithRevisions public function Checks the node preview functionality, when using revisions.
PagePreviewTest::testSimultaneousPreview public function Checks the node preview accessible for simultaneous node editing.
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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
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.