class TrustedRedirectResponseTest

Same name and namespace in other branches
  1. 9 core/tests/Drupal/Tests/Core/Routing/TrustedRedirectResponseTest.php \Drupal\Tests\Core\Routing\TrustedRedirectResponseTest
  2. 8.9.x core/tests/Drupal/Tests/Core/Routing/TrustedRedirectResponseTest.php \Drupal\Tests\Core\Routing\TrustedRedirectResponseTest
  3. 10 core/tests/Drupal/Tests/Core/Routing/TrustedRedirectResponseTest.php \Drupal\Tests\Core\Routing\TrustedRedirectResponseTest

@coversDefaultClass \Drupal\Core\Routing\TrustedRedirectResponse
@group Routing

Hierarchy

Expanded class hierarchy of TrustedRedirectResponseTest

File

core/tests/Drupal/Tests/Core/Routing/TrustedRedirectResponseTest.php, line 20

Namespace

Drupal\Tests\Core\Routing
View source
class TrustedRedirectResponseTest extends UnitTestCase {
  
  /**
   * @covers ::setTargetUrl
   */
  public function testSetTargetUrlWithInternalUrl() : void {
    $redirect_response = new TrustedRedirectResponse('/example');
    $redirect_response->setTargetUrl('/example2');
    $this->assertEquals('/example2', $redirect_response->getTargetUrl());
  }
  
  /**
   * @covers ::setTargetUrl
   */
  public function testSetTargetUrlWithUntrustedUrl() : void {
    $request_context = new RequestContext();
    $request_context->setCompleteBaseUrl('https://www.drupal.org');
    $container = new ContainerBuilder();
    $container->set('router.request_context', $request_context);
    \Drupal::setContainer($container);
    $redirect_response = new TrustedRedirectResponse('/example');
    $this->expectException(\InvalidArgumentException::class);
    $redirect_response->setTargetUrl('http://evil-url.com/example');
  }
  
  /**
   * @covers ::setTargetUrl
   */
  public function testSetTargetUrlWithTrustedUrl() : void {
    $redirect_response = new TrustedRedirectResponse('/example');
    $redirect_response->setTrustedTargetUrl('http://good-external-url.com/example');
    $this->assertEquals('http://good-external-url.com/example', $redirect_response->getTargetUrl());
  }
  
  /**
   * @covers ::createFromRedirectResponse
   * @dataProvider providerCreateFromRedirectResponse
   */
  public function testCreateFromRedirectResponse($redirect_response) : void {
    $trusted_redirect_response = TrustedRedirectResponse::createFromRedirectResponse($redirect_response);
    // The trusted redirect response is always a CacheableResponseInterface
    // instance.
    $this->assertInstanceOf(CacheableResponseInterface::class, $trusted_redirect_response);
    // But it is only actually cacheable (non-zero max-age) if the redirect
    // response passed to TrustedRedirectResponse::createFromRedirectResponse()
    // is itself cacheable.
    $expected_cacheability = $redirect_response instanceof CacheableResponseInterface ? $redirect_response->getCacheableMetadata() : (new CacheableMetadata())->setCacheMaxAge(0);
    $this->assertEquals($expected_cacheability, $trusted_redirect_response->getCacheableMetadata());
  }
  
  /**
   * @return array
   *   An array of test cases, each containing a redirect response instance.
   */
  public static function providerCreateFromRedirectResponse() {
    return [
      'cacheable-with-tags' => [
        (new CacheableRedirectResponse('/example'))->addCacheableDependency((new CacheableMetadata())->addCacheTags([
          'foo',
        ])),
      ],
      'cacheable-with-max-age-0' => [
        (new CacheableRedirectResponse('/example'))->addCacheableDependency((new CacheableMetadata())->setCacheMaxAge(0)),
      ],
      'uncacheable' => [
        new RedirectResponse('/example'),
      ],
    ];
  }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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.
TrustedRedirectResponseTest::providerCreateFromRedirectResponse public static function
TrustedRedirectResponseTest::testCreateFromRedirectResponse public function @covers ::createFromRedirectResponse[[api-linebreak]]
@dataProvider providerCreateFromRedirectResponse
TrustedRedirectResponseTest::testSetTargetUrlWithInternalUrl public function @covers ::setTargetUrl[[api-linebreak]]
TrustedRedirectResponseTest::testSetTargetUrlWithTrustedUrl public function @covers ::setTargetUrl[[api-linebreak]]
TrustedRedirectResponseTest::testSetTargetUrlWithUntrustedUrl public function @covers ::setTargetUrl[[api-linebreak]]
UnitTestCase::$root protected property The app root.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.
UnitTestCase::setUp protected function 374

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.