class EntityFetchByFieldTest in Rules 8.3

@coversDefaultClass \Drupal\rules\Plugin\RulesAction\EntityFetchByField @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\EntityFetchByFieldTest

Expanded class hierarchy of EntityFetchByFieldTest

File

tests/src/Unit/Integration/RulesAction/EntityFetchByFieldTest.php, line 14

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction

View source

class EntityFetchByFieldTest extends RulesEntityIntegrationTestBase {

  /**
   * The action to be tested.
   *
   * @var \Drupal\rules\Core\RulesActionInterface
   */
  protected $action;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->action = $this->actionManager
      ->createInstance('rules_entity_fetch_by_field');
  }

  /**
   * Tests the summary.
   *
   * @covers ::summary
   */
  public function testSummary() {
    $this
      ->assertEquals('Fetch entities by field', $this->action
      ->summary());
  }

  /**
   * Tests action execution when no value for limit is provided.
   *
   * @covers ::execute
   */
  public function testActionExecutionWithNoLimit() {

    // Create variables for action context values.
    $entity_type = 'entity_test';
    $field_name = 'test_field';
    $field_value = 'llama';

    // Create an array of dummy entities.
    $entities = [];
    for ($i = 0; $i < 2; $i++) {
      $entity = $this
        ->prophesize(EntityInterface::class);
      $entities[] = $entity
        ->reveal();
    }

    // Create dummy entity storage object.
    $entity_storage = $this
      ->prophesize(EntityStorageInterface::class);
    $entity_storage
      ->loadByProperties([
      $field_name => $field_value,
    ])
      ->willReturn($entities);
    $this->entityTypeManager
      ->getStorage($entity_type)
      ->willReturn($entity_storage
      ->reveal());

    // Set context values for EntityFetchByField action and execute.
    $this->action
      ->setContextValue('type', $entity_type)
      ->setContextValue('field_name', $field_name)
      ->setContextValue('field_value', $field_value)
      ->execute();

    // Test that executing action without a value for limit returns the dummy
    // entities array.
    $this
      ->assertEquals($entities, $this->action
      ->getProvidedContext('entity_fetched')
      ->getContextValue('entity_fetched'));
  }

  /**
   * Tests action execution when a value for limit is provided.
   *
   * @covers ::execute
   */
  public function testActionExecutionWithLimit() {
    $entity_type = 'entity_test';
    $field_name = 'test_field';
    $field_value = 'llama';
    $limit = 2;

    // Create an array of dummy entities.
    $entities = array_map(function () {
      return $this
        ->prophesize(EntityInterface::class)
        ->reveal();
    }, range(1, $limit));

    // Creates entity ids for new dummy array of entities.
    $entity_ids = range(1, $limit);

    // Create dummy query object.
    $query = $this
      ->prophesize(QueryInterface::class);
    $query
      ->condition($field_name, $field_value, '=')
      ->willReturn($query
      ->reveal())
      ->shouldBeCalledTimes(1);
    $query
      ->range(0, $limit)
      ->willReturn($query
      ->reveal())
      ->shouldBeCalledTimes(1);
    $query
      ->execute()
      ->willReturn($entity_ids)
      ->shouldBeCalledTimes(1);

    // Create dummy entity storage object.
    $entity_storage = $this
      ->prophesize(EntityStorageInterface::class);
    $entity_storage
      ->loadMultiple($entity_ids)
      ->willReturn($entities)
      ->shouldBeCalledTimes(1);
    $entity_storage
      ->getQuery()
      ->willReturn($query)
      ->shouldBeCalledTimes(1);
    $this->entityTypeManager
      ->getStorage($entity_type)
      ->willReturn($entity_storage
      ->reveal())
      ->shouldBeCalledTimes(1);

    // Set context values for EntityFetchByField action and execute.
    $this->action
      ->setContextValue('type', $entity_type)
      ->setContextValue('field_name', $field_name)
      ->setContextValue('field_value', $field_value)
      ->setContextValue('limit', $limit)
      ->execute();

    // Test that executing action with a value for limit returns the dummy
    // entities array.
    $this
      ->assertEquals($entities, $this->action
      ->getProvidedContext('entity_fetched')
      ->getContextValue('entity_fetched'));
  }

  /**
   * Tests that the action execution loads the entity from storage.
   *
   * @covers ::execute
   */
  public function testActionExecutionProvidedContextEntityType() {

    // Create variables for action context values.
    $entity_type = 'entity_test';
    $field_name = 'test_field';
    $field_value = 'llama';

    // Create an array of dummy entities.
    $entities = [];
    for ($i = 0; $i < 2; $i++) {
      $entity = $this
        ->prophesize(EntityInterface::class)
        ->reveal();
      $entities[] = $entity;
    }

    // Create dummy entity storage object.
    $entity_storage = $this
      ->prophesize(EntityStorageInterface::class);
    $entity_storage
      ->loadByProperties([
      $field_name => $field_value,
    ])
      ->willReturn($entities);
    $this->entityTypeManager
      ->getStorage($entity_type)
      ->willReturn($entity_storage
      ->reveal())
      ->shouldBeCalledTimes(1);

    // Set context values for EntityFetchByField action and execute.
    $this->action
      ->setContextValue('type', $entity_type)
      ->setContextValue('field_name', $field_name)
      ->setContextValue('field_value', $field_value)
      ->execute();
  }

  /**
   * @covers ::refineContextDefinitions
   */
  public function testRefiningContextDefinitions() {
    $this->action
      ->setContextValue('type', 'entity_test');
    $this->action
      ->refineContextDefinitions([]);
    $this
      ->assertEquals($this->action
      ->getProvidedContextDefinition('entity_fetched')
      ->getDataType(), 'entity:entity_test');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityFetchByFieldTest::$action	protected	property	The action to be tested.
EntityFetchByFieldTest::setUp	protected	function	Overrides RulesEntityIntegrationTestBase::setUp
EntityFetchByFieldTest::testActionExecutionProvidedContextEntityType	public	function	Tests that the action execution loads the entity from storage.
EntityFetchByFieldTest::testActionExecutionWithLimit	public	function	Tests action execution when a value for limit is provided.
EntityFetchByFieldTest::testActionExecutionWithNoLimit	public	function	Tests action execution when no value for limit is provided.
EntityFetchByFieldTest::testRefiningContextDefinitions	public	function	@covers ::refineContextDefinitions
EntityFetchByFieldTest::testSummary	public	function	Tests the summary.
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.
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.
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 EntityFetchByFieldTest in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation