class AssetControllerTest

Same name and namespace in other branches
  1. 11.x core/tests/Drupal/KernelTests/Core/Asset/AssetControllerTest.php \Drupal\KernelTests\Core\Asset\AssetControllerTest

Tests that the asset controllers reject invalid aggregate requests.

Attributes

#[Group('asset')] #[RunTestsInSeparateProcesses] #[CoversMethod(AssetControllerBase::class, 'deliver')]

Hierarchy

Expanded class hierarchy of AssetControllerTest

File

core/tests/Drupal/KernelTests/Core/Asset/AssetControllerTest.php, line 23

Namespace

Drupal\KernelTests\Core\Asset
View source
class AssetControllerTest extends KernelTestBase {
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'common_test',
    'system',
  ];
  
  /**
   * The asset resolver service.
   */
  protected AssetResolverInterface $assetResolver;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->assetResolver = $this->container
      ->get('asset.resolver');
  }
  
  /**
   * Tests that deliver() throws BadRequestHttpException for invalid requests.
   */
  public function testDeliverBadRequests() : void {
    $language = \Drupal::languageManager()->getCurrentLanguage();
    $controller = CssAssetController::create($this->container);
    $hash = $this->randomMachineName();
    // Valid base params for assertions that must pass the early checks.
    $valid_params = [
      'delta' => 0,
      'language' => $language->getId(),
      'theme' => 'stark',
      'include' => UrlHelper::compressQueryParameter('common_test/external'),
    ];
    // Missing theme.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_diff_key($valid_params, [
      'theme' => '',
    ])), 'css_' . $hash . '.css', 'The theme must be passed as a query argument');
    // Missing delta.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_diff_key($valid_params, [
      'delta' => '',
    ])), 'css_' . $hash . '.css', 'The numeric delta must be passed as a query argument');
    // Non-numeric delta.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_merge($valid_params, [
      'delta' => 'nan',
    ])), 'css_' . $hash . '.css', 'The numeric delta must be passed as a query argument');
    // Missing language.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_diff_key($valid_params, [
      'language' => '',
    ])), 'css_' . $hash . '.css', 'The language must be passed as a query argument');
    // Missing include.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_diff_key($valid_params, [
      'include' => '',
    ])), 'css_' . $hash . '.css', 'The libraries to include must be passed as a query argument');
    // Wrong filename prefix (JS prefix for a CSS controller).
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', $valid_params), 'js_' . $hash . '.css', 'The filename prefix must match the file extension');
    // No hash segment in filename.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', $valid_params), 'css.css', 'Invalid filename');
    // Library name without a slash in include.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_merge($valid_params, [
      'include' => UrlHelper::compressQueryParameter('noslash'),
    ])), 'css_' . $hash . '.css', 'The "noslash" library name must include at least one slash.');
    // Library name without a slash in exclude.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_merge($valid_params, [
      'exclude' => UrlHelper::compressQueryParameter('noslash'),
    ])), 'css_' . $hash . '.css', 'The "noslash" library name must include at least one slash.');
    // Out-of-bounds delta.
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_merge($valid_params, [
      'delta' => 999,
    ])), 'css_' . $hash . '.css', 'Invalid filename.');
    // External group delta: requesting an aggregate for a non-file group.
    $css_assets = $this->assetResolver
      ->getCssAssets(AttachedAssets::createFromRenderArray([
      '#attached' => [
        'library' => [
          'common_test/external',
        ],
      ],
    ]), FALSE, $language);
    $groups = $this->container
      ->get('asset.css.collection_grouper')
      ->group($css_assets);
    $external_groups = array_filter($groups, static fn($g) => $g['type'] === 'external');
    $this->assertNotEmpty($external_groups, 'common_test/external must contain an external CSS group.');
    $external_delta = array_key_first($external_groups);
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_merge($valid_params, [
      'delta' => $external_delta,
    ])), 'css_' . $hash . '.css', 'The requested asset group is not aggregated.');
    // Non-aggregated group delta: requesting an aggregate for a file group that
    // has preprocess disabled.
    $css_assets = $this->assetResolver
      ->getCssAssets(AttachedAssets::createFromRenderArray([
      '#attached' => [
        'library' => [
          'common_test/no-preprocess',
        ],
      ],
    ]), FALSE, $language);
    $groups = $this->container
      ->get('asset.css.collection_grouper')
      ->group($css_assets);
    $no_preprocess_groups = array_filter($groups, static fn($g) => $g['type'] === 'file' && $g['preprocess'] === FALSE);
    $this->assertNotEmpty($no_preprocess_groups, 'common_test/no-preprocess must contain a CSS group with preprocess disabled.');
    $no_preprocess_delta = array_key_first($no_preprocess_groups);
    $this->assertDeliverThrows($controller, Request::create('/dummy', 'GET', array_merge($valid_params, [
      'delta' => $no_preprocess_delta,
      'include' => UrlHelper::compressQueryParameter('common_test/no-preprocess'),
    ])), 'css_' . $hash . '.css', 'The requested asset group is not aggregated.');
    // Missing scope; JS-specific, since JsAssetController::getGroups() needs
    // it to distinguish header from footer assets.
    $js_controller = JsAssetController::create($this->container);
    $this->assertDeliverThrows($js_controller, Request::create('/dummy', 'GET', $valid_params), 'js_' . $hash . '.js', 'The URL must have a scope query argument.');
  }
  
  /**
   * Asserts that deliver() throws a specific BadRequestHttpException.
   *
   * @param \Drupal\system\Controller\AssetControllerBase $controller
   *   The asset controller to call.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request to deliver.
   * @param string $filename
   *   The aggregate filename to request.
   * @param string $expected_message
   *   The expected exception message.
   */
  private function assertDeliverThrows(AssetControllerBase $controller, Request $request, string $filename, string $expected_message) : void {
    try {
      $controller->deliver($request, $filename);
      $this->fail("Expected BadRequestHttpException: {$expected_message}");
    } catch (BadRequestHttpException $e) {
      $this->assertSame($expected_message, $e->getMessage());
    }
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content.
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getSimpleXmlElementsByXpath protected function Performs an xpath search on the contents of the internal browser.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath Deprecated protected function Performs an xpath search on the contents of the internal browser.
AssetControllerTest::$assetResolver protected property The asset resolver service.
AssetControllerTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
AssetControllerTest::assertDeliverThrows private function Asserts that deliver() throws a specific BadRequestHttpException.
AssetControllerTest::setUp protected function Overrides KernelTestBase::setUp
AssetControllerTest::testDeliverBadRequests public function Tests that deliver() throws BadRequestHttpException for invalid requests.
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::getTestMethodCaller protected function Retrieves the current calling line in the class under test. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
HttpKernelUiHelperTrait::$mink protected property Mink session manager.
HttpKernelUiHelperTrait::assertSession public function Returns WebAssert object.
HttpKernelUiHelperTrait::buildUrl protected function Builds a URL from a system path or a URL object.
HttpKernelUiHelperTrait::clickLink protected function Follows a link by complete name.
HttpKernelUiHelperTrait::drupalGet protected function Retrieves a Drupal path.
HttpKernelUiHelperTrait::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
HttpKernelUiHelperTrait::getNodeElementsByXpath protected function Performs an xpath search on the contents of the internal browser.
HttpKernelUiHelperTrait::getSession public function Returns Mink session.
HttpKernelUiHelperTrait::getUrl protected function Gets the current URL from the browser.
HttpKernelUiHelperTrait::initMink protected function Initializes Mink sessions.
HttpKernelUiHelperTrait::rebuildContainer protected function Rebuilds the container.
KernelTestBase::$classLoader protected property The class loader.
KernelTestBase::$configImporter protected property The configuration importer.
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property The test container.
KernelTestBase::$databasePrefix protected property The test database prefix.
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$siteDirectory protected property The relative path to the test site directory.
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 1
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 2
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function Gets the database prefix used for test isolation.
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable protected static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 43
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 11
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.

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