1 files changed, 254 insertions, 0 deletions
diff --git a/tests/lib/HelperStorageTest.php b/tests/lib/HelperStorageTest.php
new file mode 100644
index 00000000000..140be04ec64
--- /dev/null
+++ b/tests/lib/HelperStorageTest.php
@@ -0,0 +1,254 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace Test;
+
+use OC\Files\Filesystem;
+use OC\Files\Storage\Storage;
+use OC\Files\Storage\Temporary;
+use OC\Files\Storage\Wrapper\Quota;
+use OCP\Files\Mount\IMountManager;
+use OCP\IConfig;
+use OCP\Server;
+use Test\Traits\UserTrait;
+
+/**
+ * Test the storage functions of OC_Helper
+ *
+ * @group DB
+ */
+class HelperStorageTest extends \Test\TestCase {
+	use UserTrait;
+
+	/** @var string */
+	private $user;
+	/** @var Storage */
+	private $storageMock;
+	/** @var Storage */
+	private $storage;
+	private bool $savedQuotaIncludeExternalStorage;
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		$this->user = $this->getUniqueID('user_');
+		$this->createUser($this->user, $this->user);
+		$this->savedQuotaIncludeExternalStorage = $this->getIncludeExternalStorage();
+
+		Filesystem::tearDown();
+		\OC_User::setUserId($this->user);
+		Filesystem::init($this->user, '/' . $this->user . '/files');
+
+		/** @var IMountManager $manager */
+		$manager = Server::get(IMountManager::class);
+		$manager->removeMount('/' . $this->user);
+
+		$this->storageMock = null;
+	}
+
+	protected function tearDown(): void {
+		$this->setIncludeExternalStorage($this->savedQuotaIncludeExternalStorage);
+		$this->user = null;
+
+		if ($this->storageMock) {
+			$this->storageMock->getCache()->clear();
+			$this->storageMock = null;
+		}
+		Filesystem::tearDown();
+
+		\OC_User::setUserId('');
+		Server::get(IConfig::class)->deleteAllUserValues($this->user);
+
+		parent::tearDown();
+	}
+
+	/**
+	 * Returns a storage mock that returns the given value as
+	 * free space
+	 *
+	 * @param int $freeSpace free space value
+	 * @return Storage
+	 */
+	private function getStorageMock($freeSpace = 12) {
+		$this->storageMock = $this->getMockBuilder(Temporary::class)
+			->onlyMethods(['free_space'])
+			->setConstructorArgs([[]])
+			->getMock();
+
+		$this->storageMock->expects($this->once())
+			->method('free_space')
+			->willReturn($freeSpace);
+		return $this->storageMock;
+	}
+
+	/**
+	 * Test getting the storage info
+	 */
+	public function testGetStorageInfo(): void {
+		$homeStorage = $this->getStorageMock(12);
+		Filesystem::mount($homeStorage, [], '/' . $this->user . '/files');
+		$homeStorage->file_put_contents('test.txt', '01234');
+
+		$storageInfo = \OC_Helper::getStorageInfo('');
+		$this->assertEquals(12, $storageInfo['free']);
+		$this->assertEquals(5, $storageInfo['used']);
+		$this->assertEquals(17, $storageInfo['total']);
+	}
+
+	private function getIncludeExternalStorage(): bool {
+		$class = new \ReflectionClass(\OC_Helper::class);
+		$prop = $class->getProperty('quotaIncludeExternalStorage');
+		$prop->setAccessible(true);
+		return $prop->getValue(null) ?? false;
+	}
+
+	private function setIncludeExternalStorage(bool $include) {
+		$class = new \ReflectionClass(\OC_Helper::class);
+		$prop = $class->getProperty('quotaIncludeExternalStorage');
+		$prop->setAccessible(true);
+		$prop->setValue(null, $include);
+	}
+
+	/**
+	 * Test getting the storage info, ignoring extra mount points
+	 */
+	public function testGetStorageInfoExcludingExtStorage(): void {
+		$homeStorage = $this->getStorageMock(12);
+		Filesystem::mount($homeStorage, [], '/' . $this->user . '/files');
+		$homeStorage->file_put_contents('test.txt', '01234');
+
+		$extStorage = new Temporary([]);
+		$extStorage->file_put_contents('extfile.txt', 'abcdefghijklmnopq');
+		$extStorage->getScanner()->scan(''); // update root size
+
+		$this->setIncludeExternalStorage(false);
+
+		Filesystem::mount($extStorage, [], '/' . $this->user . '/files/ext');
+
+		$storageInfo = \OC_Helper::getStorageInfo('');
+		$this->assertEquals(12, $storageInfo['free']);
+		$this->assertEquals(5, $storageInfo['used']);
+		$this->assertEquals(17, $storageInfo['total']);
+	}
+
+	/**
+	 * Test getting the storage info, including extra mount points
+	 */
+	public function testGetStorageInfoIncludingExtStorage(): void {
+		$homeStorage = new Temporary([]);
+		Filesystem::mount($homeStorage, [], '/' . $this->user . '/files');
+		$homeStorage->file_put_contents('test.txt', '01234');
+
+		$extStorage = new Temporary([]);
+		$extStorage->file_put_contents('extfile.txt', 'abcdefghijklmnopq');
+		$extStorage->getScanner()->scan(''); // update root size
+
+		Filesystem::mount($extStorage, [], '/' . $this->user . '/files/ext');
+
+		$this->setIncludeExternalStorage(true);
+
+		$config = Server::get(IConfig::class);
+		$config->setUserValue($this->user, 'files', 'quota', '25');
+
+		$storageInfo = \OC_Helper::getStorageInfo('');
+		$this->assertEquals(3, $storageInfo['free']);
+		$this->assertEquals(22, $storageInfo['used']);
+		$this->assertEquals(25, $storageInfo['total']);
+
+		$config->setUserValue($this->user, 'files', 'quota', 'default');
+	}
+
+	/**
+	 * Test getting the storage info excluding extra mount points
+	 * when user has no quota set, even when quota ext storage option
+	 * was set
+	 */
+	public function testGetStorageInfoIncludingExtStorageWithNoUserQuota(): void {
+		$homeStorage = $this->getStorageMock(12);
+		Filesystem::mount($homeStorage, [], '/' . $this->user . '/files');
+		$homeStorage->file_put_contents('test.txt', '01234');
+
+		$extStorage = new Temporary([]);
+		$extStorage->file_put_contents('extfile.txt', 'abcdefghijklmnopq');
+		$extStorage->getScanner()->scan(''); // update root size
+
+		Filesystem::mount($extStorage, [], '/' . $this->user . '/files/ext');
+
+		$config = Server::get(IConfig::class);
+		$this->setIncludeExternalStorage(true);
+
+		$storageInfo = \OC_Helper::getStorageInfo('');
+		$this->assertEquals(12, $storageInfo['free'], '12 bytes free in home storage');
+		$this->assertEquals(22, $storageInfo['used'], '5 bytes of home storage and 17 bytes of the temporary storage are used');
+		$this->assertEquals(34, $storageInfo['total'], '5 bytes used and 12 bytes free in home storage as well as 17 bytes used in temporary storage');
+	}
+
+
+	/**
+	 * Test getting the storage info with quota enabled
+	 */
+	public function testGetStorageInfoWithQuota(): void {
+		$homeStorage = $this->getStorageMock(12);
+		$homeStorage->file_put_contents('test.txt', '01234');
+		$homeStorage = new Quota(
+			[
+				'storage' => $homeStorage,
+				'quota' => 7
+			]
+		);
+		Filesystem::mount($homeStorage, [], '/' . $this->user . '/files');
+
+		$storageInfo = \OC_Helper::getStorageInfo('');
+		$this->assertEquals(2, $storageInfo['free']);
+		$this->assertEquals(5, $storageInfo['used']);
+		$this->assertEquals(7, $storageInfo['total']);
+	}
+
+	/**
+	 * Test getting the storage info when data exceeds quota
+	 */
+	public function testGetStorageInfoWhenSizeExceedsQuota(): void {
+		$homeStorage = $this->getStorageMock(12);
+		$homeStorage->file_put_contents('test.txt', '0123456789');
+		$homeStorage = new Quota(
+			[
+				'storage' => $homeStorage,
+				'quota' => 7
+			]
+		);
+		Filesystem::mount($homeStorage, [], '/' . $this->user . '/files');
+
+		$storageInfo = \OC_Helper::getStorageInfo('');
+		$this->assertEquals(0, $storageInfo['free']);
+		$this->assertEquals(10, $storageInfo['used']);
+		// total = quota
+		$this->assertEquals(7, $storageInfo['total']);
+	}
+
+	/**
+	 * Test getting the storage info when the remaining
+	 * free storage space is less than the quota
+	 */
+	public function testGetStorageInfoWhenFreeSpaceLessThanQuota(): void {
+		$homeStorage = $this->getStorageMock(12);
+		$homeStorage->file_put_contents('test.txt', '01234');
+		$homeStorage = new Quota(
+			[
+				'storage' => $homeStorage,
+				'quota' => 18
+			]
+		);
+		Filesystem::mount($homeStorage, [], '/' . $this->user . '/files');
+
+		$storageInfo = \OC_Helper::getStorageInfo('');
+		$this->assertEquals(12, $storageInfo['free']);
+		$this->assertEquals(5, $storageInfo['used']);
+		// total = free + used (because quota > total)
+		$this->assertEquals(17, $storageInfo['total']);
+	}
+}