LoopTest.php

<?php

namespace Drupal\Tests\rules\Unit\Integration\Engine;

use Drupal\Core\Entity\TypedData\EntityDataDefinition;
use Drupal\Core\Field\FieldItemList;
use Drupal\node\NodeInterface;
use Drupal\rules\Context\ContextConfig;
use Drupal\rules\Context\ContextDefinition;
use Drupal\rules\Engine\RulesComponent;
use Drupal\rules\Exception\EvaluationException;
use Drupal\Tests\rules\Unit\Integration\RulesEntityIntegrationTestBase;

/**
 * Test Rules execution with the loop plugin.
 *
 * @group Rules
 */
class LoopTest extends RulesEntityIntegrationTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->enableModule('node');
    }
    
    /**
     * Tests that list items in the loop can be used during execution.
     */
    public function testListItemUsage() {
        // The rule contains a list of strings that will be concatenated into one
        // variable.
        $rule = $this->rulesExpressionManager
            ->createRule();
        $rule->addAction('rules_variable_add', ContextConfig::create()->setValue('type', 'string')
            ->setValue('value', '')
            ->provideAs('variable_added', 'result'));
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'string_list',
        ]);
        $loop->addAction('rules_data_set', ContextConfig::create()->map('data', 'result')
            ->setValue('value', '{{result}} {{list_item}}')
            ->process('value', 'rules_tokens'));
        $rule->addExpressionObject($loop);
        $result = RulesComponent::create($rule)->addContextDefinition('string_list', ContextDefinition::create('string')->setMultiple())
            ->provideContext('result')
            ->setContextValue('string_list', [
            'Hello',
            'world',
            'this',
            'is',
            'the',
            'loop',
        ])
            ->execute();
        $this->assertEquals(' Hello world this is the loop', $result['result']);
    }
    
    /**
     * Tests that list items can be renamed for usage in nested loops.
     */
    public function testListItemRenaming() {
        // The rule contains a list of strings that will be concatenated into one
        // variable.
        $rule = $this->rulesExpressionManager
            ->createRule();
        $rule->addAction('rules_variable_add', ContextConfig::create()->setValue('type', 'string')
            ->setValue('value', '')
            ->provideAs('variable_added', 'result'));
        $outer_loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'outer_list',
            'list_item' => 'outer_item',
        ]);
        $outer_loop->addAction('rules_data_set', ContextConfig::create()->map('data', 'result')
            ->setValue('value', '{{result}} {{outer_item}}')
            ->process('value', 'rules_tokens'));
        $inner_loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'inner_list',
            'list_item' => 'inner_item',
        ]);
        $inner_loop->addAction('rules_data_set', ContextConfig::create()->map('data', 'result')
            ->setValue('value', '{{result}} {{inner_item}}')
            ->process('value', 'rules_tokens'));
        $outer_loop->addExpressionObject($inner_loop);
        $rule->addExpressionObject($outer_loop);
        $result = RulesComponent::create($rule)->addContextDefinition('outer_list', ContextDefinition::create('string')->setMultiple())
            ->addContextDefinition('inner_list', ContextDefinition::create('string')->setMultiple())
            ->provideContext('result')
            ->setContextValue('outer_list', [
            'Outer 1',
            'Outer 2',
        ])
            ->setContextValue('inner_list', [
            'Inner 1',
            'Inner 2',
            'Inner 3',
        ])
            ->execute();
        $this->assertEquals(' Outer 1 Inner 1 Inner 2 Inner 3 Outer 2 Inner 1 Inner 2 Inner 3', $result['result']);
    }
    
    /**
     * Tests that a list can be chosen with a property path selector.
     */
    public function testPropertyPathList() {
        $rule = $this->rulesExpressionManager
            ->createRule();
        $rule->addAction('rules_variable_add', ContextConfig::create()->setValue('type', 'string')
            ->setValue('value', '')
            ->provideAs('variable_added', 'result'));
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'node.field_text',
        ]);
        $loop->addAction('rules_data_set', ContextConfig::create()->map('data', 'result')
            ->setValue('value', '{{result}} {{list_item}}')
            ->process('value', 'rules_tokens'));
        $rule->addExpressionObject($loop);
        // Create a fake field for the fake node for testing.
        $list_definition = $this->typedDataManager
            ->createListDataDefinition('string');
        $field_text = new FieldItemList($list_definition);
        $field_text->setValue([
            'Hello',
            'world',
            'this',
            'is',
            'the',
            'loop',
        ]);
        $node = $this->prophesizeEntity(NodeInterface::class);
        $node->get('field_text')
            ->willReturn($field_text);
        // We cannot use EntityDataDefinitionInterface here because the context
        // system in core violates the interface and relies on the actual class.
        // @see https://www.drupal.org/node/2660216
        $node_definition = $this->prophesize(EntityDataDefinition::class);
        $node_definition->getPropertyDefinition("field_text")
            ->willReturn($list_definition);
        $context_definition = $this->getContextDefinitionFor('entity:node', $node_definition);
        $component = RulesComponent::create($rule)->addContextDefinition('node', $context_definition)
            ->provideContext('result')
            ->setContextValue('node', $node->reveal());
        $violations = $component->checkIntegrity();
        $this->assertCount(0, $violations);
        $result = $component->execute();
        $this->assertEquals(' Hello world this is the loop', $result['result']);
    }
    
    /**
     * Test the integrity check for loop item names that conflict with others.
     */
    public function testItemNameConflict() {
        $rule = $this->rulesExpressionManager
            ->createRule();
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'string_list',
            'list_item' => 'existing_name',
        ]);
        $rule->addExpressionObject($loop);
        $violations = RulesComponent::create($rule)->addContextDefinition('string_list', ContextDefinition::create('string')->setMultiple())
            ->addContextDefinition('existing_name', ContextDefinition::create('string'))
            ->checkIntegrity();
        $this->assertCount(1, $violations);
        $this->assertEquals('List item name <em class="placeholder">existing_name</em> conflicts with an existing variable.', (string) $violations[0]->getMessage());
    }
    
    /**
     * Tests that the specified list variable exists in the execution state.
     */
    public function testListExists() {
        $rule = $this->rulesExpressionManager
            ->createRule();
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'unknown_list',
        ]);
        $rule->addExpressionObject($loop);
        $violations = RulesComponent::create($rule)->checkIntegrity();
        $this->assertCount(1, $violations);
        // The Exception message part of the output should be HTML-escaped.
        $this->assertEquals("List variable <em class=\"placeholder\">unknown_list</em> does not exist. Unable to get variable &#039;unknown_list&#039;; it is not defined.", (string) $violations[0]->getMessage());
    }
    
    /**
     * Tests that a loop must have a list configured.
     */
    public function testMissingList() {
        $rule = $this->rulesExpressionManager
            ->createRule();
        // Empty loop configuration, 'list' is missing.
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', []);
        $rule->addExpressionObject($loop);
        $violations = RulesComponent::create($rule)->checkIntegrity();
        $this->assertCount(1, $violations);
        $this->assertEquals('List variable is missing.', (string) $violations[0]->getMessage());
    }
    
    /**
     * Tests that a variable used in an action within the loop exists.
     */
    public function testWrongVariableInAction() {
        $rule = $this->rulesExpressionManager
            ->createRule();
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'string_list',
        ]);
        $loop->addAction('rules_test_string', ContextConfig::create()->map('text', 'unknown_variable'));
        $rule->addExpressionObject($loop);
        $violations = RulesComponent::create($rule)->addContextDefinition('string_list', ContextDefinition::create('string')->setMultiple())
            ->checkIntegrity();
        $this->assertCount(1, $violations);
        // The Exception message part of the output should be HTML-escaped.
        $this->assertEquals("Data selector <em class=\"placeholder\">unknown_variable</em> for context <em class=\"placeholder\">Text to concatenate</em> is invalid. Unable to get variable &#039;unknown_variable&#039;; it is not defined.", (string) $violations[0]->getMessage());
    }
    
    /**
     * Tests that the data type used to loop over is a list.
     */
    public function testInvalidListType() {
        $rule = $this->rulesExpressionManager
            ->createRule();
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'string_variable',
        ]);
        $rule->addExpressionObject($loop);
        $violations = RulesComponent::create($rule)->addContextDefinition('string_variable', ContextDefinition::create('string'))
            ->checkIntegrity();
        $this->assertCount(1, $violations);
        $this->assertEquals('The data type of list variable <em class="placeholder">string_variable</em> is not a list.', (string) $violations[0]->getMessage());
    }
    
    /**
     * Tests that the loop list item variable is not available after the loop.
     */
    public function testOutOfScopeVariable() {
        $rule = $this->rulesExpressionManager
            ->createRule();
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'string_list',
        ]);
        $rule->addExpressionObject($loop);
        $rule->addAction('rules_test_string', ContextConfig::create()->map('text', 'list_item'));
        $violations = RulesComponent::create($rule)->addContextDefinition('string_list', ContextDefinition::create('string')->setMultiple())
            ->checkIntegrity();
        $this->assertCount(1, $violations);
        // The Exception message part of the output should be HTML-escaped.
        $this->assertEquals("Data selector <em class=\"placeholder\">list_item</em> for context <em class=\"placeholder\">Text to concatenate</em> is invalid. Unable to get variable &#039;list_item&#039;; it is not defined.", (string) $violations[0]->getMessage());
    }
    
    /**
     * Tests that the loop list item variable is not available after the loop.
     */
    public function testOutOfScopeVariableExecution() {
        // Set the expected exception class and message.
        $this->expectException(EvaluationException::class);
        $this->expectExceptionMessage("Unable to get variable 'list_item'; it is not defined.");
        $rule = $this->rulesExpressionManager
            ->createRule();
        $loop = $this->rulesExpressionManager
            ->createInstance('rules_loop', [
            'list' => 'string_list',
        ]);
        $rule->addExpressionObject($loop);
        $rule->addAction('rules_test_string', ContextConfig::create()->map('text', 'list_item'));
        RulesComponent::create($rule)->addContextDefinition('string_list', ContextDefinition::create('string')->setMultiple())
            ->setContextValue('string_list', [
            'one',
            'two',
        ])
            ->execute();
    }

}