class RulesEngineTest

Test using the Rules API to create and evaluate rules.

@group Rules

Hierarchy

Expanded class hierarchy of RulesEngineTest

File

tests/src/Kernel/RulesEngineTest.php, line 18

Namespace

Drupal\Tests\rules\Kernel
View source
class RulesEngineTest extends RulesKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('user');
        // 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();
    }
    
    /**
     * Tests creating a rule and iterating over the rule elements.
     */
    public function testRuleCreation() {
        // Create an 'and' condition container and add conditions to it.
        $and = $this->expressionManager
            ->createAnd()
            ->addCondition('rules_test_false')
            ->addCondition('rules_test_true', ContextConfig::create()->negateResult())
            ->negate();
        // Test that the 'and' condition container evaluates to TRUE.
        $this->assertTrue($and->execute());
        // Create an 'or' condition container and add conditions to it, including
        // the previously created 'and' condition container.
        $or = $this->expressionManager
            ->createOr()
            ->addCondition('rules_test_true', ContextConfig::create()->negateResult())
            ->addCondition('rules_test_false')
            ->addExpressionObject($and);
        // Test that the 'or' condition container evaluates to TRUE.
        $this->assertTrue($or->execute());
        // Create a rule and add conditions to it, including the previously created
        // 'or' condition container.
        $rule = $this->expressionManager
            ->createRule();
        $rule->addCondition('rules_test_true')
            ->addCondition('rules_test_true')
            ->addExpressionObject($or);
        // Test that the rule's condition container evaluates to TRUE.
        $this->assertTrue($rule->getConditions()
            ->execute());
        // Add an action to it and execute the rule.
        $rule->addAction('rules_test_debug_log');
        $rule->execute();
        // Test that the action logged something.
        $this->assertRulesDebugLogEntryExists('action called');
    }
    
    /**
     * Tests passing a string context to a condition.
     */
    public function testContextPassing() {
        $rule = $this->expressionManager
            ->createRule();
        $rule->addCondition('rules_test_string_condition', ContextConfig::create()->map('text', 'test'));
        $rule->addAction('rules_test_debug_log');
        RulesComponent::create($rule)->addContextDefinition('test', ContextDefinition::create('string'))
            ->setContextValue('test', 'test value')
            ->execute();
        // Test that the action logged something.
        $this->assertRulesDebugLogEntryExists('action called');
    }
    
    /**
     * Tests that a condition can provide a value and another one can consume it.
     */
    public function testProvidedVariables() {
        $rule = $this->expressionManager
            ->createRule();
        // The first condition provides a "provided_text" variable.
        $rule->addCondition('rules_test_provider');
        // The second condition consumes the variable.
        $rule->addCondition('rules_test_string_condition', ContextConfig::create()->map('text', 'provided_text'));
        $rule->addAction('rules_test_debug_log');
        $component = RulesComponent::create($rule);
        $violations = $component->checkIntegrity();
        $this->assertCount(0, $violations);
        $component->execute();
        // Test that the action logged something.
        $this->assertRulesDebugLogEntryExists('action called');
    }
    
    /**
     * Tests that provided variables can be renamed with configuration.
     */
    public function testRenamingOfProvidedVariables() {
        $rule = $this->expressionManager
            ->createRule();
        // The condition provides a "provided_text" variable.
        $rule->addCondition('rules_test_provider', ContextConfig::create()->provideAs('provided_text', 'newname'));
        $state = ExecutionState::create();
        $rule->executeWithState($state);
        // Check that the newly named variable exists and has the provided value.
        $variable = $state->getVariable('newname');
        $this->assertEquals($variable->getValue(), 'test value');
    }
    
    /**
     * Tests that multiple actions can consume and provide context variables.
     */
    public function testActionProvidedContext() {
        // @todo Convert the test to make use of actions instead of conditions.
        $rule = $this->expressionManager
            ->createRule();
        // The condition provides a "provided_text" variable.
        $rule->addCondition('rules_test_provider');
        // The action provides a "concatenated" variable.
        $rule->addAction('rules_test_string', ContextConfig::create()->map('text', 'provided_text'));
        // Add the same action again which will provide a "concatenated2" variable
        // now.
        $rule->addAction('rules_test_string', ContextConfig::create()->map('text', 'concatenated')
            ->provideAs('concatenated', 'concatenated2'));
        $state = ExecutionState::create();
        $rule->executeWithState($state);
        // Check that the created variables exists and have the provided values.
        $concatenated = $state->getVariable('concatenated');
        $this->assertEquals($concatenated->getValue(), 'test valuetest value');
        $concatenated2 = $state->getVariable('concatenated2');
        $this->assertEquals($concatenated2->getValue(), 'test valuetest valuetest valuetest value');
    }
    
    /**
     * Verifies swapping out core services works.
     */
    public function testSwappedCoreServices() {
        $condition_manager = $this->container
            ->get('plugin.manager.condition');
        $this->assertInstanceOf(ConditionManager::class, $condition_manager);
    }

}

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.
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.
RulesEngineTest::setUp protected function Overrides RulesKernelTestBase::setUp
RulesEngineTest::testActionProvidedContext public function Tests that multiple actions can consume and provide context variables.
RulesEngineTest::testContextPassing public function Tests passing a string context to a condition.
RulesEngineTest::testProvidedVariables public function Tests that a condition can provide a value and another one can consume it.
RulesEngineTest::testRenamingOfProvidedVariables public function Tests that provided variables can be renamed with configuration.
RulesEngineTest::testRuleCreation public function Tests creating a rule and iterating over the rule elements.
RulesEngineTest::testSwappedCoreServices public function Verifies swapping out core services works.
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::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules 10
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.