cas-8.x-1.x-dev/tests/src/Functional/CasPostLoginDestinationTest.php

<?php

declare(strict_types=1);

namespace Drupal\Tests\cas\Functional;

use Drupal\Core\Url;
use Drupal\Tests\cas\Traits\CasTestTrait;
use Drupal\contact\Entity\ContactForm;

/**
 * Tests the post-login destination.
 *
 * @group cas
 */
class CasPostLoginDestinationTest extends CasBrowserTestBase {

  use CasTestTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'cas',
    'cas_mock_server',
    'cas_test',
    'contact',
    'node',
  ];

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

    // Create a local user.
    $account = $this->createUser(['access site-wide contact form'], 'beavis');
    // Create a CAS user.
    $this->createCasUser('beavis', 'beavis@example.com', 'needtp', [
      'firstname' => 'Beavis',
      'lastname' => 'El Gran Cornholio',
    ], $account);

    // Create a contact form to redirect to after a successful login.
    ContactForm::create(['id' => 'feedback'])->save();
  }

  /**
   * Tests post-login destination.
   *
   * @group legacy
   */
  public function testDestination(): void {
    $this->casLogin('beavis@example.com', 'needtp', [
      'destination' => 'contact',
    ]);
    $this->assertSession()->addressEquals('/contact');
  }

  /**
   * Tests accessing CAS login route when already logged in.
   *
   * Users should not be redirected to the CAS server but should instead
   * just be redirected to the homepage.
   */
  public function testAttemptingLoginAgainRedirectsToHomepage(): void {
    // Start by logging in a user, so we're authenticated.
    $account = $this->createUser([], 'firstname');
    $this->drupalLogin($account);

    $homepage = Url::fromRoute('<front>')->toString();

    // Disable redirects so we can test the initial response from Drupal.
    $this->disableRedirects();
    // Can't use drupalGet as it will follow redirects.
    $this->getSession()->visit($this->buildUrl(Url::fromRoute('cas.login')));
    $this->assertSession()->responseHeaderEquals('Location', $homepage);
    $this->getSession()->visit($this->buildUrl(Url::fromRoute('cas.legacy_login')));
    $this->assertSession()->responseHeaderEquals('Location', $homepage);

    // Test that a destination param on the route is respected and the user
    // is redirected there instead.
    // Create a sample node we can test a redirect to.
    $this->drupalCreateContentType(['type' => 'page', 'name' => 'Basic page']);
    $node = $this->drupalCreateNode();
    $nodeUrl = $node->toUrl(NULL, ['absolute' => TRUE])->toString();
    $nodeSystemPath = 'node/' . $node->id();

    $this->getSession()->visit($this->buildUrl(Url::fromRoute('cas.login', ['destination' => $nodeSystemPath])));
    $this->assertSession()->responseHeaderEquals('Location', $nodeUrl);
    $this->getSession()->visit($this->buildUrl(Url::fromRoute('cas.legacy_login', ['destination' => $nodeSystemPath])));
    $this->assertSession()->responseHeaderEquals('Location', $nodeUrl);

    $this->enabledRedirects();
  }

  /**
   * Tests the cached redirect to CAS login.
   *
   * This is regression test for a complex edge case described in #3277861.
   *
   * @see https://www.drupal.org/project/cas/issues/3277861
   */
  public function testCachedRedirect(): void {
    // Simulate a failed ticket validation.
    // @see \Drupal\cas_test\CasTestSubscriber::onPreValidate()
    \Drupal::state()->set('cas_test.enable_ticket_validation_failure', TRUE);

    // Login with CAS. Expect ticket validation failure.
    $this->casLogin('beavis@example.com', 'needtp', [
      'destination' => 'contact',
    ]);
    $this->assertSession()->pageTextContains('There was a problem validating your login, please contact a site administrator.');

    // Simulate an out-of-sync {cachetags} table. Is known that the redirect
    // response cache is tagged also with 'http_response' cache tag.
    // @see https://www.drupal.org/project/cas/issues/3277861
    \Drupal::database()->query("UPDATE {cachetags} SET invalidations = invalidations + 1 WHERE tag = 'http_response'")->execute();

    // Disable ticket validation failure simulation.
    // @see \Drupal\cas_test\CasTestSubscriber::onPreValidate()
    \Drupal::state()->delete('cas_test.enable_ticket_validation_failure');

    // Try again to access login with CAS.
    $this->casLogin('beavis@example.com', 'needtp', [
      'destination' => 'contact',
    ]);
    $this->assertSession()->addressEquals('/contact');
  }

}