SessionConfigurationTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Core\Session;

use Drupal\Tests\UnitTestCase;
use Symfony\Component\HttpFoundation\Request;

/**
 * @coversDefaultClass \Drupal\Core\Session\SessionConfiguration
 * @group Session
 */
class SessionConfigurationTest extends UnitTestCase {
  
  /**
   * Constructs a partially mocked SUT.
   *
   * @return \Drupal\Core\Session\SessionConfiguration|\PHPUnit\Framework\MockObject\MockObject
   */
  protected function createSessionConfiguration($options = []) {
    return $this->getMockBuilder('Drupal\\Core\\Session\\SessionConfiguration')
      ->onlyMethods([
      'drupalValidTestUa',
    ])
      ->setConstructorArgs([
      $options,
    ])
      ->getMock();
  }
  
  /**
   * Tests whether the session.cookie_domain ini settings is computed correctly.
   *
   * @covers ::getOptions
   *
   * @dataProvider providerTestGeneratedCookieDomain
   */
  public function testGeneratedCookieDomain($uri, $expected_domain) : void {
    $config = $this->createSessionConfiguration();
    $request = Request::create($uri);
    $options = $config->getOptions($request);
    $this->assertEquals($expected_domain, $options['cookie_domain']);
  }
  
  /**
   * Data provider for the cookie domain test.
   *
   * @return array
   *   Test data
   */
  public static function providerTestGeneratedCookieDomain() {
    return [
      [
        'http://example.com/path/index.php',
        '.example.com',
      ],
      [
        'http://www.example.com/path/index.php',
        '.www.example.com',
      ],
      [
        'http://subdomain.example.com/path/index.php',
        '.subdomain.example.com',
      ],
      [
        'http://example.com:8080/path/index.php',
        '.example.com',
      ],
      [
        'https://example.com/path/index.php',
        '.example.com',
      ],
      [
        'http://localhost/path/index.php',
        '',
      ],
      [
        'http://127.0.0.1/path/index.php',
        '',
      ],
      [
        'http://127.0.0.1:8888/path/index.php',
        '',
      ],
      [
        'http://1.1.1.1/path/index.php',
        '',
      ],
      [
        'http://[::1]/path/index.php',
        '',
      ],
      [
        'http://[::1]:8888/path/index.php',
        '',
      ],
    ];
  }
  
  /**
   * Tests the constructor injected session.cookie_domain ini setting.
   *
   * @covers ::__construct
   * @covers ::getOptions
   *
   * @dataProvider providerTestEnforcedCookieDomain
   */
  public function testEnforcedCookieDomain($uri, $expected_domain) : void {
    $config = $this->createSessionConfiguration([
      'cookie_domain' => '.example.com',
    ]);
    $request = Request::create($uri);
    $options = $config->getOptions($request);
    $this->assertEquals($expected_domain, $options['cookie_domain']);
  }
  
  /**
   * Data provider for the cookie domain test.
   *
   * @return array
   *   Test data
   */
  public static function providerTestEnforcedCookieDomain() {
    return [
      [
        'http://example.com/path/index.php',
        '.example.com',
      ],
      [
        'http://www.example.com/path/index.php',
        '.example.com',
      ],
      [
        'http://subdomain.example.com/path/index.php',
        '.example.com',
      ],
      [
        'http://example.com:8080/path/index.php',
        '.example.com',
      ],
      [
        'https://example.com/path/index.php',
        '.example.com',
      ],
      [
        'http://localhost/path/index.php',
        '.example.com',
      ],
      [
        'http://127.0.0.1/path/index.php',
        '.example.com',
      ],
      [
        'http://127.0.0.1:8888/path/index.php',
        '.example.com',
      ],
      [
        'http://1.1.1.1/path/index.php',
        '.example.com',
      ],
      [
        'http://[::1]/path/index.php',
        '.example.com',
      ],
      [
        'http://[::1]:8888/path/index.php',
        '.example.com',
      ],
    ];
  }
  
