public function CorsIntegrationTest::testCrossSiteRequest in Drupal 10

Same name and namespace in other branches

1. 8 core/tests/Drupal/FunctionalTests/HttpKernel/CorsIntegrationTest.php \Drupal\FunctionalTests\HttpKernel\CorsIntegrationTest::testCrossSiteRequest()
2. 9 core/tests/Drupal/FunctionalTests/HttpKernel/CorsIntegrationTest.php \Drupal\FunctionalTests\HttpKernel\CorsIntegrationTest::testCrossSiteRequest()

File

core/tests/Drupal/FunctionalTests/HttpKernel/CorsIntegrationTest.php, line 29

Class

CorsIntegrationTest

Tests CORS provided by Drupal.

Namespace

Drupal\FunctionalTests\HttpKernel

Code

public function testCrossSiteRequest() {

  // Test default parameters.
  $cors_config = $this->container
    ->getParameter('cors.config');
  $this
    ->assertFalse($cors_config['enabled']);
  $this
    ->assertSame([], $cors_config['allowedHeaders']);
  $this
    ->assertSame([], $cors_config['allowedMethods']);
  $this
    ->assertSame([
    '*',
  ], $cors_config['allowedOrigins']);
  $this
    ->assertFalse($cors_config['exposedHeaders']);
  $this
    ->assertFalse($cors_config['maxAge']);
  $this
    ->assertFalse($cors_config['supportsCredentials']);

  // Enable CORS with the default options.
  $cors_config['enabled'] = TRUE;
  $this
    ->setContainerParameter('cors.config', $cors_config);
  $this
    ->rebuildContainer();

  // Fire off a request.
  $this
    ->drupalGet('/test-page', [], [
    'Origin' => 'http://example.com',
  ]);
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertSession()
    ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
  $this
    ->assertSession()
    ->responseHeaderEquals('Access-Control-Allow-Origin', '*');
  $this
    ->assertSession()
    ->responseHeaderNotContains('Vary', 'Origin');

  // Fire the same exact request. This time it should be cached.
  $this
    ->drupalGet('/test-page', [], [
    'Origin' => 'http://example.com',
  ]);
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertSession()
    ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
  $this
    ->assertSession()
    ->responseHeaderEquals('Access-Control-Allow-Origin', '*');
  $this
    ->assertSession()
    ->responseHeaderNotContains('Vary', 'Origin');

  // Fire a request for a different origin. Verify the CORS header.
  $this
    ->drupalGet('/test-page', [], [
    'Origin' => 'http://example.org',
  ]);
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertSession()
    ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
  $this
    ->assertSession()
    ->responseHeaderEquals('Access-Control-Allow-Origin', '*');
  $this
    ->assertSession()
    ->responseHeaderNotContains('Vary', 'Origin');

  // Configure the CORS stack to allow a specific origin.
  $cors_config['allowedOrigins'] = [
    'http://example.com',
  ];
  $this
    ->setContainerParameter('cors.config', $cors_config);
  $this
    ->rebuildContainer();

  // Fire a request from an origin that isn't allowed.

  /** @var \Symfony\Component\HttpFoundation\Response $response */
  $this
    ->drupalGet('/test-page', [], [
    'Origin' => 'http://non-valid.com',
  ]);
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertSession()
    ->responseHeaderEquals('Access-Control-Allow-Origin', 'http://example.com');
  $this
    ->assertSession()
    ->responseHeaderNotContains('Vary', 'Origin');

  // Specify a valid origin.
  $this
    ->drupalGet('/test-page', [], [
    'Origin' => 'http://example.com',
  ]);
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertSession()
    ->responseHeaderEquals('Access-Control-Allow-Origin', 'http://example.com');
  $this
    ->assertSession()
    ->responseHeaderNotContains('Vary', 'Origin');

  // Configure the CORS stack to allow a specific set of origins.
  $cors_config['allowedOrigins'] = [
    'http://example.com',
    'https://drupal.org',
  ];
  $this
    ->setContainerParameter('cors.config', $cors_config);
  $this
    ->rebuildContainer();

  // Fire a request from an origin that isn't allowed.

  /** @var \Symfony\Component\HttpFoundation\Response $response */
  $this
    ->drupalGet('/test-page', [], [
    'Origin' => 'http://non-valid.com',
  ]);
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertSession()
    ->responseHeaderEquals('Access-Control-Allow-Origin', NULL);
  $this
    ->assertSession()
    ->responseHeaderContains('Vary', 'Origin');

  // Specify a valid origin.
  $this
    ->drupalGet('/test-page', [], [
    'Origin' => 'http://example.com',
  ]);
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertSession()
    ->responseHeaderEquals('Access-Control-Allow-Origin', 'http://example.com');
  $this
    ->assertSession()
    ->responseHeaderContains('Vary', 'Origin');

  // Specify a valid origin.
  $this
    ->drupalGet('/test-page', [], [
    'Origin' => 'https://drupal.org',
  ]);
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertSession()
    ->responseHeaderEquals('Access-Control-Allow-Origin', 'https://drupal.org');
  $this
    ->assertSession()
    ->responseHeaderContains('Vary', 'Origin');

  // Verify POST still functions with 'Origin' header set to site's domain.
  $origin = \Drupal::request()
    ->getSchemeAndHttpHost();

  /** @var \GuzzleHttp\ClientInterface $httpClient */
  $httpClient = $this
    ->getSession()
    ->getDriver()
    ->getClient()
    ->getClient();
  $url = Url::fromUri('base:/test-page');
  $response = $httpClient
    ->request('POST', $url
    ->setAbsolute()
    ->toString(), [
    'headers' => [
      'Origin' => $origin,
    ],
  ]);
  $this
    ->assertEquals(200, $response
    ->getStatusCode());
}