class RulesComponentTest

Tests the Rules component class.

@coversDefaultClass \Drupal\rules\Engine\RulesComponent
@group Rules

Hierarchy

Expanded class hierarchy of RulesComponentTest

File

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

Namespace

Drupal\Tests\rules\Unit\Integration\Engine
View source
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->assertArrayHasKey('concatenated', $result);
    // cspell:ignore foofoo
    $this->assertEquals('foofoo', $result['concatenated']);
  }
  
  /**
   * @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

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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.
RulesComponentTest::testGetContextDefinitions public function @covers ::getContextDefinitions[[api-linebreak]]
RulesComponentTest::testGetExpression public function @covers ::getExpression[[api-linebreak]]
RulesComponentTest::testGetProvidedContext public function @covers ::getProvidedContext[[api-linebreak]]
RulesComponentTest::testGetState public function @covers ::getState[[api-linebreak]]
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::$fieldTypeCategoryManager protected property The field type category info plugin manager.
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 Deprecated protected function Asserts if two arrays are equal by sorting them first.
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.
UnitTestCase::setUpBeforeClass public static function