class EntityPathAliasCreateTest in Rules 8.3

@coversDefaultClass \Drupal\rules\Plugin\RulesAction\EntityPathAliasCreate @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\EntityPathAliasCreateTest

Expanded class hierarchy of EntityPathAliasCreateTest

File

tests/src/Unit/Integration/RulesAction/EntityPathAliasCreateTest.php, line 16

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction

View source

class EntityPathAliasCreateTest extends RulesEntityIntegrationTestBase {

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

  /**
   * The mocked alias storage service.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface|\Prophecy\Prophecy\ProphecyInterface
   */
  protected $aliasStorage;

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

    // Must enable the path_alias module.
    $this
      ->enableModule('path_alias');

    // Prepare mocked EntityStorageInterface.
    $this->aliasStorage = $this
      ->prophesize(EntityStorageInterface::class);
    $this->entityTypeManager
      ->getStorage('path_alias')
      ->willReturn($this->aliasStorage
      ->reveal());

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

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

  /**
   * Tests the action execution with an unsaved entity.
   *
   * @covers ::execute
   */
  public function testActionExecutionWithUnsavedEntity() {
    $path_alias = $this
      ->prophesizeEntity(PathAliasInterface::class);

    // Test that the alias is only saved once.
    $path_alias
      ->save()
      ->shouldBeCalledTimes(1);
    $this->aliasStorage
      ->create([
      'path' => '/test/1',
      'alias' => '/about',
      'langcode' => 'en',
    ])
      ->willReturn($path_alias
      ->reveal())
      ->shouldBeCalledTimes(1);
    $entity = $this
      ->getMockEntity();
    $entity
      ->isNew()
      ->willReturn(TRUE)
      ->shouldBeCalledTimes(1);

    // Test that new entities are saved first.
    $entity
      ->save()
      ->shouldBeCalledTimes(1);
    $this->action
      ->setContextValue('entity', $entity
      ->reveal())
      ->setContextValue('alias', '/about');
    $this->action
      ->execute();
  }

  /**
   * Tests the action execution with a saved entity.
   *
   * @covers ::execute
   */
  public function testActionExecutionWithSavedEntity() {
    $path_alias = $this
      ->prophesizeEntity(PathAliasInterface::class);

    // Test that the alias is only saved once.
    $path_alias
      ->save()
      ->shouldBeCalledTimes(1);
    $this->aliasStorage
      ->create([
      'path' => '/test/1',
      'alias' => '/about',
      'langcode' => 'en',
    ])
      ->willReturn($path_alias
      ->reveal())
      ->shouldBeCalledTimes(1);
    $entity = $this
      ->getMockEntity();
    $entity
      ->isNew()
      ->willReturn(FALSE)
      ->shouldBeCalledTimes(1);

    // Test that existing entities are not saved again.
    $entity
      ->save()
      ->shouldNotBeCalled();
    $this->action
      ->setContextValue('entity', $entity
      ->reveal())
      ->setContextValue('alias', '/about');
    $this->action
      ->execute();
  }

  /**
   * Creates a mock entity.
   *
   * @return \Drupal\Core\Entity\EntityInterface|\Prophecy\Prophecy\ProphecyInterface
   *   The mocked entity object.
   */
  protected function getMockEntity() {
    $language = $this->languageManager
      ->reveal()
      ->getCurrentLanguage();
    $entity = $this
      ->prophesizeEntity(EntityInterface::class);
    $entity
      ->language()
      ->willReturn($language)
      ->shouldBeCalledTimes(1);
    $url = $this
      ->prophesize(Url::class);
    $url
      ->getInternalPath()
      ->willReturn('test/1')
      ->shouldBeCalledTimes(1);
    $entity
      ->toUrl(Argument::any())
      ->willReturn($url
      ->reveal())
      ->shouldBeCalledTimes(1);
    return $entity;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityPathAliasCreateTest::$action	protected	property	The action to be tested.
EntityPathAliasCreateTest::$aliasStorage	protected	property	The mocked alias storage service.
EntityPathAliasCreateTest::getMockEntity	protected	function	Creates a mock entity.
EntityPathAliasCreateTest::setUp	protected	function	Overrides RulesEntityIntegrationTestBase::setUp
EntityPathAliasCreateTest::testActionExecutionWithSavedEntity	public	function	Tests the action execution with a saved entity.
EntityPathAliasCreateTest::testActionExecutionWithUnsavedEntity	public	function	Tests the action execution with an unsaved entity.
EntityPathAliasCreateTest::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 EntityPathAliasCreateTest in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation