public function FlagServiceTest::testFlagServiceFlagExceptions in Flag 8.4

Test exceptions are thrown when flagging and unflagging.

File

tests/src/Kernel/FlagServiceTest.php, line 43

Class

FlagServiceTest

Tests the FlagService.

Namespace

Drupal\Tests\flag\Kernel

Code

public function testFlagServiceFlagExceptions() {
  $not_article = NodeType::create([
    'type' => 'not_article',
  ]);
  $not_article
    ->save();

  // The service methods don't check access, so our user can be anybody.
  // However for identification purposes we must uniquely identify the user
  // associated with the flagging.
  // First user created has uid == 0, the anonymous user. For non-global flags
  // we need to fake a session_id.
  $account = $this
    ->createUser();
  $session_id = 'anonymouse user 1 session_id';

  // Create a flag.
  $flag = Flag::create([
    'id' => strtolower($this
      ->randomMachineName()),
    'label' => $this
      ->randomString(),
    'entity_type' => 'node',
    'bundles' => [
      'article',
    ],
    'flag_type' => 'entity:node',
    'link_type' => 'reload',
    'flagTypeConfig' => [],
    'linkTypeConfig' => [],
  ]);
  $flag
    ->save();

  // Test flagging.
  // Try flagging an entity that's not a node: a user account.
  try {
    $this->flagService
      ->flag($flag, $account, $account, $session_id);
    $this
      ->fail("The exception was not thrown.");
  } catch (\LogicException $e) {
    $this
      ->pass("The flag() method throws an exception when the flag does not apply to the entity type of the flaggable entity.");
  }

  // Try flagging a node of the wrong bundle.
  $wrong_node = Node::create([
    'type' => 'not_article',
    'title' => $this
      ->randomMachineName(8),
  ]);
  $wrong_node
    ->save();
  try {
    $this->flagService
      ->flag($flag, $wrong_node, $account, $session_id);
    $this
      ->fail("The exception was not thrown.");
  } catch (\LogicException $e) {
    $this
      ->pass("The flag() method throws an exception when the flag does not apply to the bundle of the flaggable entity.");
  }

  // Flag the node, then try to flag it again.
  $flaggable_node = Node::create([
    'type' => 'article',
    'title' => $this
      ->randomMachineName(8),
  ]);
  $flaggable_node
    ->save();
  $this->flagService
    ->flag($flag, $flaggable_node, $account, $session_id);
  try {
    $this->flagService
      ->flag($flag, $flaggable_node, $account, $session_id);
    $this
      ->fail("The exception was not thrown.");
  } catch (\LogicException $e) {
    $this
      ->pass("The flag() method throws an exception when the flaggable entity is already flagged by the user with the flag.");
  }
  try {
    $this->flagService
      ->flag($flag, $flaggable_node, $account);
    $this
      ->fail("The exception was not thrown.");
  } catch (\LogicException $e) {
    $this
      ->pass("The flag() method throws an exception when a non-global flag is associated with a poorly specified anonymous user.");
  }

  // Test unflagging.
  // Try unflagging an entity that's not a node: a user account.
  try {
    $this->flagService
      ->unflag($flag, $account, $account, $session_id);
    $this
      ->fail("The exception was not thrown.");
  } catch (\LogicException $e) {
    $this
      ->pass("The unflag() method throws an exception when the flag does not apply to the entity type of the flaggable entity.");
  }

  // Try unflagging a node of the wrong bundle.
  try {
    $this->flagService
      ->unflag($flag, $wrong_node, $account, $session_id);
    $this
      ->fail("The exception was not thrown.");
  } catch (\LogicException $e) {
    $this
      ->pass("The unflag() method throws an exception when the flag does not apply to the bundle of the flaggable entity.");
  }

  // Create a new node that's not flagged, and try to unflag it.
  $unflagged_node = Node::create([
    'type' => 'article',
    'title' => $this
      ->randomMachineName(8),
  ]);
  $unflagged_node
    ->save();
  try {
    $this->flagService
      ->unflag($flag, $unflagged_node, $account, $session_id);
    $this
      ->fail("The exception was not thrown.");
  } catch (\LogicException $e) {
    $this
      ->pass("The unflag() method throws an exception when the flaggable entity is not flagged by the user with the flag.");
  }
  try {
    $this->flagService
      ->unflag($flag, $unflagged_node, $account);
    $this
      ->fail("The exception was not thrown.");
  } catch (\LogicException $e) {
    $this
      ->pass("The unflag() method throws an exception when a non-global flag is associated with a poorly specified anonymous user.");
  }

  // Demonstrate a valid combination can be unflagged without throwing an
  // exception.
  try {
    $this->flagService
      ->unflag($flag, $flaggable_node, $account, $session_id);
    $this
      ->pass('The unflag() method throws no exception when the flaggable entity and user is correct');
  } catch (\LogicException $e) {
    $this
      ->fail('The unfag() method threw an exception where processing a valid unflag request.');
  }
}