class ReverseProxyMiddlewareTest in Zircon Profile 8

Unit test the reverse proxy stack middleware.

@group StackMiddleware

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
  • class \Drupal\Tests\Core\StackMiddleware\ReverseProxyMiddlewareTest

File

core/tests/Drupal/Tests/Core/StackMiddleware/ReverseProxyMiddlewareTest.php, line 20

Contains \Drupal\Tests\Core\StackMiddleware\ReverseProxyMiddlewareTest.

Namespace

Drupal\Tests\Core\StackMiddleware

class ReverseProxyMiddlewareTest extends UnitTestCase {

  /**
   * @var \Symfony\Component\HttpKernel\HttpKernelInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $mockHttpKernel;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    $this->mockHttpKernel = $this
      ->getMock('Symfony\\Component\\HttpKernel\\HttpKernelInterface');
  }

  /**
   * Tests that subscriber does not act when reverse proxy is not set.
   */
  public function testNoProxy() {
    $settings = new Settings(array());
    $this
      ->assertEquals(0, $settings
      ->get('reverse_proxy'));
    $middleware = new ReverseProxyMiddleware($this->mockHttpKernel, $settings);

    // Mock a request object.
    $request = $this
      ->getMock('Symfony\\Component\\HttpFoundation\\Request', array(
      'setTrustedHeaderName',
      'setTrustedProxies',
    ));

    // setTrustedHeaderName() should never fire.
    $request
      ->expects($this
      ->never())
      ->method('setTrustedHeaderName');

    // Actually call the check method.
    $middleware
      ->handle($request);
  }

  /**
   * Tests that subscriber sets trusted headers when reverse proxy is set.
   *
   * @dataProvider reverseProxyEnabledProvider
   */
  public function testReverseProxyEnabled($provided_settings) {

    // Enable reverse proxy and add test values.
    $settings = new Settings(array(
      'reverse_proxy' => 1,
    ) + $provided_settings);
    $this
      ->trustedHeadersAreSet($settings);
  }

  /**
   * Data provider for testReverseProxyEnabled.
   */
  public function reverseProxyEnabledProvider() {
    return array(
      array(
        array(
          'reverse_proxy_header' => 'X_FORWARDED_FOR_CUSTOMIZED',
          'reverse_proxy_proto_header' => 'X_FORWARDED_PROTO_CUSTOMIZED',
          'reverse_proxy_host_header' => 'X_FORWARDED_HOST_CUSTOMIZED',
          'reverse_proxy_port_header' => 'X_FORWARDED_PORT_CUSTOMIZED',
          'reverse_proxy_forwarded_header' => 'FORWARDED_CUSTOMIZED',
          'reverse_proxy_addresses' => array(
            '127.0.0.2',
            '127.0.0.3',
          ),
        ),
      ),
    );
  }

  /**
   * Tests that trusted header methods are called.
   *
   * \Symfony\Component\HttpFoundation\Request::setTrustedHeaderName() and
   * \Symfony\Component\HttpFoundation\Request::setTrustedProxies() should
   * always be called when reverse proxy settings are enabled.
   *
   * @param \Drupal\Core\Site\Settings $settings
   *   The settings object that holds reverse proxy configuration.
   */
  protected function trustedHeadersAreSet(Settings $settings) {
    $middleware = new ReverseProxyMiddleware($this->mockHttpKernel, $settings);
    $request = new Request();
    $middleware
      ->handle($request);
    $this
      ->assertSame($settings
      ->get('reverse_proxy_header'), $request
      ->getTrustedHeaderName($request::HEADER_CLIENT_IP));
    $this
      ->assertSame($settings
      ->get('reverse_proxy_proto_header'), $request
      ->getTrustedHeaderName($request::HEADER_CLIENT_PROTO));
    $this
      ->assertSame($settings
      ->get('reverse_proxy_host_header'), $request
      ->getTrustedHeaderName($request::HEADER_CLIENT_HOST));
    $this
      ->assertSame($settings
      ->get('reverse_proxy_port_header'), $request
      ->getTrustedHeaderName($request::HEADER_CLIENT_PORT));
    $this
      ->assertSame($settings
      ->get('reverse_proxy_forwarded_header'), $request
      ->getTrustedHeaderName($request::HEADER_FORWARDED));
    $this
      ->assertSame($settings
      ->get('reverse_proxy_addresses'), $request
      ->getTrustedProxies());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ReverseProxyMiddlewareTest::$mockHttpKernel	protected	property
ReverseProxyMiddlewareTest::reverseProxyEnabledProvider	public	function	Data provider for testReverseProxyEnabled.
ReverseProxyMiddlewareTest::setUp	public	function	Overrides UnitTestCase::setUp
ReverseProxyMiddlewareTest::testNoProxy	public	function	Tests that subscriber does not act when reverse proxy is not set.
ReverseProxyMiddlewareTest::testReverseProxyEnabled	public	function	Tests that subscriber sets trusted headers when reverse proxy is set.
ReverseProxyMiddlewareTest::trustedHeadersAreSet	protected	function	Tests that trusted header methods are called.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName	protected	function	Mocks a block with a block plugin.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed in array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.