Skip to content

change displayName with IEventDispatcher + fixed tests #582

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

Merged
merged 2 commits into from
Apr 11, 2022
Merged

change displayName with IEventDispatcher + fixed tests #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b08656e
displayname switch to eventdispatcher
Superjamp Feb 15, 2022
df21871
Cover UserChangedEvent in unit tests
juliusknorr Feb 18, 2022
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
3 changes: 2 additions & 1 deletion appinfo/app.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@
\OC::$server->getGroupManager(),
$samlSettings,
\OC::$server->getLogger(),
$userData
$userData,
\OC::$server->query(\OCP\EventDispatcher\IEventDispatcher::class),
);
$userBackend->registerBackends(\OC::$server->getUserManager()->getBackends());
OC_User::useBackend($userBackend);
Expand Down
16 changes: 8 additions & 8 deletions lib/UserBackend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
use OCP\IURLGenerator;
use OCP\ISession;
use Symfony\Component\EventDispatcher\GenericEvent;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\User\Events\UserChangedEvent;

class UserBackend implements IApacheBackend, UserInterface, IUserBackend {
/** @var IConfig */
Expand All @@ -57,6 +59,8 @@ class UserBackend implements IApacheBackend, UserInterface, IUserBackend {
private $logger;
/** @var UserData */
private $userData;
/** @var IEventDispatcher */
private $eventDispatcher;

public function __construct(
IConfig $config,
Expand All @@ -67,7 +71,8 @@ public function __construct(
IGroupManager $groupManager,
SAMLSettings $settings,
ILogger $logger,
UserData $userData
UserData $userData,
IEventDispatcher $eventDispatcher
) {
$this->config = $config;
$this->urlGenerator = $urlGenerator;
Expand All @@ -78,6 +83,7 @@ public function __construct(
$this->settings = $settings;
$this->logger = $logger;
$this->userData = $userData;
$this->eventDispatcher = $eventDispatcher;
}

/**
Expand Down Expand Up @@ -645,13 +651,7 @@ public function updateAttributes($uid,
$currentDisplayname = (string)$this->getDisplayName($uid);
if ($newDisplayname !== null
&& $currentDisplayname !== $newDisplayname) {
\OC_Hook::emit('OC_User', 'changeUser',
[
'user' => $user,
'feature' => 'displayName',
'value' => $newDisplayname
]
);
$this->eventDispatcher->dispatchTyped(new UserChangedEvent($user, 'displayName', $newDisplayname, $currentDisplayname));
$this->setDisplayName($uid, $newDisplayname);
}

Expand Down
42 changes: 28 additions & 14 deletions tests/unit/UserBackendTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
use OCA\User_SAML\SAMLSettings;
use OCA\User_SAML\UserBackend;
use OCA\User_SAML\UserData;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IGroup;
Expand All @@ -33,29 +34,33 @@
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\IUserManager;
use OCP\User\Events\UserChangedEvent;
use PHPUnit\Framework\MockObject\MockObject;
use Test\TestCase;

class UserBackendTest extends TestCase {
/** @var UserData|\PHPUnit\Framework\MockObject\MockObject */
/** @var UserData|MockObject */
private $userData;
/** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */
/** @var IConfig|MockObject */
private $config;
/** @var IURLGenerator|\PHPUnit_Framework_MockObject_MockObject */
/** @var IURLGenerator|MockObject */
private $urlGenerator;
/** @var ISession|\PHPUnit_Framework_MockObject_MockObject */
/** @var ISession|MockObject */
private $session;
/** @var IDBConnection|\PHPUnit_Framework_MockObject_MockObject */
/** @var IDBConnection|MockObject */
private $db;
/** @var IUserManager|\PHPUnit_Framework_MockObject_MockObject */
/** @var IUserManager|MockObject */
private $userManager;
/** @var IGroupManager|\PHPUnit_Framework_MockObject_MockObject */
/** @var IGroupManager|MockObject */
private $groupManager;
/** @var UserBackend|\PHPUnit_Framework_MockObject_MockObject */
/** @var UserBackend|MockObject */
private $userBackend;
/** @var \PHPUnit_Framework_MockObject_MockObject|SAMLSettings */
/** @var SAMLSettings|MockObject */
private $SAMLSettings;
/** @var \PHPUnit_Framework_MockObject_MockObject|ILogger */
/** @var ILogger|MockObject */
private $logger;
/** @var IEventDispatcher|MockObject */
private $eventDispatcher;

protected function setUp(): void {
parent::setUp();
Expand All @@ -69,6 +74,7 @@ protected function setUp(): void {
$this->SAMLSettings = $this->getMockBuilder(SAMLSettings::class)->disableOriginalConstructor()->getMock();
$this->logger = $this->createMock(ILogger::class);
$this->userData = $this->createMock(UserData::class);
$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
}

public function getMockedBuilder(array $mockedFunctions = []) {
Expand All @@ -84,6 +90,7 @@ public function getMockedBuilder(array $mockedFunctions = []) {
$this->SAMLSettings,
$this->logger,
$this->userData,
$this->eventDispatcher
])
->setMethods($mockedFunctions)
->getMock();
Expand All @@ -97,7 +104,8 @@ public function getMockedBuilder(array $mockedFunctions = []) {
$this->groupManager,
$this->SAMLSettings,
$this->logger,
$this->userData
$this->userData,
$this->eventDispatcher
);
}
}
Expand All @@ -109,7 +117,7 @@ public function testGetBackendName() {

public function testUpdateAttributesWithoutAttributes() {
$this->getMockedBuilder(['getDisplayName']);
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $user */
/** @var IUser|MockObject $user */
$user = $this->createMock(IUser::class);

$this->userManager
Expand Down Expand Up @@ -151,7 +159,7 @@ public function testUpdateAttributesWithoutValidUser() {

public function testUpdateAttributes() {
$this->getMockedBuilder(['getDisplayName', 'setDisplayName']);
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $user */
/** @var IUser|MockObject $user */
$user = $this->createMock(IUser::class);
$groupA = $this->createMock(IGroup::class);
$groupC = $this->createMock(IGroup::class);
Expand Down Expand Up @@ -242,6 +250,9 @@ public function testUpdateAttributes() {
->expects($this->once())
->method('addUser')
->with($user);
$this->eventDispatcher->expects($this->once())
->method('dispatchTyped')
->with(new UserChangedEvent($user, 'displayName', 'New Displayname', ''));

$this->userBackend->updateAttributes('ExistingUser', [
'email' => 'new@example.com',
Expand All @@ -253,7 +264,7 @@ public function testUpdateAttributes() {

public function testUpdateAttributesQuotaDefaultFallback() {
$this->getMockedBuilder(['getDisplayName', 'setDisplayName']);
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $user */
/** @var IUser|MockObject $user */
$user = $this->createMock(IUser::class);

$this->config
Expand Down Expand Up @@ -305,6 +316,9 @@ public function testUpdateAttributesQuotaDefaultFallback() {
->expects($this->once())
->method('setDisplayName')
->with('ExistingUser', 'New Displayname');
$this->eventDispatcher->expects($this->once())
->method('dispatchTyped')
->with(new UserChangedEvent($user, 'displayName', 'New Displayname', ''));
$this->userBackend->updateAttributes('ExistingUser', ['email' => 'new@example.com', 'displayname' => 'New Displayname', 'quota' => '']);
}
}