class UserRegistrationResourceTest

Same name in other branches
  1. 9 core/modules/user/tests/src/Unit/UserRegistrationResourceTest.php \Drupal\Tests\user\Unit\UserRegistrationResourceTest
  2. 8.9.x core/modules/user/tests/src/Unit/UserRegistrationResourceTest.php \Drupal\Tests\user\Unit\UserRegistrationResourceTest
  3. 11.x core/modules/user/tests/src/Unit/UserRegistrationResourceTest.php \Drupal\Tests\user\Unit\UserRegistrationResourceTest

Tests User Registration REST resource.

@coversDefaultClass \Drupal\user\Plugin\rest\resource\UserRegistrationResource @group user

Hierarchy

Expanded class hierarchy of UserRegistrationResourceTest

File

core/modules/user/tests/src/Unit/UserRegistrationResourceTest.php, line 25

Namespace

Drupal\Tests\user\Unit
View source
class UserRegistrationResourceTest extends UnitTestCase {
    const ERROR_MESSAGE = "Unprocessable Entity: validation failed.\nproperty_path: message\nproperty_path_2: message_2\n";
    
    /**
     * Class to be tested.
     *
     * @var \Drupal\user\Plugin\rest\resource\UserRegistrationResource
     */
    protected $testClass;
    
    /**
     * A reflection of self::$testClass.
     *
     * @var \ReflectionClass
     */
    protected $reflection;
    
    /**
     * A user settings config instance.
     *
     * @var \Drupal\Core\Config\ImmutableConfig|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $userSettings;
    
    /**
     * Logger service.
     *
     * @var \Psr\Log\LoggerInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $logger;
    
    /**
     * The current user.
     *
     * @var \Drupal\Core\Session\AccountInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $currentUser;
    
    /**
     * The password generator.
     *
     * @var \Drupal\Core\Password\PasswordGeneratorInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $passwordGenerator;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->logger = $this->prophesize(LoggerInterface::class)
            ->reveal();
        $this->userSettings = $this->prophesize(ImmutableConfig::class);
        $this->currentUser = $this->prophesize(AccountInterface::class);
        $this->passwordGenerator = $this->prophesize(PasswordGeneratorInterface::class)
            ->reveal();
        $this->testClass = new UserRegistrationResource([], 'plugin_id', '', [], $this->logger, $this->userSettings
            ->reveal(), $this->currentUser
            ->reveal(), $this->passwordGenerator);
        $this->reflection = new \ReflectionClass($this->testClass);
    }
    
    /**
     * Tests that an exception is thrown when no data provided for the account.
     */
    public function testEmptyPost() : void {
        $this->expectException(BadRequestHttpException::class);
        $this->testClass
            ->post(NULL);
    }
    
    /**
     * Tests that only new user accounts can be registered.
     */
    public function testExistedEntityPost() : void {
        $entity = $this->prophesize(User::class);
        $entity->isNew()
            ->willReturn(FALSE);
        $this->expectException(BadRequestHttpException::class);
        $this->testClass
            ->post($entity->reveal());
    }
    
    /**
     * Tests that admin permissions are required to register a user account.
     */
    public function testRegistrationAdminOnlyPost() : void {
        $this->userSettings
            ->get('register')
            ->willReturn(UserInterface::REGISTER_ADMINISTRATORS_ONLY);
        $this->currentUser
            ->isAnonymous()
            ->willReturn(TRUE);
        $this->testClass = new UserRegistrationResource([], 'plugin_id', '', [], $this->logger, $this->userSettings
            ->reveal(), $this->currentUser
            ->reveal(), $this->passwordGenerator);
        $entity = $this->prophesize(User::class);
        $entity->isNew()
            ->willReturn(TRUE);
        $this->expectException(AccessDeniedHttpException::class);
        $this->testClass
            ->post($entity->reveal());
    }
    
    /**
     * Tests that only anonymous users can register users.
     */
    public function testRegistrationAnonymousOnlyPost() : void {
        $this->currentUser
            ->isAnonymous()
            ->willReturn(FALSE);
        $this->testClass = new UserRegistrationResource([], 'plugin_id', '', [], $this->logger, $this->userSettings
            ->reveal(), $this->currentUser
            ->reveal(), $this->passwordGenerator);
        $entity = $this->prophesize(User::class);
        $entity->isNew()
            ->willReturn(TRUE);
        $this->expectException(AccessDeniedHttpException::class);
        $this->testClass
            ->post($entity->reveal());
    }
    
    /**
     * Tests the deprecation messages.
     *
     * @covers ::__construct
     *
     * @group legacy
     */
    public function testDeprecations() : void {
        $this->expectDeprecation('Calling Drupal\\user\\Plugin\\rest\\resource\\UserRegistrationResource::__construct() without the $password_generator argument is deprecated in drupal:10.3.0 and will be required in drupal:11.0.0. See https://www.drupal.org/node/3405799');
        $this->expectException(BadRequestHttpException::class);
        $container = new ContainerBuilder();
        $password_generator = $this->prophesize(PasswordGeneratorInterface::class);
        $container->set('password_generator', $password_generator->reveal());
        \Drupal::setContainer($container);
        $this->testClass = new UserRegistrationResource([], 'plugin_id', '', [], $this->logger, $this->userSettings
            ->reveal(), $this->currentUser
            ->reveal());
        $this->testClass
            ->post(NULL);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
UnitTestCase::$root protected property The app root. 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::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUpBeforeClass public static function
UnitTestCase::__get public function
UserRegistrationResourceTest::$currentUser protected property The current user.
UserRegistrationResourceTest::$logger protected property Logger service.
UserRegistrationResourceTest::$passwordGenerator protected property The password generator.
UserRegistrationResourceTest::$reflection protected property A reflection of self::$testClass.
UserRegistrationResourceTest::$testClass protected property Class to be tested.
UserRegistrationResourceTest::$userSettings protected property A user settings config instance.
UserRegistrationResourceTest::ERROR_MESSAGE constant
UserRegistrationResourceTest::setUp protected function Overrides UnitTestCase::setUp
UserRegistrationResourceTest::testDeprecations public function Tests the deprecation messages.
UserRegistrationResourceTest::testEmptyPost public function Tests that an exception is thrown when no data provided for the account.
UserRegistrationResourceTest::testExistedEntityPost public function Tests that only new user accounts can be registered.
UserRegistrationResourceTest::testRegistrationAdminOnlyPost public function Tests that admin permissions are required to register a user account.
UserRegistrationResourceTest::testRegistrationAnonymousOnlyPost public function Tests that only anonymous users can register users.

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