class CoreIntegrationTest

Test using Drupal core integration of Rules API.

@group Rules

Hierarchy

Expanded class hierarchy of CoreIntegrationTest

File

tests/src/Kernel/CoreIntegrationTest.php, line 20

Namespace

Drupal\Tests\rules\Kernel
View source
class CoreIntegrationTest extends RulesKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'field',
        'text',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installSchema('system', [
            'sequences',
        ]);
        $this->installEntitySchema('user');
        $this->installEntitySchema('node');
    }
    
    /**
     * Tests that a complex data selector can be applied to entities.
     */
    public function testEntityPropertyPath() {
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $entity_type_manager->getStorage('node_type')
            ->create([
            'type' => 'page',
        ])
            ->save();
        $node = $entity_type_manager->getStorage('node')
            ->create([
            'title' => 'test',
            'type' => 'page',
        ]);
        $user = $entity_type_manager->getStorage('user')
            ->create([
            'name' => 'test value',
        ]);
        $user->save();
        $node->setOwner($user);
        $rule = $this->expressionManager
            ->createRule();
        // Test that the long detailed data selector works.
        $rule->addCondition('rules_test_string_condition', ContextConfig::create()->map('text', 'node.uid.0.entity.name.0.value'));
        // Test that the shortened data selector without list indices.
        $rule->addCondition('rules_test_string_condition', ContextConfig::create()->map('text', 'node.uid.entity.name.value'));
        $rule->addAction('rules_test_debug_log');
        RulesComponent::create($rule)->addContextDefinition('node', ContextDefinition::create('entity:node'))
            ->setContextValue('node', $node)
            ->execute();
        // Test that the action logged something.
        $this->assertRulesDebugLogEntryExists('action called');
    }
    
    /**
     * Tests that an entity is automatically saved after being changed.
     */
    public function testEntityAutoSave() {
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $entity_type_manager->getStorage('node_type')
            ->create([
            'type' => 'page',
        ])
            ->save();
        $node = $entity_type_manager->getStorage('node')
            ->create([
            'title' => 'test',
            'type' => 'page',
        ]);
        // We use the rules_test_node action plugin which marks its node context for
        // auto saving.
        // @see \Drupal\rules_test\Plugin\RulesAction\TestNodeAction
        $action = $this->expressionManager
            ->createAction('rules_test_node')
            ->setConfiguration(ContextConfig::create()->map('node', 'node')
            ->map('title', 'title')
            ->toArray());
        RulesComponent::create($action)->addContextDefinition('node', ContextDefinition::create('entity:node'))
            ->addContextDefinition('title', ContextDefinition::create('string'))
            ->setContextValue('node', $node)
            ->setContextValue('title', 'new title')
            ->execute();
        $this->assertNotNull($node->id(), 'Node ID is set, which means that the node has been saved.');
    }
    
    /**
     * Tests that tokens in action parameters get replaced.
     */
    public function testTokenReplacements() {
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $entity_type_manager->getStorage('node_type')
            ->create([
            'type' => 'page',
        ])
            ->save();
        $node = $entity_type_manager->getStorage('node')
            ->create([
            'title' => 'test',
            'type' => 'page',
        ]);
        $user = $entity_type_manager->getStorage('user')
            ->create([
            'name' => 'klausi',
        ]);
        $user->save();
        $node->setOwner($user);
        // Configure a simple rule with one action.
        $action = $this->expressionManager
            ->createInstance('rules_action', ContextConfig::create()->map('message', 'message')
            ->map('type', 'type')
            ->process('message', 'rules_tokens')
            ->setConfigKey('action_id', 'rules_system_message')
            ->toArray());
        $rule = $this->expressionManager
            ->createRule()
            ->addExpressionObject($action);
        RulesComponent::create($rule)->addContextDefinition('node', ContextDefinition::create('entity:node'))
            ->addContextDefinition('message', ContextDefinition::create('string'))
            ->addContextDefinition('type', ContextDefinition::create('string'))
            ->setContextValue('node', $node)
            ->setContextValue('message', 'Hello {{ node.uid.entity.name.value }}!')
            ->setContextValue('type', 'status')
            ->execute();
        $messages = $this->messenger
            ->all();
        $this->assertEquals((string) $messages[MessengerInterface::TYPE_STATUS][0], 'Hello klausi!');
    }
    
    /**
     * Tests that tokens used to format entity fields get replaced.
     */
    public function testTokenFormattingReplacements() {
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $entity_type_manager->getStorage('node_type')
            ->create([
            'type' => 'page',
        ])
            ->save();
        $node = $entity_type_manager->getStorage('node')
            ->create([
            'title' => 'test',
            'type' => 'page',
            // Set the created date to the first second in 1970.
'created' => 1,
        ]);
        // Configure a simple rule with one action.
        $action = $this->expressionManager
            ->createInstance('rules_action', ContextConfig::create()->map('message', 'message')
            ->map('type', 'type')
            ->process('message', 'rules_tokens')
            ->setConfigKey('action_id', 'rules_system_message')
            ->toArray());
        $rule = $this->expressionManager
            ->createRule()
            ->addExpressionObject($action);
        RulesComponent::create($rule)->addContextDefinition('node', ContextDefinition::create('entity:node'))
            ->addContextDefinition('message', ContextDefinition::create('string'))
            ->addContextDefinition('type', ContextDefinition::create('string'))
            ->setContextValue('node', $node)
            ->setContextValue('message', "The node was created in the year {{ node.created.value | format_date('custom', 'Y') }}")
            ->setContextValue('type', 'status')
            ->execute();
        $messages = $this->messenger
            ->all();
        $this->assertEquals((string) $messages[MessengerInterface::TYPE_STATUS][0], 'The node was created in the year 1970');
    }
    
    /**
     * Tests that the data set action works on entities.
     */
    public function testDataSetEntities() {
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $entity_type_manager->getStorage('node_type')
            ->create([
            'type' => 'page',
        ])
            ->save();
        $node = $entity_type_manager->getStorage('node')
            ->create([
            'title' => 'test',
            'type' => 'page',
        ]);
        // Configure a simple rule with one action.
        $action = $this->expressionManager
            ->createInstance('rules_action', ContextConfig::create()->setConfigKey('action_id', 'rules_data_set')
            ->map('data', 'node.title')
            ->map('value', 'new_title')
            ->toArray());
        $rule = $this->expressionManager
            ->createRule()
            ->addExpressionObject($action);
        RulesComponent::create($rule)->addContextDefinition('node', ContextDefinition::create('entity:node'))
            ->addContextDefinition('new_title', ContextDefinition::create('string'))
            ->setContextValue('node', $node)
            ->setContextValue('new_title', 'new title')
            ->execute();
        $this->assertEquals('new title', $node->getTitle());
        $this->assertNotNull($node->id(), 'Node ID is set, which means that the node has been auto-saved.');
    }
    
    /**
     * Tests that auto saving in a component executed as action works.
     */
    public function testComponentActionAutoSave() {
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $entity_type_manager->getStorage('node_type')
            ->create([
            'type' => 'page',
        ])
            ->save();
        $nested_rule = $this->expressionManager
            ->createRule();
        // Create a node entity with the action.
        $nested_rule->addAction('rules_entity_create:node', ContextConfig::create()->setValue('type', 'page'));
        // Set the title of the new node so that it is marked for auto-saving.
        $nested_rule->addAction('rules_data_set', ContextConfig::create()->map('data', 'node_created.title')
            ->setValue('value', 'new title'));
        $rules_config = new RulesComponentConfig([
            'id' => 'test_rule',
            'label' => 'Test rule',
        ], 'rules_component');
        $rules_config->setExpression($nested_rule);
        $rules_config->save();
        // Invoke the rules component in another rule.
        $rule = $this->expressionManager
            ->createRule();
        $rule->addAction('rules_component:test_rule');
        RulesComponent::create($rule)->execute();
        $nodes = Node::loadMultiple();
        $node = reset($nodes);
        $this->assertEquals('new title', $node->getTitle());
        $this->assertNotNull($node->id(), 'Node ID is set, which means that the node has been auto-saved.');
    }
    
    /**
     * Tests using global context.
     */
    public function testGlobalContext() {
        $account = User::create([
            'name' => 'hubert',
        ]);
        $account->save();
        $this->container
            ->get('current_user')
            ->setAccount($account);
        $rule = $this->expressionManager
            ->createRule()
            ->addAction('rules_system_message', ContextConfig::create()->map('message', '@user.current_user_context:current_user.name.value')
            ->setValue('type', 'status'));
        $component = RulesComponent::create($rule);
        $this->assertEquals(0, $component->checkIntegrity()
            ->count());
        // Ensure the execution-state is aware of global context.
        $result = $component->getState()
            ->hasVariable('@user.current_user_context:current_user');
        $this->assertTrue($result);
        // Test asking for non-existing variables.
        $this->assertFalse($component->getState()
            ->hasVariable('@user.current_user_context:invalid'));
        $this->assertFalse($component->getState()
            ->hasVariable('@user.invalid_service'));
        $this->assertFalse($component->getState()
            ->hasVariable('invalid-var'));
        // Test using global context during execution.
        $component->execute();
        $messages = $this->messenger
            ->all();
        $this->assertEquals((string) $messages[MessengerInterface::TYPE_STATUS][0], 'hubert');
    }

}

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
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.
CoreIntegrationTest::$modules protected static property Modules to enable. Overrides RulesKernelTestBase::$modules
CoreIntegrationTest::setUp protected function Overrides RulesKernelTestBase::setUp
CoreIntegrationTest::testComponentActionAutoSave public function Tests that auto saving in a component executed as action works.
CoreIntegrationTest::testDataSetEntities public function Tests that the data set action works on entities.
CoreIntegrationTest::testEntityAutoSave public function Tests that an entity is automatically saved after being changed.
CoreIntegrationTest::testEntityPropertyPath public function Tests that a complex data selector can be applied to entities.
CoreIntegrationTest::testGlobalContext public function Tests using global context.
CoreIntegrationTest::testTokenFormattingReplacements public function Tests that tokens used to format entity fields get replaced.
CoreIntegrationTest::testTokenReplacements public function Tests that tokens in action parameters get replaced.
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.