function ProtectedUserFieldConstraintValidatorTest::providerTestValidate

Same name in other branches
  1. 8.9.x core/modules/user/tests/src/Unit/Plugin/Validation/Constraint/ProtectedUserFieldConstraintValidatorTest.php \Drupal\Tests\user\Unit\Plugin\Validation\Constraint\ProtectedUserFieldConstraintValidatorTest::providerTestValidate()

Data provider for ::testValidate().

File

core/modules/user/tests/src/Unit/Plugin/Validation/Constraint/ProtectedUserFieldConstraintValidatorTest.php, line 72

Class

ProtectedUserFieldConstraintValidatorTest
@coversDefaultClass \Drupal\user\Plugin\Validation\Constraint\ProtectedUserFieldConstraintValidator @group user

Namespace

Drupal\Tests\user\Unit\Plugin\Validation\Constraint

Code

public function providerTestValidate() {
    $cases = [];
    // Case 1: Validation context should not be touched if no items are passed.
    $cases[] = [
        NULL,
        FALSE,
    ];
    // Case 2: Empty user should be ignored.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn(NULL);
    $cases[] = [
        $items,
        FALSE,
    ];
    // Case 3: Account flagged to skip protected user should be ignored.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $account = $this->createMock(User::class);
    $account->_skipProtectedUserFieldConstraint = TRUE;
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $cases[] = [
        $items,
        FALSE,
    ];
    // Case 4: New user should be ignored.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $account = $this->createMock('Drupal\\user\\UserInterface');
    $account->expects($this->once())
        ->method('isNew')
        ->willReturn(TRUE);
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $cases[] = [
        $items,
        FALSE,
    ];
    // Case 5: Mismatching user IDs should also be ignored.
    $account = $this->createMock('Drupal\\user\\UserInterface');
    $account->expects($this->once())
        ->method('isNew')
        ->willReturn(FALSE);
    $account->expects($this->once())
        ->method('id')
        ->willReturn('not-current-user');
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $cases[] = [
        $items,
        FALSE,
    ];
    // Case 6: Non-password fields that have not changed should be ignored.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $field_definition->expects($this->exactly(2))
        ->method('getName')
        ->willReturn('field_not_password');
    $account = $this->createMock('Drupal\\user\\UserInterface');
    $account->expects($this->once())
        ->method('isNew')
        ->willReturn(FALSE);
    $account->expects($this->exactly(2))
        ->method('id')
        ->willReturn('current-user');
    $account->expects($this->never())
        ->method('checkExistingPassword');
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $items->expects($this->once())
        ->method('getValue')
        ->willReturn('unchanged-value');
    $cases[] = [
        $items,
        FALSE,
    ];
    // Case 7: Password field with no value set should be ignored.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $field_definition->expects($this->once())
        ->method('getName')
        ->willReturn('pass');
    $account = $this->createMock('Drupal\\user\\UserInterface');
    $account->expects($this->once())
        ->method('isNew')
        ->willReturn(FALSE);
    $account->expects($this->exactly(2))
        ->method('id')
        ->willReturn('current-user');
    $account->expects($this->never())
        ->method('checkExistingPassword');
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $cases[] = [
        $items,
        FALSE,
    ];
    // Case 8: Non-password field changed, but user has passed provided current
    // password.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $field_definition->expects($this->exactly(2))
        ->method('getName')
        ->willReturn('field_not_password');
    $account = $this->createMock('Drupal\\user\\UserInterface');
    $account->expects($this->once())
        ->method('isNew')
        ->willReturn(FALSE);
    $account->expects($this->exactly(2))
        ->method('id')
        ->willReturn('current-user');
    $account->expects($this->once())
        ->method('checkExistingPassword')
        ->willReturn(TRUE);
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $items->expects($this->once())
        ->method('getValue')
        ->willReturn('changed-value');
    $cases[] = [
        $items,
        FALSE,
    ];
    // Case 9: Password field changed, current password confirmed.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $field_definition->expects($this->exactly(2))
        ->method('getName')
        ->willReturn('pass');
    $account = $this->createMock('Drupal\\user\\UserInterface');
    $account->expects($this->once())
        ->method('isNew')
        ->willReturn(FALSE);
    $account->expects($this->exactly(2))
        ->method('id')
        ->willReturn('current-user');
    $account->expects($this->once())
        ->method('checkExistingPassword')
        ->willReturn(TRUE);
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $items->expects($this->any())
        ->method('getValue')
        ->willReturn('changed-value');
    $items->expects($this->once())
        ->method('__get')
        ->with('value')
        ->willReturn('changed-value');
    $cases[] = [
        $items,
        FALSE,
    ];
    // The below calls should result in a violation.
    // Case 10: Password field changed, current password not confirmed.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $field_definition->expects($this->exactly(2))
        ->method('getName')
        ->willReturn('pass');
    $field_definition->expects($this->any())
        ->method('getLabel')
        ->willReturn('Password');
    $account = $this->createMock('Drupal\\user\\UserInterface');
    $account->expects($this->once())
        ->method('isNew')
        ->willReturn(FALSE);
    $account->expects($this->exactly(2))
        ->method('id')
        ->willReturn('current-user');
    $account->expects($this->once())
        ->method('checkExistingPassword')
        ->willReturn(FALSE);
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $items->expects($this->once())
        ->method('getValue')
        ->willReturn('changed-value');
    $items->expects($this->once())
        ->method('__get')
        ->with('value')
        ->willReturn('changed-value');
    $cases[] = [
        $items,
        TRUE,
        'Password',
    ];
    // Case 11: Non-password field changed, current password not confirmed.
    $field_definition = $this->createMock('Drupal\\Core\\Field\\FieldDefinitionInterface');
    $field_definition->expects($this->exactly(2))
        ->method('getName')
        ->willReturn('field_not_password');
    $field_definition->expects($this->any())
        ->method('getLabel')
        ->willReturn('Protected field');
    $account = $this->createMock('Drupal\\user\\UserInterface');
    $account->expects($this->once())
        ->method('isNew')
        ->willReturn(FALSE);
    $account->expects($this->exactly(2))
        ->method('id')
        ->willReturn('current-user');
    $account->expects($this->once())
        ->method('checkExistingPassword')
        ->willReturn(FALSE);
    $items = $this->createMock('Drupal\\Core\\Field\\FieldItemListInterface');
    $items->expects($this->once())
        ->method('getFieldDefinition')
        ->willReturn($field_definition);
    $items->expects($this->once())
        ->method('getEntity')
        ->willReturn($account);
    $items->expects($this->once())
        ->method('getValue')
        ->willReturn('changed-value');
    $cases[] = [
        $items,
        TRUE,
        'Protected field',
    ];
    return $cases;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.