Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move user creation to a separate service #35972

Merged
merged 1 commit into from
Aug 9, 2019
Merged

Move user creation to a separate service #35972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions apps/provisioning_api/appinfo/routes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@

namespace OCA\Provisioning_API\AppInfo;

use OC\User\Service\CreateUserService;
use OC\User\Service\PasswordGeneratorService;
use OC\User\Service\UserSendMailService;
use OCA\Provisioning_API\Apps;
use OCA\Provisioning_API\Groups;
use OCA\Provisioning_API\Users;
Expand All @@ -37,6 +40,20 @@
\OC::$server->getUserManager(),
\OC::$server->getGroupManager(),
\OC::$server->getUserSession(),
new CreateUserService(
\OC::$server->getUserSession(), \OC::$server->getGroupManager(),
\OC::$server->getUserManager(), \OC::$server->getSecureRandom(),
\OC::$server->getLogger(),
new UserSendMailService(
\OC::$server->getSecureRandom(), \OC::$server->getConfig(),
\OC::$server->getMailer(), \OC::$server->getURLGenerator(),
new \OC_Defaults(), \OC::$server->getTimeFactory(),
\OC::$server->getL10N('settings')
),
new PasswordGeneratorService(
\OC::$server->getEventDispatcher(), \OC::$server->getSecureRandom()
)
),
\OC::$server->getLogger(),
\OC::$server->getTwoFactorAuthManager()
);
Expand Down
27 changes: 19 additions & 8 deletions apps/provisioning_api/lib/Users.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
namespace OCA\Provisioning_API;

