class UuidFilterTest in Replication 8

Tests that the uuid filter parses parameters correctly.

@group replication

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\replication\Unit\Plugin\ReplicationFilter\UuidFilterTest

File

tests/src/Unit/Plugin/ReplicationFilter/UuidFilterTest.php, line 14

Namespace

Drupal\Tests\replication\Unit\Plugin\ReplicationFilter

class UuidFilterTest extends UnitTestCase {

  /**
   * Test filtering UUIDs.
   *
   * @dataProvider filterTestProvider
   */
  public function testFilter($uuid, $parameter_value, $expected) {

    // Use a mock builder for the class under test to eliminate the need to
    // mock all the dependencies. The method under test uses the $configuration
    // set by the constructor, but is retrieved via a get method we can stub.
    $filter = $this
      ->getMockBuilder(UuidFilter::class)
      ->disableOriginalConstructor()
      ->setMethods([
      'getConfiguration',
    ])
      ->getMock();
    $configuration = [
      'uuids' => $parameter_value,
    ];
    $filter
      ->method('getConfiguration')
      ->willReturn($configuration);
    $entity = $this
      ->getMock(EntityInterface::class);
    $entity
      ->method('uuid')
      ->willReturn($uuid);
    $value = $filter
      ->filter($entity);
    $this
      ->assertEquals($expected, $value);
  }

  /**
   * Provide test cases for the "uuids" parameter.
   */
  public function filterTestProvider() {
    return [
      // Test singular parameter values.
      [
        '123',
        [
          '123',
        ],
        TRUE,
      ],
      [
        '123',
        [
          '456',
        ],
        FALSE,
      ],
      // Test multiple parameter values.
      [
        '123',
        [
          '123',
          '456',
        ],
        TRUE,
      ],
      [
        '123',
        [
          '456',
          '789',
        ],
        FALSE,
      ],
      // Test bad data that might be entered into the parameters:
      [
        '123',
        [
          '123 ',
        ],
        FALSE,
      ],
      [
        '123',
        [
          0,
        ],
        FALSE,
      ],
      [
        '123',
        [
          NULL,
        ],
        FALSE,
      ],
    ];
  }

  /**
   * Test filtering UUIDs with no parameter.
   */
  public function testFilterNoParameter() {

    // Use a mock builder for the class under test to eliminate the need to
    // mock all the dependencies. This is OK since the method under test is a
    // pure function, i.e. does not use the state createdy by the constructor.
    $filter = $this
      ->getMockBuilder(UuidFilter::class)
      ->disableOriginalConstructor()
      ->setMethods(NULL)
      ->getMock();
    $entity = $this
      ->getMock(EntityInterface::class);
    $entity
      ->method('uuid')
      ->willReturn('123');
    $value = $filter
      ->filter($entity, []);
    $this
      ->assertEquals(FALSE, $value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
UnitTestCase::setUp	protected	function		340
UuidFilterTest::filterTestProvider	public	function	Provide test cases for the "uuids" parameter.
UuidFilterTest::testFilter	public	function	Test filtering UUIDs.
UuidFilterTest::testFilterNoParameter	public	function	Test filtering UUIDs with no parameter.