  /**
   * Tests whether the session.cookie_secure ini settings is computed correctly.
   *
   * @covers ::getOptions
   *
   * @dataProvider providerTestCookieSecure
   */
  public function testCookieSecure($uri, $expected_secure) : void {
    $config = $this->createSessionConfiguration();
    $request = Request::create($uri);
    $options = $config->getOptions($request);
    $this->assertEquals($expected_secure, $options['cookie_secure']);
  }
  
  /**
   * Test that session.cookie_samesite is configured correctly.
   */
  public function testSameSiteCookie() : void {
    $request = Request::create('https://example.com');
    $config = $this->createSessionConfiguration([
      'cookie_samesite' => 'Strict',
    ]);
    $options = $config->getOptions($request);
    $this->assertEquals('Strict', $options['cookie_samesite']);
  }
  
  /**
   * Tests that session.cookie_secure ini settings cannot be overridden.
   *
   * @covers ::__construct
   * @covers ::getOptions
   *
   * @dataProvider providerTestCookieSecure
   */
  public function testCookieSecureNotOverridable($uri, $expected_secure) : void {
    $config = $this->createSessionConfiguration([
      'cookie_secure' => FALSE,
    ]);
    $request = Request::create($uri);
    $options = $config->getOptions($request);
    $this->assertEquals($expected_secure, $options['cookie_secure']);
  }
  
  /**
   * Data provider for the cookie secure test.
   *
   * @return array
   *   Test data
   */
  public static function providerTestCookieSecure() {
    return [
      [
        'http://example.com/path/index.php',
        FALSE,
      ],
      [
        'https://www.example.com/path/index.php',
        TRUE,
      ],
      [
        'http://127.0.0.1/path/index.php',
        FALSE,
      ],
      [
        'https://127.0.0.1:8888/path/index.php',
        TRUE,
      ],
      [
        'http://[::1]/path/index.php',
        FALSE,
      ],
      [
        'https://[::1]:8888/path/index.php',
        TRUE,
      ],
    ];
  }
  
  /**
   * Tests whether the session.name ini settings is computed correctly.
   *
   * @covers ::getOptions
   *
   * @dataProvider providerTestGeneratedSessionName
   */
  public function testGeneratedSessionName($uri, $expected_name) : void {
    $config = $this->createSessionConfiguration();
    $request = Request::create($uri);
    $options = $config->getOptions($request);
    $this->assertEquals($expected_name, $options['name']);
  }
  
  /**
   * Data provider for the cookie name test.
   *
   * @return array
   *   Test data
   */
  public static function providerTestGeneratedSessionName() {
    $data = [
      [
        'http://example.com/path/index.php',
        'SESS',
        'example.com',
      ],
      [
        'http://www.example.com/path/index.php',
        'SESS',
        'www.example.com',
      ],
      [
        'http://subdomain.example.com/path/index.php',
        'SESS',
        'subdomain.example.com',
      ],
      [
        'http://example.com:8080/path/index.php',
        'SESS',
        'example.com',
      ],
      [
        'https://example.com/path/index.php',
        'SSESS',
        'example.com',
      ],
      [
        'http://example.com/path/core/install.php',
        'SESS',
        'example.com',
      ],
      [
        'http://localhost/path/index.php',
        'SESS',
        'localhost',
      ],
      [
        'http://127.0.0.1/path/index.php',
        'SESS',
        '127.0.0.1',
      ],
      [
        'http://127.0.0.1:8888/path/index.php',
        'SESS',
        '127.0.0.1',
      ],
      [
        'https://127.0.0.1/path/index.php',
        'SSESS',
        '127.0.0.1',
      ],
      [
        'https://127.0.0.1:8443/path/index.php',
        'SSESS',
        '127.0.0.1',
      ],
      [
        'http://1.1.1.1/path/index.php',
        'SESS',
        '1.1.1.1',
      ],
      [
        'https://1.1.1.1/path/index.php',
        'SSESS',
        '1.1.1.1',
      ],
      [
        'http://[::1]/path/index.php',
        'SESS',
        '[::1]',
      ],
      [
        'http://[::1]:8888/path/index.php',
        'SESS',
        '[::1]',
      ],
      [
        'https://[::1]/path/index.php',
        'SSESS',
        '[::1]',
      ],
      [
        'https://[::1]:8443/path/index.php',
        'SSESS',
        '[::1]',
      ],
    ];
    return array_map(function ($record) {
      return [
        $record[0],
        $record[1] . substr(hash('sha256', $record[2]), 0, 32),
      ];
    }, $data);
  }
  
