diff options
Diffstat (limited to 'tests/lib/UtilTest.php')
| -rw-r--r-- | tests/lib/UtilTest.php | 368 |
1 files changed, 182 insertions, 186 deletions
diff --git a/tests/lib/UtilTest.php b/tests/lib/UtilTest.php index 82897cbca29..6d995be2434 100644 --- a/tests/lib/UtilTest.php +++ b/tests/lib/UtilTest.php @@ -1,4 +1,5 @@ <?php + /** * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors * SPDX-FileCopyrightText: 2016 ownCloud, Inc. @@ -8,6 +9,12 @@ namespace Test; use OC_Util; +use OCP\Files; +use OCP\IConfig; +use OCP\ISession; +use OCP\ITempManager; +use OCP\Server; +use OCP\Util; /** * Class UtilTest @@ -16,25 +23,15 @@ use OC_Util; * @group DB */ class UtilTest extends \Test\TestCase { - public function testGetVersion() { - $version = \OCP\Util::getVersion(); + public function testGetVersion(): void { + $version = Util::getVersion(); $this->assertTrue(is_array($version)); foreach ($version as $num) { $this->assertTrue(is_int($num)); } } - public function testGetVersionString() { - $version = \OC_Util::getVersionString(); - $this->assertTrue(is_string($version)); - } - - public function testGetEditionString() { - $edition = \OC_Util::getEditionString(); - $this->assertTrue(is_string($edition)); - } - - public function testSanitizeHTML() { + public function testSanitizeHTML(): void { $badArray = [ 'While it is unusual to pass an array', 'this function actually <blink>supports</blink> it.', @@ -51,29 +48,29 @@ class UtilTest extends \Test\TestCase { 'And It Even May <strong>Nest</strong>' ], ]; - $result = OC_Util::sanitizeHTML($badArray); + $result = Util::sanitizeHTML($badArray); $this->assertEquals($goodArray, $result); $badString = '<img onload="alert(1)" />'; - $result = OC_Util::sanitizeHTML($badString); + $result = Util::sanitizeHTML($badString); $this->assertEquals('<img onload="alert(1)" />', $result); $badString = "<script>alert('Hacked!');</script>"; - $result = OC_Util::sanitizeHTML($badString); + $result = Util::sanitizeHTML($badString); $this->assertEquals('<script>alert('Hacked!');</script>', $result); $goodString = 'This is a good string without HTML.'; - $result = OC_Util::sanitizeHTML($goodString); + $result = Util::sanitizeHTML($goodString); $this->assertEquals('This is a good string without HTML.', $result); } - public function testEncodePath() { + public function testEncodePath(): void { $component = '/§#@test%&^ä/-child'; - $result = OC_Util::encodePath($component); - $this->assertEquals("/%C2%A7%23%40test%25%26%5E%C3%A4/-child", $result); + $result = Util::encodePath($component); + $this->assertEquals('/%C2%A7%23%40test%25%26%5E%C3%A4/-child', $result); } - public function testIsNonUTF8Locale() { + public function testIsNonUTF8Locale(): void { // OC_Util::isNonUTF8Locale() assumes escapeshellcmd('§') returns '' with non-UTF-8 locale. $locale = setlocale(LC_CTYPE, 0); setlocale(LC_CTYPE, 'C'); @@ -85,7 +82,7 @@ class UtilTest extends \Test\TestCase { setlocale(LC_CTYPE, $locale); } - public function testFileInfoLoaded() { + public function testFileInfoLoaded(): void { $expected = function_exists('finfo_open'); $this->assertEquals($expected, \OC_Util::fileInfoLoaded()); } @@ -95,42 +92,42 @@ class UtilTest extends \Test\TestCase { * but not for default strict email verification that requires a top level domain. * So we check that with strict email verification we fallback to the default */ - public function testGetDefaultEmailAddressStrict() { - $email = \OCP\Util::getDefaultEmailAddress("no-reply"); + public function testGetDefaultEmailAddressStrict(): void { + $email = Util::getDefaultEmailAddress('no-reply'); $this->assertEquals('no-reply@localhost.localdomain', $email); } /** * If no strict email check is enabled "localhost" should validate as a valid email domain */ - public function testGetDefaultEmailAddress() { - $config = \OC::$server->getConfig(); + public function testGetDefaultEmailAddress(): void { + $config = Server::get(IConfig::class); $config->setAppValue('core', 'enforce_strict_email_check', 'no'); - $email = \OCP\Util::getDefaultEmailAddress("no-reply"); + $email = Util::getDefaultEmailAddress('no-reply'); $this->assertEquals('no-reply@localhost', $email); $config->deleteAppValue('core', 'enforce_strict_email_check'); } - public function testGetDefaultEmailAddressFromConfig() { - $config = \OC::$server->getConfig(); + public function testGetDefaultEmailAddressFromConfig(): void { + $config = Server::get(IConfig::class); $config->setSystemValue('mail_domain', 'example.com'); - $email = \OCP\Util::getDefaultEmailAddress("no-reply"); + $email = Util::getDefaultEmailAddress('no-reply'); $this->assertEquals('no-reply@example.com', $email); $config->deleteSystemValue('mail_domain'); } - public function testGetConfiguredEmailAddressFromConfig() { - $config = \OC::$server->getConfig(); + public function testGetConfiguredEmailAddressFromConfig(): void { + $config = Server::get(IConfig::class); $config->setSystemValue('mail_domain', 'example.com'); $config->setSystemValue('mail_from_address', 'owncloud'); - $email = \OCP\Util::getDefaultEmailAddress("no-reply"); + $email = Util::getDefaultEmailAddress('no-reply'); $this->assertEquals('owncloud@example.com', $email); $config->deleteSystemValue('mail_domain'); $config->deleteSystemValue('mail_from_address'); } - public function testGetInstanceIdGeneratesValidId() { - \OC::$server->getConfig()->deleteSystemValue('instanceid'); + public function testGetInstanceIdGeneratesValidId(): void { + Server::get(IConfig::class)->deleteSystemValue('instanceid'); $instanceId = OC_Util::getInstanceId(); $this->assertStringStartsWith('oc', $instanceId); $matchesRegex = preg_match('/^[a-z0-9]+$/', $instanceId); @@ -138,98 +135,40 @@ class UtilTest extends \Test\TestCase { } /** - * @dataProvider filenameValidationProvider - */ - public function testFilenameValidation($file, $valid) { - // private API - $this->assertEquals($valid, \OC_Util::isValidFileName($file)); - // public API - $this->assertEquals($valid, \OCP\Util::isValidFileName($file)); - } - - public function filenameValidationProvider() { - return [ - // valid names - ['boringname', true], - ['something.with.extension', true], - ['now with spaces', true], - ['.a', true], - ['..a', true], - ['.dotfile', true], - ['single\'quote', true], - [' spaces before', true], - ['spaces after ', true], - ['allowed chars including the crazy ones $%&_-^@!,()[]{}=;#', true], - ['汉字也能用', true], - ['und Ümläüte sind auch willkommen', true], - // disallowed names - ['', false], - [' ', false], - ['.', false], - ['..', false], - ['back\\slash', false], - ['sl/ash', false], - ['lt<lt', true], - ['gt>gt', true], - ['col:on', true], - ['double"quote', true], - ['pi|pe', true], - ['dont?ask?questions?', true], - ['super*star', true], - ['new\nline', false], - - // better disallow these to avoid unexpected trimming to have side effects - [' ..', false], - ['.. ', false], - ['. ', false], - [' .', false], - - // part files not allowed - ['.part', false], - ['notallowed.part', false], - ['neither.filepart', false], - - // part in the middle is ok - ['super movie part one.mkv', true], - ['super.movie.part.mkv', true], - ]; - } - - /** * Test needUpgrade() when the core version is increased */ - public function testNeedUpgradeCore() { - $config = \OC::$server->getConfig(); + public function testNeedUpgradeCore(): void { + $config = Server::get(IConfig::class); $oldConfigVersion = $config->getSystemValue('version', '0.0.0'); - $oldSessionVersion = \OC::$server->getSession()->get('OC_Version'); + $oldSessionVersion = Server::get(ISession::class)->get('OC_Version'); - $this->assertFalse(\OCP\Util::needUpgrade()); + $this->assertFalse(Util::needUpgrade()); $config->setSystemValue('version', '7.0.0.0'); - \OC::$server->getSession()->set('OC_Version', [7, 0, 0, 1]); - self::invokePrivate(new \OCP\Util, 'needUpgradeCache', [null]); + Server::get(ISession::class)->set('OC_Version', [7, 0, 0, 1]); + self::invokePrivate(new Util, 'needUpgradeCache', [null]); - $this->assertTrue(\OCP\Util::needUpgrade()); + $this->assertTrue(Util::needUpgrade()); $config->setSystemValue('version', $oldConfigVersion); - \OC::$server->getSession()->set('OC_Version', $oldSessionVersion); - self::invokePrivate(new \OCP\Util, 'needUpgradeCache', [null]); + Server::get(ISession::class)->set('OC_Version', $oldSessionVersion); + self::invokePrivate(new Util, 'needUpgradeCache', [null]); - $this->assertFalse(\OCP\Util::needUpgrade()); + $this->assertFalse(Util::needUpgrade()); } - public function testCheckDataDirectoryValidity() { - $dataDir = \OC::$server->getTempManager()->getTemporaryFolder(); - touch($dataDir . '/.ocdata'); + public function testCheckDataDirectoryValidity(): void { + $dataDir = Server::get(ITempManager::class)->getTemporaryFolder(); + touch($dataDir . '/.ncdata'); $errors = \OC_Util::checkDataDirectoryValidity($dataDir); $this->assertEmpty($errors); - \OCP\Files::rmdirr($dataDir); + Files::rmdirr($dataDir); - $dataDir = \OC::$server->getTempManager()->getTemporaryFolder(); + $dataDir = Server::get(ITempManager::class)->getTemporaryFolder(); // no touch $errors = \OC_Util::checkDataDirectoryValidity($dataDir); $this->assertNotEmpty($errors); - \OCP\Files::rmdirr($dataDir); + Files::rmdirr($dataDir); $errors = \OC_Util::checkDataDirectoryValidity('relative/path'); $this->assertNotEmpty($errors); @@ -238,39 +177,37 @@ class UtilTest extends \Test\TestCase { protected function setUp(): void { parent::setUp(); - \OC_Util::$scripts = []; \OC_Util::$styles = []; - self::invokePrivate(\OCP\Util::class, 'scripts', [[]]); - self::invokePrivate(\OCP\Util::class, 'scriptDeps', [[]]); + self::invokePrivate(Util::class, 'scripts', [[]]); + self::invokePrivate(Util::class, 'scriptDeps', [[]]); } protected function tearDown(): void { parent::tearDown(); - \OC_Util::$scripts = []; \OC_Util::$styles = []; - self::invokePrivate(\OCP\Util::class, 'scripts', [[]]); - self::invokePrivate(\OCP\Util::class, 'scriptDeps', [[]]); + self::invokePrivate(Util::class, 'scripts', [[]]); + self::invokePrivate(Util::class, 'scriptDeps', [[]]); } - public function testAddScript() { - \OCP\Util::addScript('first', 'myFirstJSFile'); - \OCP\Util::addScript('core', 'myFancyJSFile1'); - \OCP\Util::addScript('files', 'myFancyJSFile2', 'core'); - \OCP\Util::addScript('myApp5', 'myApp5JSFile', 'myApp2'); - \OCP\Util::addScript('myApp', 'myFancyJSFile3'); - \OCP\Util::addScript('core', 'myFancyJSFile4'); + public function testAddScript(): void { + Util::addScript('first', 'myFirstJSFile'); + Util::addScript('core', 'myFancyJSFile1'); + Util::addScript('files', 'myFancyJSFile2', 'core'); + Util::addScript('myApp5', 'myApp5JSFile', 'myApp2'); + Util::addScript('myApp', 'myFancyJSFile3'); + Util::addScript('core', 'myFancyJSFile4'); // after itself - \OCP\Util::addScript('core', 'myFancyJSFile5', 'core'); + Util::addScript('core', 'myFancyJSFile5', 'core'); // add duplicate - \OCP\Util::addScript('core', 'myFancyJSFile1'); + Util::addScript('core', 'myFancyJSFile1'); // dependency chain - \OCP\Util::addScript('myApp4', 'myApp4JSFile', 'myApp3'); - \OCP\Util::addScript('myApp3', 'myApp3JSFile', 'myApp2'); - \OCP\Util::addScript('myApp2', 'myApp2JSFile', 'myApp'); - \OCP\Util::addScript('core', 'common'); - \OCP\Util::addScript('core', 'main'); + Util::addScript('myApp4', 'myApp4JSFile', 'myApp3'); + Util::addScript('myApp3', 'myApp3JSFile', 'myApp2'); + Util::addScript('myApp2', 'myApp2JSFile', 'myApp'); + Util::addScript('core', 'common'); + Util::addScript('core', 'main'); - $scripts = \OCP\Util::getScripts(); + $scripts = Util::getScripts(); // Core should appear first $this->assertEquals( @@ -320,75 +257,58 @@ class UtilTest extends \Test\TestCase { // All scripts still there $scripts = [ - "core/js/common", - "core/js/main", - "core/js/myFancyJSFile1", - "core/js/myFancyJSFile4", - "core/js/myFancyJSFile5", - "first/l10n/en", - "first/js/myFirstJSFile", - "files/l10n/en", - "files/js/myFancyJSFile2", - "myApp/l10n/en", - "myApp/js/myFancyJSFile3", - "myApp2/l10n/en", - "myApp2/js/myApp2JSFile", - "myApp5/l10n/en", - "myApp5/js/myApp5JSFile", - "myApp3/l10n/en", - "myApp3/js/myApp3JSFile", - "myApp4/l10n/en", - "myApp4/js/myApp4JSFile", + 'core/js/common', + 'core/js/main', + 'core/js/myFancyJSFile1', + 'core/js/myFancyJSFile4', + 'core/js/myFancyJSFile5', + 'first/l10n/en', + 'first/js/myFirstJSFile', + 'files/l10n/en', + 'files/js/myFancyJSFile2', + 'myApp/l10n/en', + 'myApp/js/myFancyJSFile3', + 'myApp2/l10n/en', + 'myApp2/js/myApp2JSFile', + 'myApp5/l10n/en', + 'myApp5/js/myApp5JSFile', + 'myApp3/l10n/en', + 'myApp3/js/myApp3JSFile', + 'myApp4/l10n/en', + 'myApp4/js/myApp4JSFile', ]; foreach ($scripts as $script) { $this->assertContains($script, $scripts); } } - public function testAddScriptCircularDependency() { - \OCP\Util::addScript('circular', 'file1', 'dependency'); - \OCP\Util::addScript('dependency', 'file2', 'circular'); + public function testAddScriptCircularDependency(): void { + Util::addScript('circular', 'file1', 'dependency'); + Util::addScript('dependency', 'file2', 'circular'); - $scripts = \OCP\Util::getScripts(); + $scripts = Util::getScripts(); $this->assertContains('circular/js/file1', $scripts); $this->assertContains('dependency/js/file2', $scripts); } - public function testAddVendorScript() { - \OC_Util::addVendorScript('core', 'myFancyJSFile1'); - \OC_Util::addVendorScript('myApp', 'myFancyJSFile2'); - \OC_Util::addVendorScript('core', 'myFancyJSFile0', true); - \OC_Util::addVendorScript('core', 'myFancyJSFile10', true); - // add duplicate - \OC_Util::addVendorScript('core', 'myFancyJSFile1'); - - $this->assertEquals([ - 'core/vendor/myFancyJSFile10', - 'core/vendor/myFancyJSFile0', - 'core/vendor/myFancyJSFile1', - 'myApp/vendor/myFancyJSFile2', - ], \OC_Util::$scripts); - $this->assertEquals([], \OC_Util::$styles); - } - - public function testAddTranslations() { - \OC_Util::addTranslations('appId', 'de'); + public function testAddTranslations(): void { + Util::addTranslations('appId', 'de'); $this->assertEquals([ 'appId/l10n/de' - ], \OC_Util::$scripts); + ], Util::getScripts()); $this->assertEquals([], \OC_Util::$styles); } - public function testAddStyle() { - \OC_Util::addStyle('core', 'myFancyCSSFile1'); - \OC_Util::addStyle('myApp', 'myFancyCSSFile2'); - \OC_Util::addStyle('core', 'myFancyCSSFile0', true); - \OC_Util::addStyle('core', 'myFancyCSSFile10', true); + public function testAddStyle(): void { + Util::addStyle('core', 'myFancyCSSFile1'); + Util::addStyle('myApp', 'myFancyCSSFile2'); + Util::addStyle('core', 'myFancyCSSFile0', true); + Util::addStyle('core', 'myFancyCSSFile10', true); // add duplicate - \OC_Util::addStyle('core', 'myFancyCSSFile1'); + Util::addStyle('core', 'myFancyCSSFile1'); - $this->assertEquals([], \OC_Util::$scripts); + $this->assertEquals([], Util::getScripts()); $this->assertEquals([ 'core/css/myFancyCSSFile10', 'core/css/myFancyCSSFile0', @@ -397,7 +317,7 @@ class UtilTest extends \Test\TestCase { ], \OC_Util::$styles); } - public function testAddVendorStyle() { + public function testAddVendorStyle(): void { \OC_Util::addVendorStyle('core', 'myFancyCSSFile1'); \OC_Util::addVendorStyle('myApp', 'myFancyCSSFile2'); \OC_Util::addVendorStyle('core', 'myFancyCSSFile0', true); @@ -405,7 +325,7 @@ class UtilTest extends \Test\TestCase { // add duplicate \OC_Util::addVendorStyle('core', 'myFancyCSSFile1'); - $this->assertEquals([], \OC_Util::$scripts); + $this->assertEquals([], Util::getScripts()); $this->assertEquals([ 'core/vendor/myFancyCSSFile10', 'core/vendor/myFancyCSSFile0', @@ -414,10 +334,86 @@ class UtilTest extends \Test\TestCase { ], \OC_Util::$styles); } - public function testShortenMultibyteString() { - $this->assertEquals('Short nuff', \OCP\Util::shortenMultibyteString('Short nuff', 255)); - $this->assertEquals('ABC', \OCP\Util::shortenMultibyteString('ABCDEF', 3)); + public function testShortenMultibyteString(): void { + $this->assertEquals('Short nuff', Util::shortenMultibyteString('Short nuff', 255)); + $this->assertEquals('ABC', Util::shortenMultibyteString('ABCDEF', 3)); // each of the characters is 12 bytes - $this->assertEquals('🙈', \OCP\Util::shortenMultibyteString('🙈🙊🙉', 16, 2)); + $this->assertEquals('🙈', Util::shortenMultibyteString('🙈🙊🙉', 16, 2)); + } + + #[\PHPUnit\Framework\Attributes\DataProvider('humanFileSizeProvider')] + public function testHumanFileSize($expected, $input): void { + $result = Util::humanFileSize($input); + $this->assertEquals($expected, $result); + } + + public static function humanFileSizeProvider(): array { + return [ + ['0 B', 0], + ['1 KB', 1024], + ['9.5 MB', 10000000], + ['1.3 GB', 1395864371], + ['465.7 GB', 500000000000], + ['454.7 TB', 500000000000000], + ['444.1 PB', 500000000000000000], + ]; + } + + #[\PHPUnit\Framework\Attributes\DataProvider('providesComputerFileSize')] + public function testComputerFileSize($expected, $input): void { + $result = Util::computerFileSize($input); + $this->assertEquals($expected, $result); + } + + public static function providesComputerFileSize(): array { + return [ + [0.0, '0 B'], + [1024.0, '1 KB'], + [1395864371.0, '1.3 GB'], + [9961472.0, '9.5 MB'], + [500041567437.0, '465.7 GB'], + [false, '12 GB etfrhzui'] + ]; + } + + public function testMb_array_change_key_case(): void { + $arrayStart = [ + 'Foo' => 'bar', + 'Bar' => 'foo', + ]; + $arrayResult = [ + 'foo' => 'bar', + 'bar' => 'foo', + ]; + $result = Util::mb_array_change_key_case($arrayStart); + $expected = $arrayResult; + $this->assertEquals($result, $expected); + + $arrayStart = [ + 'foo' => 'bar', + 'bar' => 'foo', + ]; + $arrayResult = [ + 'FOO' => 'bar', + 'BAR' => 'foo', + ]; + $result = Util::mb_array_change_key_case($arrayStart, MB_CASE_UPPER); + $expected = $arrayResult; + $this->assertEquals($result, $expected); } + + public function testRecursiveArraySearch(): void { + $haystack = [ + 'Foo' => 'own', + 'Bar' => 'Cloud', + ]; + + $result = Util::recursiveArraySearch($haystack, 'own'); + $expected = 'Foo'; + $this->assertEquals($result, $expected); + + $result = Util::recursiveArraySearch($haystack, 'NotFound'); + $this->assertFalse($result); + } + } |