123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778 |
- <?php
- declare(strict_types=1);
- namespace Test\L10N;
- use OC\L10N\Factory;
- use OC\L10N\LanguageNotFoundException;
- use OCP\App\AppPathNotFoundException;
- use OCP\App\IAppManager;
- use OCP\ICacheFactory;
- use OCP\IConfig;
- use OCP\IRequest;
- use OCP\IUser;
- use OCP\IUserSession;
- use OCP\L10N\ILanguageIterator;
- use PHPUnit\Framework\MockObject\MockObject;
- use Test\TestCase;
- class FactoryTest extends TestCase {
-
- protected $config;
-
- protected $request;
-
- protected $userSession;
-
- protected $cacheFactory;
-
- protected $serverRoot;
-
- protected IAppManager $appManager;
- protected function setUp(): void {
- parent::setUp();
- $this->config = $this->createMock(IConfig::class);
- $this->request = $this->createMock(IRequest::class);
- $this->userSession = $this->createMock(IUserSession::class);
- $this->cacheFactory = $this->createMock(ICacheFactory::class);
- $this->appManager = $this->createMock(IAppManager::class);
- $this->serverRoot = \OC::$SERVERROOT;
- $this->config
- ->method('getSystemValueBool')
- ->willReturnMap([
- ['installed', false, true],
- ]);
- }
-
- protected function getFactory(array $methods = [], $mockRequestGetHeaderMethod = false) {
- if ($mockRequestGetHeaderMethod) {
- $this->request->expects(self::any())
- ->method('getHeader')
- ->willReturn('');
- }
- if (!empty($methods)) {
- return $this->getMockBuilder(Factory::class)
- ->setConstructorArgs([
- $this->config,
- $this->request,
- $this->userSession,
- $this->cacheFactory,
- $this->serverRoot,
- $this->appManager,
- ])
- ->setMethods($methods)
- ->getMock();
- }
- return new Factory($this->config, $this->request, $this->userSession, $this->cacheFactory, $this->serverRoot, $this->appManager);
- }
- public function dataFindAvailableLanguages(): array {
- return [
- [null],
- ['files'],
- ];
- }
- public function testFindLanguageWithExistingRequestLanguageAndNoApp(): void {
- $factory = $this->getFactory(['languageExists']);
- $this->invokePrivate($factory, 'requestLanguage', ['de']);
- $factory->expects(self::once())
- ->method('languageExists')
- ->with(null, 'de')
- ->willReturn(true);
- self::assertSame('de', $factory->findLanguage());
- }
- public function testFindLanguageWithExistingRequestLanguageAndApp(): void {
- $factory = $this->getFactory(['languageExists']);
- $this->invokePrivate($factory, 'requestLanguage', ['de']);
- $factory->expects(self::once())
- ->method('languageExists')
- ->with('MyApp', 'de')
- ->willReturn(true);
- self::assertSame('de', $factory->findLanguage('MyApp'));
- }
- public function testFindLanguageWithNotExistingRequestLanguageAndExistingStoredUserLanguage(): void {
- $factory = $this->getFactory(['languageExists']);
- $this->invokePrivate($factory, 'requestLanguage', ['de']);
- $factory->expects($this->exactly(2))
- ->method('languageExists')
- ->withConsecutive(
- ['MyApp', 'de'],
- ['MyApp', 'jp'],
- )
- ->willReturnOnConsecutiveCalls(
- false,
- true,
- );
- $this->config
- ->expects($this->exactly(1))
- ->method('getSystemValue')
- ->withConsecutive(
- ['force_language', false],
- )->willReturnOnConsecutiveCalls(
- false,
- );
- $user = $this->getMockBuilder(IUser::class)
- ->getMock();
- $user->expects(self::once())
- ->method('getUID')
- ->willReturn('MyUserUid');
- $this->userSession
- ->expects(self::exactly(2))
- ->method('getUser')
- ->willReturn($user);
- $this->config
- ->expects(self::once())
- ->method('getUserValue')
- ->with('MyUserUid', 'core', 'lang', null)
- ->willReturn('jp');
- self::assertSame('jp', $factory->findLanguage('MyApp'));
- }
- public function testFindLanguageWithNotExistingRequestLanguageAndNotExistingStoredUserLanguage(): void {
- $factory = $this->getFactory(['languageExists'], true);
- $this->invokePrivate($factory, 'requestLanguage', ['de']);
- $factory->expects($this->exactly(3))
- ->method('languageExists')
- ->willReturnMap([
- ['MyApp', 'de', false],
- ['MyApp', 'jp', false],
- ['MyApp', 'es', true],
- ]);
- $this->config
- ->expects($this->exactly(2))
- ->method('getSystemValue')
- ->willReturnMap([
- ['force_language', false, false],
- ['default_language', false, 'es']
- ]);
- $user = $this->getMockBuilder(IUser::class)
- ->getMock();
- $user->expects(self::once())
- ->method('getUID')
- ->willReturn('MyUserUid');
- $this->userSession
- ->expects(self::exactly(2))
- ->method('getUser')
- ->willReturn($user);
- $this->config
- ->expects(self::once())
- ->method('getUserValue')
- ->with('MyUserUid', 'core', 'lang', null)
- ->willReturn('jp');
- self::assertSame('es', $factory->findLanguage('MyApp'));
- }
- public function testFindLanguageWithNotExistingRequestLanguageAndNotExistingStoredUserLanguageAndNotExistingDefault(): void {
- $factory = $this->getFactory(['languageExists'], true);
- $this->invokePrivate($factory, 'requestLanguage', ['de']);
- $factory->expects($this->exactly(3))
- ->method('languageExists')
- ->willReturnMap([
- ['MyApp', 'de', false],
- ['MyApp', 'jp', false],
- ['MyApp', 'es', false],
- ]);
- $this->config
- ->expects($this->exactly(2))
- ->method('getSystemValue')
- ->willReturnMap([
- ['force_language', false, false],
- ['default_language', false, 'es']
- ]);
- $user = $this->getMockBuilder(IUser::class)
- ->getMock();
- $user->expects(self::once())
- ->method('getUID')
- ->willReturn('MyUserUid');
- $this->userSession
- ->expects(self::exactly(2))
- ->method('getUser')
- ->willReturn($user);
- $this->config
- ->expects(self::once())
- ->method('getUserValue')
- ->with('MyUserUid', 'core', 'lang', null)
- ->willReturn('jp');
- $this->config
- ->expects(self::never())
- ->method('setUserValue');
- self::assertSame('en', $factory->findLanguage('MyApp'));
- }
- public function testFindLanguageWithNotExistingRequestLanguageAndNotExistingStoredUserLanguageAndNotExistingDefaultAndNoAppInScope(): void {
- $factory = $this->getFactory(['languageExists'], true);
- $this->invokePrivate($factory, 'requestLanguage', ['de']);
- $factory->expects($this->exactly(3))
- ->method('languageExists')
- ->willReturnMap([
- ['MyApp', 'de', false],
- ['MyApp', 'jp', false],
- ['MyApp', 'es', false],
- ]);
- $this->config
- ->expects($this->exactly(2))
- ->method('getSystemValue')
- ->willReturnMap([
- ['force_language', false, false],
- ['default_language', false, 'es']
- ]);
- $user = $this->getMockBuilder(IUser::class)
- ->getMock();
- $user->expects(self::once())
- ->method('getUID')
- ->willReturn('MyUserUid');
- $this->userSession
- ->expects(self::exactly(2))
- ->method('getUser')
- ->willReturn($user);
- $this->config
- ->expects(self::once())
- ->method('getUserValue')
- ->with('MyUserUid', 'core', 'lang', null)
- ->willReturn('jp');
- $this->config
- ->expects(self::never())
- ->method('setUserValue')
- ->with('MyUserUid', 'core', 'lang', 'en');
- self::assertSame('en', $factory->findLanguage('MyApp'));
- }
- public function testFindLanguageWithForcedLanguage(): void {
- $factory = $this->getFactory(['languageExists']);
- $this->config
- ->expects($this->once())
- ->method('getSystemValue')
- ->with('force_language', false)
- ->willReturn('de');
- $factory->expects($this->once())
- ->method('languageExists')
- ->with('MyApp', 'de')
- ->willReturn(true);
- self::assertSame('de', $factory->findLanguage('MyApp'));
- }
-
- public function testFindAvailableLanguages($app): void {
- $factory = $this->getFactory(['findL10nDir']);
- $factory->expects(self::once())
- ->method('findL10nDir')
- ->with($app)
- ->willReturn(\OC::$SERVERROOT . '/tests/data/l10n/');
- self::assertEqualsCanonicalizing(['cs', 'de', 'en', 'ru'], $factory->findAvailableLanguages($app));
- }
- public function dataLanguageExists(): array {
- return [
- [null, 'en', [], true],
- [null, 'de', [], false],
- [null, 'de', ['ru'], false],
- [null, 'de', ['ru', 'de'], true],
- ['files', 'en', [], true],
- ['files', 'de', [], false],
- ['files', 'de', ['ru'], false],
- ['files', 'de', ['de', 'ru'], true],
- ];
- }
- public function testFindAvailableLanguagesWithThemes(): void {
- $this->serverRoot .= '/tests/data';
- $app = 'files';
- $factory = $this->getFactory(['findL10nDir']);
- $factory->expects(self::once())
- ->method('findL10nDir')
- ->with($app)
- ->willReturn($this->serverRoot . '/apps/files/l10n/');
- $this->config
- ->expects(self::once())
- ->method('getSystemValueString')
- ->with('theme')
- ->willReturn('abc');
- self::assertEqualsCanonicalizing(['en', 'zz'], $factory->findAvailableLanguages($app));
- }
-
- public function testLanguageExists($app, $lang, array $availableLanguages, $expected): void {
- $factory = $this->getFactory(['findAvailableLanguages']);
- $factory->expects(($lang === 'en') ? self::never() : self::once())
- ->method('findAvailableLanguages')
- ->with($app)
- ->willReturn($availableLanguages);
- self::assertSame($expected, $factory->languageExists($app, $lang));
- }
- public function dataSetLanguageFromRequest(): array {
- return [
-
- [null, 'de', ['de'], 'de'],
- [null, 'de,en', ['de'], 'de'],
- [null, 'de-DE,en-US;q=0.8,en;q=0.6', ['de'], 'de'],
-
- [null, 'de', ['ru'], new LanguageNotFoundException()],
- [null, 'de,en', ['ru', 'en'], 'en'],
- [null, 'de-DE,en-US;q=0.8,en;q=0.6', ['ru', 'en'], 'en'],
-
- ['files_pdfviewer', 'de', ['de'], 'de'],
- ['files_pdfviewer', 'de,en', ['de'], 'de'],
- ['files_pdfviewer', 'de-DE,en-US;q=0.8,en;q=0.6', ['de'], 'de'],
-
- ['files_pdfviewer', 'de', ['ru'], new LanguageNotFoundException()],
- ['files_pdfviewer', 'de,en', ['ru', 'en'], 'en'],
- ['files_pdfviewer', 'de-DE,en-US;q=0.8,en;q=0.6', ['ru', 'en'], 'en'],
- ];
- }
-
- public function testGetLanguageFromRequest($app, $header, array $availableLanguages, $expected): void {
- $factory = $this->getFactory(['findAvailableLanguages', 'respectDefaultLanguage']);
- $factory->expects(self::once())
- ->method('findAvailableLanguages')
- ->with($app)
- ->willReturn($availableLanguages);
- $factory->expects(self::any())
- ->method('respectDefaultLanguage')->willReturnCallback(function ($app, $lang) {
- return $lang;
- });
- $this->request->expects(self::once())
- ->method('getHeader')
- ->with('ACCEPT_LANGUAGE')
- ->willReturn($header);
- if ($expected instanceof LanguageNotFoundException) {
- $this->expectException(LanguageNotFoundException::class);
- self::invokePrivate($factory, 'getLanguageFromRequest', [$app]);
- } else {
- self::assertSame($expected, self::invokePrivate($factory, 'getLanguageFromRequest', [$app]), 'Asserting returned language');
- }
- }
- public function dataGetL10nFilesForApp(): array {
- return [
- ['', 'de', [\OC::$SERVERROOT . '/core/l10n/de.json']],
- ['core', 'ru', [\OC::$SERVERROOT . '/core/l10n/ru.json']],
- ['lib', 'ru', [\OC::$SERVERROOT . '/lib/l10n/ru.json']],
- ['settings', 'de', [\OC::$SERVERROOT . '/apps/settings/l10n/de.json']],
- ['files', 'de', [\OC::$SERVERROOT . '/apps/files/l10n/de.json']],
- ['files', '_lang_never_exists_', []],
- ['_app_never_exists_', 'de', [\OC::$SERVERROOT . '/core/l10n/de.json']],
- ];
- }
-
- public function testGetL10nFilesForApp($app, $lang, $expected): void {
- $factory = $this->getFactory();
- if (in_array($app, ['settings','files'])) {
- $this->appManager
- ->method('getAppPath')
- ->with($app)
- ->willReturn(\OC::$SERVERROOT . '/apps/' . $app);
- } else {
- $this->appManager
- ->method('getAppPath')
- ->with($app)
- ->willThrowException(new AppPathNotFoundException());
- }
- self::assertSame($expected, $this->invokePrivate($factory, 'getL10nFilesForApp', [$app, $lang]));
- }
- public function dataFindL10NDir(): array {
- return [
- ['', \OC::$SERVERROOT . '/core/l10n/'],
- ['core', \OC::$SERVERROOT . '/core/l10n/'],
- ['lib', \OC::$SERVERROOT . '/lib/l10n/'],
- ['settings', \OC::$SERVERROOT . '/apps/settings/l10n/'],
- ['files', \OC::$SERVERROOT . '/apps/files/l10n/'],
- ['_app_never_exists_', \OC::$SERVERROOT . '/core/l10n/'],
- ];
- }
-
- public function testFindL10NDir($app, $expected): void {
- $factory = $this->getFactory();
- if (in_array($app, ['settings','files'])) {
- $this->appManager
- ->method('getAppPath')
- ->with($app)
- ->willReturn(\OC::$SERVERROOT . '/apps/' . $app);
- } else {
- $this->appManager
- ->method('getAppPath')
- ->with($app)
- ->willThrowException(new AppPathNotFoundException());
- }
- self::assertSame($expected, $this->invokePrivate($factory, 'findL10nDir', [$app]));
- }
- public function dataFindLanguage(): array {
- return [
-
- [false, [], 'en'],
- [false, ['fr'], 'fr'],
- [false, ['de', 'fr'], 'de'],
- [false, ['nl', 'de', 'fr'], 'de'],
- [true, [], 'en'],
- [true, ['fr'], 'fr'],
- [true, ['de', 'fr'], 'de'],
- [true, ['nl', 'de', 'fr'], 'nl'],
- ];
- }
-
- public function testFindLanguage($loggedIn, $availableLang, $expected): void {
- $userLang = 'nl';
- $browserLang = 'de';
- $defaultLang = 'fr';
- $this->config->expects(self::any())
- ->method('getSystemValue')
- ->willReturnCallback(function ($var, $default) use ($defaultLang) {
- if ($var === 'default_language') {
- return $defaultLang;
- } else {
- return $default;
- }
- });
- if ($loggedIn) {
- $user = $this->getMockBuilder(IUser::class)
- ->getMock();
- $user->expects(self::any())
- ->method('getUID')
- ->willReturn('MyUserUid');
- $this->userSession
- ->expects(self::any())
- ->method('getUser')
- ->willReturn($user);
- $this->config->expects(self::any())
- ->method('getUserValue')
- ->with('MyUserUid', 'core', 'lang', null)
- ->willReturn($userLang);
- } else {
- $this->userSession
- ->expects(self::any())
- ->method('getUser')
- ->willReturn(null);
- }
- $this->request->expects(self::any())
- ->method('getHeader')
- ->with($this->equalTo('ACCEPT_LANGUAGE'))
- ->willReturn($browserLang);
- $factory = $this->getFactory(['languageExists', 'findAvailableLanguages', 'respectDefaultLanguage']);
- $factory->expects(self::any())
- ->method('languageExists')
- ->willReturnCallback(function ($app, $lang) use ($availableLang) {
- return in_array($lang, $availableLang);
- });
- $factory->expects(self::any())
- ->method('findAvailableLanguages')
- ->willReturnCallback(function ($app) use ($availableLang) {
- return $availableLang;
- });
- $factory->expects(self::any())
- ->method('respectDefaultLanguage')->willReturnCallback(function ($app, $lang) {
- return $lang;
- });
- $lang = $factory->findLanguage();
- self::assertSame($expected, $lang);
- }
- public function testFindGenericLanguageByEnforcedLanguage(): void {
- $factory = $this->getFactory();
- $this->config->expects(self::once())
- ->method('getSystemValue')
- ->with('force_language', false)
- ->willReturn('cz');
- $lang = $factory->findGenericLanguage();
- self::assertSame('cz', $lang);
- }
- public function testFindGenericLanguageByDefaultLanguage(): void {
- $factory = $this->getFactory(['languageExists']);
- $this->config->expects(self::exactly(2))
- ->method('getSystemValue')
- ->willReturnMap([
- ['force_language', false, false,],
- ['default_language', false, 'cz',],
- ]);
- $factory->expects(self::once())
- ->method('languageExists')
- ->with(null, 'cz')
- ->willReturn(true);
- $lang = $factory->findGenericLanguage();
- self::assertSame('cz', $lang);
- }
- public function testFindGenericLanguageByUserLanguage(): void {
- $factory = $this->getFactory();
- $this->config->expects(self::exactly(2))
- ->method('getSystemValue')
- ->willReturnMap([
- ['force_language', false, false,],
- ['default_language', false, false,],
- ]);
- $user = $this->createMock(IUser::class);
- $this->userSession->expects(self::once())
- ->method('getUser')
- ->willReturn($user);
- $user->method('getUID')->willReturn('user123');
- $this->config->expects(self::once())
- ->method('getUserValue')
- ->with('user123', 'core', 'lang', null)
- ->willReturn('cz');
- $lang = $factory->findGenericLanguage();
- self::assertSame('cz', $lang);
- }
- public function testFindGenericLanguageByRequestLanguage(): void {
- $factory = $this->getFactory(['findAvailableLanguages', 'languageExists']);
- $this->config->method('getSystemValue')
- ->willReturnMap([
- ['force_language', false, false,],
- ['default_language', false, false,],
- ]);
- $user = $this->createMock(IUser::class);
- $this->userSession->expects(self::once())
- ->method('getUser')
- ->willReturn($user);
- $user->method('getUID')->willReturn('user123');
- $this->config->expects(self::once())
- ->method('getUserValue')
- ->with('user123', 'core', 'lang', null)
- ->willReturn(null);
- $this->request->expects(self::once())
- ->method('getHeader')
- ->with('ACCEPT_LANGUAGE')
- ->willReturn('cz');
- $factory->expects(self::once())
- ->method('findAvailableLanguages')
- ->with(null)
- ->willReturn(['cz']);
- $lang = $factory->findGenericLanguage();
- self::assertSame('cz', $lang);
- }
- public function testFindGenericLanguageFallback(): void {
- $factory = $this->getFactory(['findAvailableLanguages', 'languageExists']);
- $this->config->method('getSystemValue')
- ->willReturnMap([
- ['force_language', false, false,],
- ['default_language', false, false,],
- ]);
- $user = $this->createMock(IUser::class);
- $this->userSession->expects(self::once())
- ->method('getUser')
- ->willReturn($user);
- $user->method('getUID')->willReturn('user123');
- $this->config->expects(self::once())
- ->method('getUserValue')
- ->with('user123', 'core', 'lang', null)
- ->willReturn(null);
- $this->request->expects(self::once())
- ->method('getHeader')
- ->with('ACCEPT_LANGUAGE')
- ->willReturn('');
- $factory->expects(self::never())
- ->method('findAvailableLanguages');
- $factory->expects(self::never())
- ->method('languageExists');
- $lang = $factory->findGenericLanguage();
- self::assertSame('en', $lang);
- }
- public function dataTestRespectDefaultLanguage(): array {
- return [
- ['de', 'de_DE', true, 'de_DE'],
- ['de', 'de', true, 'de'],
- ['de', false, true, 'de'],
- ['fr', 'de_DE', true, 'fr'],
- ];
- }
-
- public function testRespectDefaultLanguage($lang, $defaultLanguage, $langExists, $expected): void {
- $factory = $this->getFactory(['languageExists']);
- $factory->expects(self::any())
- ->method('languageExists')->willReturn($langExists);
- $this->config->expects(self::any())
- ->method('getSystemValue')->with('default_language', false)->willReturn($defaultLanguage);
- $result = $this->invokePrivate($factory, 'respectDefaultLanguage', ['app', $lang]);
- self::assertSame($expected, $result);
- }
- public static function dataTestReduceToLanguages(): array {
- return [
- ['en', ['en', 'de', 'fr', 'it', 'es'], ['en', 'fr', 'de'], ['en', 'fr', 'de']],
- ['en', ['en', 'de', 'fr', 'it', 'es'], ['en', 'de'], ['en', 'de']],
- ['en', ['en', 'de', 'fr', 'it', 'es'], [], ['de', 'en', 'es', 'fr', 'it']],
- ];
- }
-
- public function testReduceLanguagesByConfiguration(string $lang, array $availableLanguages, array $reducedLanguageSet, array $expected): void {
- $factory = $this->getFactory(['findAvailableLanguages', 'languageExists']);
- $factory->expects(self::any())
- ->method('languageExists')->willReturn(true);
- $factory->expects(self::any())
- ->method('findAvailableLanguages')
- ->willReturnCallback(function ($app) use ($availableLanguages) {
- return $availableLanguages;
- });
- $this->config
- ->method('getSystemValue')
- ->willReturnMap([
- ['force_language', false, false],
- ['default_language', false, $lang],
- ['reduce_to_languages', [], $reducedLanguageSet]
- ]);
- $result = $this->invokePrivate($factory, 'getLanguages');
- $commonLanguagesCodes = array_map(function ($lang) {
- return $lang['code'];
- }, $result['commonLanguages']);
- self::assertEqualsCanonicalizing($expected, $commonLanguagesCodes);
- }
- public function languageIteratorRequestProvider():array {
- return [
- [ true, $this->createMock(IUser::class)],
- [ false, $this->createMock(IUser::class)],
- [ false, null]
- ];
- }
-
- public function testGetLanguageIterator(bool $hasSession, ?IUser $iUserMock = null): void {
- $factory = $this->getFactory();
- if ($iUserMock === null) {
- $matcher = $this->userSession->expects(self::once())
- ->method('getUser');
- if ($hasSession) {
- $matcher->willReturn($this->createMock(IUser::class));
- } else {
- $this->expectException(\RuntimeException::class);
- }
- }
- $iterator = $factory->getLanguageIterator($iUserMock);
- self::assertInstanceOf(ILanguageIterator::class, $iterator);
- }
- }
|