class AutocompleteTest

Tests that data selector autocomplete results work correctly.

@group Rules

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait
- class \Drupal\Tests\rules\Kernel\RulesKernelTestBase extends \Drupal\KernelTests\KernelTestBase
  - class \Drupal\Tests\rules\Kernel\Engine\AutocompleteTest extends \Drupal\Tests\rules\Kernel\RulesKernelTestBase

Expanded class hierarchy of AutocompleteTest

File

tests/src/Kernel/Engine/AutocompleteTest.php, line 17

Namespace

Drupal\Tests\rules\Kernel\Engine

View source

class AutocompleteTest extends RulesKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field',
        'rules',
        'node',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('user');
        $this->installEntitySchema('node');
        // The global CurrentUserContext doesn't work properly without a
        // fully-installed user module.
        // @see https://www.drupal.org/project/rules/issues/2989417
        $this->container
            ->get('module_handler')
            ->loadInclude('user', 'install');
        user_install();
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $entity_type_manager->getStorage('node_type')
            ->create([
            'type' => 'page',
        ])
            ->save();
        // Create a multi-value integer field for testing.
        FieldStorageConfig::create([
            'field_name' => 'field_integer',
            'type' => 'integer',
            'entity_type' => 'node',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ])->save();
        FieldConfig::create([
            'field_name' => 'field_integer',
            'entity_type' => 'node',
            'bundle' => 'page',
        ])->save();
    }
    
    /**
     * Tests autocompletion works for a variable in the metadata state.
     */
    public function testAutocomplete() {
        $rule = $this->expressionManager
            ->createRule();
        $action = $this->expressionManager
            ->createAction('rules_data_set');
        $rule->addExpressionObject($action);
        $results = RulesComponent::create($rule)->addContextDefinition('entity', ContextDefinition::create('entity'))
            ->autocomplete('e', $action);
        $this->assertSame([
            [
                'value' => 'entity',
                'label' => 'entity',
            ],
            [
                'value' => 'entity.',
                'label' => 'entity...',
            ],
        ], $results);
    }
    
    /**
     * Test various node example data selectors.
     */
    public function testNodeAutocomplete() {
        $rule = $this->expressionManager
            ->createRule();
        $rule->addAction('rules_data_set');
        $component = RulesComponent::create($rule)->addContextDefinition('node', ContextDefinition::create('entity:node:page'));
        // Tests that "node.uid.en" returns the suggestion "node.uid.entity".
        $results = $component->autocomplete('node.uid.en');
        $this->assertSame([
            [
                'value' => 'node.uid.entity',
                'label' => 'node.uid.entity (User)',
            ],
            [
                'value' => 'node.uid.entity.',
                'label' => 'node.uid.entity... (User)',
            ],
        ], $results);
        // Tests that "node." returns all available fields on a node.
        $results = $component->autocomplete('node.');
        $expected = array_merge([
            [
                'value' => 'node.changed',
                'label' => 'node.changed (Changed)',
            ],
            [
                'value' => 'node.changed.',
                'label' => 'node.changed... (Changed)',
            ],
            [
                'value' => 'node.created',
                'label' => 'node.created (Authored on)',
            ],
            [
                'value' => 'node.created.',
                'label' => 'node.created... (Authored on)',
            ],
            [
                'value' => 'node.default_langcode',
                'label' => 'node.default_langcode (Default translation)',
            ],
            [
                'value' => 'node.default_langcode.',
                'label' => 'node.default_langcode... (Default translation)',
            ],
            [
                'value' => 'node.field_integer',
                'label' => 'node.field_integer (field_integer)',
            ],
            [
                'value' => 'node.field_integer.',
                'label' => 'node.field_integer... (field_integer)',
            ],
            [
                'value' => 'node.langcode',
                'label' => 'node.langcode (Language)',
            ],
            [
                'value' => 'node.langcode.',
                'label' => 'node.langcode... (Language)',
            ],
            [
                'value' => 'node.nid',
                'label' => 'node.nid (ID)',
            ],
            [
                'value' => 'node.nid.',
                'label' => 'node.nid... (ID)',
            ],
            [
                'value' => 'node.promote',
                'label' => 'node.promote (Promoted to front page)',
            ],
            [
                'value' => 'node.promote.',
                'label' => 'node.promote... (Promoted to front page)',
            ],
        ], [
            [
                'value' => 'node.revision_default',
                'label' => 'node.revision_default (Default revision)',
            ],
            [
                'value' => 'node.revision_default.',
                'label' => 'node.revision_default... (Default revision)',
            ],
        ], [
            [
                'value' => 'node.revision_log',
                'label' => 'node.revision_log (Revision log message)',
            ],
            [
                'value' => 'node.revision_log.',
                'label' => 'node.revision_log... (Revision log message)',
            ],
            [
                'value' => 'node.revision_timestamp',
                'label' => 'node.revision_timestamp (Revision create time)',
            ],
            [
                'value' => 'node.revision_timestamp.',
                'label' => 'node.revision_timestamp... (Revision create time)',
            ],
            [
                'value' => 'node.revision_translation_affected',
                'label' => 'node.revision_translation_affected (Revision translation affected)',
            ],
            [
                'value' => 'node.revision_translation_affected.',
                'label' => 'node.revision_translation_affected... (Revision translation affected)',
            ],
            [
                'value' => 'node.revision_uid',
                'label' => 'node.revision_uid (Revision user)',
            ],
            [
                'value' => 'node.revision_uid.',
                'label' => 'node.revision_uid... (Revision user)',
            ],
            [
                'value' => 'node.status',
                'label' => 'node.status (Published)',
            ],
            [
                'value' => 'node.status.',
                'label' => 'node.status... (Published)',
            ],
            [
                'value' => 'node.sticky',
                'label' => 'node.sticky (Sticky at top of lists)',
            ],
            [
                'value' => 'node.sticky.',
                'label' => 'node.sticky... (Sticky at top of lists)',
            ],
            [
                'value' => 'node.title',
                'label' => 'node.title (Title)',
            ],
            [
                'value' => 'node.title.',
                'label' => 'node.title... (Title)',
            ],
            [
                'value' => 'node.type',
                'label' => 'node.type (Content type)',
            ],
            [
                'value' => 'node.type.',
                'label' => 'node.type... (Content type)',
            ],
            [
                'value' => 'node.uid',
                'label' => 'node.uid (Authored by)',
            ],
            [
                'value' => 'node.uid.',
                'label' => 'node.uid... (Authored by)',
            ],
            [
                'value' => 'node.uuid',
                'label' => 'node.uuid (UUID)',
            ],
            [
                'value' => 'node.uuid.',
                'label' => 'node.uuid... (UUID)',
            ],
            [
                'value' => 'node.vid',
                'label' => 'node.vid (Revision ID)',
            ],
            [
                'value' => 'node.vid.',
                'label' => 'node.vid... (Revision ID)',
            ],
        ]);
        // Because this is a huge array, run the assertion per entry as that is
        // easier for debugging.
        foreach ($expected as $index => $entry) {
            $this->assertSame($entry, $results[$index]);
        }
        // Tests that "node.uid.entity.na" returns "node.uid.entity.name".
        $results = $component->autocomplete('node.uid.entity.na');
        $this->assertSame([
            [
                'value' => 'node.uid.entity.name',
                'label' => 'node.uid.entity.name (Name)',
            ],
            [
                'value' => 'node.uid.entity.name.',
                'label' => 'node.uid.entity.name... (Name)',
            ],
        ], $results);
        // A multi-valued field should show numeric indices suggestions.
        $results = $component->autocomplete('node.field_integer.');
        $this->assertSame([
            [
                'value' => 'node.field_integer.0',
                'label' => 'node.field_integer.0',
            ],
            [
                'value' => 'node.field_integer.0.',
                'label' => 'node.field_integer.0...',
            ],
            [
                'value' => 'node.field_integer.1',
                'label' => 'node.field_integer.1',
            ],
            [
                'value' => 'node.field_integer.1.',
                'label' => 'node.field_integer.1...',
            ],
            [
                'value' => 'node.field_integer.2',
                'label' => 'node.field_integer.2',
            ],
            [
                'value' => 'node.field_integer.2.',
                'label' => 'node.field_integer.2...',
            ],
            [
                'value' => 'node.field_integer.value',
                'label' => 'node.field_integer.value (Integer value)',
            ],
        ], $results);
        // A single-valued field should not show numeric indices suggestions.
        $results = $component->autocomplete('node.title.');
        $this->assertSame([
            [
                'value' => 'node.title.value',
                'label' => 'node.title.value (Text value)',
            ],
        ], $results);
        // A single-valued field should not show numeric indices suggestions.
        $results = $component->autocomplete('n');
        $this->assertSame([
            [
                'value' => 'node',
                'label' => 'node',
            ],
            [
                'value' => 'node.',
                'label' => 'node...',
            ],
        ], $results);
    }
    
    /**
     * Tests that autocomplete results for a flat list are correct.
     */
    public function testListAutocomplete() {
        $rule = $this->expressionManager
            ->createRule();
        $rule->addAction('rules_data_set');
        $context_definition = ContextDefinition::create('integer');
        $context_definition->setMultiple();
        $component = RulesComponent::create($rule)->addContextDefinition('list', $context_definition);
        $results = $component->autocomplete('list.');
        $this->assertSame([
            [
                'value' => 'list.0',
                'label' => 'list.0',
            ],
            [
                'value' => 'list.1',
                'label' => 'list.1',
            ],
            [
                'value' => 'list.2',
                'label' => 'list.2',
            ],
        ], $results);
    }

}

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.		1
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::assertFieldById		protected	function	Asserts that a field exists with the given ID and value.
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::assertFieldChecked		protected	function	Asserts that a checkbox field in the current page is checked.
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::assertNoDuplicateIds		protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped		protected	function	Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField		protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById		protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName		protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath		protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked		protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink		protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref		protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion		protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption		protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected		protected	function	Asserts that a select option in the current page is not checked.
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::assertNoTitle		protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText		protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption		protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText		protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected		protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector		protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector		protected	function	Asserts that a select option in the current page exists.
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::assertTextPattern		protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput		protected	function	Asserts themed output.
AssertContentTrait::assertTitle		protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText		protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper		protected	function	Helper for assertUniqueText and assertNoUniqueText.
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::getTextContent		protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl		protected	function	Get the current URL from the cURL handler.		1
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		protected	function	Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert	Deprecated	protected	function
AssertLegacyTrait::assertEqual	Deprecated	protected	function
AssertLegacyTrait::assertIdentical	Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject	Deprecated	protected	function
AssertLegacyTrait::assertNotEqual	Deprecated	protected	function
AssertLegacyTrait::assertNotIdentical	Deprecated	protected	function
AssertLegacyTrait::pass	Deprecated	protected	function
AssertLegacyTrait::verbose	Deprecated	protected	function
AutocompleteTest::$modules		protected static	property	Modules to enable.	Overrides RulesKernelTestBase::$modules
AutocompleteTest::setUp		protected	function		Overrides RulesKernelTestBase::setUp
AutocompleteTest::testAutocomplete		public	function	Tests autocompletion works for a variable in the metadata state.
AutocompleteTest::testListAutocomplete		public	function	Tests that autocomplete results for a flat list are correct.
AutocompleteTest::testNodeAutocomplete		public	function	Test various node example data selectors.
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.
ExtensionListTestTrait::getModulePath		protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath		protected	function	Gets the path for the specified theme.
KernelTestBase::$backupGlobals		protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes		protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist		protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader		protected	property
KernelTestBase::$configImporter		protected	property	@todo Move into Config test base class.		6
KernelTestBase::$configSchemaCheckerExclusions		protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container		protected	property
KernelTestBase::$databasePrefix		protected	property
KernelTestBase::$keyValue		protected	property	The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState		protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root		protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess		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::$siteDirectory		protected	property
KernelTestBase::$strictConfigSchema		protected	property	Set to TRUE to strict check all configuration saved.		7
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		private	function	Bootstraps a kernel for a test.
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.
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
KernelTestBase::getExtensionsForModules		private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable		private static	function	Returns the modules to enable 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	26
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::setUpBeforeClass		public static	function			1
KernelTestBase::setUpFilesystem		protected	function	Sets up the filesystem, so things like the file directory.		3
KernelTestBase::stop		protected	function	Stops test execution.
KernelTestBase::tearDown		protected	function			5
KernelTestBase::tearDownCloseDatabaseConnection		public	function	@after
KernelTestBase::vfsDump		protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep		public	function	Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings		private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning		public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator		protected	property	The random generator.
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.		1
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.
RandomGeneratorTrait::randomStringValidate		public	function	Callback for random string validation.
RulesKernelTestBase::$conditionManager		protected	property	The condition plugin manager.
RulesKernelTestBase::$debugLog		protected	property	Rules debug log.
RulesKernelTestBase::$expressionManager		protected	property	The expression plugin manager.
RulesKernelTestBase::$logger		protected	property	Rules debug logger channel.
RulesKernelTestBase::$messenger		protected	property	The messenger service.
RulesKernelTestBase::$time		protected	property	The datetime.time service.
RulesKernelTestBase::$typedDataManager		protected	property	The typed data manager.
RulesKernelTestBase::assertRulesDebugLogEntryExists		protected	function	Checks if particular message is in the log with given delta.
RulesKernelTestBase::assertRulesDebugLogEntryNotExists		protected	function	Checks if particular message is NOT in the log.
RulesKernelTestBase::createCondition		protected	function	Creates a new condition.
StorageCopyTrait::replaceStorageContents		protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements		private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements		protected	function	Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot		protected static	function	Returns the Drupal root directory.

class AutocompleteTest

Hierarchy

File

Namespace

Members

Search rules 8.x-3.x

API Navigation

Breadcrumb

class AutocompleteTest

Hierarchy

File

Namespace

Members

Search rules 8.x-3.x

API Navigation