ReverseProxySubscriberUnitTest.php

<?php

/**
 * @file
 * Contains \Drupal\Core\EventSubscriber\ReverseProxySubscriberUnitTest.
 */
namespace Drupal\Tests\Core\EventSubscriber;

use Drupal\Component\Utility\Settings;
use Drupal\Core\EventSubscriber\ReverseProxySubscriber;
use Drupal\Tests\UnitTestCase;

/**
 * Tests the ReverseProxySubscriber.
 *
 * @group System
 */
class ReverseProxySubscriberUnitTest extends UnitTestCase {
  public static function getInfo() {
    return array(
      'name' => 'Reverse proxy implementation',
      'description' => 'Unit test the reverse proxy event subscriber.',
      'group' => 'System',
    );
  }

  /**
   * 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'));
    $subscriber = new ReverseProxySubscriber($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');

    // Mock a response event.
    $event = $this
      ->getMockedEvent($request);

    // Actually call the check method.
    $subscriber
      ->onKernelRequestReverseProxyCheck($event);
  }

  /**
   * Tests that subscriber sets trusted headers when reverse proxy is set.
   */
  public function testReverseProxyEnabled() {
    $cases = array(
      array(
        'reverse_proxy_header' => 'HTTP_X_FORWARDED_FOR',
        'reverse_proxy_addresses' => array(),
      ),
      array(
        'reverse_proxy_header' => 'X_FORWARDED_HOST',
        'reverse_proxy_addresses' => array(
          '127.0.0.2',
          '127.0.0.3',
        ),
      ),
    );
    foreach ($cases as $case) {

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

  /**
   * 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\Component\Utility\Settings $settings
   *   The settings object that holds reverse proxy configuration.
   */
  protected function trustedHeadersAreSet(Settings $settings) {
    $subscriber = new ReverseProxySubscriber($settings);
    $request = $this
      ->getMock('Symfony\\Component\\HttpFoundation\\Request', array(
      'setTrustedHeaderName',
      'setTrustedProxies',
    ));
    $request
      ->staticExpects($this
      ->at(0))
      ->method('setTrustedHeaderName')
      ->with($this
      ->equalTo($request::HEADER_CLIENT_IP), $this
      ->equalTo($settings
      ->get('reverse_proxy_header')));
    $request
      ->staticExpects($this
      ->at(1))
      ->method('setTrustedProxies')
      ->with($this
      ->equalTo($settings
      ->get('reverse_proxy_addresses')));
    $event = $this
      ->getMockedEvent($request);
    $subscriber
      ->onKernelRequestReverseProxyCheck($event);
  }

  /**
   * Creates a mocked event.
   *
   * Mocks a \Symfony\Component\HttpKernel\Event\GetResponseEvent object
   * and stubs its getRequest() method to return a mocked request object.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   A mocked Request object.
   *
   * @return \Symfony\Component\HttpKernel\Event\GetResponseEvent
   *   The GetResponseEvent mocked object.
   */
  protected function getMockedEvent($request) {
    $event = $this
      ->getMockBuilder('Symfony\\Component\\HttpKernel\\Event\\GetResponseEvent')
      ->disableOriginalConstructor()
      ->getMock();
    $event
      ->expects($this
      ->once())
      ->method('getRequest')
      ->will($this
      ->returnValue($request));
    return $event;
  }

}