class SettingsFormTest in Automated Logout 8

Tests the settings form.

@description Ensures that the settings form functions as expected.

@group Autologout

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\autologout\Kernel\SettingsFormTest uses UserCreationTrait

Expanded class hierarchy of SettingsFormTest

File

tests/src/Kernel/SettingsFormTest.php, line 17

Namespace

Drupal\Tests\autologout\Kernel

View source

class SettingsFormTest extends KernelTestBase {
  use UserCreationTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'user',
    'system',
    'autologout',
  ];

  /**
   * User with admin rights.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $privilegedUser;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The user data service.
   *
   * @var \Drupal\user\UserData
   */
  public $userData;

  /**
   * The autologout settings form.
   *
   * @var \Drupal\autologout\Form\AutologoutSettingsForm
   */
  protected $settingsForm;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('user', [
      'users_data',
    ]);
    $this
      ->installSchema('system', [
      'sequences',
    ]);
    $this
      ->installConfig('autologout');
    $this->configFactory = $this->container
      ->get('config.factory');
    $this->userData = $this->container
      ->get('user.data');
    $this->privilegedUser = $this
      ->createUser([
      'change own logout threshold',
    ]);
  }

  /**
   * Tests the behaviour of the settings upon submission.
   */
  public function testSettingsForm() {
    $form_builder = $this->container
      ->get('form_builder');
    $settings = $this->configFactory
      ->getEditable('autologout.settings');
    $roles = user_roles();
    $settings
      ->set('max_timeout', 1000)
      ->save();

    // Test that it is possible to set a value above the max_timeout threshold.
    $form_state = (new FormState())
      ->setValues([
      'timeout' => 1500,
      'max_timeout' => 2000,
      'padding' => 60,
      'role_logout' => TRUE,
      'redirect_url' => '/user/login',
    ]);
    foreach ($roles as $key => $role) {
      $form_state
        ->setValue([
        'table',
        $key,
        'enabled',
      ], TRUE);
      $form_state
        ->setValue([
        'table',
        $key,
        'timeout',
      ], 1200);
      $form_state
        ->setValue([
        'table',
        $key,
        'url',
      ], '/user/login');
    }
    $form_builder
      ->submitForm(AutologoutSettingsForm::class, $form_state);
    $this
      ->assertCount(0, $form_state
      ->getErrors());

    // Test that out of range values are picked up.
    $form_state
      ->setValues([
      'timeout' => 2500,
      'max_timeout' => 2000,
      'padding' => 60,
      'role_logout' => TRUE,
      'redirect_url' => '/user/login',
    ]);
    foreach ($roles as $key => $role) {
      $form_state
        ->setValue([
        'table',
        $key,
        'enabled',
      ], TRUE);
      $form_state
        ->setValue([
        'table',
        $key,
        'timeout',
      ], 1200);
      $form_state
        ->setValue([
        'table',
        $key,
        'url',
      ], '/user/login');
    }
    $form_builder
      ->submitForm(AutologoutSettingsForm::class, $form_state);
    $form_errors = $form_state
      ->getErrors();
    $this
      ->assertCount(1, $form_errors);
    $this
      ->assertEquals('The timeout must be an integer greater than or equal to 60 and less then or equal to <em class="placeholder">2000</em>.', $form_errors['timeout']);

    // Test that out of range values are picked up.
    $form_state
      ->setValues([
      'timeout' => 1500,
      'max_timeout' => 2000,
      'padding' => 60,
      'role_logout' => TRUE,
      'redirect_url' => '/user/login',
    ]);
    foreach ($roles as $key => $role) {
      $form_state
        ->setValue([
        'table',
        $key,
        'enabled',
      ], TRUE);
      $form_state
        ->setValue([
        'table',
        $key,
        'timeout',
      ], 2500);
      $form_state
        ->setValue([
        'table',
        $key,
        'url',
      ], '/user/login');
    }
    $form_builder
      ->submitForm(AutologoutSettingsForm::class, $form_state);
    $form_errors = $form_state
      ->getErrors();
    $this
      ->assertCount(1, $form_errors);
    $this
      ->assertEquals(t('%role role timeout must be an integer greater than 60, less then <em class="placeholder">2000</em> or 0 to disable autologout for that role.', [
      '%role' => key($roles),
    ]), $form_errors['table][' . key($roles) . '][timeout']);

    // Test that role timeouts are not validated for disabled roles.
    $form_state
      ->setValues([
      'timeout' => 1500,
      'max_timeout' => 2000,
      'padding' => 60,
      'role_logout' => TRUE,
      'redirect_url' => '/user/login',
    ]);
    foreach ($roles as $key => $role) {
      $form_state
        ->setValue([
        'table',
        $key,
        'enabled',
      ], FALSE);
      $form_state
        ->setValue([
        'table',
        $key,
        'timeout',
      ], 1200);
      $form_state
        ->setValue([
        'table',
        $key,
        'url',
      ], '/user/login');
    }
    $form_builder
      ->submitForm(AutologoutSettingsForm::class, $form_state);
    $this
      ->assertCount(0, $form_state
      ->getErrors());

    // Test clearing of users individual timeout when this becomes disabled.
    $uid = $this->privilegedUser
      ->id();
    $this->userData
      ->set('autologout', $uid, 'timeout', 1600);
    $form_state
      ->setValues([
      'no_individual_logout_threshold' => TRUE,
    ]);
    $form_builder
      ->submitForm(AutologoutSettingsForm::class, $form_state);
    $this
      ->assertAutotimeout($uid, 1500, 'User timeout is cleared when setting no_individual_logout_threshold is activated.');
  }

  /**
   * Tests the precedence of the timeouts.
   *
   * This tests the following function:
   *  _autologout_get_user_timeout();
   */
  public function testTimeoutPrecedence() {
    $settings = $this->configFactory
      ->getEditable('autologout.settings');
    $user_settings = $this->container
      ->get('user.data');
    $uid = $this->privilegedUser
      ->id();
    $role_settings = $this->configFactory
      ->getEditable('autologout.role.' . key(user_roles()));

    // Default used if no role is specified.
    $settings
      ->set('timeout', 100)
      ->set('role_logout', FALSE)
      ->save();
    $role_settings
      ->set('enabled', FALSE)
      ->set('timeout', 200)
      ->save();
    $this
      ->assertAutotimeout($uid, 100, 'User timeout uses default if no other option is set.');

    // Default used if role is selected but no user role is selected.
    $settings
      ->set('role_logout', TRUE)
      ->save();
    $role_settings
      ->set('enabled', FALSE)
      ->set('timeout', 200)
      ->save();
    $this
      ->assertAutotimeout($uid, 100, 'User timeout uses default if role timeouts are used but not one of the current user.');

    // Role timeout is used if user role is selected.
    $settings
      ->set('role_logout', TRUE)
      ->save();
    $role_settings
      ->set('enabled', TRUE)
      ->set('timeout', 200)
      ->save();
    $this
      ->assertAutotimeout($uid, 200, 'User timeout uses role value.');

    // Role timeout is used if user role is selected.
    $settings
      ->set('role_logout', TRUE)
      ->save();
    $role_settings
      ->set('enabled', TRUE)
      ->set('timeout', 0)
      ->save();
    $this
      ->assertAutotimeout($uid, 0, 'User timeout uses role value of 0 if set for one of the user roles.');

    // Role timeout used if personal timeout is an empty string.
    $settings
      ->set('role_logout', TRUE)
      ->save();
    $role_settings
      ->set('enabled', TRUE)
      ->set('timeout', 200)
      ->save();
    $user_settings
      ->set('autologout', $uid, 'timeout', '');
    $user_settings
      ->set('autologout', $uid, 'enabled', FALSE);
    $this
      ->assertAutotimeout($uid, 200, 'User timeout uses role value if personal value is an empty string.');

    // Default timeout used if personal timeout is an empty string.
    $settings
      ->set('role_logout', TRUE)
      ->save();
    $role_settings
      ->set('enabled', FALSE)
      ->set('timeout', 200)
      ->save();
    $user_settings
      ->set('autologout', $uid, 'timeout', '');
    $user_settings
      ->set('autologout', $uid, 'enabled', FALSE);
    $this
      ->assertAutotimeout($uid, 100, 'User timeout uses default value if personal value is an empty string and no role timeout is specified.');

    // Personal timeout used if set.
    $settings
      ->set('role_logout', TRUE)
      ->save();
    $role_settings
      ->set('enabled', FALSE)
      ->set('timeout', 200)
      ->save();
    $user_settings
      ->set('autologout', $uid, 'timeout', 300);
    $user_settings
      ->set('autologout', $uid, 'enabled', TRUE);
    $this
      ->assertAutotimeout($uid, 300, 'User timeout uses personal timeout.');
  }

  /**
   * Asserts the timeout for a particular user.
   *
   * @param int $uid
   *   User uid to assert the timeout for.
   * @param int $expected_timeout
   *   The expected timeout.
   * @param string $message
   *   The test message.
   */
  protected function assertAutotimeout($uid, $expected_timeout, $message = '') {
    self::assertEquals($this->container
      ->get('autologout.manager')
      ->getUserTimeout($uid), $expected_timeout, $message);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
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::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
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.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
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.
SettingsFormTest::$configFactory	protected	property	The config factory service.
SettingsFormTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
SettingsFormTest::$privilegedUser	protected	property	User with admin rights.
SettingsFormTest::$settingsForm	protected	property	The autologout settings form.
SettingsFormTest::$userData	public	property	The user data service.
SettingsFormTest::assertAutotimeout	protected	function	Asserts the timeout for a particular user.
SettingsFormTest::setUp	protected	function	Overrides KernelTestBase::setUp
SettingsFormTest::testSettingsForm	public	function	Tests the behaviour of the settings upon submission.
SettingsFormTest::testTimeoutPrecedence	public	function	Tests the precedence of the timeouts.
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.
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.
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions.
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.

You are here

class SettingsFormTest in Automated Logout 8

Hierarchy

File

Namespace

Members

API Navigation