class SessionConfigurationTest in Drupal 9

Same name and namespace in other branches

8 core/tests/Drupal/Tests/Core/Session/SessionConfigurationTest.php \Drupal\Tests\Core\Session\SessionConfigurationTest

@coversDefaultClass \Drupal\Core\Session\SessionConfiguration @group Session

Hierarchy

class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
- class \Drupal\Tests\Core\Session\SessionConfigurationTest

Expanded class hierarchy of SessionConfigurationTest

File

core/tests/Drupal/Tests/Core/Session/SessionConfigurationTest.php, line 12

Namespace

Drupal\Tests\Core\Session

View source

class SessionConfigurationTest extends UnitTestCase {

  /**
   * Constructs a partially mocked SUT.
   *
   * @returns \Drupal\Core\Session\SessionConfiguration|\PHPUnit\Framework\MockObject\MockObject
   */
  protected function createSessionConfiguration($options = []) {
    return $this
      ->getMockBuilder('Drupal\\Core\\Session\\SessionConfiguration')
      ->setMethods([
      '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) {
    $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.
   *
   * @returns array
   *   Test data
   */
  public 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) {
    $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.
   *
   * @returns array
   *   Test data
   */
  public 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) {
    $config = $this
      ->createSessionConfiguration();
    $request = Request::create($uri);
    $options = $config
      ->getOptions($request);
    $this
      ->assertEquals($expected_secure, $options['cookie_secure']);
  }

  /**
   * Tests that session.cookie_secure ini settings cannot be overridden.
   *
   * @covers ::__construct
   * @covers ::getOptions
   *
   * @dataProvider providerTestCookieSecure
   */
  public function testCookieSecureNotOverridable($uri, $expected_secure) {
    $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.
   *
   * @returns array
   *   Test data
   */
  public 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) {
    $config = $this
      ->createSessionConfiguration();
    $request = Request::create($uri);
    $options = $config
      ->getOptions($request);
    $this
      ->assertEquals($expected_name, $options['name']);
  }

  /**
   * Data provider for the cookie name test.
   *
   * @returns array
   *   Test data
   */
  public 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) {
    $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.
   *
   * @returns array
   *   Test data
   */
  public 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) {
    $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']);
  }

  /**
   * Data provider for the constructor test.
   *
   * @returns array
   *   Test data
   */
  public function providerTestConstructorDefaultSettings() {
    return [
      [
        [],
        48,
        6,
      ],
      [
        [
          'sid_length' => 100,
        ],
        100,
        6,
      ],
      [
        [
          'sid_bits_per_character' => 5,
        ],
        48,
        5,
      ],
      [
        [
          'sid_length' => 100,
          'sid_bits_per_character' => 5,
        ],
        100,
        5,
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
SessionConfigurationTest::createSessionConfiguration	protected	function	Constructs a partially mocked SUT.
SessionConfigurationTest::providerTestConstructorDefaultSettings	public	function	Data provider for the constructor test.
SessionConfigurationTest::providerTestCookieSecure	public	function	Data provider for the cookie secure test.
SessionConfigurationTest::providerTestEnforcedCookieDomain	public	function	Data provider for the cookie domain test.
SessionConfigurationTest::providerTestEnforcedSessionName	public	function	Data provider for the cookie name test.
SessionConfigurationTest::providerTestGeneratedCookieDomain	public	function	Data provider for the cookie domain test.
SessionConfigurationTest::providerTestGeneratedSessionName	public	function	Data provider for the cookie name test.
SessionConfigurationTest::testConstructorDefaultSettings	public	function	Tests constructor's default settings.
SessionConfigurationTest::testCookieSecure	public	function	Tests whether the session.cookie_secure ini settings is computed correctly.
SessionConfigurationTest::testCookieSecureNotOverridable	public	function	Tests that session.cookie_secure ini settings cannot be overridden.
SessionConfigurationTest::testEnforcedCookieDomain	public	function	Tests the constructor injected session.cookie_domain ini setting.
SessionConfigurationTest::testEnforcedSessionNameViaCookieDomain	public	function	Tests whether the session.name ini settings is computed correctly.
SessionConfigurationTest::testGeneratedCookieDomain	public	function	Tests whether the session.cookie_domain ini settings is computed correctly.
SessionConfigurationTest::testGeneratedSessionName	public	function	Tests whether the session.name ini settings is computed correctly.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals Deprecated	protected	function	Asserts if two arrays are equal by sorting them first.
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::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.
UnitTestCase::setUp	protected	function		308
UnitTestCase::setUpBeforeClass	public static	function

You are here

class SessionConfigurationTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation