class NameAutocompleteTest in Log entity 2.x
Tests name autocomplete for logs.
@group Log
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\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
- class \Drupal\Tests\log\Kernel\NameAutocompleteTest uses LogCreationTrait
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
Expanded class hierarchy of NameAutocompleteTest
File
- tests/
src/ Kernel/ NameAutocompleteTest.php, line 15
Namespace
Drupal\Tests\log\KernelView source
class NameAutocompleteTest extends EntityKernelTestBase {
use LogCreationTrait;
/**
* {@inheritdoc}
*/
public static $modules = [
'log',
'log_test',
'datetime',
'entity',
'state_machine',
];
/**
* An admin account.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $adminAccount;
/**
* An account with 'view any default log' permission.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $anyAccount;
/**
* An account with 'view own default log' permission.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $ownAccount;
/**
* An account with no view permissions.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $noneAccount;
/**
* A collection of logs.
*
* @var \Drupal\log\Entity\LogInterface[]
*/
protected $logs = [];
/**
* The request stack used for testing.
*
* @var \Symfony\Component\HttpFoundation\RequestStack
*/
protected $requestStack;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this
->installEntitySchema('log');
$this
->installConfig([
'log',
'log_test',
]);
// Create the test user accounts.
$this->adminAccount = $this
->createUser([], [
'administer log',
]);
$this->anyAccount = $this
->createUser([], [
'view any default log',
'create default log',
]);
$this->ownAccount = $this
->createUser([], [
'view own default log',
'create default log',
]);
$this->noneAccount = $this
->createUser([], [
'create default log',
]);
// Create the different log entries.
$this->logs[] = $this
->createLogEntity([
'name' => 'First log',
'uid' => $this->adminAccount
->id(),
]);
$this->logs[] = $this
->createLogEntity([
'name' => 'Second log',
'uid' => $this->adminAccount
->id(),
]);
$this->logs[] = $this
->createLogEntity([
'name' => 'Third log',
'uid' => $this->ownAccount
->id(),
]);
}
/**
* Returns the result of an autocomplete request.
*
* @param string $input
* The label of the entity to query by.
*
* @return mixed
* The JSON value encoded in its appropriate PHP type.
*
* @throws \Exception
*/
protected function getAutocompleteResult($input) {
// Rebuild the route cache on each request to avoid parameter bag cache
// leaks.
$this->container
->get('router.builder')
->rebuild();
// Build the autocomplete request, 'q' is the right parameter to mock this.
$request = Request::create('/log/default/autocomplete');
$request->query
->set('q', $input);
/** @var \Symfony\Component\HttpKernel\HttpKernelInterface $http_kernel */
$http_kernel = $this->container
->get('http_kernel');
$response = $http_kernel
->handle($request);
// The response is a JsonResponse and the content is a string that needs to
// be decoded to array.
$result = $response
->getContent();
return Json::decode($result);
}
/**
* Tests name autocomplete route.
*/
public function testLogNameAutocomplete() {
// Tests admin account with an autocomplete query that shouldn't return any
// logs.
$this->container
->get('current_user')
->setAccount($this->adminAccount);
$result = $this
->getAutocompleteResult('nonsense');
$this
->assertEmpty($result, 'No results for non matching search query.');
// Tests admin account so it returns the complete set of logs.
$result = $this
->getAutocompleteResult('log');
$this
->assertEqual(count($this->logs), count($result), 'Number of results for matching query and admin user is as expected.');
// With an account that has 'view any default log' permission, the result
// should be the complete set of logs.
$this->container
->get('current_user')
->setAccount($this->anyAccount);
$result = $this
->getAutocompleteResult('log');
$this
->assertEqual(3, count($result), 'Number of results for matching query and user with view any permission is as expected.');
// With an account that has 'view own default log' permission, the result
// should be the logs belonging to that user.
$this->container
->get('current_user')
->setAccount($this->ownAccount);
$result = $this
->getAutocompleteResult('log');
$this
->assertEqual(1, count($result), 'Number of results for matching query and user with view own permission is as expected.');
$own_log = array_filter($this->logs, function ($log) {
/** @var \Drupal\log\Entity\LogInterface $log */
return $log
->id() == $this->ownAccount
->id();
});
$own_log = reset($own_log);
$this
->assertEqual($result[0], $own_log
->label(), 'The right log for the user is returned.');
// With an account with no permissions and the right query, there should be
// no results anyway.
$this->container
->get('current_user')
->setAccount($this->noneAccount);
$result = $this
->getAutocompleteResult('log');
$this
->assertEmpty($result, 'No results for user without permissions.');
}
/**
* Tests the order of logs returned.
*/
public function testLogNameAutocompleteMultipleLogs() {
// Add a duplicate log that should be on top of the results.
$this->logs[] = $this
->createLogEntity([
'name' => 'Z log',
'uid' => $this->adminAccount
->id(),
]);
$this->logs[] = $this
->createLogEntity([
'name' => 'Z log',
'uid' => $this->adminAccount
->id(),
]);
$this->container
->get('current_user')
->setAccount($this->adminAccount);
$result = $this
->getAutocompleteResult('log');
$this
->assertEqual(count($this->logs) - 1, count($result), 'Duplicated log is not duplicated in the autocomplete results.');
$expected_order = [
'Z log',
'First log',
'Second log',
'Third log',
];
$this
->assertEqual($result, $expected_order, 'Order of results is as expected.');
}
}
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. | |
EntityKernelTestBase:: |
protected | property | The entity type manager service. | 1 |
EntityKernelTestBase:: |
protected | property | A list of generated identifiers. | |
EntityKernelTestBase:: |
protected | property | The state service. | |
EntityKernelTestBase:: |
protected | function | Creates a user. | |
EntityKernelTestBase:: |
protected | function | Generates a random ID avoiding collisions. | |
EntityKernelTestBase:: |
protected | function | Returns the entity_test hook invocation info. | |
EntityKernelTestBase:: |
protected | function | Installs a module and refreshes services. | |
EntityKernelTestBase:: |
protected | function | Refresh services. | 1 |
EntityKernelTestBase:: |
protected | function | Reloads the given entity from the storage and returns it. | |
EntityKernelTestBase:: |
protected | function | Uninstalls a module and refreshes services. | |
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. | |
LogCreationTrait:: |
protected | function | Creates a log entity. | |
NameAutocompleteTest:: |
protected | property | An admin account. | |
NameAutocompleteTest:: |
protected | property | An account with 'view any default log' permission. | |
NameAutocompleteTest:: |
protected | property | A collection of logs. | |
NameAutocompleteTest:: |
public static | property |
Modules to enable. Overrides EntityKernelTestBase:: |
|
NameAutocompleteTest:: |
protected | property | An account with no view permissions. | |
NameAutocompleteTest:: |
protected | property | An account with 'view own default log' permission. | |
NameAutocompleteTest:: |
protected | property | The request stack used for testing. | |
NameAutocompleteTest:: |
protected | function | Returns the result of an autocomplete request. | |
NameAutocompleteTest:: |
protected | function |
Overrides EntityKernelTestBase:: |
|
NameAutocompleteTest:: |
public | function | Tests name autocomplete route. | |
NameAutocompleteTest:: |
public | function | Tests the order of logs returned. | |
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. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions | |
UserCreationTrait:: |
protected | function | Creates an administrative role. Aliased as: drupalCreateAdminRole | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. Aliased as: drupalGrantPermissions | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. Aliased as: drupalSetCurrentUser | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser |