ComponentMetadataTest.php
Same filename in this branch
Same filename and directory in other branches
Namespace
Drupal\Tests\Core\Theme\ComponentFile
-
core/
tests/ Drupal/ Tests/ Core/ Theme/ Component/ ComponentMetadataTest.php
View source
<?php
declare (strict_types=1);
namespace Drupal\Tests\Core\Theme\Component;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Theme\Component\ComponentMetadata;
use Drupal\Core\Render\Component\Exception\InvalidComponentException;
use Drupal\Tests\UnitTestCaseTest;
use PHPUnit\Framework\Attributes\DataProvider;
/**
* Unit tests for the component metadata class.
*
* @coversDefaultClass \Drupal\Core\Theme\Component\ComponentMetadata
* @group sdc
*/
class ComponentMetadataTest extends UnitTestCaseTest {
/**
* Tests that the correct data is returned for each property.
*/
public function testMetadata(array $metadata_info, array $expectations) : void {
$metadata = new ComponentMetadata($metadata_info, 'foo/', FALSE);
$this->assertSame($expectations['path'], $metadata->path);
$this->assertSame($expectations['status'], $metadata->status);
$this->assertSame($expectations['thumbnail'], $metadata->getThumbnailPath());
$this->assertEquals($expectations['props'], $metadata->schema);
}
/**
* Tests the correct checks when enforcing schemas or not.
*/
public function testMetadataEnforceSchema(array $metadata_info, array $expectations, bool $missing_schema) : void {
if ($missing_schema) {
$this->expectException(InvalidComponentException::class);
$this->expectExceptionMessage('The component "' . $metadata_info['id'] . '" does not provide schema information. Schema definitions are mandatory for components declared in modules. For components declared in themes, schema definitions are only mandatory if the "enforce_prop_schemas" key is set to "true" in the theme info file.');
new ComponentMetadata($metadata_info, 'foo/', TRUE);
}
else {
new ComponentMetadata($metadata_info, 'foo/', TRUE);
$this->expectNotToPerformAssertions();
}
}
/**
* Data provider for the test testMetadataEnforceSchema.
*
* @return array[]
* The batches of data.
*/
public static function dataProviderMetadata() : array {
return [
'minimal example without schemas' => [
[
'path' => 'foo/bar/component-name',
'id' => 'core:component-name',
'name' => 'Component Name',
'libraryOverrides' => [
'dependencies' => [
'core/drupal',
],
],
'group' => 'my-group',
'description' => 'My description',
],
[
'path' => 'bar/component-name',
'status' => 'stable',
'thumbnail' => '',
'props' => NULL,
],
TRUE,
],
'complete example with schema, but no meta:enum' => [
[
'$schema' => 'https://git.drupalcode.org/project/drupal/-/raw/HEAD/core/assets/schemas/v1/metadata.schema.json',
'id' => 'core:my-button',
'machineName' => 'my-button',
'path' => 'foo/my-other/path',
'name' => 'Button',
'description' => 'JavaScript enhanced button that tracks the number of times a user clicked it.',
'libraryOverrides' => [
'dependencies' => [
'core/drupal',
],
],
'group' => 'my-group',
'props' => [
'type' => 'object',
'required' => [
'text',
],
'properties' => [
'text' => [
'type' => 'string',
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'iconType' => [
'type' => 'string',
'title' => 'Icon Type',
'enum' => [
'power',
'like',
'external',
],
],
],
],
],
[
'path' => 'my-other/path',
'status' => 'stable',
'thumbnail' => '',
'group' => 'my-group',
'additionalProperties' => FALSE,
'props' => [
'type' => 'object',
'required' => [
'text',
],
'additionalProperties' => FALSE,
'properties' => [
'text' => [
'type' => [
'string',
'object',
],
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'iconType' => [
'type' => [
'string',
'object',
],
'title' => 'Icon Type',
'enum' => [
'power',
'like',
'external',
],
'meta:enum' => [
'power' => new TranslatableMarkup('power', [], [
'context' => '',
]),
'like' => new TranslatableMarkup('like', [], [
'context' => '',
]),
'external' => new TranslatableMarkup('external', [], [
'context' => '',
]),
],
],
],
],
],
FALSE,
],
'complete example with schema, but no matching meta:enum' => [
[
'$schema' => 'https://git.drupalcode.org/project/drupal/-/raw/HEAD/core/assets/schemas/v1/metadata.schema.json',
'id' => 'core:my-button',
'machineName' => 'my-button',
'path' => 'foo/my-other/path',
'name' => 'Button',
'description' => 'JavaScript enhanced button that tracks the number of times a user clicked it.',
'libraryOverrides' => [
'dependencies' => [
'core/drupal',
],
],
'group' => 'my-group',
'props' => [
'type' => 'object',
'required' => [
'text',
],
'properties' => [
'text' => [
'type' => 'string',
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'iconType' => [
'type' => 'string',
'title' => 'Icon Type',
'enum' => [
'power',
'like',
'external',
],
'meta:enum' => [
'power' => 'Power',
'fav' => 'Favorite',
'external' => 'External',
],
],
],
],
],
[
'path' => 'my-other/path',
'status' => 'stable',
'thumbnail' => '',
'group' => 'my-group',
'additionalProperties' => FALSE,
'props' => [
'type' => 'object',
'required' => [
'text',
],
'additionalProperties' => FALSE,
'properties' => [
'text' => [
'type' => [
'string',
'object',
],
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'iconType' => [
'type' => [
'string',
'object',
],
'title' => 'Icon Type',
'enum' => [
'power',
'like',
'external',
],
'meta:enum' => [
'power' => new TranslatableMarkup('Power', [], [
'context' => '',
]),
'like' => new TranslatableMarkup('like', [], [
'context' => '',
]),
'external' => new TranslatableMarkup('External', [], [
'context' => '',
]),
],
],
],
],
],
FALSE,
],
'complete example with schema, but no meta:enum, prop value not as string' => [
[
'$schema' => 'https://git.drupalcode.org/project/drupal/-/raw/HEAD/core/assets/schemas/v1/metadata.schema.json',
'id' => 'core:my-button',
'machineName' => 'my-button',
'path' => 'foo/my-other/path',
'name' => 'Button',
'description' => 'JavaScript enhanced button that tracks the number of times a user clicked it.',
'libraryOverrides' => [
'dependencies' => [
'core/drupal',
],
],
'group' => 'my-group',
'props' => [
'type' => 'object',
'required' => [
'text',
],
'properties' => [
'col' => [
'type' => 'string',
'title' => 'Column',
'enum' => [
1,
2,
3,
],
],
],
],
],
[
'path' => 'my-other/path',
'status' => 'stable',
'thumbnail' => '',
'group' => 'my-group',
'additionalProperties' => FALSE,
'props' => [
'type' => 'object',
'required' => [
'text',
],
'additionalProperties' => FALSE,
'properties' => [
'col' => [
'type' => [
'string',
'object',
],
'title' => 'Column',
'enum' => [
1,
2,
3,
],
'meta:enum' => [
1 => new TranslatableMarkup('1', [], [
'context' => '',
]),
2 => new TranslatableMarkup('2', [], [
'context' => '',
]),
3 => new TranslatableMarkup('3', [], [
'context' => '',
]),
],
],
],
],
],
FALSE,
],
'complete example with schema (including meta:enum)' => [
[
'$schema' => 'https://git.drupalcode.org/project/drupal/-/raw/HEAD/core/assets/schemas/v1/metadata.schema.json',
'id' => 'core:my-button',
'machineName' => 'my-button',
'path' => 'foo/my-other/path',
'name' => 'Button',
'description' => 'JavaScript enhanced button that tracks the number of times a user clicked it.',
'libraryOverrides' => [
'dependencies' => [
'core/drupal',
],
],
'group' => 'my-group',
'props' => [
'type' => 'object',
'required' => [
'text',
],
'properties' => [
'text' => [
'type' => 'string',
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'iconType' => [
'type' => 'string',
'title' => 'Icon Type',
'enum' => [
'power',
'like',
'external',
],
'meta:enum' => [
'power' => 'Power',
'like' => 'Like',
'external' => 'External',
],
],
],
],
],
[
'path' => 'my-other/path',
'status' => 'stable',
'thumbnail' => '',
'group' => 'my-group',
'additionalProperties' => FALSE,
'props' => [
'type' => 'object',
'required' => [
'text',
],
'additionalProperties' => FALSE,
'properties' => [
'text' => [
'type' => [
'string',
'object',
],
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'iconType' => [
'type' => [
'string',
'object',
],
'title' => 'Icon Type',
'enum' => [
'power',
'like',
'external',
],
'meta:enum' => [
'power' => new TranslatableMarkup('Power', [], [
'context' => '',
]),
'like' => new TranslatableMarkup('Like', [], [
'context' => '',
]),
'external' => new TranslatableMarkup('External', [], [
'context' => '',
]),
],
],
],
],
],
FALSE,
],
'complete example with schema (including meta:enum and x-translation-context)' => [
[
'$schema' => 'https://git.drupalcode.org/project/drupal/-/raw/HEAD/core/assets/schemas/v1/metadata.schema.json',
'id' => 'core:my-button',
'machineName' => 'my-button',
'path' => 'foo/my-other/path',
'name' => 'Button',
'description' => 'JavaScript enhanced button that tracks the number of times a user clicked it.',
'libraryOverrides' => [
'dependencies' => [
'core/drupal',
],
],
'group' => 'my-group',
'props' => [
'type' => 'object',
'required' => [
'text',
],
'properties' => [
'text' => [
'type' => 'string',
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'iconType' => [
'type' => 'string',
'title' => 'Icon Type',
'enum' => [
'power',
'like',
'external',
],
'meta:enum' => [
'power' => 'Power',
'like' => 'Like',
'external' => 'External',
],
'x-translation-context' => 'Icon Type',
],
],
],
],
[
'path' => 'my-other/path',
'status' => 'stable',
'thumbnail' => '',
'group' => 'my-group',
'additionalProperties' => FALSE,
'props' => [
'type' => 'object',
'required' => [
'text',
],
'additionalProperties' => FALSE,
'properties' => [
'text' => [
'type' => [
'string',
'object',
],
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'iconType' => [
'type' => [
'string',
'object',
],
'title' => 'Icon Type',
'enum' => [
'power',
'like',
'external',
],
'meta:enum' => [
'power' => new TranslatableMarkup('Power', [], [
'context' => 'Icon Type',
]),
'like' => new TranslatableMarkup('Like', [], [
'context' => 'Icon Type',
]),
'external' => new TranslatableMarkup('External', [], [
'context' => 'Icon Type',
]),
],
'x-translation-context' => 'Icon Type',
],
],
],
],
FALSE,
],
'complete example with schema (including meta:enum and x-translation-context and an empty value)' => [
[
'$schema' => 'https://git.drupalcode.org/project/drupal/-/raw/HEAD/core/assets/schemas/v1/metadata.schema.json',
'id' => 'core:my-button',
'machineName' => 'my-button',
'path' => 'foo/my-other/path',
'name' => 'Button',
'description' => 'JavaScript enhanced button that tracks the number of times a user clicked it.',
'libraryOverrides' => [
'dependencies' => [
'core/drupal',
],
],
'group' => 'my-group',
'props' => [
'type' => 'object',
'required' => [
'text',
],
'properties' => [
'text' => [
'type' => 'string',
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'target' => [
'type' => 'string',
'title' => 'Icon Type',
'enum' => [
'',
'_blank',
],
'meta:enum' => [
'' => 'Opens in same window',
'_blank' => 'Opens in new window',
],
'x-translation-context' => 'Link target',
],
],
],
],
[
'path' => 'my-other/path',
'status' => 'stable',
'thumbnail' => '',
'group' => 'my-group',
'additionalProperties' => FALSE,
'props' => [
'type' => 'object',
'required' => [
'text',
],
'additionalProperties' => FALSE,
'properties' => [
'text' => [
'type' => [
'string',
'object',
],
'title' => 'Title',
'description' => 'The title for the button',
'minLength' => 2,
'examples' => [
'Press',
'Submit now',
],
],
'target' => [
'type' => [
'string',
'object',
],
'title' => 'Icon Type',
'enum' => [
'',
'_blank',
],
'meta:enum' => [
'' => new TranslatableMarkup('Opens in same window', [], [
'context' => 'Link target',
]),
'_blank' => new TranslatableMarkup('Opens in new window', [], [
'context' => 'Link target',
]),
],
'x-translation-context' => 'Link target',
],
],
],
],
FALSE,
],
];
}
}Classes
| Title | Deprecated | Summary |
|---|---|---|
| ComponentMetadataTest | Unit tests for the component metadata class. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.