class AjaxPageStateTest

Same name in this branch
  1. main core/modules/system/tests/src/Functional/Render/AjaxPageStateTest.php \Drupal\Tests\system\Functional\Render\AjaxPageStateTest
Same name and namespace in other branches
  1. 11.x core/modules/system/tests/src/Functional/Render/AjaxPageStateTest.php \Drupal\Tests\system\Functional\Render\AjaxPageStateTest
  2. 11.x core/tests/Drupal/Tests/Core/StackMiddleware/AjaxPageStateTest.php \Drupal\Tests\Core\StackMiddleware\AjaxPageStateTest
  3. 10 core/modules/system/tests/src/Functional/Render/AjaxPageStateTest.php \Drupal\Tests\system\Functional\Render\AjaxPageStateTest
  4. 9 core/modules/system/tests/src/Functional/Render/AjaxPageStateTest.php \Drupal\Tests\system\Functional\Render\AjaxPageStateTest
  5. 8.9.x core/modules/system/tests/src/Functional/Render/AjaxPageStateTest.php \Drupal\Tests\system\Functional\Render\AjaxPageStateTest

Tests Drupal\Core\StackMiddleware\AjaxPageState.

Attributes

#[CoversClass(AjaxPageState::class)] #[Group('StackMiddleware')]

Hierarchy

Expanded class hierarchy of AjaxPageStateTest

File

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

Namespace

Drupal\Tests\Core\StackMiddleware
View source
class AjaxPageStateTest extends UnitTestCase {
  
  /**
   * Tests that the query and request libraries are merged.
   */
  public function testHandle(?string $query_libraries, ?string $request_libraries, ?string $query_expected, ?string $request_expected) : void {
    $request = new Request();
    if ($query_libraries) {
      $request->query
        ->set('ajax_page_state', [
        'libraries' => $query_libraries,
      ]);
    }
    if ($request_libraries) {
      $request->request
        ->set('ajax_page_state', [
        'libraries' => $request_libraries,
      ]);
    }
    $result_request = new Request();
    if ($query_expected) {
      $result_request->query
        ->set('ajax_page_state', [
        'libraries' => $query_expected,
      ]);
      $result_request->attributes
        ->set('ajax_page_state', [
        'libraries' => $query_expected,
      ]);
    }
    if ($request_expected) {
      $result_request->request
        ->set('ajax_page_state', [
        'libraries' => $request_expected,
      ]);
      $result_request->attributes
        ->set('ajax_page_state', [
        'libraries' => $request_expected,
      ]);
    }
    $kernel = $this->prophesize(HttpKernelInterface::class);
    $kernel->handle($result_request, HttpKernelInterface::MAIN_REQUEST, TRUE)
      ->shouldBeCalled()
      ->willReturn($this->createStub(Response::class));
    $middleware = new AjaxPageState($kernel->reveal());
    $middleware->handle($request);
    // Ensure the modified request matches the expected request.
    $this->assertEquals($request->request
      ->all(), $result_request->request
      ->all());
    $this->assertEquals($request->query
      ->all(), $result_request->query
      ->all());
    $this->assertEquals($request->attributes
      ->all(), $result_request->attributes
      ->all());
  }
  
  /**
   * Provides data for testHandle().
   */
  public static function providerHandle() : array {
    $foo_bar = UrlHelper::compressQueryParameter('core/foo,core/bar');
    $foo_baz = UrlHelper::compressQueryParameter('core/foo,core/baz');
    $data = [];
    $data['only query'] = [
      $foo_bar,
      NULL,
      'core/foo,core/bar',
      NULL,
    ];
    $data['only request'] = [
      NULL,
      $foo_bar,
      NULL,
      'core/foo,core/bar',
    ];
    $data['matching'] = [
      $foo_bar,
      $foo_bar,
      'core/foo,core/bar',
      'core/foo,core/bar',
    ];
    $data['different'] = [
      $foo_baz,
      $foo_bar,
      'core/foo,core/bar,core/baz',
      'core/foo,core/bar,core/baz',
    ];
    $data['invalid libraries discarded'] = [
      UrlHelper::compressQueryParameter('<b>foo'),
      NULL,
      NULL,
      NULL,
    ];
    $data['mixed valid and invalid'] = [
      UrlHelper::compressQueryParameter('core/drupal,<b>foo'),
      NULL,
      'core/drupal',
      NULL,
    ];
    // A name containing a slash is structurally valid; the middleware does not
    // need to filter it because the asset system ignores unknown libraries.
    $data['slash-containing name preserved'] = [
      UrlHelper::compressQueryParameter('core/<b>foo'),
      NULL,
      'core/<b>foo',
      NULL,
    ];
    return $data;
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overrides
AjaxPageStateTest::providerHandle public static function Provides data for testHandle().
AjaxPageStateTest::testHandle public function Tests that the query and request libraries are merged.
DrupalTestCase::$root protected property The Drupal root directory.
DrupalTestCase::getDrupalRoot Deprecated protected function Returns the Drupal root directory. 1
DrupalTestCase::setUpRoot final protected function Ensure that the $root property is set initially.
DrupalTestCase::skipTestWithAttribute final protected function Supports skipping tests with the Skip attribute.
DrupalTestCaseTrait::checkErrorHandlerOnTearDown public function Checks the test error handler after test execution. 1
DrupalTestCaseTrait::checkLegacySymfonyDeprecationHelperEnvVariable public function Checks legacy SYMFONY_DEPRECATIONS_HELPER env variable is not used.
DrupalTestCaseTrait::expectExceptionMessageIs protected function Expects an exactly matching exception message.
DrupalTestCaseTrait::expectExceptionMessageIsOrContains protected function Expects an exception message containing a specified string.
DrupalTestCaseTrait::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.
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.
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::setUp protected function 361
UnitTestCase::setupMockIterator protected function Set up a traversable class mock to return specific items when iterated.

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