You are here

class DataListItemAddTest in Rules 8.3

@coversDefaultClass \Drupal\rules\Plugin\RulesAction\DataListItemAdd @group RulesAction

Hierarchy

Expanded class hierarchy of DataListItemAddTest

File

tests/src/Unit/Integration/RulesAction/DataListItemAddTest.php, line 11

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction
View source
class DataListItemAddTest extends RulesIntegrationTestBase {

  /**
   * 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_list_item_add');
  }

  /**
   * Tests the summary.
   *
   * @covers ::summary
   */
  public function testSummary() {
    $this
      ->assertEquals('Add list item', $this->action
      ->summary());
  }

  /**
   * Tests the action execution with default values.
   *
   * @covers ::execute
   */
  public function testActionExecutionWithDefaults() {

    // Test adding a value at the end (default position).
    $list = [
      'One',
      'Two',
      'Three',
    ];
    $this->action
      ->setContextValue('list', $list)
      ->setContextValue('item', 'Four');
    $this->action
      ->execute();

    // The list should contain four items, with the new item at the end.
    $this
      ->assertEquals([
      'One',
      'Two',
      'Three',
      'Four',
    ], $this->action
      ->getContextValue('list'));
  }

  /**
   * Tests the action execution - item append.
   *
   * @covers ::execute
   */
  public function testActionExecutionItemAppend() {

    // Test adding a value at the end.
    $list = [
      'One',
      'Two',
      'Three',
    ];
    $this->action
      ->setContextValue('list', $list)
      ->setContextValue('item', 'Four')
      ->setContextValue('position', 'end');
    $this->action
      ->execute();

    // The list should contain four items, with the new item added at the end.
    $this
      ->assertEquals([
      'One',
      'Two',
      'Three',
      'Four',
    ], $this->action
      ->getContextValue('list'));
  }

  /**
   * Tests the action execution - item prepend.
   *
   * @covers ::execute
   */
  public function testActionExecutionItemPrepend() {

    // Test adding a value at the start.
    $list = [
      'One',
      'Two',
      'Three',
    ];
    $this->action
      ->setContextValue('list', $list)
      ->setContextValue('item', 'Zero')
      ->setContextValue('position', 'start');
    $this->action
      ->execute();

    // The list should contain four items, with the new item added at the start.
    $this
      ->assertEquals([
      'Zero',
      'One',
      'Two',
      'Three',
    ], $this->action
      ->getContextValue('list'));
  }

  /**
   * Tests the action execution - enforce unique items.
   *
   * @covers ::execute
   */
  public function testActionExecutionEnforceUnique() {

    // Test unique.
    $list = [
      'One',
      'Two',
      'Three',
      'Four',
    ];
    $this->action
      ->setContextValue('list', $list)
      ->setContextValue('item', 'Four')
      ->setContextValue('unique', TRUE);
    $this->action
      ->execute();

    // The list should remain the same.
    $this
      ->assertEquals([
      'One',
      'Two',
      'Three',
      'Four',
    ], $this->action
      ->getContextValue('list'));
  }

  /**
   * Tests the action execution - add non-unique items.
   *
   * @covers ::execute
   */
  public function testActionExecutionNonUnique() {

    // Test non-unique.
    $list = [
      'One',
      'Two',
      'Three',
      'Four',
    ];
    $this->action
      ->setContextValue('list', $list)
      ->setContextValue('item', 'Four')
      ->setContextValue('unique', FALSE)
      ->setContextValue('position', 'end');
    $this->action
      ->execute();

    // The list should contain five items, with the new item added at the end.
    $this
      ->assertEquals([
      'One',
      'Two',
      'Three',
      'Four',
      'Four',
    ], $this->action
      ->getContextValue('list'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DataListItemAddTest::$action protected property The action to be tested.
DataListItemAddTest::setUp protected function Overrides RulesIntegrationTestBase::setUp
DataListItemAddTest::testActionExecutionEnforceUnique public function Tests the action execution - enforce unique items.
DataListItemAddTest::testActionExecutionItemAppend public function Tests the action execution - item append.
DataListItemAddTest::testActionExecutionItemPrepend public function Tests the action execution - item prepend.
DataListItemAddTest::testActionExecutionNonUnique public function Tests the action execution - add non-unique items.
DataListItemAddTest::testActionExecutionWithDefaults public function Tests the action execution with default values.
DataListItemAddTest::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.
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.