class PageCacheTest in Drupal 9

Same name and namespace in other branches

8 core/modules/page_cache/tests/src/Functional/PageCacheTest.php \Drupal\Tests\page_cache\Functional\PageCacheTest

Enables the page cache and tests it with various HTTP requests.

@group page_cache

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\page_cache\Functional\PageCacheTest uses AssertPageCacheContextsAndTagsTrait

Expanded class hierarchy of PageCacheTest

File

core/modules/page_cache/tests/src/Functional/PageCacheTest.php, line 19

Namespace

Drupal\Tests\page_cache\Functional

View source

class PageCacheTest extends BrowserTestBase {
  use AssertPageCacheContextsAndTagsTrait;
  protected $dumpHeaders = TRUE;

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'test_page_test',
    'system_test',
    'entity_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->config('system.site')
      ->set('name', 'Drupal')
      ->set('page.front', '/test-page')
      ->save();
  }

  /**
   * Tests that cache tags are properly persisted.
   *
   * Since tag based invalidation works, we know that our tag properly
   * persisted.
   */
  public function testPageCacheTags() {
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();
    $path = 'system-test/cache_tags_page';
    $tags = [
      'system_test_cache_tags_page',
    ];
    $this
      ->drupalGet($path);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->drupalGet($path);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $cid_parts = [
      Url::fromRoute('system_test.cache_tags_page', [], [
        'absolute' => TRUE,
      ])
        ->toString(),
      '',
    ];
    $cid = implode(':', $cid_parts);
    $cache_entry = \Drupal::cache('page')
      ->get($cid);
    sort($cache_entry->tags);
    $expected_tags = [
      'config:user.role.anonymous',
      'http_response',
      'pre_render',
      'rendered',
      'system_test_cache_tags_page',
    ];
    $this
      ->assertSame($expected_tags, $cache_entry->tags);
    Cache::invalidateTags($tags);
    $this
      ->drupalGet($path);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
  }

  /**
   * Tests that the page cache doesn't depend on cacheability headers.
   */
  public function testPageCacheTagsIndependentFromCacheabilityHeaders() {

    // Disable the cacheability headers.
    $this
      ->setContainerParameter('http.response.debug_cacheability_headers', FALSE);
    $this
      ->rebuildContainer();
    $this
      ->resetAll();
    $path = 'system-test/cache_tags_page';
    $tags = [
      'system_test_cache_tags_page',
    ];
    $this
      ->drupalGet($path);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->drupalGet($path);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $cid_parts = [
      Url::fromRoute('system_test.cache_tags_page', [], [
        'absolute' => TRUE,
      ])
        ->toString(),
      '',
    ];
    $cid = implode(':', $cid_parts);
    $cache_entry = \Drupal::cache('page')
      ->get($cid);
    sort($cache_entry->tags);
    $expected_tags = [
      'config:user.role.anonymous',
      'http_response',
      'pre_render',
      'rendered',
      'system_test_cache_tags_page',
    ];
    $this
      ->assertSame($expected_tags, $cache_entry->tags);
    Cache::invalidateTags($tags);
    $this
      ->drupalGet($path);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
  }

  /**
   * Tests support for different cache items with different request formats
   * specified via a query parameter.
   */
  public function testQueryParameterFormatRequests() {
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();
    $accept_header_cache_url = Url::fromRoute('system_test.page_cache_accept_header');
    $accept_header_cache_url_with_json = Url::fromRoute('system_test.page_cache_accept_header', [
      '_format' => 'json',
    ]);
    $this
      ->drupalGet($accept_header_cache_url);

    // Verify that HTML page was not yet cached.
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->drupalGet($accept_header_cache_url);

    // Verify that HTML page was cached.
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');

    // Verify that the correct HTML response was returned.
    $this
      ->assertSession()
      ->responseContains('<p>oh hai this is html.</p>');
    $this
      ->drupalGet($accept_header_cache_url_with_json);

    // Verify that JSON response was not yet cached.
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->drupalGet($accept_header_cache_url_with_json);

    // Verify that JSON response was cached.
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');

    // Verify that the correct JSON response was returned.
    $this
      ->assertSession()
      ->responseContains('{"content":"oh hai this is json"}');

    // Enable REST support for nodes and hal+json.
    \Drupal::service('module_installer')
      ->install([
      'node',
      'rest',
      'hal',
      'basic_auth',
    ]);
    $this
      ->drupalCreateContentType([
      'type' => 'article',
    ]);
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
    ]);
    $node_uri = $node
      ->toUrl();
    $node_url_with_hal_json_format = $node
      ->toUrl('canonical')
      ->setRouteParameter('_format', 'hal_json');
    $this
      ->drupalGet($node_uri);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'text/html; charset=UTF-8');
    $this
      ->drupalGet($node_uri);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'text/html; charset=UTF-8');

    // Now request a HAL page, we expect that the first request is a cache miss
    // and it serves HTML.
    $this
      ->drupalGet($node_url_with_hal_json_format);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'application/hal+json');
    $this
      ->drupalGet($node_url_with_hal_json_format);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'application/hal+json');

    // Clear the page cache. After that request a HAL request, followed by an
    // ordinary HTML one.
    \Drupal::cache('page')
      ->deleteAll();
    $this
      ->drupalGet($node_url_with_hal_json_format);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'application/hal+json');
    $this
      ->drupalGet($node_url_with_hal_json_format);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'application/hal+json');
    $this
      ->drupalGet($node_uri);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'text/html; charset=UTF-8');
    $this
      ->drupalGet($node_uri);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'text/html; charset=UTF-8');
  }

  /**
   * Tests support of requests with If-Modified-Since and If-None-Match headers.
   */
  public function testConditionalRequests() {
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();

    // Fill the cache.
    $this
      ->drupalGet('');

    // Verify the page is not printed twice when the cache is cold.
    $this
      ->assertSession()
      ->responseNotMatches('#<html.*<html#');
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $etag = $this
      ->getSession()
      ->getResponseHeader('ETag');
    $last_modified = $this
      ->getSession()
      ->getResponseHeader('Last-Modified');

    // Ensure a conditional request returns 304 Not Modified.
    $this
      ->drupalGet('', [], [
      'If-Modified-Since' => $last_modified,
      'If-None-Match' => $etag,
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(304);

    // Ensure a conditional request with obsolete If-Modified-Since date
    // returns 304 Not Modified.
    $this
      ->drupalGet('', [], [
      'If-Modified-Since' => gmdate(DATE_RFC822, strtotime($last_modified)),
      'If-None-Match' => $etag,
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(304);

    // Ensure a conditional request with obsolete If-Modified-Since date
    // returns 304 Not Modified.
    $this
      ->drupalGet('', [], [
      'If-Modified-Since' => gmdate(DATE_RFC850, strtotime($last_modified)),
      'If-None-Match' => $etag,
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(304);

    // Ensure a conditional request without If-None-Match returns 200 OK.
    $this
      ->drupalGet('', [], [
      'If-Modified-Since' => $last_modified,
      'If-None-Match' => NULL,
    ]);

    // Verify the page is not printed twice when the cache is warm.
    $this
      ->assertSession()
      ->responseNotMatches('#<html.*<html#');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');

    // Ensure a conditional request with If-Modified-Since newer than
    // Last-Modified returns 200 OK.
    $this
      ->drupalGet('', [], [
      'If-Modified-Since' => gmdate(DateTimePlus::RFC7231, strtotime($last_modified) + 1),
      'If-None-Match' => $etag,
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');

    // Ensure a conditional request by an authenticated user returns 200 OK.
    $user = $this
      ->drupalCreateUser();
    $this
      ->drupalLogin($user);
    $this
      ->drupalGet('', [], [
      'If-Modified-Since' => $last_modified,
      'If-None-Match' => $etag,
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Verify that absence of Page was not cached.
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('X-Drupal-Cache');
  }

  /**
   * Tests cache headers.
   */
  public function testPageCache() {
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();

    // Fill the cache.
    $this
      ->drupalGet('system-test/set-header', [
      'query' => [
        'name' => 'Foo',
        'value' => 'bar',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->assertSession()
      ->responseHeaderContains('Vary', 'cookie');

    // Symfony's Response logic determines a specific order for the subvalues
    // of the Cache-Control header, even if they are explicitly passed in to
    // the response header bag in a different order.
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=300, public');
    $this
      ->assertSession()
      ->responseHeaderEquals('Expires', 'Sun, 19 Nov 1978 05:00:00 GMT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Foo', 'bar');

    // Check cache.
    $this
      ->drupalGet('system-test/set-header', [
      'query' => [
        'name' => 'Foo',
        'value' => 'bar',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderContains('Vary', 'cookie');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=300, public');
    $this
      ->assertSession()
      ->responseHeaderEquals('Expires', 'Sun, 19 Nov 1978 05:00:00 GMT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Foo', 'bar');

    // Check replacing default headers.
    $this
      ->drupalGet('system-test/set-header', [
      'query' => [
        'name' => 'Expires',
        'value' => 'Fri, 19 Nov 2008 05:00:00 GMT',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('Expires', 'Fri, 19 Nov 2008 05:00:00 GMT');
    $this
      ->drupalGet('system-test/set-header', [
      'query' => [
        'name' => 'Vary',
        'value' => 'User-Agent',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderContains('Vary', 'user-agent');

    // Check that authenticated users bypass the cache.
    $user = $this
      ->drupalCreateUser();
    $this
      ->drupalLogin($user);
    $this
      ->drupalGet('system-test/set-header', [
      'query' => [
        'name' => 'Foo',
        'value' => 'bar',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('X-Drupal-Cache');
    $this
      ->assertSession()
      ->responseHeaderNotContains('Vary', 'cookie');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'must-revalidate, no-cache, private');
    $this
      ->assertSession()
      ->responseHeaderEquals('Expires', 'Sun, 19 Nov 1978 05:00:00 GMT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Foo', 'bar');

    // Until bubbling of max-age up to the response is supported, verify that
    // a custom #cache max-age set on an element does not affect page max-age.
    $this
      ->drupalLogout();
    $this
      ->drupalGet('system-test/cache_maxage_page');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=300, public');
  }

  /**
   * Tests the automatic presence of the anonymous role's cache tag.
   *
   * The 'user.permissions' cache context ensures that if the permissions for a
   * role are modified, users are not served stale render cache content. But,
   * when entire responses are cached in reverse proxies, the value for the
   * cache context is never calculated, causing the stale response to not be
   * invalidated. Therefore, when varying by permissions and the current user is
   * the anonymous user, the cache tag for the 'anonymous' role must be added.
   *
   * This test verifies that, and it verifies that it does not happen for other
   * roles.
   */
  public function testPageCacheAnonymousRolePermissions() {
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();
    $content_url = Url::fromRoute('system_test.permission_dependent_content');
    $route_access_url = Url::fromRoute('system_test.permission_dependent_route_access');

    // 1. anonymous user, without permission.
    $this
      ->drupalGet($content_url);
    $this
      ->assertSession()
      ->pageTextContains('Permission to pet llamas: no!');
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertSession()
      ->responseHeaderContains('X-Drupal-Cache-Tags', 'config:user.role.anonymous');
    $this
      ->drupalGet($route_access_url);
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertSession()
      ->responseHeaderContains('X-Drupal-Cache-Tags', 'config:user.role.anonymous');

    // 2. anonymous user, with permission.
    user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
      'pet llamas',
    ]);
    $this
      ->drupalGet($content_url);
    $this
      ->assertSession()
      ->pageTextContains('Permission to pet llamas: yes!');
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertSession()
      ->responseHeaderContains('X-Drupal-Cache-Tags', 'config:user.role.anonymous');
    $this
      ->drupalGet($route_access_url);
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertSession()
      ->responseHeaderContains('X-Drupal-Cache-Tags', 'config:user.role.anonymous');

    // 3. authenticated user, without permission.
    $auth_user = $this
      ->drupalCreateUser();
    $this
      ->drupalLogin($auth_user);
    $this
      ->drupalGet($content_url);
    $this
      ->assertSession()
      ->pageTextContains('Permission to pet llamas: no!');
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertSession()
      ->responseHeaderNotContains('X-Drupal-Cache-Tags', 'config:user.role.authenticated');
    $this
      ->drupalGet($route_access_url);
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertSession()
      ->responseHeaderNotContains('X-Drupal-Cache-Tags', 'config:user.role.authenticated');

    // 4. authenticated user, with permission.
    user_role_grant_permissions(RoleInterface::AUTHENTICATED_ID, [
      'pet llamas',
    ]);
    $this
      ->drupalGet($content_url);
    $this
      ->assertSession()
      ->pageTextContains('Permission to pet llamas: yes!');
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertSession()
      ->responseHeaderNotContains('X-Drupal-Cache-Tags', 'config:user.role.authenticated');
    $this
      ->drupalGet($route_access_url);
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertSession()
      ->responseHeaderNotContains('X-Drupal-Cache-Tags', 'config:user.role.authenticated');
  }

  /**
   * Tests the 4xx-response cache tag is added and invalidated.
   */
  public function testPageCacheAnonymous403404() {
    $admin_url = Url::fromRoute('system.admin');
    $invalid_url = 'foo/does_not_exist';
    $tests = [
      403 => $admin_url,
      404 => $invalid_url,
    ];
    $cache_ttl_4xx = Settings::get('cache_ttl_4xx', 3600);
    foreach ($tests as $code => $content_url) {

      // Anonymous user, without permissions.
      $this
        ->drupalGet($content_url);
      $this
        ->assertSession()
        ->statusCodeEquals($code);
      $this
        ->assertSession()
        ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
      $this
        ->assertSession()
        ->responseHeaderContains('X-Drupal-Cache-Tags', '4xx-response');
      $this
        ->drupalGet($content_url);
      $this
        ->assertSession()
        ->statusCodeEquals($code);
      $this
        ->assertSession()
        ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
      $entity_values = [
        'name' => $this
          ->randomMachineName(),
        'user_id' => 1,
        'field_test_text' => [
          0 => [
            'value' => $this
              ->randomString(),
            'format' => 'plain_text',
          ],
        ],
      ];
      $entity = EntityTest::create($entity_values);
      $entity
        ->save();

      // Saving an entity clears 4xx cache tag.
      $this
        ->drupalGet($content_url);
      $this
        ->assertSession()
        ->statusCodeEquals($code);
      $this
        ->assertSession()
        ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
      $this
        ->drupalGet($content_url);
      $this
        ->assertSession()
        ->statusCodeEquals($code);
      $this
        ->assertSession()
        ->responseHeaderEquals('X-Drupal-Cache', 'HIT');

      // Rebuilding the router should invalidate the 4xx cache tag.
      $this->container
        ->get('router.builder')
        ->rebuild();
      $this
        ->drupalGet($content_url);
      $this
        ->assertSession()
        ->statusCodeEquals($code);
      $this
        ->assertSession()
        ->responseHeaderEquals('X-Drupal-Cache', 'MISS');

      // Ensure the 'expire' field on the cache entry uses cache_ttl_4xx.
      $cache_item = \Drupal::service('cache.page')
        ->get($this
        ->getUrl() . ':');
      $difference = $cache_item->expire - (int) $cache_item->created;

      // Given that a second might have passed we cannot be sure that
      // $difference will exactly equal the default cache_ttl_4xx setting.
      // Account for any timing difference or rounding errors by ensuring the
      // value is within 10 seconds.
      $this
        ->assertTrue($difference > $cache_ttl_4xx - 10 && $difference < $cache_ttl_4xx + 10, "The cache entry expiry time uses the cache_ttl_4xx setting. Expire: {$cache_item->expire} Created: {$cache_item->created}");
    }

    // Disable 403 and 404 caching.
    $settings['settings']['cache_ttl_4xx'] = (object) [
      'value' => 0,
      'required' => TRUE,
    ];
    $this
      ->writeSettings($settings);
    \Drupal::service('cache.page')
      ->deleteAll();
    foreach ($tests as $code => $content_url) {

      // Getting the 404 page twice should still result in a cache miss.
      $this
        ->drupalGet($content_url);
      $this
        ->drupalGet($content_url);
      $this
        ->assertSession()
        ->statusCodeEquals($code);
      $this
        ->assertSession()
        ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    }
  }

  /**
   * Tests the omit_vary_cookie setting.
   */
  public function testPageCacheWithoutVaryCookie() {
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();
    $settings['settings']['omit_vary_cookie'] = (object) [
      'value' => TRUE,
      'required' => TRUE,
    ];
    $this
      ->writeSettings($settings);

    // Fill the cache.
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->assertSession()
      ->responseHeaderNotContains('Vary', 'cookie');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=300, public');

    // Check cache.
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderNotContains('Vary', 'cookie');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=300, public');
  }

  /**
   * Tests the setting of forms to be immutable.
   */
  public function testFormImmutability() {

    // Install the module that provides the test form.
    $this->container
      ->get('module_installer')
      ->install([
      'page_cache_form_test',
    ]);

    // Uninstall the page_cache module to verify that form is immutable
    // regardless of the internal page cache module.
    $this->container
      ->get('module_installer')
      ->uninstall([
      'page_cache',
    ]);
    $this
      ->drupalGet('page_cache_form_test_immutability');
    $this
      ->assertSession()
      ->pageTextContains("Immutable: TRUE");

    // The immutable flag is set unconditionally by system_form_alter(), set
    // a flag to tell page_cache_form_test_module_implements_alter() to disable
    // that implementation.
    \Drupal::state()
      ->set('page_cache_bypass_form_immutability', TRUE);
    \Drupal::moduleHandler()
      ->resetImplementations();
    Cache::invalidateTags([
      'rendered',
    ]);
    $this
      ->drupalGet('page_cache_form_test_immutability');
    $this
      ->assertSession()
      ->pageTextContains("Immutable: FALSE");
  }

  /**
   * Tests cacheability of a CacheableResponse.
   *
   * Tests the difference between having a controller return a plain Symfony
   * Response object versus returning a Response object that implements the
   * CacheableResponseInterface.
   */
  public function testCacheableResponseResponses() {
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();

    // GET a URL, which would be marked as a cache miss if it were cacheable.
    $this
      ->drupalGet('/system-test/respond-response');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('X-Drupal-Cache');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'must-revalidate, no-cache, private');

    // GET it again, verify it's still not cached.
    $this
      ->drupalGet('/system-test/respond-response');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('X-Drupal-Cache');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'must-revalidate, no-cache, private');

    // GET a URL, which would be marked as a cache miss if it were cacheable.
    $this
      ->drupalGet('/system-test/respond-public-response');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('X-Drupal-Cache');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=60, public');

    // GET it again, verify it's still not cached.
    $this
      ->drupalGet('/system-test/respond-public-response');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('X-Drupal-Cache');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=60, public');

    // GET a URL, which should be marked as a cache miss.
    $this
      ->drupalGet('/system-test/respond-cacheable-response');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=300, public');

    // GET it again, it should now be a cache hit.
    $this
      ->drupalGet('/system-test/respond-cacheable-response');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'max-age=300, public');

    // Uninstall page cache. This should flush all caches so the next call to a
    // previously cached page should be a miss now.
    $this->container
      ->get('module_installer')
      ->uninstall([
      'page_cache',
    ]);

    // GET a URL that was cached by Page Cache before, it should not be now.
    $this
      ->drupalGet('/respond-cacheable-response');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('X-Drupal-Cache');
  }

  /**
   * Tests that HEAD requests are treated the same as GET requests.
   */
  public function testHead() {

    /** @var \GuzzleHttp\ClientInterface $client */
    $client = $this
      ->getSession()
      ->getDriver()
      ->getClient()
      ->getClient();

    // GET, then HEAD.
    $url_a = $this
      ->buildUrl('system-test/set-header', [
      'query' => [
        'name' => 'Foo',
        'value' => 'bar',
      ],
    ]);
    $response_body = $this
      ->drupalGet($url_a);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
    $this
      ->assertSession()
      ->responseHeaderEquals('Foo', 'bar');
    $this
      ->assertEquals('The following header was set: <em class="placeholder">Foo</em>: <em class="placeholder">bar</em>', $response_body);
    $response = $client
      ->request('HEAD', $url_a);
    $this
      ->assertEquals('HIT', $response
      ->getHeaderLine('X-Drupal-Cache'), 'Page was cached.');
    $this
      ->assertEquals('bar', $response
      ->getHeaderLine('Foo'), 'Custom header was sent.');
    $this
      ->assertEquals('', $response
      ->getBody()
      ->getContents());

    // HEAD, then GET.
    $url_b = $this
      ->buildUrl('system-test/set-header', [
      'query' => [
        'name' => 'Foo',
        'value' => 'baz',
      ],
    ]);
    $response = $client
      ->request('HEAD', $url_b);
    $this
      ->assertEquals('MISS', $response
      ->getHeaderLine('X-Drupal-Cache'), 'Page was not cached.');
    $this
      ->assertEquals('baz', $response
      ->getHeaderLine('Foo'), 'Custom header was sent.');
    $this
      ->assertEquals('', $response
      ->getBody()
      ->getContents());
    $response_body = $this
      ->drupalGet($url_b);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderEquals('Foo', 'baz');
    $this
      ->assertEquals('The following header was set: <em class="placeholder">Foo</em>: <em class="placeholder">baz</em>', $response_body);
  }

  /**
   * Tests a cacheable response with custom cache control.
   */
  public function testCacheableWithCustomCacheControl() {
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();
    $this
      ->drupalGet('/system-test/custom-cache-control');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('Cache-Control', 'bar, private');
  }

  /**
   * Tests that URLs are cached in a not normalized form.
   */
  public function testNoUrlNormalization() {

    // Use absolute URLs to avoid any processing.
    $url = Url::fromRoute('<front>')
      ->setAbsolute()
      ->toString();

    // In each test, the first array value is raw URL, the second one is the
    // possible normalized URL.
    $tests = [
      [
        $url . '?z=z&a=a',
        $url . '?a=a&z=z',
      ],
      [
        $url . '?a=b+c',
        $url . '?a=b%20c',
      ],
    ];
    foreach ($tests as list($url_raw, $url_normalized)) {

      // Initialize cache on raw URL.
      $headers = $this
        ->getHeaders($url_raw);
      $this
        ->assertEquals('MISS', $headers['X-Drupal-Cache']);

      // Ensure cache was set.
      $headers = $this
        ->getHeaders($url_raw);
      $this
        ->assertEquals('HIT', $headers['X-Drupal-Cache'], "Cache was set for {$url_raw} URL.");

      // Check if the normalized URL is not cached.
      $headers = $this
        ->getHeaders($url_normalized);
      $this
        ->assertEquals('MISS', $headers['X-Drupal-Cache'], "Cache is missing for {$url_normalized} URL.");
    }
  }

  /**
   * Retrieves only the headers for an absolute path.
   *
   * Executes a cURL request without any modifications to the given URL.
   * Note that Guzzle always normalizes URLs which prevents testing all
   * possible edge cases.
   *
   * @param string $url
   *   URL to request.
   *
   * @return array
   *   Array of headers.
   */
  protected function getHeaders($url) {
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HEADER, TRUE);
    curl_setopt($ch, CURLOPT_NOBODY, TRUE);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_USERAGENT, drupal_generate_test_ua($this->databasePrefix));
    $output = curl_exec($ch);
    curl_close($ch);
    $headers = [];
    foreach (explode("\n", $output) as $header) {
      if (strpos($header, ':')) {
        list($key, $value) = explode(':', $header, 2);
        $headers[trim($key)] = trim($value);
      }
    }
    return $headers;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
AssertPageCacheContextsAndTagsTrait::assertCacheContext	protected	function	Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts	protected	function	Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge	protected	function	Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags	protected	function	Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext	protected	function	Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags	protected	function	Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching	protected	function	Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues	protected	function	Gets a specific header value as array.
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	1
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.	1
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PageCacheTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PageCacheTest::$dumpHeaders	protected	property
PageCacheTest::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules
PageCacheTest::getHeaders	protected	function	Retrieves only the headers for an absolute path.
PageCacheTest::setUp	protected	function	Overrides BrowserTestBase::setUp
PageCacheTest::testCacheableResponseResponses	public	function	Tests cacheability of a CacheableResponse.
PageCacheTest::testCacheableWithCustomCacheControl	public	function	Tests a cacheable response with custom cache control.
PageCacheTest::testConditionalRequests	public	function	Tests support of requests with If-Modified-Since and If-None-Match headers.
PageCacheTest::testFormImmutability	public	function	Tests the setting of forms to be immutable.
PageCacheTest::testHead	public	function	Tests that HEAD requests are treated the same as GET requests.
PageCacheTest::testNoUrlNormalization	public	function	Tests that URLs are cached in a not normalized form.
PageCacheTest::testPageCache	public	function	Tests cache headers.
PageCacheTest::testPageCacheAnonymous403404	public	function	Tests the 4xx-response cache tag is added and invalidated.
PageCacheTest::testPageCacheAnonymousRolePermissions	public	function	Tests the automatic presence of the anonymous role's cache tag.
PageCacheTest::testPageCacheTags	public	function	Tests that cache tags are properly persisted.
PageCacheTest::testPageCacheTagsIndependentFromCacheabilityHeaders	public	function	Tests that the page cache doesn't depend on cacheability headers.
PageCacheTest::testPageCacheWithoutVaryCookie	public	function	Tests the omit_vary_cookie setting.
PageCacheTest::testQueryParameterFormatRequests	public	function	Tests support for different cache items with different request formats specified via a query parameter.
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
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.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	1
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
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. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
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.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class PageCacheTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation