class EntityAutocompleteTest in Drupal 10
Same name and namespace in other branches
- 8 core/tests/Drupal/KernelTests/Core/Entity/EntityAutocompleteTest.php \Drupal\KernelTests\Core\Entity\EntityAutocompleteTest
- 9 core/tests/Drupal/KernelTests/Core/Entity/EntityAutocompleteTest.php \Drupal\KernelTests\Core\Entity\EntityAutocompleteTest
Tests the autocomplete functionality.
@group Entity
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, ConfigTestTrait, ExtensionListTestTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
- class \Drupal\KernelTests\Core\Entity\EntityAutocompleteTest
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
Expanded class hierarchy of EntityAutocompleteTest
File
- core/
tests/ Drupal/ KernelTests/ Core/ Entity/ EntityAutocompleteTest.php, line 19
Namespace
Drupal\KernelTests\Core\EntityView source
class EntityAutocompleteTest extends EntityKernelTestBase {
/**
* The entity type used in this test.
*
* @var string
*/
protected $entityType = 'entity_test';
/**
* The bundle used in this test.
*
* @var string
*/
protected $bundle = 'entity_test';
/**
* Tests autocompletion edge cases with slashes in the names.
*/
public function testEntityReferenceAutocompletion() {
// Add an entity with a slash in its name.
$entity_1 = $this->container
->get('entity_type.manager')
->getStorage($this->entityType)
->create([
'name' => '10/16/2011',
]);
$entity_1
->save();
// Add another entity that differs after the slash character.
$entity_2 = $this->container
->get('entity_type.manager')
->getStorage($this->entityType)
->create([
'name' => '10/17/2011',
]);
$entity_2
->save();
// Add another entity that has both a comma, a slash and markup.
$entity_3 = $this->container
->get('entity_type.manager')
->getStorage($this->entityType)
->create([
'name' => 'label with, and / test',
]);
$entity_3
->save();
// Try to autocomplete an entity label that matches both entities.
// We should get both entities in a JSON encoded string.
$input = '10/';
$data = $this
->getAutocompleteResult($input);
$this
->assertSame(Html::escape($entity_1->name->value), $data[0]['label'], 'Autocomplete returned the first matching entity');
$this
->assertSame(Html::escape($entity_2->name->value), $data[1]['label'], 'Autocomplete returned the second matching entity');
// Try to autocomplete an entity label that matches the first entity.
// We should only get the first entity in a JSON encoded string.
$input = '10/16';
$data = $this
->getAutocompleteResult($input);
$target = [
'value' => $entity_1->name->value . ' (1)',
'label' => Html::escape($entity_1->name->value),
];
$this
->assertSame($target, reset($data), 'Autocomplete returns only the expected matching entity.');
// Try to autocomplete an entity label that matches the second entity, and
// the first entity is already typed in the autocomplete (tags) widget.
$input = $entity_1->name->value . ' (1), 10/17';
$data = $this
->getAutocompleteResult($input);
$this
->assertSame(Html::escape($entity_2->name->value), $data[0]['label'], 'Autocomplete returned the second matching entity');
// Try to autocomplete an entity label with both comma, slash and markup.
$input = '"label with, and /"';
$data = $this
->getAutocompleteResult($input);
$n = $entity_3->name->value . ' (3)';
// Entity labels containing commas or quotes must be wrapped in quotes.
$n = Tags::encode($n);
$target = [
'value' => $n,
'label' => Html::escape($entity_3->name->value),
];
$this
->assertSame($target, reset($data), 'Autocomplete returns an entity label containing a comma and a slash.');
$input = '';
$data = $this
->getAutocompleteResult($input);
$this
->assertSame([], $data, 'Autocomplete of empty string returns empty result');
$input = ',';
$data = $this
->getAutocompleteResult($input);
$this
->assertSame(Html::escape($entity_1->name->value), $data[0]['label'], 'Autocomplete returned the first matching entity');
$this
->assertSame(Html::escape($entity_2->name->value), $data[1]['label'], 'Autocomplete returned the second matching entity');
$this
->assertSame(Html::escape($entity_3->name->value), $data[2]['label'], 'Autocomplete returned the third matching entity');
// Strange input that is mangled by
// \Drupal\Component\Utility\Tags::explode().
$input = '"l!J>&Tw';
$data = $this
->getAutocompleteResult($input);
$this
->assertSame(Html::escape($entity_1->name->value), $data[0]['label'], 'Autocomplete returned the first matching entity');
$this
->assertSame(Html::escape($entity_2->name->value), $data[1]['label'], 'Autocomplete returned the second matching entity');
$this
->assertSame(Html::escape($entity_3->name->value), $data[2]['label'], 'Autocomplete returned the third matching entity');
}
/**
* Tests that missing or invalid selection setting key are handled correctly.
*/
public function testSelectionSettingsHandling() {
$entity_reference_controller = EntityAutocompleteController::create($this->container);
$request = Request::create('entity_reference_autocomplete/' . $this->entityType . '/default');
$request->query
->set('q', $this
->randomString());
try {
// Pass an invalid selection settings key (i.e. one that does not exist
// in the key/value store).
$selection_settings_key = $this
->randomString();
$entity_reference_controller
->handleAutocomplete($request, $this->entityType, 'default', $selection_settings_key);
$this
->fail('Non-existent selection settings key throws an exception.');
} catch (AccessDeniedHttpException $e) {
// Expected exception; just continue testing.
}
try {
// Generate a valid hash key but store a modified settings array.
$selection_settings = [];
$selection_settings_key = Crypt::hmacBase64(serialize($selection_settings) . $this->entityType . 'default', Settings::getHashSalt());
$selection_settings[$this
->randomMachineName()] = $this
->randomString();
\Drupal::keyValue('entity_autocomplete')
->set($selection_settings_key, $selection_settings);
$entity_reference_controller
->handleAutocomplete($request, $this->entityType, 'default', $selection_settings_key);
} catch (AccessDeniedHttpException $e) {
$this
->assertSame('Invalid selection settings key.', $e
->getMessage());
}
}
/**
* Returns the result of an Entity reference autocomplete request.
*
* @param string $input
* The label of the entity to query by.
*
* @return mixed
* The JSON value encoded in its appropriate PHP type.
*/
protected function getAutocompleteResult($input) {
$request = Request::create('entity_reference_autocomplete/' . $this->entityType . '/default');
$request->query
->set('q', $input);
$selection_settings = [];
$selection_settings_key = Crypt::hmacBase64(serialize($selection_settings) . $this->entityType . 'default', Settings::getHashSalt());
\Drupal::keyValue('entity_autocomplete')
->set($selection_settings_key, $selection_settings);
$entity_reference_controller = EntityAutocompleteController::create($this->container);
$result = $entity_reference_controller
->handleAutocomplete($request, $this->entityType, 'default', $selection_settings_key)
->getContent();
return Json::decode($result);
}
}