You are here

Home » API reference » Zircon Profile 8 » PageCacheTest.php

class PageCacheTest in Zircon Profile 8

Same name in this branch
  1. 8 core/modules/page_cache/src/Tests/PageCacheTest.php \Drupal\page_cache\Tests\PageCacheTest
  2. 8 core/modules/rest/src/Tests/PageCacheTest.php \Drupal\rest\Tests\PageCacheTest
Same name and namespace in other branches
  1. 8.0 core/modules/page_cache/src/Tests/PageCacheTest.php \Drupal\page_cache\Tests\PageCacheTest

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

@group page_cache

Hierarchy

Expanded class hierarchy of PageCacheTest

File

core/modules/page_cache/src/Tests/PageCacheTest.php, line 23
Contains \Drupal\page_cache\Tests\PageCacheTest.

Namespace

Drupal\page_cache\Tests
View source 
class PageCacheTest extends WebTestBase {
  protected $dumpHeaders = TRUE;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'test_page_test',
    'system_test',
    'entity_test',
  );

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

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

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->drupalGet($path);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT');
    $cid_parts = array(
      \Drupal::url('system_test.cache_tags_page', array(), array(
        'absolute' => TRUE,
      )),
      'html',
    );
    $cid = implode(':', $cid_parts);
    $cache_entry = \Drupal::cache('render')
      ->get($cid);
    sort($cache_entry->tags);
    $expected_tags = array(
      'config:user.role.anonymous',
      'pre_render',
      'rendered',
      'system_test_cache_tags_page',
    );
    $this
      ->assertIdentical($cache_entry->tags, $expected_tags);
    Cache::invalidateTags($tags);
    $this
      ->drupalGet($path);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS');
  }

  /**
   * Test that the page cache doesn't depend on cacheability headers.
   */
  function testPageCacheTagsIndependentFromCacheabilityHeaders() {
    $this
      ->setHttpResponseDebugCacheabilityHeaders(FALSE);
    $path = 'system-test/cache_tags_page';
    $tags = array(
      'system_test_cache_tags_page',
    );
    $this
      ->drupalGet($path);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->drupalGet($path);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT');
    $cid_parts = array(
      \Drupal::url('system_test.cache_tags_page', array(), array(
        'absolute' => TRUE,
      )),
      'html',
    );
    $cid = implode(':', $cid_parts);
    $cache_entry = \Drupal::cache('render')
      ->get($cid);
    sort($cache_entry->tags);
    $expected_tags = array(
      'config:user.role.anonymous',
      'pre_render',
      'rendered',
      'system_test_cache_tags_page',
    );
    $this
      ->assertIdentical($cache_entry->tags, $expected_tags);
    Cache::invalidateTags($tags);
    $this
      ->drupalGet($path);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS');
  }

  /**
   * Tests support for different cache items with different request formats
   * specified via a query parameter.
   */
  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);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS', 'HTML page was not yet cached.');
    $this
      ->drupalGet($accept_header_cache_url);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'HTML page was cached.');
    $this
      ->assertRaw('<p>oh hai this is html.</p>', 'The correct HTML response was returned.');
    $this
      ->drupalGet($accept_header_cache_url_with_json);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS', 'Json response was not yet cached.');
    $this
      ->drupalGet($accept_header_cache_url_with_json);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Json response was cached.');
    $this
      ->assertRaw('{"content":"oh hai this is json"}', 'The correct Json response was returned.');

    // Enable REST support for nodes and hal+json.
    \Drupal::service('module_installer')
      ->install([
      'node',
      'rest',
      'hal',
    ]);
    $this
      ->drupalCreateContentType([
      'type' => 'article',
    ]);
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
    ]);
    $node_uri = $node
      ->urlInfo();
    $node_url_with_hal_json_format = $node
      ->urlInfo('canonical')
      ->setRouteParameter('_format', 'hal_json');

    /** @var \Drupal\user\RoleInterface $role */
    $role = Role::load('anonymous');
    $role
      ->grantPermission('restful get entity:node');
    $role
      ->save();
    $this
      ->drupalGet($node_uri);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Content-Type'), 'text/html; charset=UTF-8');
    $this
      ->drupalGet($node_uri);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT');
    $this
      ->assertEqual($this
      ->drupalGetHeader('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
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Content-Type'), 'application/hal+json');
    $this
      ->drupalGet($node_url_with_hal_json_format);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Content-Type'), 'application/hal+json');

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

  /**
   * Tests support of requests with If-Modified-Since and If-None-Match headers.
   */
  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
      ->assertNoPattern('#<html.*<html#');
    $this
      ->drupalHead('');
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Page was cached.');
    $etag = $this
      ->drupalGetHeader('ETag');
    $last_modified = $this
      ->drupalGetHeader('Last-Modified');
    $this
      ->drupalGet('', array(), array(
      'If-Modified-Since: ' . $last_modified,
      'If-None-Match: ' . $etag,
    ));
    $this
      ->assertResponse(304, 'Conditional request returned 304 Not Modified.');
    $this
      ->drupalGet('', array(), array(
      'If-Modified-Since: ' . gmdate(DATE_RFC822, strtotime($last_modified)),
      'If-None-Match: ' . $etag,
    ));
    $this
      ->assertResponse(304, 'Conditional request with obsolete If-Modified-Since date returned 304 Not Modified.');
    $this
      ->drupalGet('', array(), array(
      'If-Modified-Since: ' . gmdate(DATE_RFC850, strtotime($last_modified)),
      'If-None-Match: ' . $etag,
    ));
    $this
      ->assertResponse(304, 'Conditional request with obsolete If-Modified-Since date returned 304 Not Modified.');
    $this
      ->drupalGet('', array(), array(
      'If-Modified-Since: ' . $last_modified,
    ));

    // Verify the page is not printed twice when the cache is warm.
    $this
      ->assertNoPattern('#<html.*<html#');
    $this
      ->assertResponse(200, 'Conditional request without If-None-Match returned 200 OK.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Page was cached.');
    $this
      ->drupalGet('', array(), array(
      'If-Modified-Since: ' . gmdate(DateTimePlus::RFC7231, strtotime($last_modified) + 1),
      'If-None-Match: ' . $etag,
    ));
    $this
      ->assertResponse(200, 'Conditional request with new a If-Modified-Since date newer than Last-Modified returned 200 OK.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Page was cached.');
    $user = $this
      ->drupalCreateUser();
    $this
      ->drupalLogin($user);
    $this
      ->drupalGet('', array(), array(
      'If-Modified-Since: ' . $last_modified,
      'If-None-Match: ' . $etag,
    ));
    $this
      ->assertResponse(200, 'Conditional request returned 200 OK for authenticated user.');
    $this
      ->assertFalse($this
      ->drupalGetHeader('X-Drupal-Cache'), 'Absence of Page was not cached.');
  }

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

    // Fill the cache.
    $this
      ->drupalGet('system-test/set-header', array(
      'query' => array(
        'name' => 'Foo',
        'value' => 'bar',
      ),
    ));
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS', 'Page was not cached.');
    $this
      ->assertEqual(strtolower($this
      ->drupalGetHeader('Vary')), 'cookie,accept-encoding', 'Vary header was sent.');

    // 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
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'max-age=300, public', 'Cache-Control header was sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Expires'), 'Sun, 19 Nov 1978 05:00:00 GMT', 'Expires header was sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Foo'), 'bar', 'Custom header was sent.');

    // Check cache.
    $this
      ->drupalGet('system-test/set-header', array(
      'query' => array(
        'name' => 'Foo',
        'value' => 'bar',
      ),
    ));
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Page was cached.');
    $this
      ->assertEqual(strtolower($this
      ->drupalGetHeader('Vary')), 'cookie,accept-encoding', 'Vary: Cookie header was sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'max-age=300, public', 'Cache-Control header was sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Expires'), 'Sun, 19 Nov 1978 05:00:00 GMT', 'Expires header was sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Foo'), 'bar', 'Custom header was sent.');

    // Check replacing default headers.
    $this
      ->drupalGet('system-test/set-header', array(
      'query' => array(
        'name' => 'Expires',
        'value' => 'Fri, 19 Nov 2008 05:00:00 GMT',
      ),
    ));
    $this
      ->assertEqual($this
      ->drupalGetHeader('Expires'), 'Fri, 19 Nov 2008 05:00:00 GMT', 'Default header was replaced.');
    $this
      ->drupalGet('system-test/set-header', array(
      'query' => array(
        'name' => 'Vary',
        'value' => 'User-Agent',
      ),
    ));
    $this
      ->assertEqual(strtolower($this
      ->drupalGetHeader('Vary')), 'user-agent,accept-encoding', 'Default header was replaced.');

    // Check that authenticated users bypass the cache.
    $user = $this
      ->drupalCreateUser();
    $this
      ->drupalLogin($user);
    $this
      ->drupalGet('system-test/set-header', array(
      'query' => array(
        'name' => 'Foo',
        'value' => 'bar',
      ),
    ));
    $this
      ->assertFalse($this
      ->drupalGetHeader('X-Drupal-Cache'), 'Caching was bypassed.');
    $this
      ->assertTrue(strpos(strtolower($this
      ->drupalGetHeader('Vary')), 'cookie') === FALSE, 'Vary: Cookie header was not sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'must-revalidate, no-cache, post-check=0, pre-check=0, private', 'Cache-Control header was sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Expires'), 'Sun, 19 Nov 1978 05:00:00 GMT', 'Expires header was sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Foo'), 'bar', 'Custom header was sent.');

    // 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
      ->assertEqual($this
      ->drupalGetHeader('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
      ->assertText('Permission to pet llamas: no!');
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertCacheTag('config:user.role.anonymous');
    $this
      ->drupalGet($route_access_url);
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertCacheTag('config:user.role.anonymous');

    // 2. anonymous user, with permission.
    user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
      'pet llamas',
    ]);
    $this
      ->drupalGet($content_url);
    $this
      ->assertText('Permission to pet llamas: yes!');
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertCacheTag('config:user.role.anonymous');
    $this
      ->drupalGet($route_access_url);
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertCacheTag('config:user.role.anonymous');

    // 3. authenticated user, without permission.
    $auth_user = $this
      ->drupalCreateUser();
    $this
      ->drupalLogin($auth_user);
    $this
      ->drupalGet($content_url);
    $this
      ->assertText('Permission to pet llamas: no!');
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertNoCacheTag('config:user.role.authenticated');
    $this
      ->drupalGet($route_access_url);
    $this
      ->assertCacheContext('user.permissions');
    $this
      ->assertNoCacheTag('config:user.role.authenticated');

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

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

      // Anonymous user, without permissions.
      $this
        ->drupalGet($content_url);
      $this
        ->assertResponse($code);
      $this
        ->assertEqual($this
        ->drupalGetHeader('X-Drupal-Cache'), 'MISS');
      $this
        ->assertCacheTag('4xx-response');
      $this
        ->drupalGet($content_url);
      $this
        ->assertResponse($code);
      $this
        ->assertEqual($this
        ->drupalGetHeader('X-Drupal-Cache'), 'HIT');
      $entity_values = array(
        'name' => $this
          ->randomMachineName(),
        'user_id' => 1,
        'field_test_text' => array(
          0 => array(
            '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
        ->assertResponse($code);
      $this
        ->assertEqual($this
        ->drupalGetHeader('X-Drupal-Cache'), 'MISS');
      $this
        ->drupalGet($content_url);
      $this
        ->assertResponse($code);
      $this
        ->assertEqual($this
        ->drupalGetHeader('X-Drupal-Cache'), 'HIT');

      // Rebuilding the router should invalidate the 4xx cache tag.
      $this->container
        ->get('router.builder')
        ->rebuild();
      $this
        ->drupalGet($content_url);
      $this
        ->assertResponse($code);
      $this
        ->assertEqual($this
        ->drupalGetHeader('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) array(
      'value' => TRUE,
      'required' => TRUE,
    );
    $this
      ->writeSettings($settings);

    // Fill the cache.
    $this
      ->drupalGet('');
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS', 'Page was not cached.');
    $this
      ->assertTrue(strpos($this
      ->drupalGetHeader('Vary'), 'Cookie') === FALSE, 'Vary: Cookie header was not sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'max-age=300, public', 'Cache-Control header was sent.');

    // Check cache.
    $this
      ->drupalGet('');
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Page was cached.');
    $this
      ->assertTrue(strpos($this
      ->drupalGetHeader('Vary'), 'Cookie') === FALSE, 'Vary: Cookie header was not sent.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'max-age=300, public', 'Cache-Control header was sent.');
  }

  /**
   * Test 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',
    ]);
    \Drupal::service('router.builder')
      ->rebuild();
    $this
      ->drupalGet('page_cache_form_test_immutability');
    $this
      ->assertText("Immutable: TRUE", "Form is immutable.");

    // 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
      ->assertText("Immutable: FALSE", "Form is not immutable,");
  }

  /**
   * 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-reponse');
    $this
      ->assertFalse($this
      ->drupalGetHeader('X-Drupal-Cache'), 'Drupal page cache header not found.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'must-revalidate, no-cache, post-check=0, pre-check=0, private', 'Cache-Control header was sent');

    // GET it again, verify it's still not cached.
    $this
      ->drupalGet('/system-test/respond-reponse');
    $this
      ->assertFalse($this
      ->drupalGetHeader('X-Drupal-Cache'), 'Drupal page cache header not found.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'must-revalidate, no-cache, post-check=0, pre-check=0, private', 'Cache-Control header was sent');

    // GET a URL, which would be marked as a cache miss if it were cacheable.
    $this
      ->drupalGet('/system-test/respond-public-response');
    $this
      ->assertFalse($this
      ->drupalGetHeader('X-Drupal-Cache'), 'Drupal page cache header not found.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'max-age=60, public', 'Cache-Control header was sent');

    // GET it again, verify it's still not cached.
    $this
      ->drupalGet('/system-test/respond-public-response');
    $this
      ->assertFalse($this
      ->drupalGetHeader('X-Drupal-Cache'), 'Drupal page cache header not found.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'max-age=60, public', 'Cache-Control header was sent');

    // GET a URL, which should be marked as a cache miss.
    $this
      ->drupalGet('/system-test/respond-cacheable-reponse');
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS', 'Page was not cached.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'max-age=300, public', 'Cache-Control header was sent.');

    // GET it again, it should now be a cache hit.
    $this
      ->drupalGet('/system-test/respond-cacheable-reponse');
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Page was cached.');
    $this
      ->assertEqual($this
      ->drupalGetHeader('Cache-Control'), 'max-age=300, public', 'Cache-Control header was sent.');

    // 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-reponse');
    $this
      ->assertFalse($this
      ->drupalGetHeader('X-Drupal-Cache'), 'Drupal page cache header not found.');
  }

}

Members

Namesort descending 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. 2
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::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 function Casts MarkupInterface objects into strings.
PageCacheTest::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. Overrides WebTestBase::$dumpHeaders
PageCacheTest::$modules public static property Modules to enable.
PageCacheTest::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp
PageCacheTest::testCacheableResponseResponses public function Tests cacheability of a CacheableResponse.
PageCacheTest::testConditionalRequests function Tests support of requests with If-Modified-Since and If-None-Match headers.
PageCacheTest::testFormImmutability public function Test the setting of forms to be immutable.
PageCacheTest::testPageCache function Tests cache headers.
PageCacheTest::testPageCacheAnonymous403404 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 function Test that cache tags are properly persisted.
PageCacheTest::testPageCacheTagsIndependentFromCacheabilityHeaders function Test that the page cache doesn't depend on cacheability headers.
PageCacheTest::testPageCacheWithoutVaryCookie public function Tests the omit_vary_cookie setting.
PageCacheTest::testQueryParameterFormatRequests function Tests support for different cache items with different request formats specified via a query parameter.
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.
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.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
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::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public 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::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is 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::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
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.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
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. 3
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::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
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::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$classLoader protected property The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories protected property The config directories used in this test.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$kernel protected property The kernel used in this test. Overrides TestBase::$kernel
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 30
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$rootUser protected property The "#1" admin user.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertMail protected function Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString protected function Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code.
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 2
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::doInstall protected function Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView protected function Builds the renderable view of an entity.
WebTestBase::drupalCompareFiles protected function Compare two files based on size and file name.
WebTestBase::drupalCreateContentType protected function Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode protected function Creates a node based on default settings.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails protected function Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle function Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles protected function Gets a list of files that can be used in tests.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPlaceBlock protected function Creates a block instance based on default settings.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::getDatabaseTypes protected function Returns all supported database driver installer objects.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::initConfig protected function Initialize various configurations post-installation.
WebTestBase::initKernel protected function Initializes the kernel after installation.
WebTestBase::initSettings protected function Initialize settings created during install.
WebTestBase::initUserSession protected function Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`.
WebTestBase::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 2
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings protected function Prepares site settings and services before installation. 1
WebTestBase::rebuildAll protected function Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer protected function Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables protected function Refreshes in-memory configuration and state information. 1
WebTestBase::resetAll protected function Resets all data structures after having enabled new modules.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setContainerParameter protected function Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 2
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings protected function Rewrites the settings.php file of the test site.
WebTestBase::__construct function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1