class EntityCreateTest in Rules 8.3

@coversDefaultClass \Drupal\rules\Plugin\RulesAction\EntityCreate @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\EntityCreateTest

Expanded class hierarchy of EntityCreateTest

File

tests/src/Unit/Integration/RulesAction/EntityCreateTest.php, line 17

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction

View source

class EntityCreateTest extends RulesEntityIntegrationTestBase {

  /**
   * A constant that will be used instead of an entity.
   */
  const ENTITY_REPLACEMENT = 'This is a fake entity';

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Prepare some mocked bundle field definitions. This is needed because
    // EntityCreateDeriver adds required contexts for required fields, and
    // assumes that the bundle field is required.
    $bundle_field_definition = $this
      ->prophesize(BaseFieldDefinition::class);
    $bundle_field_definition_optional = $this
      ->prophesize(BaseFieldDefinition::class);
    $bundle_field_definition_required = $this
      ->prophesize(BaseFieldDefinition::class);
    $property_definition = $this
      ->prophesize(DataDefinitionInterface::class);
    $property_definition
      ->getDataType()
      ->willReturn('string');
    $item_definition = $this
      ->prophesize(FieldItemDataDefinition::class);
    $item_definition
      ->getPropertyDefinition(Argument::any())
      ->willReturn($property_definition
      ->reveal());
    $item_definition
      ->getMainPropertyName()
      ->willReturn('value');

    // The next methods are mocked because EntityCreateDeriver executes them,
    // and the mocked field definition is instantiated without the necessary
    // information.
    $bundle_field_definition
      ->getItemDefinition()
      ->willReturn($item_definition
      ->reveal());
    $bundle_field_definition
      ->getCardinality()
      ->willReturn(1)
      ->shouldBeCalledTimes(1);
    $bundle_field_definition
      ->getType()
      ->willReturn('string');
    $bundle_field_definition
      ->getLabel()
      ->willReturn('Bundle')
      ->shouldBeCalledTimes(1);
    $bundle_field_definition
      ->getDescription()
      ->willReturn('Bundle mock description')
      ->shouldBeCalledTimes(1);
    $bundle_field_definition_required
      ->getItemDefinition()
      ->willReturn($item_definition
      ->reveal());
    $bundle_field_definition_required
      ->getCardinality()
      ->willReturn(1)
      ->shouldBeCalledTimes(1);
    $bundle_field_definition_required
      ->getType()
      ->willReturn('string');
    $bundle_field_definition_required
      ->getLabel()
      ->willReturn('Required field')
      ->shouldBeCalledTimes(1);
    $bundle_field_definition_required
      ->getDescription()
      ->willReturn('Required field mock description')
      ->shouldBeCalledTimes(1);
    $bundle_field_definition_required
      ->isRequired()
      ->willReturn(TRUE)
      ->shouldBeCalledTimes(1);
    $bundle_field_definition_optional
      ->isRequired()
      ->willReturn(FALSE)
      ->shouldBeCalledTimes(1);

    // Prepare mocked entity storage.
    $entity_type_storage = $this
      ->prophesize(EntityStorageBase::class);
    $entity_type_storage
      ->create([
      'bundle' => 'test',
      'field_required' => NULL,
    ])
      ->willReturn(self::ENTITY_REPLACEMENT);

    // Return the mocked storage controller.
    $this->entityTypeManager
      ->getStorage('test')
      ->willReturn($entity_type_storage
      ->reveal());

    // Return a mocked list of base fields definitions.
    $this->entityFieldManager
      ->getBaseFieldDefinitions('test')
      ->willReturn([
      'bundle' => $bundle_field_definition
        ->reveal(),
      'field_required' => $bundle_field_definition_required
        ->reveal(),
      'field_optional' => $bundle_field_definition_optional
        ->reveal(),
    ]);

    // Instantiate the action we are testing.
    $this->action = $this->actionManager
      ->createInstance('rules_entity_create:test');
  }

  /**
   * Tests the summary.
   *
   * @covers ::summary
   */
  public function testSummary() {
    $this
      ->assertEquals('Create a new test', $this->action
      ->summary());
  }

  /**
   * Tests the action execution.
   *
   * @covers ::execute
   */
  public function testActionExecution() {
    $this->action
      ->setContextValue('bundle', 'test');
    $this->action
      ->execute();
    $entity = $this->action
      ->getProvidedContext('test_created')
      ->getContextValue();
    $this
      ->assertEquals(self::ENTITY_REPLACEMENT, $entity);
  }

  /**
   * Tests context definitions for the bundle and required fields.
   *
   * @covers \Drupal\rules\Plugin\RulesAction\EntityCreateDeriver::getDerivativeDefinitions
   */
  public function testRequiredContexts() {
    $context_definitions = $this->action
      ->getContextDefinitions();
    $this
      ->assertCount(2, $context_definitions);
    $this
      ->assertArrayHasKey('bundle', $context_definitions);
    $this
      ->assertEquals(ContextDefinition::ASSIGNMENT_RESTRICTION_INPUT, $context_definitions['bundle']
      ->getAssignmentRestriction());
    $this
      ->assertTrue($context_definitions['bundle']
      ->isRequired());
    $this
      ->assertArrayHasKey('field_required', $context_definitions);
    $this
      ->assertNull($context_definitions['field_required']
      ->getAssignmentRestriction());
    $this
      ->assertFalse($context_definitions['field_required']
      ->isRequired());
  }

  /**
   * Tests the context refining.
   *
   * @covers ::refineContextDefinitions
   */
  public function testRefiningContextDefinitions() {
    $this->action
      ->setContextValue('bundle', 'bundle_test');
    $this->action
      ->refineContextDefinitions([]);
    $this
      ->assertEquals($this->action
      ->getProvidedContextDefinition('test_created')
      ->getDataType(), 'entity:test:bundle_test');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityCreateTest::$action	protected	property	The action to be tested.
EntityCreateTest::ENTITY_REPLACEMENT		constant	A constant that will be used instead of an entity.
EntityCreateTest::setUp	protected	function	Overrides RulesEntityIntegrationTestBase::setUp
EntityCreateTest::testActionExecution	public	function	Tests the action execution.
EntityCreateTest::testRefiningContextDefinitions	public	function	Tests the context refining.
EntityCreateTest::testRequiredContexts	public	function	Tests context definitions for the bundle and required fields.
EntityCreateTest::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 EntityCreateTest in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation