You are here

class LikeAndDislikeTest in Like & Dislike 8

Provides a web test for like_and_dislike module.

Tests that visibility of the like and dislike extra field can be properly changed using the settings form and view mode configuration page. Also test that voting works properly (that likes and dislikes are correctly considered and displayed, for different users, and that vote cancellation can be enabled or disabled).

@group like_and_dislike

Hierarchy

Expanded class hierarchy of LikeAndDislikeTest

File

tests/src/FunctionalJavascript/LikeAndDislikeTest.php, line 26

Namespace

Drupal\Tests\like_and_dislike\FunctionalJavascript
View source
class LikeAndDislikeTest extends WebDriverTestBase {

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  use CommentTestTrait;
  use EntityViewTrait {
    buildEntityView as drupalBuildEntityView;
  }

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'like_and_dislike',
    'node',
    'field_ui',
    'comment',
  ];

  /**
   * A test user with administration permissions.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $adminUser;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Create a node type.
    $node_type = NodeType::create([
      'type' => 'article',
      'name' => 'Article',
    ]);
    $node_type
      ->save();

    // Create a comment type.
    $comment_type = CommentType::create([
      'id' => 'comment',
      'label' => 'Default comments',
      'description' => 'Default comment field',
      'target_entity_type_id' => 'article',
    ]);
    $comment_type
      ->save();
    $this
      ->addDefaultCommentField('node', 'article', 'test_comment_field', CommentItemInterface::OPEN, 'test_comment_type');

    // Create a user with admin permissions and login as this user.
    $admin_permissions = [
      'administer like and dislike',
      'administer node display',
      'administer user display',
      'administer comment display',
      'administer display modes',
      'access comments',
      'administer permissions',
    ];
    $this->adminUser = $this
      ->drupalCreateUser($admin_permissions);
    $this
      ->drupalLogin($this->adminUser);
  }

  /**
   * Tests likes visibility.
   *
   * Test that visibility of likes an dislikes can be correctly changed using
   * the settings form and the extra field visibility setting.
   */
  public function testVisibility() {

    // Create a node.
    $node = Node::create([
      'title' => 'Test node title',
      'type' => 'article',
    ]);
    $node
      ->save();

    // Enable custom display settings for the teaser view mode.
    $this
      ->drupalGet('admin/structure/types/manage/article/display');
    $this
      ->click('#edit-modes summary');
    $edit = [
      'display_modes_custom[teaser]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Enable like an dislike for our article node type, disable for our
    // comment type and enable vote cancellation.
    $edit = [
      'enabled_types[node][enabled]' => TRUE,
      'enabled_types[node][bundle_info][bundles][article]' => TRUE,
      'enabled_types[comment][enabled]' => TRUE,
      'enabled_types[comment][bundle_info][bundles][test_comment_type]' => TRUE,
      'allow_cancel_vote' => TRUE,
      'hide_vote_widget' => FALSE,
    ];
    $this
      ->drupalPostForm('admin/config/search/votingapi/like_and_dislike', $edit, t('Save configuration'));
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    $this
      ->assertFieldChecked('edit-enabled-types-node-enabled');
    $this
      ->assertFieldChecked('edit-enabled-types-comment-enabled');
    $this
      ->assertFieldChecked('edit-enabled-types-node-bundle-info-bundles-article');
    $this
      ->assertNoFieldChecked('edit-enabled-types-comment-bundle-info-bundles-comment');
    $this
      ->assertFieldChecked('edit-enabled-types-comment-bundle-info-bundles-test-comment-type');
    $this
      ->assertFieldChecked('edit-allow-cancel-vote');
    $this
      ->assertNoFieldChecked('edit-hide-vote-widget');

    // Verify there are new like and dislike permissions.
    $this
      ->drupalGet('admin/people/permissions');
    $this
      ->assertSession()
      ->pageTextContains('Content (Article): add/remove Like vote');
    $this
      ->assertSession()
      ->pageTextContains('Content (Article): add/remove Dislike vote');
    $this
      ->assertSession()
      ->pageTextNotContains('Comment (Default comments): add/remove Like vote');
    $this
      ->assertSession()
      ->pageTextNotContains('Comment (Default comments): add/remove Dislike vote');
    $this
      ->assertSession()
      ->pageTextContains('Comment (Test_comment_type): add/remove Like vote');
    $this
      ->assertSession()
      ->pageTextContains('Comment (Test_comment_type): add/remove Dislike vote');

    // Update the user with like and dislike permissions.
    $user_roles = $this->adminUser
      ->getRoles();
    $user_role = end($user_roles);
    $edit = [
      $user_role . '[add or remove like votes on article of node]' => TRUE,
      $user_role . '[add or remove dislike votes on article of node]' => TRUE,
      $user_role . '[add or remove like votes on test_comment_type of comment]' => TRUE,
      $user_role . '[add or remove dislike votes on test_comment_type of comment]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save permissions');

    // Verify that like and dislike field is showing up as a field for default
    // view mode and that it is disabled by default.
    $this
      ->drupalGet('admin/structure/types/manage/article/display');
    $this
      ->assertSession()
      ->pageTextContains('Like and dislike');
    $this
      ->assertOptionSelected('edit-fields-like-and-dislike-region', 'hidden');

    // Same for teaser view mode.
    $this
      ->drupalGet('admin/structure/types/manage/article/display/teaser');
    $this
      ->assertSession()
      ->pageTextContains('Like and dislike');
    $this
      ->assertOptionSelected('edit-fields-like-and-dislike-region', 'hidden');

    // Toggle on visibility of the extra field for default view mode.
    $this
      ->drupalGet('admin/structure/types/manage/article/display');
    $this
      ->assertSession()
      ->waitForElementVisible('css', '[name="fields[like_and_dislike][region]"]');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Show row weights');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('fields[like_and_dislike][region]', 'content');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists('fields[like_and_dislike][region]', 'content')
      ->isSelected());
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');
    $this
      ->assertFalse($this
      ->assertSession()
      ->optionExists('edit-fields-like-and-dislike-region', 'hidden')
      ->isSelected());

    // Verify that like and dislike are properly displayed as links.
    $node_id = $node
      ->id();
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertLikesAndDislikes('node', $node_id);

    // Verify that like and dislike aren't showing up on teaser view mode.
    $teaser_render_array = $this
      ->drupalBuildEntityView($node, 'teaser');
    $this
      ->assertFalse(isset($teaser_render_array['like_and_dislike']));

    // Toggle off visibility of like and dislike for default view mode and on
    // for teaser mode, for nodes.
    $this
      ->drupalGet('admin/structure/types/manage/article/display');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('fields[like_and_dislike][region]', 'hidden');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists('fields[like_and_dislike][region]', 'hidden')
      ->isSelected());
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');
    $this
      ->assertOptionSelected('edit-fields-like-and-dislike-region', 'hidden');
    $this
      ->drupalPostForm('admin/structure/types/manage/article/display/teaser', [
      'fields[like_and_dislike][region]' => 'content',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');
    $this
      ->assertFalse($this
      ->assertSession()
      ->optionExists('edit-fields-like-and-dislike-region', 'hidden')
      ->isSelected());

    // Verify that like and dislike are no longer showing up on default view
    // mode.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertSession()
      ->pageTextNotContains('Like');
    $this
      ->assertSession()
      ->pageTextNotContains('Dislike');

    // Verify that like and dislike are now showing on teaser view mode.
    $teaser_render_array = $this
      ->drupalBuildEntityView($node, 'teaser');
    $this
      ->assertTrue(isset($teaser_render_array['like_and_dislike']));

    // Add a comment to this node.
    $comment = Comment::create([
      'subject' => 'Test subject',
      'comment_body' => 'Test body',
      'entity_id' => $node_id,
      'entity_type' => 'node',
      'node_type' => 'article',
      'field_name' => 'test_comment_field',
      'status' => CommentInterface::PUBLISHED,
      'uid' => $this->adminUser
        ->id(),
    ]);
    $comment
      ->save();
    $comment_id = $comment
      ->id();

    // Verify that like and dislike are not showing up for the comment.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertSession()
      ->pageTextNotContains('Like');
    $this
      ->assertSession()
      ->pageTextNotContains('Dislike');

    // Disable like and dislike for nodes and enable for comments.
    $edit = [
      'enabled_types[node][enabled]' => FALSE,
      'enabled_types[comment][enabled]' => TRUE,
      'enabled_types[comment][bundle_info][bundles][test_comment_type]' => TRUE,
      'allow_cancel_vote' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/config/search/votingapi/like_and_dislike', $edit, t('Save configuration'));
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');

    // Verify that like and dislike are no longer showing up for nodes.
    $teaser_render_array = $this
      ->drupalBuildEntityView($node, 'teaser');
    $this
      ->assertFalse(isset($teaser_render_array['like_and_dislike']));

    // Verify that like an dislike are not showing up for comments yet.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertSession()
      ->pageTextNotContains('Like');
    $this
      ->assertSession()
      ->pageTextNotContains('Dislike');

    // Toggle on visibility of like and dislike for the default view mode for
    // comments.
    $this
      ->drupalGet('admin/structure/comment/manage/test_comment_type/display');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('fields[like_and_dislike][region]', 'content');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Verify that like and dislike are now showing for the comment.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertLikesAndDislikes('comment', $comment_id);

    // Enable and toggle on visibility of like and dislike for both nodes and
    // comments.
    $edit = [
      'enabled_types[node][enabled]' => TRUE,
      'enabled_types[node][bundle_info][bundles][article]' => TRUE,
      'allow_cancel_vote' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/config/search/votingapi/like_and_dislike', $edit, t('Save configuration'));
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    $this
      ->drupalGet('admin/structure/types/manage/article/display');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('fields[like_and_dislike][region]', 'content');
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Verify that both are showing up on the default view mode.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertLikesAndDislikes('node', $node_id);
    $this
      ->assertLikesAndDislikes('comment', $comment_id);

    // Turn on hide vote widget permission.
    $edit = [
      'hide_vote_widget' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/config/search/votingapi/like_and_dislike', $edit, t('Save configuration'));
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    $this
      ->assertFieldChecked('edit-hide-vote-widget');

    // Turn off dislike permission for node and comment.
    $this
      ->drupalGet('admin/people/permissions');
    $edit = [
      $user_role . '[add or remove dislike votes on article of node]' => FALSE,
      $user_role . '[add or remove dislike votes on test_comment_type of comment]' => FALSE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save permissions');

    // Verify that dislike icon is not showed in default view mode.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertVotingIconExistence('node', $node_id, 'like', TRUE);
    $this
      ->assertVotingIconExistence('node', $node_id, 'dislike', FALSE);
    $this
      ->assertVotingIconExistence('comment', $comment_id, 'like', TRUE);
    $this
      ->assertVotingIconExistence('comment', $comment_id, 'dislike', FALSE);

    // Turn off like permission for node and comment.
    $this
      ->drupalGet('admin/people/permissions');
    $edit = [
      $user_role . '[add or remove like votes on article of node]' => FALSE,
      $user_role . '[add or remove like votes on test_comment_type of comment]' => FALSE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save permissions');

    // Verify that both like and dislike icons are not showed in default view
    // mode.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertVotingIconExistence('node', $node_id, 'like', FALSE);
    $this
      ->assertVotingIconExistence('node', $node_id, 'dislike', FALSE);
    $this
      ->assertVotingIconExistence('node', $comment_id, 'dislike', FALSE);
    $this
      ->assertVotingIconExistence('comment', $comment_id, 'dislike', FALSE);
  }

  /**
   * Asserts likes and dislikes for users.
   */
  public function testUserEntity() {

    // Enable likes and dislikes for users.
    $edit = [
      'enabled_types[user][enabled]' => TRUE,
      'allow_cancel_vote' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/config/search/votingapi/like_and_dislike', $edit, t('Save configuration'));
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    $this
      ->assertFieldChecked('edit-enabled-types-user-enabled');

    // Make "like and dislike" component visible.
    $this
      ->drupalGet('admin/config/people/accounts/display');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Show row weights');
    $this
      ->assertSession()
      ->waitForElementVisible('css', '[name="fields[like_and_dislike][region]"]');
    $this
      ->submitForm([
      'fields[like_and_dislike][region]' => 'content',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Go to user profile.
    $user_id = $this->adminUser
      ->id();
    $this
      ->drupalGet('user/' . $user_id);

    // Likes and dislikes are displayed but the user has no permission to vote.
    $this
      ->assertLikesAndDislikes('user', $user_id, '0', '0', TRUE);

    // Allow user "like" permission only and assert the links.
    $user_roles = $this->adminUser
      ->getRoles();
    $user_role = end($user_roles);
    $edit = [
      $user_role . '[add or remove like votes on user]' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/people/permissions', $edit, 'Save permissions');
    $this
      ->drupalGet('user/' . $user_id);

    // Assert user is able to like, but not to dislike.
    $xpath = $this
      ->xpath('//*[@id="like-container-user-' . $user_id . '"]/a')[0];
    $this
      ->assertFalse($xpath
      ->hasAttribute('class'));
    $this
      ->assertEquals($this
      ->cssSelect('#dislike-container-user-' . $user_id . ' a[class]')[0]
      ->getAttribute('class'), 'disable-status');

    // Assert that enabled_types is an empty Array.
    $enabled_types = \Drupal::config('like_and_dislike.settings')
      ->get('enabled_types');
    $this
      ->assertEquals($enabled_types['user'], []);
  }

  /**
   * Asserts module voting.
   *
   * Test that voting (liking and disliking) properly works, including removing
   * a like or dislike (if enabled) and changing a vote.
   */
  public function testVoting() {

    // Create a node and add a comment to it.
    $node = Node::create([
      'title' => 'Test node title',
      'type' => 'article',
    ]);
    $node
      ->save();
    $node_id = $node
      ->id();
    $comment = Comment::create([
      'subject' => 'Test subject',
      'comment_body' => 'Test body',
      'entity_id' => $node_id,
      'entity_type' => 'node',
      'node_type' => 'article',
      'field_name' => 'test_comment_field',
      'status' => CommentInterface::PUBLISHED,
      'uid' => $this->adminUser
        ->id(),
    ]);
    $comment
      ->save();
    $comment_id = $comment
      ->id();

    // Enable like and dislike for nodes and comments (test_comment_type)
    // and enable vote cancellation.
    $edit = [
      'enabled_types[node][enabled]' => TRUE,
      'enabled_types[node][bundle_info][bundles][article]' => TRUE,
      'enabled_types[comment][enabled]' => TRUE,
      'enabled_types[comment][bundle_info][bundles][test_comment_type]' => TRUE,
      'allow_cancel_vote' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/config/search/votingapi/like_and_dislike', $edit, t('Save configuration'));
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');

    // Update user with voting permissions.
    $user_roles = $this->adminUser
      ->getRoles();
    $user_role = end($user_roles);
    $edit = [
      $user_role . '[add or remove like votes on article of node]' => TRUE,
      $user_role . '[add or remove dislike votes on article of node]' => TRUE,
      $user_role . '[add or remove like votes on test_comment_type of comment]' => TRUE,
      $user_role . '[add or remove dislike votes on test_comment_type of comment]' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/people/permissions', $edit, 'Save permissions');

    // Toggle on visibility of the extra fields.
    $this
      ->drupalGet('admin/structure/types/manage/article/display');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Show row weights');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('fields[like_and_dislike][region]', 'content');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists('fields[like_and_dislike][region]', 'content')
      ->isSelected());
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');
    $this
      ->drupalGet('admin/structure/comment/manage/test_comment_type/display');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('fields[like_and_dislike][region]', 'content');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists('fields[like_and_dislike][region]', 'content')
      ->isSelected());
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Verify that the node and comment don't have any like or dislike.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertLikesAndDislikes('node', $node_id);
    $this
      ->assertLikesAndDislikes('comment', $comment_id);

    // Add likes and dislikes and verify that the count increments.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->vote('like', 'node', $node_id, 'Your like vote was added.');
    $xpath = $this
      ->xpath('//*[@id="like-container-node-' . $node_id . '"]/a')[0];
    $this
      ->assertTrue($xpath
      ->hasAttribute('class'));
    $this
      ->assertLikesAndDislikes('node', $node_id, '1');
    $this
      ->assertLikesAndDislikes('comment', $comment_id);
    $this
      ->vote('dislike', 'comment', $comment_id, 'Your dislike vote was added.');
    $xpath = $this
      ->xpath('//*[@id="like-container-comment-' . $comment_id . '"]/a')[0];
    $this
      ->assertFalse($xpath
      ->hasAttribute('class'));
    $this
      ->assertLikesAndDislikes('node', $node_id, '1');
    $this
      ->assertLikesAndDislikes('comment', $comment_id, '0', '1');

    // Login as different users to further increment votes.
    $user2_permissions = [
      'access comments',
      'add or remove like votes on article of node',
      'add or remove dislike votes on article of node',
      'add or remove like votes on test_comment_type of comment',
      'add or remove dislike votes on test_comment_type of comment',
    ];
    $user2 = $this
      ->drupalCreateUser($user2_permissions);
    $this
      ->drupalLogin($user2);

    // Assert that icons are not marked as "voted".
    $this
      ->drupalGet('node/' . $node_id);
    $xpath = $this
      ->xpath('//*[@id="like-container-node-' . $node_id . '"]/a')[0];
    $this
      ->assertFalse($xpath
      ->hasAttribute('class'));
    $xpath = $this
      ->xpath('//*[@id="dislike-container-comment-' . $comment_id . '"]/a')[0];
    $this
      ->assertFalse($xpath
      ->hasAttribute('class'));
    $this
      ->vote('like', 'node', $node_id);
    $this
      ->assertLikesAndDislikes('node', $node_id, '2');
    $this
      ->assertLikesAndDislikes('comment', $comment_id, '0', '1');
    $this
      ->vote('like', 'comment', $comment_id);
    $this
      ->assertLikesAndDislikes('node', $node_id, '2');
    $this
      ->assertLikesAndDislikes('comment', $comment_id, '1', '1');

    // Vote the opposite, to swap the votes.
    $this
      ->vote('dislike', 'node', $node_id);
    $xpath = $this
      ->xpath('//*[@id="like-container-node-' . $node_id . '"]/a')[0];
    $this
      ->assertEquals('', $xpath
      ->getAttribute('class'));
    $this
      ->assertLikesAndDislikes('node', $node_id, '1', '1');
    $this
      ->assertLikesAndDislikes('comment', $comment_id, '1', '1');

    // Vote the same again to cancel the votes. At this point, user 2 voted to
    // dislike the article and like the comment.
    $this
      ->vote('dislike', 'node', $node_id, NULL, TRUE);
    $xpath = $this
      ->xpath('//*[@id="like-container-node-' . $node_id . '"]/a')[0];
    $this
      ->assertEquals('', $xpath
      ->getAttribute('class'));
    $this
      ->assertLikesAndDislikes('node', $node_id, '1');
    $this
      ->assertLikesAndDislikes('comment', $comment_id, '1', '1');

    // Disable vote cancellation.
    $this
      ->drupalLogin($this->adminUser);
    $edit = [
      'enabled_types[node][enabled]' => TRUE,
      'enabled_types[comment][enabled]' => TRUE,
      'enabled_types[comment][bundle_info][bundles][test_comment_type]' => TRUE,
      'allow_cancel_vote' => FALSE,
    ];
    $this
      ->drupalPostForm('admin/config/search/votingapi/like_and_dislike', $edit, t('Save configuration'));
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    $this
      ->drupalLogin($user2);

    // Unsuccessfully try to cancel the comment like vote.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->vote('like', 'comment', $comment_id, 'You are not allowed to vote the same way multiple times.', TRUE);
    $this
      ->assertLikesAndDislikes('node', $node_id, '1');
    $this
      ->assertLikesAndDislikes('comment', $comment_id, '1', '1');

    // Login as a user without permission to add or remove votes.
    $user3_permissions = [
      'access comments',
    ];
    $user3 = $this
      ->drupalCreateUser($user3_permissions);
    $this
      ->drupalLogin($user3);

    // Verify that the votes are correctly displayed, but are not links.
    $this
      ->drupalGet('node/' . $node_id);
    $this
      ->assertLikesAndDislikes('node', $node_id, '1', '0', TRUE);
    $this
      ->assertLikesAndDislikes('comment', $comment_id, '1', '1', TRUE);
  }

  /**
   * Triggers a voting action with given parameters.
   *
   * @param string $vote_type
   *   The vote type.
   * @param string $entity_type_id
   *   The entity type ID.
   * @param string $entity_id
   *   The entity ID.
   * @param string|null $message
   *   (optional) The message to assert.
   * @param bool $cancel
   *   (optional) TRUE if the vote is cancelled. Otherwise, FALSE.
   */
  protected function vote($vote_type, $entity_type_id, $entity_id, $message = NULL, $cancel = FALSE) {

    // Get the current URL.
    $page = $this
      ->getSession()
      ->getPage();
    $container_id = "{$vote_type}-container-{$entity_type_id}-{$entity_id}";
    $link = $page
      ->find('css', "#{$container_id} a");
    $link
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    if ($message) {

      // @todo: The message content is not recognized.
      // $this->assertRaw($message);
    }

    // Assert that voted icon was updated.
    if (!$cancel) {
      $this
        ->assertEquals('voted', $link
        ->getAttribute('class'));
    }
  }

  /**
   * Asserts likes and dislikes markup and their number.
   *
   * @param string $entity_type_id
   *   The entity type ID.
   * @param string $entity_id
   *   The entity ID.
   * @param string $likes
   *   (optional) The number of likes. Default to zero.
   * @param string $dislikes
   *   (optional) The number of dislikes. Default to zero.
   * @param bool $disabled
   *   (optional) If TRUE disabled CSS class is checked.
   */
  protected function assertLikesAndDislikes($entity_type_id, $entity_id, $likes = '0', $dislikes = '0', $disabled = FALSE) {

    // Assert likes.
    $like_container_id = '#like-container-' . $entity_type_id . '-' . $entity_id;
    $this
      ->assertSession()
      ->elementAttributeContains('css', $like_container_id . ' a', 'data-entity-type', $entity_type_id);
    $this
      ->assertSession()
      ->elementAttributeContains('css', $like_container_id . ' a', 'data-entity-id', $entity_id);
    $this
      ->assertSession()
      ->elementContains('css', $like_container_id . ' span.count', $likes);

    // Assert dislikes.
    $dislike_container_id = '#dislike-container-' . $entity_type_id . '-' . $entity_id;
    $this
      ->assertSession()
      ->elementAttributeContains('css', $dislike_container_id . ' a', 'data-entity-type', $entity_type_id);
    $this
      ->assertSession()
      ->elementAttributeContains('css', $dislike_container_id . ' a', 'data-entity-id', $entity_id);
    $this
      ->assertSession()
      ->elementContains('css', $dislike_container_id . ' span.count', $dislikes);
    if ($disabled) {
      $this
        ->assertSession()
        ->elementExists('css', $like_container_id . ' a.disable-status');
      $this
        ->assertSession()
        ->elementExists('css', $dislike_container_id . ' a.disable-status');
    }
  }

  /**
   * Asserts voting icon existence on the page.
   *
   * @param string $entity_type_id
   *   The entity type ID.
   * @param string $entity_id
   *   The entity ID.
   * @param string $type
   *   Type of the icon, can be 'like' or 'dislike'.
   * @param bool $exist
   *   TRUE if icon should exist, FALSE if not.
   */
  protected function assertVotingIconExistence($entity_type_id, $entity_id, $type, $exist) {
    $container_id = $type . '-container-' . $entity_type_id . '-' . $entity_id;
    $css_selector = "#{$container_id} a[data-entity-type]";
    if ($exist) {
      $this
        ->assertSession()
        ->elementExists('css', $css_selector);
    }
    else {
      $this
        ->assertSession()
        ->elementNotExists('css', $css_selector);
    }
  }

}

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::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::$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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
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
EntityViewTrait::buildEntityView protected function Builds the renderable view of an entity. Aliased as: drupalBuildEntityView
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::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.
LikeAndDislikeTest::$adminUser protected property A test user with administration permissions.
LikeAndDislikeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LikeAndDislikeTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
LikeAndDislikeTest::assertLikesAndDislikes protected function Asserts likes and dislikes markup and their number.
LikeAndDislikeTest::assertVotingIconExistence protected function Asserts voting icon existence on the page.
LikeAndDislikeTest::setUp protected function Overrides BrowserTestBase::setUp
LikeAndDislikeTest::testUserEntity public function Asserts likes and dislikes for users.
LikeAndDislikeTest::testVisibility public function Tests likes visibility.
LikeAndDislikeTest::testVoting public function Asserts module voting.
LikeAndDislikeTest::vote protected function Triggers a voting action with given parameters.
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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.