Skip to content

test: strengthen lock cleanup coverage #1205

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
CarlSchwan merged 1 commit into from
Sep 8, 2026
+56 −17
Merged

test: strengthen lock cleanup coverage #1205

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
73 changes: 56 additions & 17 deletions tests/Feature/LockFeatureTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,34 +227,59 @@ public function testLockUserExpire(): void {
}

public function testExpiredLocksAreDeprecated(): void {
$service = \OCP\Server::get(LockService::class);
\OCP\Server::get(IConfig::class)->setAppValue(Application::APP_ID, ConfigLexicon::LOCK_TIMEOUT, 30);
$file = $this->loginAndGetUserFolder(self::TEST_USER1)
->newFile('test-expired-lock-is-deprecated', 'AAA');
$this->lockManager->lock(new LockContext($file, ILock::TYPE_USER, self::TEST_USER1));
$this->toTheFuture(3600);
$deprecated = \OCP\Server::get(LockService::class)->getDeprecatedLocks();
self::assertNotEmpty($deprecated);
->newFile('test-expired-lock', 'AAA');
$lock = $this->lockManager->lock(new LockContext($file, ILock::TYPE_USER, self::TEST_USER1));
// Travel past the 30m timeout window.
$this->toTheFuture(30 * 60 + 1);
$mapToIds = fn (ILock $deprecatedLock): int => $deprecatedLock->getId();
$deprecated = array_map($mapToIds, $service->getDeprecatedLocks());

self::assertContains(
$lock->getId(),
$deprecated,
'The expired lock created by this test should be returned as deprecated.',
);
}

public function testRemoveLocks(): void {
$service = \OCP\Server::get(LockService::class);
$file = $this->loginAndGetUserFolder(self::TEST_USER1)
->newFile('test-file-remove-lock', 'AAA');
$lock = $this->lockManager->lock(
new LockContext($file, ILock::TYPE_USER, self::TEST_USER1)
);

self::assertGreaterThan(0, $lock->getId());

$service->removeLocks([$lock]);

self::assertCount(0, $this->lockManager->getLocks($file->getId()));
}

// Use expired locks to model the cron cleanup workflow:
// getDeprecatedLocks() selects stale locks and removeLocks() deletes them.
public function testRemoveDeprecatedLocks(): void {
$service = \OCP\Server::get(LockService::class);
\OCP\Server::get(IConfig::class)->setAppValue(Application::APP_ID, ConfigLexicon::LOCK_TIMEOUT, 30);
$file = $this->loginAndGetUserFolder(self::TEST_USER1)->newFile('test-expired-lock-is-deprecated', 'AAA');
$file = $this->loginAndGetUserFolder(self::TEST_USER1)->newFile('test-expired-lock-remove-1', 'AAA');
$lock1 = $this->lockManager->lock(new LockContext($file, ILock::TYPE_USER, self::TEST_USER1));
$file2 = $this->loginAndGetUserFolder(self::TEST_USER1)->newFile('test-expired-lock-is-deprecated-2', 'AAA');
$file2 = $this->loginAndGetUserFolder(self::TEST_USER1)->newFile('test-expired-lock-remove-2', 'AAA');
$lock2 = $this->lockManager->lock(new LockContext($file2, ILock::TYPE_USER, self::TEST_USER1));
$this->toTheFuture(3600);
$mapToTokens = fn (ILock $lock): string => $lock->getToken();
$deprecated = array_map($mapToTokens, $service->getDeprecatedLocks());
$this->toTheFuture(30 * 60 + 1);
$mapToIds = fn (ILock $lock): int => $lock->getId();
$deprecated = array_map($mapToIds, $service->getDeprecatedLocks());

self::assertContains($lock1->getToken(), $deprecated);
self::assertContains($lock2->getToken(), $deprecated);
self::assertContains($lock1->getId(), $deprecated);
self::assertContains($lock2->getId(), $deprecated);

$service->removeLocks([$lock1, $lock2]);
$deprecated = array_map($mapToTokens, $service->getDeprecatedLocks());
$deprecated = array_map($mapToIds, $service->getDeprecatedLocks());

self::assertNotContains($lock1->getToken(), $deprecated);
self::assertNotContains($lock2->getToken(), $deprecated);
self::assertNotContains($lock1->getId(), $deprecated);
self::assertNotContains($lock2->getId(), $deprecated);
}

public function testLockUserInfinite(): void {
Expand Down Expand Up @@ -377,7 +402,7 @@ public function testExtendLock(): void {
\OCP\Server::get(IConfig::class)->setAppValue(Application::APP_ID, ConfigLexicon::LOCK_TIMEOUT, 15);

// Create a file and lock it
$file = $this->loginAndGetUserFolder(self::TEST_USER1)->newFile('test-file', 'AAA');
$file = $this->loginAndGetUserFolder(self::TEST_USER1)->newFile('test-file-extend', 'AAA');
$this->lockManager->lock(new LockContext($file, ILock::TYPE_USER, self::TEST_USER1));
$locks = $this->lockManager->getLocks($file->getId());

Expand Down Expand Up @@ -409,7 +434,7 @@ public function testExtendInfiniteLock(): void {
\OCP\Server::get(IConfig::class)->setAppValue(Application::APP_ID, ConfigLexicon::LOCK_TIMEOUT, '0');

// Create a file and lock it
$file = $this->loginAndGetUserFolder(self::TEST_USER1)->newFile('test-file', 'AAA');
$file = $this->loginAndGetUserFolder(self::TEST_USER1)->newFile('test-file-extend-infinite', 'AAA');
$this->lockManager->lock(new LockContext($file, ILock::TYPE_USER, self::TEST_USER1));
$locks = $this->lockManager->getLocks($file->getId());

Expand All @@ -428,6 +453,20 @@ public function testExtendInfiniteLock(): void {
$this->assertEquals($id, $locks[0]->getId());
}

public function testTokenIsPersisted(): void {
$file = $this->loginAndGetUserFolder(self::TEST_USER1)
->newFile('test-file-token', 'AAA');
$lock = $this->lockManager->lock(
new LockContext($file, ILock::TYPE_TOKEN, self::TEST_USER1)
);

$locks = $this->lockManager->getLocks($file->getId());

self::assertCount(1, $locks);
self::assertNotSame('', $lock->getToken());
self::assertSame($lock->getToken(), $locks[0]->getToken());
}

public function testUnlockStaleClientLock(): void {
\OCP\Server::get(IConfig::class)->setAppValue(Application::APP_ID, ConfigLexicon::LOCK_TIMEOUT, '0');

Expand Down
Loading