use OC\OCS\Result;
use OC\User\Service\CreateUserService;
use OC_Helper;
use OCP\API;
use OCP\Files\FileInfo;
Expand All @@ -50,25 +51,33 @@ class Users {
private $groupManager;
/** @var IUserSession */
private $userSession;
/** @var CreateUserService */
private $createUserService;
/** @var ILogger */
private $logger;
/** @var \OC\Authentication\TwoFactorAuth\Manager */
private $twoFactorAuthManager;

/**
* Users constructor.
*
* @param IUserManager $userManager
* @param IGroupManager $groupManager
* @param IUserSession $userSession
* @param CreateUserService $createUserService
* @param ILogger $logger
* @param \OC\Authentication\TwoFactorAuth\Manager $twoFactorAuthManager
*/
public function __construct(IUserManager $userManager,
IGroupManager $groupManager,
IUserSession $userSession,
CreateUserService $createUserService,
ILogger $logger,
\OC\Authentication\TwoFactorAuth\Manager $twoFactorAuthManager) {
$this->userManager = $userManager;
$this->groupManager = $groupManager;
$this->userSession = $userSession;
$this->createUserService = $createUserService;
$this->logger = $logger;
$this->twoFactorAuthManager = $twoFactorAuthManager;
}
Expand Down Expand Up @@ -125,8 +134,9 @@ public function getUsers() {
*/
public function addUser() {
$userId = isset($_POST['userid']) ? $_POST['userid'] : null;
$password = isset($_POST['password']) ? $_POST['password'] : null;
$groups = isset($_POST['groups']) ? $_POST['groups'] : null;
$password = isset($_POST['password']) ? $_POST['password'] : '';
$groups = isset($_POST['groups']) ? $_POST['groups'] : [];
$emailAddress = isset($_POST['email']) ? $_POST['email'] : '';
$user = $this->userSession->getUser();
$isAdmin = $this->groupManager->isAdmin($user->getUID());
$subAdminManager = $this->groupManager->getSubAdmin();
Expand All @@ -140,7 +150,7 @@ public function addUser() {
return new Result(null, 102, 'User already exists');
}

if (\is_array($groups)) {
if (\is_array($groups) && (\count($groups) > 0)) {
foreach ($groups as $group) {
if (!$this->groupManager->groupExists($group)) {
return new Result(null, 104, 'group '.$group.' does not exist');
Expand All @@ -156,13 +166,14 @@ public function addUser() {
}

try {
$newUser = $this->userManager->createUser($userId, $password);
$newUser = $this->createUserService->createUser(['username' => $userId, 'password' => $password, 'email' => $emailAddress]);
$this->logger->info('Successful addUser call with userid: '.$userId, ['app' => 'ocs_api']);

if (\is_array($groups)) {
foreach ($groups as $group) {
$this->groupManager->get($group)->addUser($newUser);
$this->logger->info('Added userid '.$userId.' to group '.$group, ['app' => 'ocs_api']);
if (\count($groups) > 0) {
$failedToAddGroups = $this->createUserService->addUserToGroups($newUser, $groups);
if (\count($failedToAddGroups) > 0) {
$failedToAddGroups = \implode(',', $failedToAddGroups);
$this->logger->error("User $userId could not be added to groups $failedToAddGroups");
}
}
return new Result(null, 100);
Expand Down
65 changes: 30 additions & 35 deletions apps/provisioning_api/tests/UsersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
namespace OCA\Provisioning_API\Tests;

use OC\OCS\Result;
use OC\User\Service\CreateUserService;
use OCA\Provisioning_API\Users;
use OCP\API;
use OCP\ILogger;
Expand All @@ -56,6 +57,8 @@ class UsersTest extends OriginalTest {
protected $api;
/** @var \OC\Authentication\TwoFactorAuth\Manager | PHPUnit\Framework\MockObject\MockObject */
private $twoFactorAuthManager;
/** @var CreateUserService | PHPUnit\Framework\MockObject\MockObject */
private $createUserService;

protected function tearDown() {
$_GET = null;
Expand All @@ -79,11 +82,13 @@ protected function setUp() {
$this->twoFactorAuthManager->expects($this->any())
->method('isTwoFactorAuthenticated')
->willReturn(false);
$this->createUserService = $this->createMock(CreateUserService::class);
$this->api = $this->getMockBuilder(Users::class)
->setConstructorArgs([
$this->userManager,
$this->groupManager,
$this->userSession,
$this->createUserService,
$this->logger,
$this->twoFactorAuthManager
])
Expand Down Expand Up @@ -324,15 +329,17 @@ public function testAddUserExistingGroupNonExistingGroup() {
public function testAddUserSuccessful() {
$_POST['userid'] = 'NewUser';
$_POST['password'] = 'PasswordOfTheNewUser';
$newUserCreated = $this->createMock(IUser::class);
$this->userManager
->expects($this->once())
->method('userExists')
->with('NewUser')
->will($this->returnValue(false));
$this->userManager
$this->createUserService
->expects($this->once())
->method('createUser')
->with('NewUser', 'PasswordOfTheNewUser');
->with(['username' => 'NewUser', 'password' => 'PasswordOfTheNewUser', 'email' => ''])
->will($this->returnValue($newUserCreated));
$this->logger
->expects($this->once())
->method('info')
Expand Down Expand Up @@ -385,27 +392,22 @@ public function testAddUserExistingGroup() {
->with('ExistingGroup')
->willReturn(true);
$user = $this->createMock(IUser::class);
$this->userManager
$this->createUserService
->expects($this->once())
->method('createUser')
->with('NewUser', 'PasswordOfTheNewUser')
->with(['username' => 'NewUser', 'password' => 'PasswordOfTheNewUser', 'email' => ''])
->willReturn($user);
$group = $this->createMock(IGroup::class);
$group
->expects($this->once())
->method('addUser')
->with($user);
$this->groupManager
$this->createUserService
->expects($this->once())
->method('get')
->with('ExistingGroup')
->willReturn($group);
->method('addUserToGroups')
->with($user, ['ExistingGroup'])
->will($this->returnValue([]));
$group = $this->createMock(IGroup::class);
$this->logger
->expects($this->exactly(2))
->expects($this->exactly(1))
->method('info')
->withConsecutive(
['Successful addUser call with userid: NewUser', ['app' => 'ocs_api']],
['Added userid NewUser to group ExistingGroup', ['app' => 'ocs_api']]
['Successful addUser call with userid: NewUser', ['app' => 'ocs_api']]
);

$expected = new Result(null, 100);
Expand All @@ -420,10 +422,10 @@ public function testAddUserUnsuccessful() {
->method('userExists')
->with('NewUser')
->will($this->returnValue(false));
$this->userManager
$this->createUserService
->expects($this->once())
->method('createUser')
->with('NewUser', 'PasswordOfTheNewUser')
->with(['username' => 'NewUser', 'password' => 'PasswordOfTheNewUser', 'email' => ''])
->will($this->throwException(new \Exception('User backend not found.')));
$this->logger
->expects($this->once())
Expand Down Expand Up @@ -599,27 +601,22 @@ public function testAddUserAsSubAdminExistingGroups() {
)
->willReturn(true);
$user = $this->createMock(IUser::class);
$this->userManager
$this->createUserService
->expects($this->once())
->method('createUser')
->with('NewUser', 'PasswordOfTheNewUser')
->with(['username' => 'NewUser', 'password' => 'PasswordOfTheNewUser', 'email' => ''])
->willReturn($user);
$this->createUserService
->expects($this->once())
->method('addUserToGroups')
->with($user, ['ExistingGroup1', 'ExistingGroup2'])
->willReturn([]);
$existingGroup1 = $this->createMock(IGroup::class);
$existingGroup2 = $this->createMock(IGroup::class);
$existingGroup1
->expects($this->once())
->method('addUser')
->with($user);
$existingGroup2
->expects($this->once())
->method('addUser')
->with($user);
$this->groupManager
->expects($this->exactly(4))
->expects($this->exactly(2))
->method('get')
->withConsecutive(
['ExistingGroup1'],
['ExistingGroup2'],
['ExistingGroup1'],
['ExistingGroup2']
)
Expand All @@ -628,12 +625,10 @@ public function testAddUserAsSubAdminExistingGroups() {
['ExistingGroup2', $existingGroup2]
]));
$this->logger
->expects($this->exactly(3))
->expects($this->exactly(1))
->method('info')
->withConsecutive(
['Successful addUser call with userid: NewUser', ['app' => 'ocs_api']],
['Added userid NewUser to group ExistingGroup1', ['app' => 'ocs_api']],
['Added userid NewUser to group ExistingGroup2', ['app' => 'ocs_api']]
['Successful addUser call with userid: NewUser', ['app' => 'ocs_api']]
);
$subAdminManager = $this->getMockBuilder(SubAdmin::class)
->disableOriginalConstructor()->getMock();
Expand Down
7 changes: 6 additions & 1 deletion core/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
use OCP\IConfig;
use OCP\ILogger;
use OCP\IServerContainer;
use OCP\IURLGenerator;
use OCP\Util;

/**
Expand Down Expand Up @@ -87,7 +88,11 @@ public function __construct(array $urlParams= []) {
$c->query('AppName'),
$c->query('Request'),
$c->query('UserManager'),
$c->query('Defaults')
$c->query('Defaults'),
$c->query('OC\User\Service\UserSendMailService'),
$c->query('URLGenerator'),
$c->query('Logger'),
$c->query('L10N')
);
});
$container->registerService('AvatarController', function (SimpleContainer $c) {
Expand Down
Loading