class RulesComponentTest in Rules 8.3

Tests the Rules component class.

@coversDefaultClass \Drupal\rules\Engine\RulesComponent @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\Engine\RulesComponentTest

File

tests/src/Unit/Integration/Engine/RulesComponentTest.php, line 17

Namespace

Drupal\Tests\rules\Unit\Integration\Engine

class RulesComponentTest extends RulesIntegrationTestBase {

  /**
   * Tests executing a rule providing context based upon given context.
   */
  public function testRuleExecutionWithContext() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $rule
      ->addAction('rules_test_string', ContextConfig::create()
      ->map('text', 'text'));
    $result = RulesComponent::create($rule)
      ->addContextDefinition('text', ContextDefinition::create('string'))
      ->provideContext('concatenated')
      ->setContextValue('text', 'foo')
      ->execute();

    // Ensure the provided context is returned.
    $this
      ->assertTrue(isset($result['concatenated']) && $result['concatenated'] == 'foofoo');
  }

  /**
   * @covers ::getExpression
   */
  public function testGetExpression() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $this
      ->assertSame(RulesComponent::create($rule)
      ->getExpression(), $rule);
  }

  /**
   * @covers ::getContextDefinitions
   */
  public function testGetContextDefinitions() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $definition = ContextDefinition::create('string');
    $component = RulesComponent::create($rule)
      ->addContextDefinition('test', $definition);
    $this
      ->assertEquals(array_keys($component
      ->getContextDefinitions()), [
      'test',
    ]);
    $this
      ->assertSame($component
      ->getContextDefinitions()['test'], $definition);
  }

  /**
   * @covers ::getProvidedContext
   */
  public function testGetProvidedContext() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $component = RulesComponent::create($rule)
      ->provideContext('test');
    $this
      ->assertEquals($component
      ->getProvidedContext(), [
      'test',
    ]);
  }

  /**
   * @covers ::getState
   */
  public function testGetState() {
    $rule = $this->rulesExpressionManager
      ->createRule();
    $component = RulesComponent::create($rule);
    $this
      ->assertInstanceOf(ExecutionStateInterface::class, $component
      ->getState());

    // Test that set context values are available in the state.
    $component
      ->addContextDefinition('foo', ContextDefinition::create('string'))
      ->setContextValue('foo', 'bar');
    $this
      ->assertEquals($component
      ->getState()
      ->getVariableValue('foo'), 'bar');
  }

}

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.
RulesComponentTest::testGetContextDefinitions	public	function	@covers ::getContextDefinitions
RulesComponentTest::testGetExpression	public	function	@covers ::getExpression
RulesComponentTest::testGetProvidedContext	public	function	@covers ::getProvidedContext
RulesComponentTest::testGetState	public	function	@covers ::getState
RulesComponentTest::testRuleExecutionWithContext	public	function	Tests executing a rule providing context based upon given context.
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.
RulesIntegrationTestBase::setUp	protected	function	Overrides UnitTestCase::setUp	22
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.