class RulesComponentActionTest in Rules 8.3

Tests for exposing Rules components as action plugins.

@group RulesAction

Hierarchy

class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
- class \Drupal\Tests\rules\Unit\Integration\RulesIntegrationTestBase
  - class \Drupal\Tests\rules\Unit\Integration\RulesEntityIntegrationTestBase
    class \Drupal\Tests\rules\Unit\Integration\RulesAction\RulesComponentActionTest

Expanded class hierarchy of RulesComponentActionTest

File

tests/src/Unit/Integration/RulesAction/RulesComponentActionTest.php, line 18

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction

View source

class RulesComponentActionTest extends RulesEntityIntegrationTestBase {

  /**
   * Tests that a rule can be used as action.
   */
  public function testActionAvailable() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $rules_config = new RulesComponentConfig([
      'id' => 'test_rule',
      'label' => 'Test rule',
    ], 'rules_component');
    $rules_config
      ->setExpression($rule);
    $this
      ->prophesizeStorage([
      $rules_config,
    ]);
    $definition = $this->actionManager
      ->getDefinition('rules_component:test_rule');
    $this
      ->assertEquals('Components', $definition['category']);
    $this
      ->assertEquals('Rule: Test rule', (string) $definition['label']);
  }

  /**
   * Tests that the execution of the action invokes the Rules component.
   */
  public function testExecute() {

    // Set up a rules component that will just save an entity.
    $nested_rule = $this->rulesExpressionManager
      ->createRule();
    $nested_rule
      ->addAction('rules_entity_save', ContextConfig::create()
      ->map('entity', 'entity'));
    $rules_config = new RulesComponentConfig([
      'id' => 'test_rule',
      'label' => 'Test rule',
    ], 'rules_component');
    $rules_config
      ->setExpression($nested_rule);
    $rules_config
      ->setContextDefinitions([
      'entity' => ContextDefinition::create('entity'),
    ]);
    $this
      ->prophesizeStorage([
      $rules_config,
    ]);

    // Invoke the rules component in another rule.
    $rule = $this->rulesExpressionManager
      ->createRule();
    $rule
      ->addAction('rules_component:test_rule', ContextConfig::create()
      ->map('entity', 'entity'));

    // The call to save the entity means that the action was executed.
    $entity = $this
      ->prophesizeEntity(EntityInterface::class);
    $entity
      ->save()
      ->shouldBeCalledTimes(1);
    RulesComponent::create($rule)
      ->addContextDefinition('entity', ContextDefinition::create('entity'))
      ->setContextValue('entity', $entity
      ->reveal())
      ->execute();
  }

  /**
   * Tests that context definitions are available on the derived action.
   */
  public function testContextDefinitions() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $rule
      ->addAction('rules_entity_save', ContextConfig::create()
      ->map('entity', 'entity'))
      ->addAction('rules_test_string', ContextConfig::create()
      ->setValue('text', 'x'));
    $rules_config = new RulesComponentConfig([
      'id' => 'test_rule',
      'label' => 'Test rule',
    ], 'rules_component');
    $rules_config
      ->setExpression($rule);
    $context_definitions = [
      'entity' => ContextDefinition::create('entity'),
    ];
    $rules_config
      ->setContextDefinitions($context_definitions);
    $provided_definitions = [
      'concatenated' => ContextDefinition::create('string'),
    ];
    $rules_config
      ->setProvidedContextDefinitions($provided_definitions);
    $this
      ->prophesizeStorage([
      $rules_config,
    ]);
    $definition = $this->actionManager
      ->getDefinition('rules_component:test_rule');
    $this
      ->assertEquals($context_definitions, $definition['context_definitions']);
    $this
      ->assertEquals($provided_definitions, $definition['provides']);
  }

  /**
   * Tests that a rules component in an action can also provide variables.
   */
  public function testExecutionProvidedVariables() {

    // Create a rule that produces a provided string variable.
    $nested_rule = $this->rulesExpressionManager
      ->createRule();
    $nested_rule
      ->addAction('rules_test_string', ContextConfig::create()
      ->setValue('text', 'x'));
    $rules_config = new RulesComponentConfig([
      'id' => 'test_rule',
      'label' => 'Test rule',
    ], 'rules_component');
    $rules_config
      ->setExpression($nested_rule);
    $rules_config
      ->setProvidedContextDefinitions([
      'concatenated' => ContextDefinition::create('string'),
    ]);
    $this
      ->prophesizeStorage([
      $rules_config,
    ]);

    // Invoke the rules component in another rule.
    $rule = $this->rulesExpressionManager
      ->createRule();
    $rule
      ->addAction('rules_component:test_rule');
    $result = RulesComponent::create($rule)
      ->provideContext('concatenated')
      ->execute();
    $this
      ->assertEquals('xx', $result['concatenated']);
  }

  /**
   * Tests that auto saving is only triggered once with nested components.
   */
  public function testAutosaveOnlyOnce() {
    $entity = $this
      ->prophesizeEntity(EntityInterface::class);
    $nested_rule = $this->rulesExpressionManager
      ->createRule();
    $nested_rule
      ->addAction('rules_entity_save', ContextConfig::create()
      ->map('entity', 'entity'));
    $rules_config = new RulesComponentConfig([
      'id' => 'test_rule',
      'label' => 'Test rule',
    ], 'rules_component');
    $rules_config
      ->setExpression($nested_rule);
    $rules_config
      ->setContextDefinitions([
      'entity' => ContextDefinition::create('entity'),
    ]);
    $this
      ->prophesizeStorage([
      $rules_config,
    ]);

    // Create a rule with a nested rule. Overall there are 2 actions to set the
    // entity then.
    $rule = $this->rulesExpressionManager
      ->createRule();
    $rule
      ->addAction('rules_component:test_rule', ContextConfig::create()
      ->map('entity', 'entity'));
    $rule
      ->addAction('rules_entity_save', ContextConfig::create()
      ->map('entity', 'entity'));

    // Auto-saving should only be triggered once on the entity.
    $entity
      ->save()
      ->shouldBeCalledTimes(1);
    RulesComponent::create($rule)
      ->addContextDefinition('entity', ContextDefinition::create('entity'))
      ->setContextValue('entity', $entity
      ->reveal())
      ->execute();
  }

  /**
   * Prepares a mocked entity storage that returns the provided Rules configs.
   *
   * @param \Drupal\rules\Entity\RulesComponentConfig[] $rules_configs
   *   The Rules component configuration entities that should be returned.
   */
  protected function prophesizeStorage(array $rules_configs) {
    $storage = $this
      ->prophesize(ConfigEntityStorageInterface::class);
    $keyed_configs = [];
    foreach ($rules_configs as $rules_config) {
      $keyed_configs[$rules_config
        ->id()] = $rules_config;
      $storage
        ->load($rules_config
        ->id())
        ->willReturn($rules_config);
    }
    $storage
      ->loadMultiple(NULL)
      ->willReturn($keyed_configs);
    $this->entityTypeManager
      ->getStorage('rules_component')
      ->willReturn($storage
      ->reveal());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RulesComponentActionTest::prophesizeStorage	protected	function	Prepares a mocked entity storage that returns the provided Rules configs.
RulesComponentActionTest::testActionAvailable	public	function	Tests that a rule can be used as action.
RulesComponentActionTest::testAutosaveOnlyOnce	public	function	Tests that auto saving is only triggered once with nested components.
RulesComponentActionTest::testContextDefinitions	public	function	Tests that context definitions are available on the derived action.
RulesComponentActionTest::testExecute	public	function	Tests that the execution of the action invokes the Rules component.
RulesComponentActionTest::testExecutionProvidedVariables	public	function	Tests that a rules component in an action can also provide variables.
RulesEntityIntegrationTestBase::$entityAccess	protected	property	The mocked entity access handler.
RulesEntityIntegrationTestBase::$fieldTypeManager	protected	property	The field type manager.
RulesEntityIntegrationTestBase::$languageManager	protected	property	The language manager mock.
RulesEntityIntegrationTestBase::getContextDefinitionFor	protected	function	Helper to mock a context definition with a mocked data definition.
RulesEntityIntegrationTestBase::setUp	protected	function	Overrides RulesIntegrationTestBase::setUp	33
RulesIntegrationTestBase::$actionManager	protected	property
RulesIntegrationTestBase::$cacheBackend	protected	property
RulesIntegrationTestBase::$classResolver	protected	property	The class resolver mock for the typed data manager.
RulesIntegrationTestBase::$conditionManager	protected	property
RulesIntegrationTestBase::$container	protected	property	The Drupal service container.
RulesIntegrationTestBase::$dataFetcher	protected	property	The data fetcher service.
RulesIntegrationTestBase::$dataFilterManager	protected	property	The data filter manager.
RulesIntegrationTestBase::$enabledModules	protected	property	Array object keyed with module names and TRUE as value.
RulesIntegrationTestBase::$entityFieldManager	protected	property
RulesIntegrationTestBase::$entityTypeBundleInfo	protected	property
RulesIntegrationTestBase::$entityTypeManager	protected	property
RulesIntegrationTestBase::$logger	protected	property	A mocked Rules logger.channel.rules_debug service.	6
RulesIntegrationTestBase::$messenger	protected	property	The messenger service.
RulesIntegrationTestBase::$moduleHandler	protected	property
RulesIntegrationTestBase::$namespaces	protected	property	All setup'ed namespaces.
RulesIntegrationTestBase::$placeholderResolver	protected	property	The placeholder resolver service.
RulesIntegrationTestBase::$rulesDataProcessorManager	protected	property
RulesIntegrationTestBase::$rulesExpressionManager	protected	property
RulesIntegrationTestBase::$typedDataManager	protected	property
RulesIntegrationTestBase::constructModulePath	protected	function	Determines the path to a module's class files.
RulesIntegrationTestBase::enableModule	protected	function	Fakes the enabling of a module and adds its namespace for plugin loading.
RulesIntegrationTestBase::getTypedData	protected	function	Returns a typed data object.
RulesIntegrationTestBase::prophesizeEntity	protected	function	Helper method to mock irrelevant cache methods on entities.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.

You are here

class RulesComponentActionTest in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation