Skip to content

Commit ea18ef4

Browse files
committed
test: more group/user test trait usage and setup/teardown improvements
Signed-off-by: Robin Appelman <robin@icewind.nl>
1 parent a55798a commit ea18ef4

7 files changed

Lines changed: 68 additions & 133 deletions

File tree

apps/files_sharing/tests/CacheTest.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ class CacheTest extends TestCase {
3333
protected Cache $sharedCache;
3434
protected Storage $ownerStorage;
3535
protected Storage $sharedStorage;
36-
/** @var \OCP\Share\IManager $shareManager */
37-
protected $shareManager;
3836

3937
protected function setUp(): void {
4038
parent::setUp();

apps/files_sharing/tests/Controller/ShareControllerTest.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,14 @@
4949
use OCP\Share\IPublicShareTemplateFactory;
5050
use OCP\Share\IShare;
5151
use PHPUnit\Framework\MockObject\MockObject;
52+
use Test\Traits\UserTrait;
5253

5354
/**
5455
* @package OCA\Files_Sharing\Controllers
5556
*/
5657
#[\PHPUnit\Framework\Attributes\Group(name: 'DB')]
5758
class ShareControllerTest extends \Test\TestCase {
59+
use UserTrait;
5860

5961
private string $user;
6062
private string $oldUser;
@@ -150,7 +152,7 @@ protected function setUp(): void {
150152
// Create a dummy user
151153
$this->user = Server::get(ISecureRandom::class)->generate(12, ISecureRandom::CHAR_LOWER);
152154

153-
Server::get(IUserManager::class)->createUser($this->user, $this->user);
155+
$this->createUser($this->user, $this->user);
154156
\OC_Util::tearDownFS();
155157
$this->loginAsUser($this->user);
156158
}

apps/files_sharing/tests/DeleteOrphanedSharesJobTest.php

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use OCP\IUserManager;
1717
use OCP\Server;
1818
use OCP\Share\IShare;
19+
use Test\Traits\UserTrait;
1920

2021
/**
2122
* Class DeleteOrphanedSharesJobTest
@@ -25,6 +26,8 @@
2526
*/
2627
#[\PHPUnit\Framework\Attributes\Group(name: 'DB')]
2728
class DeleteOrphanedSharesJobTest extends \Test\TestCase {
29+
use UserTrait;
30+
2831
/**
2932
* @var bool
3033
*/
@@ -75,9 +78,8 @@ protected function setUp(): void {
7578
$this->user1 = $this->getUniqueID('user1_');
7679
$this->user2 = $this->getUniqueID('user2_');
7780

78-
$userManager = Server::get(IUserManager::class);
79-
$userManager->createUser($this->user1, 'pass');
80-
$userManager->createUser($this->user2, 'pass');
81+
$this->createUser($this->user1, 'pass');
82+
$this->createUser($this->user2, 'pass');
8183

8284
\OC::registerShareHooks(Server::get(SystemConfig::class));
8385

apps/files_sharing/tests/ExpireSharesJobTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@
1414
use OCP\Files\IRootFolder;
1515
use OCP\IDBConnection;
1616
use OCP\IUser;
17-
use OCP\IUserManager;
1817
use OCP\Server;
1918
use OCP\Share\IManager;
2019
use OCP\Share\IShare;
2120
use PHPUnit\Framework\Attributes\DataProvider;
21+
use Test\Traits\UserTrait;
2222

2323
/**
2424
* Class ExpireSharesJobTest
@@ -28,6 +28,7 @@
2828
*/
2929
#[\PHPUnit\Framework\Attributes\Group(name: 'DB')]
3030
class ExpireSharesJobTest extends \Test\TestCase {
31+
use UserTrait;
3132

3233
private ExpireSharesJob $job;
3334

@@ -50,9 +51,8 @@ protected function setUp(): void {
5051
$user1 = $this->getUniqueID('user1_');
5152
$user2 = $this->getUniqueID('user2_');
5253

53-
$userManager = Server::get(IUserManager::class);
54-
$this->user1 = $userManager->createUser($user1, 'longrandompassword');
55-
$this->user2 = $userManager->createUser($user2, 'longrandompassword');
54+
$this->user1 = $this->createUser($user1, 'longrandompassword');
55+
$this->user2 = $this->createUser($user2, 'longrandompassword');
5656

5757
\OC::registerShareHooks(Server::get(SystemConfig::class));
5858

apps/files_sharing/tests/External/ManagerTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ class ManagerTest extends TestCase {
6969
protected ICloudFederationFactory&MockObject $cloudFederationFactory;
7070
protected IGroupManager&MockObject $groupManager;
7171
protected IUserManager&MockObject $userManager;
72-
protected ISetupManager&MockObject $setupManager;
72+
protected ISetupManager&MockObject $setupManagerEncTrait;
7373
protected ICertificateManager&MockObject $certificateManager;
7474
private ExternalShareMapper $externalShareMapper;
7575
private IConfig $config;
@@ -87,7 +87,7 @@ protected function setUp(): void {
8787
$this->groupManager = $this->createMock(IGroupManager::class);
8888
$this->userManager = $this->createMock(IUserManager::class);
8989
$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
90-
$this->setupManager = $this->createMock(ISetupManager::class);
90+
$this->setupManagerEncTrait = $this->createMock(ISetupManager::class);
9191
$this->rootFolder = $this->createMock(IRootFolder::class);
9292
$this->rootFolder->method('getUserFolder')
9393
->willReturnCallback(function (string $userId): Folder {
@@ -169,7 +169,7 @@ private function createManagerForUser(IUser $user): Manager&MockObject {
169169
$this->eventDispatcher,
170170
$this->logger,
171171
$this->rootFolder,
172-
$this->setupManager,
172+
$this->setupManagerEncTrait,
173173
$this->certificateManager,
174174
$this->externalShareMapper,
175175
$this->config,

apps/files_sharing/tests/LockingTest.php

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@
1010
use OC\Files\Filesystem;
1111
use OC\Files\View;
1212
use OCP\Constants;
13-
use OCP\IUserManager;
1413
use OCP\Lock\ILockingProvider;
1514
use OCP\Lock\LockedException;
16-
use OCP\Server;
1715
use OCP\Share\IShare;
16+
use Test\Traits\UserTrait;
1817

1918
/**
2019
* Class LockingTest
@@ -24,24 +23,18 @@
2423
*/
2524
#[\PHPUnit\Framework\Attributes\Group(name: 'DB')]
2625
class LockingTest extends TestCase {
27-
/**
28-
* @var \Test\Util\User\Dummy
29-
*/
30-
private $userBackend;
26+
use UserTrait;
3127

3228
private $ownerUid;
3329
private $recipientUid;
3430

3531
protected function setUp(): void {
3632
parent::setUp();
3733

38-
$this->userBackend = new \Test\Util\User\Dummy();
39-
Server::get(IUserManager::class)->registerBackend($this->userBackend);
40-
4134
$this->ownerUid = $this->getUniqueID('owner_');
4235
$this->recipientUid = $this->getUniqueID('recipient_');
43-
$this->userBackend->createUser($this->ownerUid, '');
44-
$this->userBackend->createUser($this->recipientUid, '');
36+
$this->createUser($this->ownerUid, '');
37+
$this->createUser($this->recipientUid, '');
4538

4639
$this->loginAsUser($this->ownerUid);
4740
Filesystem::mkdir('/foo');
@@ -60,11 +53,6 @@ protected function setUp(): void {
6053
$this->assertTrue(Filesystem::file_exists('bar.txt'));
6154
}
6255

63-
protected function tearDown(): void {
64-
Server::get(IUserManager::class)->removeBackend($this->userBackend);
65-
parent::tearDown();
66-
}
67-
6856

6957
public function testLockAsRecipient(): void {
7058
$this->expectException(LockedException::class);

apps/files_sharing/tests/TestCase.php

Lines changed: 49 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,35 @@
77
*/
88
namespace OCA\Files_Sharing\Tests;
99

10-
use OC\Files\Cache\Storage;
11-
use OC\Files\Filesystem;
1210
use OC\Files\View;
13-
use OC\Group\Database;
1411
use OC\SystemConfig;
1512
use OC\User\DisplayNameCache;
13+
use OC\User\Session;
1614
use OCA\Files_Sharing\AppInfo\Application;
1715
use OCA\Files_Sharing\External\MountProvider as ExternalMountProvider;
1816
use OCA\Files_Sharing\Listener\SharesUpdatedListener;
1917
use OCA\Files_Sharing\MountProvider;
2018
use OCP\Files\Config\IMountProviderCollection;
2119
use OCP\Files\IRootFolder;
20+
use OCP\Files\ISetupManager;
2221
use OCP\IDBConnection;
23-
use OCP\IGroupManager;
2422
use OCP\IUserManager;
2523
use OCP\IUserSession;
2624
use OCP\Server;
25+
use OCP\Share\IManager;
2726
use OCP\Share\IShare;
27+
use Test\Traits\GroupTrait;
2828
use Test\Traits\MountProviderTrait;
29+
use Test\Traits\UserTrait;
2930

3031
/**
3132
* Base class for sharing tests.
3233
*/
3334
#[\PHPUnit\Framework\Attributes\Group(name: 'DB')]
3435
abstract class TestCase extends \Test\TestCase {
3536
use MountProviderTrait;
37+
use UserTrait;
38+
use GroupTrait;
3639

3740
public const TEST_FILES_SHARING_API_USER1 = 'test-share-user1';
3841
public const TEST_FILES_SHARING_API_USER2 = 'test-share-user2';
@@ -54,13 +57,21 @@ abstract class TestCase extends \Test\TestCase {
5457
public $folder;
5558
public $subfolder;
5659

57-
/** @var \OCP\Share\IManager */
60+
/** @var IManager */
5861
protected $shareManager;
5962
/** @var IRootFolder */
6063
protected $rootFolder;
64+
protected Session $userSession;
65+
protected ISetupManager $setupManager;
6166

62-
public static function setUpBeforeClass(): void {
63-
parent::setUpBeforeClass();
67+
protected function setUp(): void {
68+
parent::setUp();
69+
70+
$this->shareManager = Server::get(IManager::class);
71+
$this->rootFolder = Server::get(IRootFolder::class);
72+
73+
$this->setupManager = Server::get(ISetupManager::class);
74+
$this->userSession = Server::get(IUserSession::class);
6475

6576
$app = new Application();
6677
$app->registerMountProviders(
@@ -69,54 +80,43 @@ public static function setUpBeforeClass(): void {
6980
Server::get(ExternalMountProvider::class),
7081
);
7182

72-
// reset backend
73-
Server::get(IUserManager::class)->clearBackends();
74-
Server::get(IGroupManager::class)->clearBackends();
75-
7683
// clear share hooks
7784
\OC_Hook::clear('OCP\\Share');
7885
\OC::registerShareHooks(Server::get(SystemConfig::class));
7986

80-
// create users
81-
$backend = new \Test\Util\User\Dummy();
82-
Server::get(IUserManager::class)->registerBackend($backend);
83-
$backend->createUser(self::TEST_FILES_SHARING_API_USER1, self::TEST_FILES_SHARING_API_USER1);
84-
$backend->createUser(self::TEST_FILES_SHARING_API_USER2, self::TEST_FILES_SHARING_API_USER2);
85-
$backend->createUser(self::TEST_FILES_SHARING_API_USER3, self::TEST_FILES_SHARING_API_USER3);
86-
$backend->createUser(self::TEST_FILES_SHARING_API_USER4, self::TEST_FILES_SHARING_API_USER4);
87-
88-
// create group
89-
$groupBackend = new \Test\Util\Group\Dummy();
90-
$groupBackend->createGroup(self::TEST_FILES_SHARING_API_GROUP1);
91-
$groupBackend->createGroup('group');
92-
$groupBackend->createGroup('group1');
93-
$groupBackend->createGroup('group2');
94-
$groupBackend->createGroup('group3');
95-
$groupBackend->addToGroup(self::TEST_FILES_SHARING_API_USER1, 'group');
96-
$groupBackend->addToGroup(self::TEST_FILES_SHARING_API_USER2, 'group');
97-
$groupBackend->addToGroup(self::TEST_FILES_SHARING_API_USER3, 'group');
98-
$groupBackend->addToGroup(self::TEST_FILES_SHARING_API_USER2, 'group1');
99-
$groupBackend->addToGroup(self::TEST_FILES_SHARING_API_USER3, 'group2');
100-
$groupBackend->addToGroup(self::TEST_FILES_SHARING_API_USER4, 'group3');
101-
$groupBackend->addToGroup(self::TEST_FILES_SHARING_API_USER2, self::TEST_FILES_SHARING_API_GROUP1);
102-
Server::get(IGroupManager::class)->addBackend($groupBackend);
103-
10487
Server::get(SharesUpdatedListener::class)->setCutOffMarkTime(-1);
105-
}
10688

107-
protected function setUp(): void {
108-
parent::setUp();
10989
Server::get(DisplayNameCache::class)->clear();
11090

91+
$this->createUser(self::TEST_FILES_SHARING_API_USER1, self::TEST_FILES_SHARING_API_USER1);
92+
$this->createUser(self::TEST_FILES_SHARING_API_USER2, self::TEST_FILES_SHARING_API_USER2);
93+
$this->createUser(self::TEST_FILES_SHARING_API_USER3, self::TEST_FILES_SHARING_API_USER3);
94+
$this->createUser(self::TEST_FILES_SHARING_API_USER4, self::TEST_FILES_SHARING_API_USER4);
95+
96+
$this->createGroup(self::TEST_FILES_SHARING_API_GROUP1, [
97+
self::TEST_FILES_SHARING_API_USER2,
98+
]);
99+
$this->createGroup('group', [
100+
self::TEST_FILES_SHARING_API_USER1,
101+
self::TEST_FILES_SHARING_API_USER2,
102+
self::TEST_FILES_SHARING_API_USER3,
103+
]);
104+
$this->createGroup('group1', [
105+
self::TEST_FILES_SHARING_API_USER2,
106+
]);
107+
$this->createGroup('group2', [
108+
self::TEST_FILES_SHARING_API_USER3,
109+
]);
110+
$this->createGroup('group3', [
111+
self::TEST_FILES_SHARING_API_USER4,
112+
]);
113+
111114
//login as user1
112115
$this->loginHelper(self::TEST_FILES_SHARING_API_USER1);
113116

114117
$this->data = 'foobar';
115118
$this->view = new View('/' . self::TEST_FILES_SHARING_API_USER1 . '/files');
116119
$this->view2 = new View('/' . self::TEST_FILES_SHARING_API_USER2 . '/files');
117-
118-
$this->shareManager = Server::get(\OCP\Share\IManager::class);
119-
$this->rootFolder = Server::get(IRootFolder::class);
120120
}
121121

122122
protected function tearDown(): void {
@@ -132,73 +132,18 @@ protected function tearDown(): void {
132132
$qb->delete('filecache')->runAcrossAllShards();
133133
$qb->executeStatement();
134134

135+
$this->userSession->setUser(null);
136+
$this->setupManager->tearDown();
137+
135138
parent::tearDown();
136139
}
137140

138-
public static function tearDownAfterClass(): void {
139-
// cleanup users
140-
$user = Server::get(IUserManager::class)->get(self::TEST_FILES_SHARING_API_USER1);
141-
if ($user !== null) {
142-
$user->delete();
143-
}
144-
$user = Server::get(IUserManager::class)->get(self::TEST_FILES_SHARING_API_USER2);
145-
if ($user !== null) {
146-
$user->delete();
147-
}
148-
$user = Server::get(IUserManager::class)->get(self::TEST_FILES_SHARING_API_USER3);
149-
if ($user !== null) {
150-
$user->delete();
151-
}
152-
153-
// delete group
154-
$group = Server::get(IGroupManager::class)->get(self::TEST_FILES_SHARING_API_GROUP1);
155-
if ($group) {
156-
$group->delete();
157-
}
158-
159-
\OC_Util::tearDownFS();
160-
\OC_User::setUserId('');
161-
Filesystem::tearDown();
162-
163-
// reset backend
164-
Server::get(IUserManager::class)->clearBackends();
165-
Server::get(IUserManager::class)->registerBackend(new \OC\User\Database());
166-
Server::get(IGroupManager::class)->clearBackends();
167-
Server::get(IGroupManager::class)->addBackend(new Database());
168-
169-
parent::tearDownAfterClass();
170-
}
141+
protected function loginHelper(string $uid) {
142+
$this->setupManager->tearDown();
143+
$user = Server::get(IUserManager::class)->get($uid);
144+
$this->userSession->completeLogin($user, ['loginName' => $uid, 'password' => $uid], false);
171145

172-
/**
173-
* @param string $user
174-
* @param bool $create
175-
* @param bool $password
176-
*/
177-
protected function loginHelper($user, $create = false, $password = false) {
178-
if ($password === false) {
179-
$password = $user;
180-
}
181-
182-
if ($create) {
183-
$userManager = Server::get(IUserManager::class);
184-
$groupManager = Server::get(IGroupManager::class);
185-
186-
$userObject = $userManager->createUser($user, $password);
187-
$group = $groupManager->createGroup('group');
188-
189-
if ($group && $userObject) {
190-
$group->addUser($userObject);
191-
}
192-
}
193-
194-
\OC_Util::tearDownFS();
195-
Storage::getGlobalCache()->clearCache();
196-
Server::get(IUserSession::class)->setUser(null);
197-
Filesystem::tearDown();
198-
Server::get(IUserSession::class)->login($user, $password);
199-
\OC::$server->getUserFolder($user);
200-
201-
\OC_Util::setupFS($user);
146+
$this->rootFolder->newFolder('/' . $uid . '/files');
202147
}
203148

204149
/**

0 commit comments

Comments
 (0)