  /**
   * Tests whether the session.name ini settings is computed correctly.
   *
   * @covers ::getOptions
   *
   * @dataProvider providerTestEnforcedSessionName
   */
  public function testEnforcedSessionNameViaCookieDomain($uri, $expected_name) : void {
    $config = $this->createSessionConfiguration([
      'cookie_domain' => '.example.com',
    ]);
    $request = Request::create($uri);
    $options = $config->getOptions($request);
    $this->assertEquals($expected_name, $options['name']);
  }
  
  /**
   * Data provider for the cookie name test.
   *
   * @return array
   *   Test data
   */
  public static function providerTestEnforcedSessionName() {
    $data = [
      [
        'http://example.com/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'http://www.example.com/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'http://subdomain.example.com/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'http://example.com:8080/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'https://example.com/path/index.php',
        'SSESS',
        '.example.com',
      ],
      [
        'http://example.com/path/core/install.php',
        'SESS',
        '.example.com',
      ],
      [
        'http://localhost/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'http://127.0.0.1/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'http://127.0.0.1:8888/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'https://127.0.0.1/path/index.php',
        'SSESS',
        '.example.com',
      ],
      [
        'https://127.0.0.1:8443/path/index.php',
        'SSESS',
        '.example.com',
      ],
      [
        'http://1.1.1.1/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'https://1.1.1.1/path/index.php',
        'SSESS',
        '.example.com',
      ],
      [
        'http://[::1]/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'http://[::1]:8888/path/index.php',
        'SESS',
        '.example.com',
      ],
      [
        'https://[::1]/path/index.php',
        'SSESS',
        '.example.com',
      ],
      [
        'https://[::1]:8443/path/index.php',
        'SSESS',
        '.example.com',
      ],
    ];
    return array_map(function ($record) {
      return [
        $record[0],
        $record[1] . substr(hash('sha256', $record[2]), 0, 32),
      ];
    }, $data);
  }
  
  /**
   * Tests constructor's default settings.
   *
   * @covers ::__construct
   *
   * @dataProvider providerTestConstructorDefaultSettings
   */
  public function testConstructorDefaultSettings(array $options, int $expected_sid_length, int $expected_sid_bits_per_character, string $expected_name_suffix) : void {
    $config = $this->createSessionConfiguration($options);
    $options = $config->getOptions(Request::createFromGlobals());
    $this->assertSame($expected_sid_length, $options['sid_length']);
    $this->assertSame($expected_sid_bits_per_character, $options['sid_bits_per_character']);
    $this->assertSame($expected_name_suffix, $options['name_suffix']);
  }
  
  /**
   * Data provider for the constructor test.
   *
   * @return array
   *   Test data
   */
  public static function providerTestConstructorDefaultSettings() {
    return [
      [
        [],
        48,
        6,
        '',
      ],
      [
        [
          'sid_length' => 100,
        ],
        100,
        6,
        '',
      ],
      [
        [
          'sid_bits_per_character' => 5,
        ],
        48,
        5,
        '',
      ],
      [
        [
          'name_suffix' => 'some-suffix',
        ],
        48,
        6,
        'some-suffix',
      ],
      [
        [
          'sid_length' => 100,
          'sid_bits_per_character' => 5,
          'name_suffix' => 'some-suffix',
        ],
        100,
        5,
        'some-suffix',
      ],
    ];
  }

}