class PrepareExecutionMetadataStateTest in Rules 8.3

Tests that the setup of the execution metadata state for an expression works.

@group Rules

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\Engine\PrepareExecutionMetadataStateTest

Expanded class hierarchy of PrepareExecutionMetadataStateTest

File

tests/src/Unit/Integration/Engine/PrepareExecutionMetadataStateTest.php, line 16

Namespace

Drupal\Tests\rules\Unit\Integration\Engine

View source

class PrepareExecutionMetadataStateTest extends RulesEntityIntegrationTestBase {

  /**
   * Tests that a variable can be added by an action and is then available.
   */
  public function testAddingVariable() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $rule
      ->addAction('rules_variable_add', ContextConfig::create()
      ->setValue('type', 'string')
      ->setValue('value', '')
      ->provideAs('variable_added', 'result'));
    $state = ExecutionMetadataState::create();
    $found = $rule
      ->prepareExecutionMetadataState($state);
    $this
      ->assertTrue($state
      ->hasDataDefinition('result'));
    $this
      ->assertNull($found);
  }

  /**
   * Tests partial state setup until an expression is reached in the tree.
   */
  public function testPreparingUntil() {

    // Setup a rule with 2 actions.
    $rule = $this->rulesExpressionManager
      ->createRule();
    $rule
      ->addAction('rules_variable_add', ContextConfig::create()
      ->setValue('type', 'string')
      ->setValue('value', '')
      ->provideAs('variable_added', 'result1'));
    $second_action = $this->rulesExpressionManager
      ->createAction('rules_variable_add')
      ->setConfiguration(ContextConfig::create()
      ->setValue('type', 'string')
      ->setValue('value', '')
      ->provideAs('variable_added', 'result2')
      ->toArray());
    $rule
      ->addExpressionObject($second_action);
    $state = ExecutionMetadataState::create();

    // Preparing the state until the second action means the variable of the
    // first action is available, but the second is not yet.
    $found = $rule
      ->prepareExecutionMetadataState($state, $second_action);
    $this
      ->assertTrue($state
      ->hasDataDefinition('result1'));
    $this
      ->assertFalse($state
      ->hasDataDefinition('result2'));
    $this
      ->assertTrue($found);
  }

  /**
   * Tests that state preparation also works for actions in a loop.
   */
  public function testPrepareInLoop() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $loop = $this->rulesExpressionManager
      ->createInstance('rules_loop', [
      'list' => 'string_list',
    ]);
    $action = $this->rulesExpressionManager
      ->createAction('rules_test_string')
      ->setConfiguration(ContextConfig::create()
      ->setValue('text', 'x')
      ->toArray());
    $loop
      ->addExpressionObject($action);
    $rule
      ->addExpressionObject($loop);
    $state = RulesComponent::create($rule)
      ->addContextDefinition('string_list', ContextDefinition::create('string')
      ->setMultiple())
      ->getMetadataState();
    $found = $rule
      ->prepareExecutionMetadataState($state, $action);
    $this
      ->assertTrue($state
      ->hasDataDefinition('list_item'));
    $this
      ->assertTrue($found);
  }

  /**
   * Tests that the loop list item is removed after the loop.
   */
  public function testPrepareAfterLoop() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $loop = $this->rulesExpressionManager
      ->createInstance('rules_loop', [
      'list' => 'string_list',
    ]);
    $action = $this->rulesExpressionManager
      ->createAction('rules_test_string')
      ->setConfiguration(ContextConfig::create()
      ->setValue('text', 'x')
      ->toArray());
    $loop
      ->addExpressionObject($action);
    $rule
      ->addExpressionObject($loop);
    $state = RulesComponent::create($rule)
      ->addContextDefinition('string_list', ContextDefinition::create('string')
      ->setMultiple())
      ->getMetadataState();
    $found = $rule
      ->prepareExecutionMetadataState($state);
    $this
      ->assertFalse($state
      ->hasDataDefinition('list_item'));
    $this
      ->assertNull($found);
  }

}

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.
PrepareExecutionMetadataStateTest::testAddingVariable	public	function	Tests that a variable can be added by an action and is then available.
PrepareExecutionMetadataStateTest::testPrepareAfterLoop	public	function	Tests that the loop list item is removed after the loop.
PrepareExecutionMetadataStateTest::testPrepareInLoop	public	function	Tests that state preparation also works for actions in a loop.
PrepareExecutionMetadataStateTest::testPreparingUntil	public	function	Tests partial state setup until an expression is reached in the tree.
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 PrepareExecutionMetadataStateTest in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation