class FocalPointFieldWidgetTest in Focal Point 8

@coversDefaultClass \Drupal\focal_point\Plugin\Field\FieldWidget\FocalPointImageWidget

@group Focal Point

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\focal_point\Unit\FieldWidgets\FocalPointFieldWidgetTest

File

tests/src/Unit/FieldWidgets/FocalPointFieldWidgetTest.php, line 20

Namespace

Drupal\Tests\focal_point\Unit\FieldWidgets

class FocalPointFieldWidgetTest extends UnitTestCase {

  /**
   * A simple form element for testing.
   *
   * @var testElement
   */
  protected $testElement;

  /**
   * A mock FormState object for testing.
   *
   * @var \Drupal\Core\Form\FormStateInterface
   */
  protected $testFormState;

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

    // Create some mock objects.
    $entity_type_manager = $this
      ->prophesize(EntityTypeManager::class)
      ->reveal();
    $focal_point_manager = new FocalPointManager($entity_type_manager);

    // Create and set the mock container.
    $container = $this
      ->prophesize(ContainerInterface::class);
    $container
      ->get('entity_type.manager')
      ->willReturn($entity_type_manager);
    $container
      ->get('focal_point.manager')
      ->willReturn($focal_point_manager);
    \Drupal::setContainer($container
      ->reveal());

    // Setup an image element for testing.
    $this->testElement = [
      '#title' => 'some title',
      '#parents' => [
        'field_image',
      ],
    ];

    // Setup a mock form state object for testing.
    // @todo: Figure out why using prophesize for this mock causes an exception.
    $this->testFormState = $this
      ->getMockBuilder('\\Drupal\\Core\\Form\\FormStateInterface')
      ->disableOriginalConstructor()
      ->getMock();
  }

  /**
   * Testing focal point validation.
   *
   * @covers ::validateFocalPoint
   *
   * @dataProvider providerValidateFocalPoint
   */
  public function testValidateFocalPoint($value, $is_valid) {
    $this->testElement['#value'] = $value;

    // Test that an invalid focal point value sets a form error and a valid
    // focal point value does not.
    if ($is_valid === TRUE) {
      $this->testFormState
        ->expects($this
        ->never())
        ->method('setError');
    }
    else {
      $this->testFormState
        ->expects($this
        ->once())
        ->method('setError')
        ->will($this
        ->returnSelf());
    }
    $element = [
      '#title' => 'foo',
      '#value' => $value,
    ];

    // Create a focal point image widget and test the validate method. Note that
    // an additional argument was added to the ImageWidget constructor in 8.5.
    if (version_compare(Drupal::VERSION, '8.5', '<')) {
      $focalPointImageWidget = new FocalPointImageWidget([], [], $this
        ->prophesize(FieldDefinitionInterface::class)
        ->reveal(), [], [], $this
        ->prophesize(ElementInfoManagerInterface::class)
        ->reveal());
    }
    else {
      $focalPointImageWidget = new FocalPointImageWidget([], [], $this
        ->prophesize(FieldDefinitionInterface::class)
        ->reveal(), [], [], $this
        ->prophesize(ElementInfoManagerInterface::class)
        ->reveal(), $this
        ->prophesize(ImageFactory::class)
        ->reveal());
    }
    $focalPointImageWidget::validateFocalPoint($element, $this->testFormState);
  }

  /**
   * Data provider for testFocalPoint().
   */
  public function providerValidateFocalPoint() {
    $data = [];
    $data['default_focal_point_position'] = [
      '50,50',
      TRUE,
    ];
    $data['basic_focal_point_position_1'] = [
      '75,25',
      TRUE,
    ];
    $data['basic_focal_point_position_2'] = [
      '3,50',
      TRUE,
    ];
    $data['basic_focal_point_position_3'] = [
      '83,6',
      TRUE,
    ];
    $data['basic_focal_point_position_4'] = [
      '2,9',
      TRUE,
    ];
    $data['extreme_focal_point_position_top_right'] = [
      '100,0',
      TRUE,
    ];
    $data['extreme_focal_point_position_top_left'] = [
      '0,0',
      TRUE,
    ];
    $data['extreme_focal_point_position_bottom_right'] = [
      '100,100',
      TRUE,
    ];
    $data['extreme_focal_point_position_bottom_left'] = [
      '0,100',
      TRUE,
    ];
    $data['invalid_focal_point_position_negative_x'] = [
      '-20,50',
      FALSE,
    ];
    $data['invalid_focal_point_position_negative_y'] = [
      '18,-3',
      FALSE,
    ];
    $data['invalid_focal_point_position_out_of_bounds_x'] = [
      '101,33',
      FALSE,
    ];
    $data['invalid_focal_point_position_out_of_bounds_y'] = [
      '44,101',
      FALSE,
    ];
    $data['invalid_focal_point_position_out_of_bounds_xy'] = [
      '313,512',
      FALSE,
    ];
    $data['invalid_focal_point_position_empty'] = [
      '',
      FALSE,
    ];
    $data['invalid_focal_point_position_incorrect_format_1'] = [
      'invalid',
      FALSE,
    ];
    $data['invalid_focal_point_position_incorrect_format_2'] = [
      'invalid,invalid',
      FALSE,
    ];
    $data['invalid_focal_point_position_incorrect_format_3'] = [
      '23,invalid',
      FALSE,
    ];
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FocalPointFieldWidgetTest::$testElement	protected	property	A simple form element for testing.
FocalPointFieldWidgetTest::$testFormState	protected	property	A mock FormState object for testing.
FocalPointFieldWidgetTest::providerValidateFocalPoint	public	function	Data provider for testFocalPoint().
FocalPointFieldWidgetTest::setUp	protected	function	Overrides UnitTestCase::setUp
FocalPointFieldWidgetTest::testValidateFocalPoint	public	function	Testing focal point validation.
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.