AgreementCustomUnprivilegedUserTest.php in Agreement 3.0.x

Namespace

Drupal\Tests\agreement\Functional

File

tests/src/Functional/AgreementCustomUnprivilegedUserTest.php

<?php

namespace Drupal\Tests\agreement\Functional;


/**
 * Tests custom agreement settings.
 *
 * @group agreement
 */
class AgreementCustomUnprivilegedUserTest extends AgreementTestBase {

  /**
   * The user account.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $account;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->account = $this
      ->createUnprivilegedUser();
  }

  /**
   * Asserts that agreement only functions on the front page.
   */
  public function testAgreementPages() {
    $settings = $this->agreement
      ->getSettings();
    $settings['visibility']['settings'] = 1;
    $settings['visibility']['pages'] = [
      '<front>',
    ];
    $this->agreement
      ->set('settings', $settings);
    $this->agreement
      ->save();
    $this
      ->drupalLogin($this->account);

    // Not sent to agreement page.
    $this
      ->assertNotAgreementPage($this->agreement);

    // Go to front page, open agreement.
    $this
      ->drupalGet('/node');
    $this
      ->assertAgreementPage($this->agreement);

    // Go anywhere else, no agreement.
    $this
      ->drupalGet('/user/' . $this->account
      ->id() . '/edit');
    $this
      ->assertNotAgreementPage($this->agreement);
    $privilegedUser = $this
      ->createPrivilegedUser();
    $this
      ->drupalLogin($privilegedUser);
    $this
      ->drupalGet('/admin/config/people/agreement/manage/' . $this->agreement
      ->id() . '/delete');
    $this
      ->submitForm([], 'Confirm');
    $this
      ->assertSession()
      ->pageTextContains('Successfully deleted agreement');
  }

  /**
   * Asserts the agreement frequency option.
   */
  public function testAgreementFrequency() {

    // A) Agreement required once.
    $settings = $this->agreement
      ->getSettings();
    $settings['visibility']['settings'] = 1;
    $settings['visibility']['pages'] = [
      '<front>',
    ];
    $this->agreement
      ->set('settings', $settings);
    $this->agreement
      ->save();

    // Log in, go to front page, open agreement.
    $this
      ->drupalLogin($this->account);
    $this
      ->drupalGet('/node');
    $this
      ->assertAgreementPage($this->agreement);
    $this
      ->assertAgreed($this->agreement);

    // Log out, log back in, open agreement.
    $this
      ->drupalLogin($this->account);
    $this
      ->drupalGet('/node');
    $this
      ->assertNotAgreementPage($this->agreement);
    $this
      ->drupalLogout();

    // B) Agreement required on every login.
    $settings['frequency'] = 0;
    $this->agreement
      ->set('settings', $settings);
    $this->agreement
      ->save();

    // Log in, go to front page, open agreement.
    $this
      ->drupalLogin($this->account);
    $this
      ->drupalGet('/node');
    $this
      ->assertAgreementPage($this->agreement);
    $this
      ->assertAgreed($this->agreement);

    // Log out, log back in, open agreement.
    $this
      ->drupalLogin($this->account);
    $this
      ->drupalGet('/node');
    $this
      ->assertAgreementPage($this->agreement);
    $this
      ->assertAgreed($this->agreement);

    // Change password, no agreement.
    $settings['visibility']['pages'] = [];
    $this->agreement
      ->set('settings', $settings);
    $this->agreement
      ->save();
    $edit = [
      'current_pass' => $this->account->passRaw,
      'pass[pass1]' => $pass = $this
        ->randomString(),
      'pass[pass2]' => $pass,
    ];
    $this
      ->drupalGet('/user/' . $this->account
      ->id() . '/edit');
    $this
      ->submitForm($edit, 'Save');
    if ($this
      ->checkForMetaRefresh()) {
      $this->metaRefreshCount = 0;
    }
    $this
      ->assertNotAgreementPage($this->agreement);
    $this
      ->assertSession()
      ->pageTextContains('The changes have been saved.');
  }

  /**
   * Tests the agreement destination functionality.
   *
   * 1. Agreement destination = blank.
   *   - user goes to regular get URL -> redirect to front.
   *   - user goes to node/1 -> redirect to node/1.
   *   - user needs to change password -> redirect to user/%/edit
   * 2. Agreement destination = node/1.
   *   - user goes to regular get URL -> redirect to node/1.
   *   - user goes to user profile -> redirect to node/1.
   *   - user needs to change password -> redirect to user/%/edit.
   */
  public function testAgreementDestination() {

    // A) Agreement destination = blank.
    $settings = $this->agreement
      ->getSettings();
    $settings['frequency'] = 0;
    $settings['visibility']['pages'] = [
      '/user',
      '/user/*',
    ];
    $this->agreement
      ->set('settings', $settings);
    $this->agreement
      ->save();

    // Log in, open agreement directly (no destination), go to front page.
    $this
      ->drupalLogin($this->account);
    $this
      ->drupalGet($this->agreement
      ->get('path'));
    $this
      ->assertAgreementPage($this->agreement);
    $this
      ->assertAgreed($this->agreement);
    $this
      ->assertFrontPage();
    $this
      ->drupalLogout();

    // Log in, go somewhere other than front page, open agreement, go to user's
    // original destination.
    $this
      ->drupalLogin($this->account);
    $this
      ->drupalGet('/node/' . $this->node
      ->id());
    $this
      ->assertAgreementPage($this->agreement);
    $this
      ->assertAgreed($this->agreement);
    $this
      ->assertSession()
      ->addressMatches('/node\\/' . $this->node
      ->id() . '$/');
    $this
      ->drupalLogout();

    // B) Agreement destination = node/1.
    $settings = $this->agreement
      ->getSettings();
    $settings['destination'] = '/node/1';
    $this->agreement
      ->set('settings', $settings);
    $this->agreement
      ->save();

    // Log in, open agreement via the front page, go to node/1.
    $this
      ->drupalLogin($this->account);
    $this
      ->drupalGet('/node');
    $this
      ->assertAgreementPage($this->agreement);
    $this
      ->assertAgreed($this->agreement);
    $this
      ->assertSession()
      ->addressMatches('/node\\/' . $this->node
      ->id() . '$/');
    $this
      ->drupalLogout();

    // Log in, go somewhere other than front page, open agreement, go to node/1.
    $this
      ->drupalLogin($this->account);
    $this
      ->drupalGet('/node/' . $this->otherNode
      ->id());
    $this
      ->assertAgreementPage($this->agreement);
    $this
      ->assertAgreed($this->agreement);
    $this
      ->assertSession()
      ->addressMatches('/node\\/' . $this->node
      ->id() . '$/');

    // @todo: Log in following password reset link, go somewhere other than
    // front page, open agreement, go to user profile.
  }

}

Classes

Name	Description
AgreementCustomUnprivilegedUserTest	Tests custom agreement settings.