* * @author Arthur Schiwon * @author Bjoern Schiessle * @author Jan-Christoph Borchardt * @author Joas Schilling * @author Julius Haertl * @author Julius Härtl * @author Lukas Reschke * @author Morris Jobke * * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * */ namespace OCA\Theming\Tests; use OCA\Theming\ImageManager; use OCA\Theming\ThemingDefaults; use OCP\App\IAppManager; use OCP\Files\IAppData; use OCA\Theming\Util; use OCP\Files\NotFoundException; use OCP\Files\SimpleFS\ISimpleFile; use OCP\Files\SimpleFS\ISimpleFolder; use OCP\ICache; use OCP\ICacheFactory; use OCP\IConfig; use OCP\IL10N; use OCP\IURLGenerator; use Test\TestCase; class ThemingDefaultsTest extends TestCase { /** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */ private $config; /** @var IL10N|\PHPUnit_Framework_MockObject_MockObject */ private $l10n; /** @var IURLGenerator|\PHPUnit_Framework_MockObject_MockObject */ private $urlGenerator; /** @var \OC_Defaults|\PHPUnit_Framework_MockObject_MockObject */ private $defaults; /** @var IAppData|\PHPUnit_Framework_MockObject_MockObject */ private $appData; /** @var ICacheFactory|\PHPUnit_Framework_MockObject_MockObject */ private $cacheFactory; /** @var ThemingDefaults */ private $template; /** @var Util|\PHPUnit_Framework_MockObject_MockObject */ private $util; /** @var ICache|\PHPUnit_Framework_MockObject_MockObject */ private $cache; /** @var IAppManager|\PHPUnit_Framework_MockObject_MockObject */ private $appManager; /** @var ImageManager|\PHPUnit_Framework_MockObject_MockObject */ private $imageManager; public function setUp() { parent::setUp(); $this->config = $this->createMock(IConfig::class); $this->l10n = $this->createMock(IL10N::class); $this->urlGenerator = $this->createMock(IURLGenerator::class); $this->cacheFactory = $this->createMock(ICacheFactory::class); $this->cache = $this->createMock(ICache::class); $this->util = $this->createMock(Util::class); $this->imageManager = $this->createMock(ImageManager::class); $this->appManager = $this->createMock(IAppManager::class); $this->defaults = new \OC_Defaults(); $this->urlGenerator ->expects($this->any()) ->method('getBaseUrl') ->willReturn(''); $this->template = new ThemingDefaults( $this->config, $this->l10n, $this->urlGenerator, $this->cacheFactory, $this->util, $this->imageManager, $this->appManager ); } public function testGetNameWithDefault() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('Nextcloud'); $this->assertEquals('Nextcloud', $this->template->getName()); } public function testGetNameWithCustom() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('MyCustomCloud'); $this->assertEquals('MyCustomCloud', $this->template->getName()); } public function testGetHTMLNameWithDefault() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('Nextcloud'); $this->assertEquals('Nextcloud', $this->template->getHTMLName()); } public function testGetHTMLNameWithCustom() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('MyCustomCloud'); $this->assertEquals('MyCustomCloud', $this->template->getHTMLName()); } public function testGetTitleWithDefault() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('Nextcloud'); $this->assertEquals('Nextcloud', $this->template->getTitle()); } public function testGetTitleWithCustom() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('MyCustomCloud'); $this->assertEquals('MyCustomCloud', $this->template->getTitle()); } public function testGetEntityWithDefault() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('Nextcloud'); $this->assertEquals('Nextcloud', $this->template->getEntity()); } public function testGetEntityWithCustom() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('MyCustomCloud'); $this->assertEquals('MyCustomCloud', $this->template->getEntity()); } public function testGetBaseUrlWithDefault() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'url', $this->defaults->getBaseUrl()) ->willReturn($this->defaults->getBaseUrl()); $this->assertEquals($this->defaults->getBaseUrl(), $this->template->getBaseUrl()); } public function testGetBaseUrlWithCustom() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'url', $this->defaults->getBaseUrl()) ->willReturn('https://example.com/'); $this->assertEquals('https://example.com/', $this->template->getBaseUrl()); } public function imprintUrlProvider() { return [ [ '' ], [ 'https://example.com/imprint.html'] ]; } /** * @param $imprintUrl * @dataProvider imprintUrlProvider */ public function testGetImprintURL($imprintUrl) { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'imprintUrl', '') ->willReturn($imprintUrl); $this->assertEquals($imprintUrl, $this->template->getImprintUrl()); } public function testGetSloganWithDefault() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'slogan', $this->defaults->getSlogan()) ->willReturn($this->defaults->getSlogan()); $this->assertEquals($this->defaults->getSlogan(), $this->template->getSlogan()); } public function testGetSloganWithCustom() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'slogan', $this->defaults->getSlogan()) ->willReturn('My custom Slogan'); $this->assertEquals('My custom Slogan', $this->template->getSlogan()); } public function testGetShortFooter() { $this->config ->expects($this->exactly(4)) ->method('getAppValue') ->willReturnMap([ ['theming', 'url', $this->defaults->getBaseUrl(), 'url'], ['theming', 'name', 'Nextcloud', 'Name'], ['theming', 'slogan', $this->defaults->getSlogan(), 'Slogan'], ['theming', 'imprintUrl', '', ''], ]); $this->assertEquals('Name – Slogan', $this->template->getShortFooter()); } public function testGetShortFooterEmptySlogan() { $this->config ->expects($this->exactly(4)) ->method('getAppValue') ->willReturnMap([ ['theming', 'url', $this->defaults->getBaseUrl(), 'url'], ['theming', 'name', 'Nextcloud', 'Name'], ['theming', 'slogan', $this->defaults->getSlogan(), ''], ['theming', 'imprintUrl', '', ''], ]); $this->assertEquals('Name', $this->template->getShortFooter()); } public function testGetShortFooterImprint() { $this->config ->expects($this->exactly(4)) ->method('getAppValue') ->willReturnMap([ ['theming', 'url', $this->defaults->getBaseUrl(), 'url'], ['theming', 'name', 'Nextcloud', 'Name'], ['theming', 'slogan', $this->defaults->getSlogan(), 'Slogan'], ['theming', 'imprintUrl', '', 'https://example.com/imprint'], ]); $this->l10n ->expects($this->any()) ->method('t') ->willReturnArgument(0); $this->assertEquals('Name – Slogan
Legal notice', $this->template->getShortFooter()); } public function invalidImprintUrlProvider() { return [ ['example.com/imprint'], # missing scheme ['https:///imprint'], # missing host ]; } /** * @param $invalidImprintUrl * @dataProvider invalidImprintUrlProvider */ public function testGetShortFooterInvalidImprint($invalidImprintUrl) { $this->config ->expects($this->exactly(4)) ->method('getAppValue') ->willReturnMap([ ['theming', 'url', $this->defaults->getBaseUrl(), 'url'], ['theming', 'name', 'Nextcloud', 'Name'], ['theming', 'slogan', $this->defaults->getSlogan(), 'Slogan'], ['theming', 'imprintUrl', '', $invalidImprintUrl], ]); $this->assertEquals('Name – Slogan', $this->template->getShortFooter()); } public function testgetColorPrimaryWithDefault() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'color', $this->defaults->getColorPrimary()) ->willReturn($this->defaults->getColorPrimary()); $this->assertEquals($this->defaults->getColorPrimary(), $this->template->getColorPrimary()); } public function testgetColorPrimaryWithCustom() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'color', $this->defaults->getColorPrimary()) ->willReturn('#fff'); $this->assertEquals('#fff', $this->template->getColorPrimary()); } public function testSet() { $this->config ->expects($this->at(0)) ->method('setAppValue') ->with('theming', 'MySetting', 'MyValue'); $this->config ->expects($this->at(1)) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('15'); $this->config ->expects($this->at(2)) ->method('setAppValue') ->with('theming', 'cachebuster', 16); $this->cacheFactory ->expects($this->at(0)) ->method('createDistributed') ->with('theming-') ->willReturn($this->cache); $this->cacheFactory ->expects($this->at(1)) ->method('createDistributed') ->with('imagePath') ->willReturn($this->cache); $this->cache ->expects($this->any()) ->method('clear') ->with(''); $this->template->set('MySetting', 'MyValue'); } public function testUndoName() { $this->config ->expects($this->at(0)) ->method('deleteAppValue') ->with('theming', 'name'); $this->config ->expects($this->at(1)) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('15'); $this->config ->expects($this->at(2)) ->method('setAppValue') ->with('theming', 'cachebuster', 16); $this->config ->expects($this->at(3)) ->method('getAppValue') ->with('theming', 'name', 'Nextcloud') ->willReturn('Nextcloud'); $this->assertSame('Nextcloud', $this->template->undo('name')); } public function testUndoBaseUrl() { $this->config ->expects($this->at(0)) ->method('deleteAppValue') ->with('theming', 'url'); $this->config ->expects($this->at(1)) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('15'); $this->config ->expects($this->at(2)) ->method('setAppValue') ->with('theming', 'cachebuster', 16); $this->config ->expects($this->at(3)) ->method('getAppValue') ->with('theming', 'url', $this->defaults->getBaseUrl()) ->willReturn($this->defaults->getBaseUrl()); $this->assertSame($this->defaults->getBaseUrl(), $this->template->undo('url')); } public function testUndoSlogan() { $this->config ->expects($this->at(0)) ->method('deleteAppValue') ->with('theming', 'slogan'); $this->config ->expects($this->at(1)) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('15'); $this->config ->expects($this->at(2)) ->method('setAppValue') ->with('theming', 'cachebuster', 16); $this->config ->expects($this->at(3)) ->method('getAppValue') ->with('theming', 'slogan', $this->defaults->getSlogan()) ->willReturn($this->defaults->getSlogan()); $this->assertSame($this->defaults->getSlogan(), $this->template->undo('slogan')); } public function testUndoColor() { $this->config ->expects($this->at(0)) ->method('deleteAppValue') ->with('theming', 'color'); $this->config ->expects($this->at(1)) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('15'); $this->config ->expects($this->at(2)) ->method('setAppValue') ->with('theming', 'cachebuster', 16); $this->config ->expects($this->at(3)) ->method('getAppValue') ->with('theming', 'color', $this->defaults->getColorPrimary()) ->willReturn($this->defaults->getColorPrimary()); $this->assertSame($this->defaults->getColorPrimary(), $this->template->undo('color')); } public function testUndoDefaultAction() { $this->config ->expects($this->at(0)) ->method('deleteAppValue') ->with('theming', 'defaultitem'); $this->config ->expects($this->at(1)) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('15'); $this->config ->expects($this->at(2)) ->method('setAppValue') ->with('theming', 'cachebuster', 16); $this->assertSame('', $this->template->undo('defaultitem')); } public function testGetBackground() { $this->imageManager ->expects($this->once()) ->method('getImageUrl') ->with('background') ->willReturn('custom-background?v=0'); $this->assertEquals('custom-background?v=0', $this->template->getBackground()); } private function getLogoHelper($withName, $useSvg) { $this->imageManager->expects($this->any()) ->method('getImage') ->with('logo') ->willThrowException(new NotFoundException()); $this->config ->expects($this->at(0)) ->method('getAppValue') ->with('theming', 'logoMime') ->willReturn(''); $this->config ->expects($this->at(1)) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('0'); $this->urlGenerator->expects($this->once()) ->method('imagePath') ->with('core', $withName) ->willReturn('core-logo'); $this->assertEquals('core-logo?v=0', $this->template->getLogo($useSvg)); } public function testGetLogoDefaultWithSvg() { $this->getLogoHelper('logo.svg', true); } public function testGetLogoDefaultWithoutSvg() { $this->getLogoHelper('logo.png', false); } public function testGetLogoCustom() { $file = $this->createMock(ISimpleFile::class); $this->imageManager->expects($this->once()) ->method('getImage') ->with('logo') ->willReturn($file); $this->config ->expects($this->at(0)) ->method('getAppValue') ->with('theming', 'logoMime', false) ->willReturn('image/svg+xml'); $this->config ->expects($this->at(1)) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('0'); $this->urlGenerator->expects($this->once()) ->method('linkToRoute') ->with('theming.Theming.getImage') ->willReturn('custom-logo'); $this->assertEquals('custom-logo' . '?v=0', $this->template->getLogo()); } public function testGetScssVariablesCached() { $this->cacheFactory->expects($this->once()) ->method('createDistributed') ->with('theming-') ->willReturn($this->cache); $this->cache->expects($this->once())->method('get')->with('getScssVariables')->willReturn(['foo'=>'bar']); $this->assertEquals(['foo'=>'bar'], $this->template->getScssVariables()); } public function testGetScssVariables() { $this->config->expects($this->at(0))->method('getAppValue')->with('theming', 'cachebuster', '0')->willReturn('0'); $this->config->expects($this->at(1))->method('getAppValue')->with('theming', 'logoMime', false)->willReturn('jpeg'); $this->config->expects($this->at(2))->method('getAppValue')->with('theming', 'backgroundMime', false)->willReturn('jpeg'); $this->config->expects($this->at(3))->method('getAppValue')->with('theming', 'logoheaderMime', false)->willReturn('jpeg'); $this->config->expects($this->at(4))->method('getAppValue')->with('theming', 'faviconMime', false)->willReturn('jpeg'); $this->config->expects($this->at(5))->method('getAppValue')->with('theming', 'color', null)->willReturn($this->defaults->getColorPrimary()); $this->config->expects($this->at(6))->method('getAppValue')->with('theming', 'color', $this->defaults->getColorPrimary())->willReturn($this->defaults->getColorPrimary()); $this->config->expects($this->at(7))->method('getAppValue')->with('theming', 'color', $this->defaults->getColorPrimary())->willReturn($this->defaults->getColorPrimary()); $this->config->expects($this->at(8))->method('getAppValue')->with('theming', 'color', $this->defaults->getColorPrimary())->willReturn($this->defaults->getColorPrimary()); $this->util->expects($this->any())->method('invertTextColor')->with($this->defaults->getColorPrimary())->willReturn(false); $this->util->expects($this->any())->method('elementColor')->with($this->defaults->getColorPrimary())->willReturn('#aaaaaa'); $this->cacheFactory->expects($this->once()) ->method('createDistributed') ->with('theming-') ->willReturn($this->cache); $this->cache->expects($this->once())->method('get')->with('getScssVariables')->willReturn(null); $this->imageManager->expects($this->at(0))->method('getImageUrl')->with('logo')->willReturn('custom-logo?v=0'); $this->imageManager->expects($this->at(1))->method('getImageUrl')->with('logoheader')->willReturn('custom-logoheader?v=0'); $this->imageManager->expects($this->at(2))->method('getImageUrl')->with('favicon')->willReturn('custom-favicon?v=0'); $this->imageManager->expects($this->at(3))->method('getImageUrl')->with('background')->willReturn('custom-background?v=0'); $expected = [ 'theming-cachebuster' => '\'0\'', 'theming-logo-mime' => '\'jpeg\'', 'theming-background-mime' => '\'jpeg\'', 'image-logo' => "'custom-logo?v=0'", 'image-login-background' => "'custom-background?v=0'", 'color-primary' => $this->defaults->getColorPrimary(), 'color-primary-text' => '#ffffff', 'image-login-plain' => 'false', 'color-primary-element' => '#aaaaaa', 'theming-logoheader-mime' => '\'jpeg\'', 'theming-favicon-mime' => '\'jpeg\'', 'image-logoheader' => '\'custom-logoheader?v=0\'', 'image-favicon' => '\'custom-favicon?v=0\'' ]; $this->assertEquals($expected, $this->template->getScssVariables()); } public function testGetDefaultAndroidURL() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'AndroidClientUrl', 'https://play.google.com/store/apps/details?id=com.nextcloud.client') ->willReturn('https://play.google.com/store/apps/details?id=com.nextcloud.client'); $this->assertEquals('https://play.google.com/store/apps/details?id=com.nextcloud.client', $this->template->getAndroidClientUrl()); } public function testGetCustomAndroidURL() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'AndroidClientUrl', 'https://play.google.com/store/apps/details?id=com.nextcloud.client') ->willReturn('https://play.google.com/store/apps/details?id=com.mycloud.client'); $this->assertEquals('https://play.google.com/store/apps/details?id=com.mycloud.client', $this->template->getAndroidClientUrl()); } public function testGetDefaultiOSURL() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'iOSClientUrl', 'https://geo.itunes.apple.com/us/app/nextcloud/id1125420102?mt=8') ->willReturn('https://geo.itunes.apple.com/us/app/nextcloud/id1125420102?mt=8'); $this->assertEquals('https://geo.itunes.apple.com/us/app/nextcloud/id1125420102?mt=8', $this->template->getiOSClientUrl()); } public function testGetCustomiOSURL() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'iOSClientUrl', 'https://geo.itunes.apple.com/us/app/nextcloud/id1125420102?mt=8') ->willReturn('https://geo.itunes.apple.com/us/app/nextcloud/id1234567890?mt=8'); $this->assertEquals('https://geo.itunes.apple.com/us/app/nextcloud/id1234567890?mt=8', $this->template->getiOSClientUrl()); } public function testGetDefaultiTunesAppId() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'iTunesAppId', '1125420102') ->willReturn('1125420102'); $this->assertEquals('1125420102', $this->template->getiTunesAppId()); } public function testGetCustomiTunesAppId() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'iTunesAppId', '1125420102') ->willReturn('1234567890'); $this->assertEquals('1234567890', $this->template->getiTunesAppId()); } public function dataReplaceImagePath() { return [ ['core', 'test.png', false], ['core', 'manifest.json'], ['core', 'favicon.ico'], ['core', 'favicon-touch.png'] ]; } /** @dataProvider dataReplaceImagePath */ public function testReplaceImagePath($app, $image, $result = 'themingRoute?v=0') { $this->cache->expects($this->any()) ->method('get') ->with('shouldReplaceIcons') ->willReturn(true); $this->config ->expects($this->any()) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('0'); $this->urlGenerator ->expects($this->any()) ->method('linkToRoute') ->willReturn('themingRoute'); $this->assertEquals($result, $this->template->replaceImagePath($app, $image)); } }