class FormCacheTest

Tests form caching.

Hierarchy

Expanded class hierarchy of FormCacheTest

File

drupal/core/modules/system/lib/Drupal/system/Tests/Form/FormCacheTest.php, line 15
Contains \Drupal\system\Tests\Form\FormCacheTest.

Namespace

Drupal\system\Tests\Form
View source
class FormCacheTest extends DrupalUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'system',
    'user',
  );
  public static function getInfo() {
    return array(
      'name' => 'Form cache tests',
      'description' => 'Tests form_set_cache() and form_get_cache()',
      'group' => 'Form API',
    );
  }
  public function setUp() {
    parent::setUp();
    $this
      ->installSchema('system', array(
      'key_value_expire',
    ));
    $this->form_build_id = $this
      ->randomName();
    $this->form = array(
      '#property' => $this
        ->randomName(),
    );
    $this->form_state = form_state_defaults();
    $this->form_state['example'] = $this
      ->randomName();
  }

  /**
   * Tests the form cache with a logged-in user.
   */
  function testCacheToken() {
    $GLOBALS['user']->uid = 1;
    form_set_cache($this->form_build_id, $this->form, $this->form_state);
    $cached_form_state = form_state_defaults();
    $cached_form = form_get_cache($this->form_build_id, $cached_form_state);
    $this
      ->assertEqual($this->form['#property'], $cached_form['#property']);
    $this
      ->assertTrue(!empty($cached_form['#cache_token']), 'Form has a cache token');
    $this
      ->assertEqual($this->form_state['example'], $cached_form_state['example']);

    // Test that the form cache isn't loaded when the session/token has changed.
    // Change the private key. (We cannot change the session ID because this
    // will break the parent site test runner batch.)
    \Drupal::state()
      ->set('system.private_key', 'invalid');
    $cached_form_state = form_state_defaults();
    $cached_form = form_get_cache($this->form_build_id, $cached_form_state);
    $this
      ->assertFalse($cached_form, 'No form returned from cache');
    $this
      ->assertTrue(empty($cached_form_state['example']));

    // Test that loading the cache with a different form_id fails.
    $wrong_form_build_id = $this
      ->randomName(9);
    $cached_form_state = form_state_defaults();
    $this
      ->assertFalse(form_get_cache($wrong_form_build_id, $cached_form_state), 'No form returned from cache');
    $this
      ->assertTrue(empty($cached_form_state['example']), 'Cached form state was not loaded');
  }

  /**
   * Tests the form cache without a logged-in user.
   */
  function testNoCacheToken() {
    $GLOBALS['user']->uid = 0;
    $this->form_state['example'] = $this
      ->randomName();
    form_set_cache($this->form_build_id, $this->form, $this->form_state);
    $cached_form_state = form_state_defaults();
    $cached_form = form_get_cache($this->form_build_id, $cached_form_state);
    $this
      ->assertEqual($this->form['#property'], $cached_form['#property']);
    $this
      ->assertTrue(empty($cached_form['#cache_token']), 'Form has no cache token');
    $this
      ->assertEqual($this->form_state['example'], $cached_form_state['example']);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalUnitTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test. 1
DrupalUnitTestBase::disableModules protected function Disables modules for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installConfig protected function Installs default configuration for a given list of modules.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
DrupalUnitTestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. Overrides TestBase::tearDown 2
DrupalUnitTestBase::__construct function Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase::__construct
FormCacheTest::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules
FormCacheTest::getInfo public static function
FormCacheTest::setUp public function Sets up Drupal unit test environment. Overrides DrupalUnitTestBase::setUp
FormCacheTest::testCacheToken function Tests the form cache with a logged-in user.
FormCacheTest::testNoCacheToken function Tests the form cache without a logged-in user.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 1
TestBase::$container protected property The dependency injection container used in the test. 1
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSettings protected property The settings array.
TestBase::$public_files_directory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 4
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 1
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container(). 1
TestBase::run public function Run all tests in this class.
TestBase::settingsSet protected function Changes in memory settings.
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property