open-dsi
/
nextcloud-server
mirror of https://github.com/nextcloud/server
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(talkbackend): Make function names positive and remove talk internals from docs

Browse Source 
Signed-off-by: Joas Schilling <coding@schilljs.com>
pull/59918/head
Joas Schilling 1 month ago
parent c55cfc4367
commit 109eb0c8a9
No known key found for this signature in database
GPG Key ID: F72FA5B49FFA96B0
4 changed files with 89 additions and 74 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 14
      lib/private/Talk/Broker.php
  2. 16
      lib/public/Talk/IBroker.php
  3. 16
      lib/public/Talk/ITalkBackend.php
  4. 117
      tests/lib/Talk/BrokerTest.php

14
lib/private/Talk/Broker.php
Unescape View File

@ -92,19 +92,19 @@ class Broker implements IBroker {
$this->backend->deleteConversation($id);
}
public function isDisabledForUser(): bool {
if (!$this->hasBackend()) {
return true;
public function isAllowedToCreateConversations(): bool {
if (!$this->isEnabledForUser()) {
return false;
}
return $this->backend->isDisabledForUser();
return $this->backend->isAllowedToCreateConversations();
}
public function isNotAllowedToCreateConversations(): bool {
public function isEnabledForUser(): bool {
if (!$this->hasBackend()) {
return true;
return false;
}
return $this->backend->isNotAllowedToCreateConversations();
return $this->backend->isEnabledForUser();
}
}

16
lib/public/Talk/IBroker.php
Unescape View File

@ -67,26 +67,22 @@ interface IBroker {
public function deleteConversation(string $id): void;
/**
* Check if the logged in user is not allowed to create conversations,
* respecting the per-group restrictions configured in Talk admin settings
* (allowed_groups).
* Check if the logged-in user is allowed to create conversations
*
* Returns false when Talk is not available at all.
* Also returns false when no backend is available
*
* @return bool
* @since 34.0.0
*/
public function isNotAllowedToCreateConversations(): bool;
public function isAllowedToCreateConversations(): bool;
/**
* Check if Talk is disabled for the logged in user, respecting the
* per-group restriction configured in Talk admin settings
* (start_conversations).
* Check if the Talk backend is enabled for the logged-in user
*
* Returns false when Talk is not available at all.
* Also returns false when no backend is available
*
* @return bool
* @since 34.0.0
*/
public function isDisabledForUser(): bool;
public function isEnabledForUser(): bool;
}

16
lib/public/Talk/ITalkBackend.php
Unescape View File

@ -44,26 +44,20 @@ interface ITalkBackend {
public function deleteConversation(string $id): void;
/**
* Check if the logged in user is not allowed to create conversations,
* respecting the per-group restrictions configured in Talk admin settings
* (allowed_groups).
* Check if the logged-in user is allowed to create conversations
*
* Returns false when Talk is not available at all.
* Also returns false when no backend is enabled for the user
*
* @return bool
* @since 34.0.0
*/
public function isNotAllowedToCreateConversations(): bool;
public function isAllowedToCreateConversations(): bool;
/**
* Check if Talk is disabled for the logged in user, respecting the
* per-group restriction configured in Talk admin settings
* (start_conversations).
*
* Returns false when Talk is not available at all.
* Check if the Talk backend is enabled for the logged-in user
*
* @return bool
* @since 34.0.0
*/
public function isDisabledForUser(): bool;
public function isEnabledForUser(): bool;
}

117
tests/lib/Talk/BrokerTest.php
Unescape View File

@ -17,6 +17,7 @@ use OCP\AppFramework\QueryException;
use OCP\IServerContainer;
use OCP\Talk\IConversationOptions;
use OCP\Talk\ITalkBackend;
use PHPUnit\Framework\Attributes\DataProvider;
use Psr\Log\LoggerInterface;
use RuntimeException;
use Test\TestCase;
@ -51,7 +52,7 @@ class BrokerTest extends TestCase {
}
public function testHasNoBackend(): void {
$this->coordinator->expects(self::once())
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($this->createMock(RegistrationContext::class));
@ -63,16 +64,16 @@ class BrokerTest extends TestCase {
public function testHasFaultyBackend(): void {
$fakeTalkServiceClass = '\\OCA\\Spreed\\TalkBackend';
$registrationContext = $this->createMock(RegistrationContext::class);
$this->coordinator->expects(self::once())
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($registrationContext);
$registrationContext->expects(self::once())
$registrationContext->expects($this->once())
->method('getTalkBackendRegistration')
->willReturn(new ServiceRegistration('spreed', $fakeTalkServiceClass));
$this->container->expects(self::once())
$this->container->expects($this->once())
->method('get')
->willThrowException(new QueryException());
$this->logger->expects(self::once())
$this->logger->expects($this->once())
->method('error');
self::assertFalse(
@ -83,14 +84,14 @@ class BrokerTest extends TestCase {
public function testHasBackend(): void {
$fakeTalkServiceClass = '\\OCA\\Spreed\\TalkBackend';
$registrationContext = $this->createMock(RegistrationContext::class);
$this->coordinator->expects(self::once())
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($registrationContext);
$registrationContext->expects(self::once())
$registrationContext->expects($this->once())
->method('getTalkBackendRegistration')
->willReturn(new ServiceRegistration('spreed', $fakeTalkServiceClass));
$talkService = $this->createMock(ITalkBackend::class);
$this->container->expects(self::once())
$this->container->expects($this->once())
->method('get')
->with($fakeTalkServiceClass)
->willReturn($talkService);
@ -110,19 +111,19 @@ class BrokerTest extends TestCase {
public function testCreateConversation(): void {
$fakeTalkServiceClass = '\\OCA\\Spreed\\TalkBackend';
$registrationContext = $this->createMock(RegistrationContext::class);
$this->coordinator->expects(self::once())
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($registrationContext);
$registrationContext->expects(self::once())
$registrationContext->expects($this->once())
->method('getTalkBackendRegistration')
->willReturn(new ServiceRegistration('spreed', $fakeTalkServiceClass));
$talkService = $this->createMock(ITalkBackend::class);
$this->container->expects(self::once())
$this->container->expects($this->once())
->method('get')
->with($fakeTalkServiceClass)
->willReturn($talkService);
$options = $this->createMock(IConversationOptions::class);
$talkService->expects(self::once())
$talkService->expects($this->once())
->method('createConversation')
->with('Watercooler', [], $options);
@ -133,91 +134,115 @@ class BrokerTest extends TestCase {
);
}
public function testIsDisabledForUserNoBackend(): void {
$this->coordinator->expects(self::once())
public function testIsEnabledForUserNoBackend(): void {
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($this->createMock(RegistrationContext::class));
self::assertTrue(
$this->broker->isDisabledForUser()
self::assertFalse(
$this->broker->isEnabledForUser()
);
}
public static function dataIsDisabledForUser(): array {
public static function dataIsEnabledForUser(): array {
return [
[true],
[false],
];
}
/**
* @dataProvider dataIsDisabledForUser
*/
public function testIsDisabledForUser(bool $disabled): void {
#[DataProvider('dataIsEnabledForUser')]
public function testIsEnabledForUser(bool $enabled): void {
$fakeTalkServiceClass = '\\OCA\\Spreed\\TalkBackend';
$registrationContext = $this->createMock(RegistrationContext::class);
$this->coordinator->expects(self::once())
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($registrationContext);
$registrationContext->expects(self::once())
$registrationContext->expects($this->once())
->method('getTalkBackendRegistration')
->willReturn(new ServiceRegistration('spreed', $fakeTalkServiceClass));
$talkService = $this->createMock(ITalkBackend::class);
$this->container->expects(self::once())
$this->container->expects($this->once())
->method('get')
->with($fakeTalkServiceClass)
->willReturn($talkService);
$talkService->expects(self::once())
->method('isDisabledForUser')
->willReturn($disabled);
$talkService->expects($this->once())
->method('isEnabledForUser')
->willReturn($enabled);
self::assertSame(
$disabled,
$this->broker->isDisabledForUser()
$enabled,
$this->broker->isEnabledForUser()
);
}
public function testIsNotAllowedToCreateConversationsNoBackend(): void {
$this->coordinator->expects(self::once())
public function testIsAllowedToCreateConversationsNoBackend(): void {
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($this->createMock(RegistrationContext::class));
self::assertTrue(
$this->broker->isNotAllowedToCreateConversations()
self::assertFalse(
$this->broker->isAllowedToCreateConversations()
);
}
public function testIsAllowedToCreateConversationsBackendDisabled(): void {
$fakeTalkServiceClass = '\\OCA\\Spreed\\TalkBackend';
$registrationContext = $this->createMock(RegistrationContext::class);
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($registrationContext);
$registrationContext->expects($this->once())
->method('getTalkBackendRegistration')
->willReturn(new ServiceRegistration('spreed', $fakeTalkServiceClass));
$talkService = $this->createMock(ITalkBackend::class);
$this->container->expects($this->once())
->method('get')
->with($fakeTalkServiceClass)
->willReturn($talkService);
$talkService->expects($this->once())
->method('isEnabledForUser')
->willReturn(false);
$talkService->expects($this->never())
->method('isAllowedToCreateConversations');
self::assertFalse(
$this->broker->isAllowedToCreateConversations()
);
}
public static function dataIsNotAllowedToCreateConversations(): array {
public static function dataIsAllowedToCreateConversations(): array {
return [
[true],
[false],
];
}
/**
* @dataProvider dataIsNotAllowedToCreateConversations
*/
public function testIsNotAllowedToCreateConversations(bool $notAllowed): void {
#[DataProvider('dataIsAllowedToCreateConversations')]
public function testIsAllowedToCreateConversations(bool $allowed): void {
$fakeTalkServiceClass = '\\OCA\\Spreed\\TalkBackend';
$registrationContext = $this->createMock(RegistrationContext::class);
$this->coordinator->expects(self::once())
$this->coordinator->expects($this->once())
->method('getRegistrationContext')
->willReturn($registrationContext);
$registrationContext->expects(self::once())
$registrationContext->expects($this->once())
->method('getTalkBackendRegistration')
->willReturn(new ServiceRegistration('spreed', $fakeTalkServiceClass));
$talkService = $this->createMock(ITalkBackend::class);
$this->container->expects(self::once())
$this->container->expects($this->once())
->method('get')
->with($fakeTalkServiceClass)
->willReturn($talkService);
$talkService->expects(self::once())
->method('isNotAllowedToCreateConversations')
->willReturn($notAllowed);
$talkService->expects($this->once())
->method('isEnabledForUser')
->willReturn(true);
$talkService->expects($this->once())
->method('isAllowedToCreateConversations')
->willReturn($allowed);
self::assertSame(
$notAllowed,
$this->broker->isNotAllowedToCreateConversations()
$allowed,
$this->broker->isAllowedToCreateConversations()
);
}
}

Write Preview
Loading…
Cancel
Save