class MediaLibraryStateTest in Drupal 9
Same name and namespace in other branches
- 8 core/modules/media_library/tests/src/Kernel/MediaLibraryStateTest.php \Drupal\Tests\media_library\Kernel\MediaLibraryStateTest
Tests the media library state value object.
@group media_library
@coversDefaultClass \Drupal\media_library\MediaLibraryState
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\media_library\Kernel\MediaLibraryStateTest uses MediaTypeCreationTrait
Expanded class hierarchy of MediaLibraryStateTest
File
- core/
modules/ media_library/ tests/ src/ Kernel/ MediaLibraryStateTest.php, line 20
Namespace
Drupal\Tests\media_library\KernelView source
class MediaLibraryStateTest extends KernelTestBase {
use MediaTypeCreationTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'media',
'media_library',
'file',
'field',
'image',
'system',
'views',
'user',
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this
->installEntitySchema('user');
$this
->installEntitySchema('file');
$this
->installSchema('file', 'file_usage');
$this
->installSchema('system', 'sequences');
$this
->installEntitySchema('media');
$this
->installConfig([
'field',
'system',
'file',
'image',
'media',
'media_library',
]);
// Create some media types to validate against.
$this
->createMediaType('file', [
'id' => 'document',
]);
$this
->createMediaType('image', [
'id' => 'image',
]);
$this
->createMediaType('video_file', [
'id' => 'video',
]);
}
/**
* Tests the media library state methods.
*/
public function testMethods() {
$opener_id = 'test';
$allowed_media_type_ids = [
'document',
'image',
];
$selected_media_type_id = 'image';
$remaining_slots = 2;
$state = MediaLibraryState::create($opener_id, $allowed_media_type_ids, $selected_media_type_id, $remaining_slots);
$this
->assertSame($opener_id, $state
->getOpenerId());
$this
->assertSame($allowed_media_type_ids, $state
->getAllowedTypeIds());
$this
->assertSame($selected_media_type_id, $state
->getSelectedTypeId());
$this
->assertSame($remaining_slots, $state
->getAvailableSlots());
$this
->assertTrue($state
->hasSlotsAvailable());
$state = MediaLibraryState::create($opener_id, $allowed_media_type_ids, $selected_media_type_id, 0);
$this
->assertFalse($state
->hasSlotsAvailable());
}
/**
* Tests the media library state creation.
*
* @param string $opener_id
* The opener ID.
* @param string[] $allowed_media_type_ids
* The allowed media type IDs.
* @param string $selected_type_id
* The selected media type ID.
* @param int $remaining_slots
* The number of remaining items the user is allowed to select or add in the
* library.
* @param string $exception_message
* The expected exception message.
*
* @covers ::create
* @dataProvider providerCreate
*/
public function testCreate($opener_id, array $allowed_media_type_ids, $selected_type_id, $remaining_slots, $exception_message = '') {
if ($exception_message) {
$this
->expectException(\InvalidArgumentException::class);
$this
->expectExceptionMessage($exception_message);
}
$state = MediaLibraryState::create($opener_id, $allowed_media_type_ids, $selected_type_id, $remaining_slots);
$this
->assertInstanceOf(MediaLibraryState::class, $state);
// Ensure that the state object carries cache metadata.
$this
->assertInstanceOf(CacheableDependencyInterface::class, $state);
$this
->assertSame([
'url.query_args',
], $state
->getCacheContexts());
$this
->assertSame(Cache::PERMANENT, $state
->getCacheMaxAge());
}
/**
* Data provider for testCreate().
*
* @return array
* The data sets to test.
*/
public function providerCreate() {
$test_data = [];
// Assert no exception is thrown when we add the parameters as expected.
$test_data['valid parameters'] = [
'test',
[
'document',
'image',
],
'image',
2,
];
// Assert an exception is thrown when the opener ID parameter is empty.
$test_data['empty opener ID'] = [
'',
[
'document',
'image',
],
'image',
2,
'The opener ID parameter is required and must be a string.',
];
// Assert an exception is thrown when the opener ID parameter is not a
// valid string.
$test_data['integer opener ID'] = [
1,
[
'document',
'image',
],
'image',
2,
'The opener ID parameter is required and must be a string.',
];
$test_data['boolean opener ID'] = [
TRUE,
[
'document',
'image',
],
'image',
2,
'The opener ID parameter is required and must be a string.',
];
$test_data['spaces opener ID'] = [
' ',
[
'document',
'image',
],
'image',
2,
'The opener ID parameter is required and must be a string.',
];
// Assert an exception is thrown when the allowed types parameter is empty.
$test_data['empty allowed types'] = [
'test',
[],
'image',
2,
'The allowed types parameter is required and must be an array of strings.',
];
// It is not possible to assert a non-array allowed types parameter, since
// that would throw a TypeError which is not a subclass of Exception.
// Continue asserting an exception is thrown when the allowed types
// parameter contains elements that are not a valid string.
$test_data['integer in allowed types'] = [
'test',
[
1,
'image',
],
'image',
2,
'The allowed types parameter is required and must be an array of strings.',
];
$test_data['boolean in allowed types'] = [
'test',
[
TRUE,
'image',
],
'image',
2,
'The allowed types parameter is required and must be an array of strings.',
];
$test_data['spaces in allowed types'] = [
'test',
[
' ',
'image',
],
'image',
2,
'The allowed types parameter is required and must be an array of strings.',
];
// Assert an exception is thrown when the selected type parameter is empty.
$test_data['empty selected type'] = [
'test',
[
'document',
'image',
],
'',
2,
'The selected type parameter is required and must be a string.',
];
// Assert an exception is thrown when the selected type parameter is not a
// valid string.
$test_data['numeric selected type'] = [
'test',
[
'document',
'image',
],
1,
2,
'The selected type parameter is required and must be a string.',
];
$test_data['boolean selected type'] = [
'test',
[
'document',
'image',
],
TRUE,
2,
'The selected type parameter is required and must be a string.',
];
$test_data['spaces selected type'] = [
'test',
[
'document',
'image',
],
' ',
2,
'The selected type parameter is required and must be a string.',
];
// Assert an exception is thrown when the selected type parameter is not in
// the list of allowed types.
$test_data['non-present selected type'] = [
'test',
[
'document',
'image',
],
'video',
2,
'The selected type parameter must be present in the list of allowed types.',
];
// Assert an exception is thrown when the remaining slots parameter is
// empty.
$test_data['empty remaining slots'] = [
'test',
[
'document',
'image',
],
'image',
'',
'The remaining slots parameter is required and must be numeric.',
];
// Assert an exception is thrown when the remaining slots parameter is
// not numeric.
$test_data['string remaining slots'] = [
'test',
[
'document',
'image',
],
'image',
'fail',
'The remaining slots parameter is required and must be numeric.',
];
$test_data['boolean remaining slots'] = [
'test',
[
'document',
'image',
],
'image',
TRUE,
'The remaining slots parameter is required and must be numeric.',
];
return $test_data;
}
/**
* Tests the hash validation when the state is created from a request.
*
* @param array $query_overrides
* The query parameters to override.
* @param bool $exception_expected
* Whether an AccessDeniedHttpException is expected or not.
*
* @covers ::fromRequest
* @dataProvider providerFromRequest
*/
public function testFromRequest(array $query_overrides, $exception_expected) {
// Override the query parameters and verify an exception is thrown when
// required state parameters are changed.
$query = MediaLibraryState::create('test', [
'file',
'image',
], 'image', 2)
->all();
$query = array_merge($query, $query_overrides);
if ($exception_expected) {
$this
->expectException(BadRequestHttpException::class);
$this
->expectExceptionMessage("Invalid media library parameters specified.");
}
$state = MediaLibraryState::fromRequest(new Request($query));
$this
->assertInstanceOf(MediaLibraryState::class, $state);
}
/**
* @covers ::fromRequest
*/
public function testFromRequestQueryLess() {
$this
->expectException(\InvalidArgumentException::class);
$this
->expectExceptionMessage('The opener ID parameter is required and must be a string.');
$state = MediaLibraryState::fromRequest(new Request());
$this
->assertInstanceOf(MediaLibraryState::class, $state);
}
/**
* Data provider for testFromRequest().
*
* @return array
* The data sets to test.
*/
public function providerFromRequest() {
$test_data = [];
// Assert no exception is thrown when we use valid state parameters.
$test_data['valid parameters'] = [
[],
FALSE,
];
// Assert no exception is thrown when we override all query parameters with
// the same data.
$test_data['changed with same values'] = [
[
'media_library_opener_id' => 'test',
'media_library_allowed_types' => [
'file',
'image',
],
'media_library_selected_type' => 'image',
'media_library_remaining' => 2,
],
FALSE,
];
// Assert an exception is thrown when we change the opener ID parameter.
$test_data['changed opener ID'] = [
[
'media_library_opener_id' => 'fail',
],
TRUE,
];
// Assert an exception is thrown when we change the allowed types parameter.
$test_data['changed allowed types'] = [
[
'media_library_allowed_types' => [
'audio',
'image',
],
],
TRUE,
];
// Assert an exception is thrown when we change the selected type parameter.
$test_data['changed selected type'] = [
[
'media_library_selected_type' => 'file',
],
TRUE,
];
// Assert an exception is thrown when we change the remaining slots
// parameter.
$test_data['changed remaining'] = [
[
'media_library_remaining' => 4,
],
TRUE,
];
// Assert an exception is thrown when we change the actual hash.
$test_data['changed hash'] = [
[
'hash' => 'fail',
],
TRUE,
];
return $test_data;
}
/**
* @covers ::getOpenerParameters
*/
public function testOpenerParameters() {
$state = MediaLibraryState::create('test', [
'file',
], 'file', -1, [
'foo' => 'baz',
]);
$this
->assertSame([
'foo' => 'baz',
], $state
->getOpenerParameters());
}
/**
* Tests that hash is unaffected by allowed media type order.
*/
public function testHashUnaffectedByMediaTypeOrder() {
$state1 = MediaLibraryState::create('test', [
'file',
'image',
], 'image', 2);
$state2 = MediaLibraryState::create('test', [
'image',
'file',
], 'image', 2);
$this
->assertSame($state1
->getHash(), $state2
->getHash());
}
/**
* Tests that hash is unaffected by opener parameter order.
*/
public function testHashUnaffectedByOpenerParamOrder() {
$state1 = MediaLibraryState::create('test', [
'file',
], 'file', -1, [
'foo' => 'baz',
'baz' => 'foo',
]);
$state2 = MediaLibraryState::create('test', [
'file',
], 'file', -1, [
'baz' => 'foo',
'foo' => 'baz',
]);
$this
->assertSame($state1
->getHash(), $state2
->getHash());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
MediaLibraryStateTest:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
MediaLibraryStateTest:: |
public | function | Data provider for testCreate(). | |
MediaLibraryStateTest:: |
public | function | Data provider for testFromRequest(). | |
MediaLibraryStateTest:: |
protected | function |
Overrides KernelTestBase:: |
|
MediaLibraryStateTest:: |
public | function | Tests the media library state creation. | |
MediaLibraryStateTest:: |
public | function | Tests the hash validation when the state is created from a request. | |
MediaLibraryStateTest:: |
public | function | @covers ::fromRequest | |
MediaLibraryStateTest:: |
public | function | Tests that hash is unaffected by allowed media type order. | |
MediaLibraryStateTest:: |
public | function | Tests that hash is unaffected by opener parameter order. | |
MediaLibraryStateTest:: |
public | function | Tests the media library state methods. | |
MediaLibraryStateTest:: |
public | function | @covers ::getOpenerParameters | |
MediaTypeCreationTrait:: |
protected | function | Create a media type for a source plugin. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |