From 4fbf9a4feb15a7001886d86285eb4da42b13927b Mon Sep 17 00:00:00 2001 From: Julius Haertl Date: Sun, 5 Mar 2017 23:28:59 +0100 Subject: Add tests for SCSSCacher MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- tests/lib/Template/SCSSCacherTest.php | 108 ++++++++++++++++++++++++++++++++++ 1 file changed, 108 insertions(+) create mode 100644 tests/lib/Template/SCSSCacherTest.php (limited to 'tests') diff --git a/tests/lib/Template/SCSSCacherTest.php b/tests/lib/Template/SCSSCacherTest.php new file mode 100644 index 00000000000..52c1cad5307 --- /dev/null +++ b/tests/lib/Template/SCSSCacherTest.php @@ -0,0 +1,108 @@ + + * + * @author Julius Härtl + * + * @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 Test\Template; + +use OC\Template\SCSSCacher; +use OCP\Files\IAppData; +use OCP\Files\NotFoundException; +use OCP\Files\SimpleFS\ISimpleFile; +use OCP\Files\SimpleFS\ISimpleFolder; +use OCP\IConfig; +use OCP\ILogger; +use OCP\IURLGenerator; + +class SCSSCacherTest extends \Test\TestCase { + /** @var ILogger|\PHPUnit_Framework_MockObject_MockObject */ + protected $logger; + /** @var IAppData|\PHPUnit_Framework_MockObject_MockObject */ + protected $appData; + /** @var IURLGenerator|\PHPUnit_Framework_MockObject_MockObject */ + protected $urlGenerator; + /** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */ + protected $config; + /** @var \OC_Defaults|\PHPUnit_Framework_MockObject_MockObject */ + protected $defaults; + /** @var SCSSCacher */ + protected $scssCacher; + + protected function setUp() { + parent::setUp(); + $this->logger = $this->createMock(ILogger::class); + $this->appData = $this->createMock(IAppData::class); + $this->urlGenerator = $this->createMock(IURLGenerator::class); + $this->config = $this->createMock(IConfig::class); + $this->defaults = $this->createMock(\OC_Defaults::class); + $this->scssCacher = new SCSSCacher( + $this->logger, + $this->appData, + $this->urlGenerator, + $this->config, + $this->defaults + ); + } + + public function testProcess() { + + } + + public function testVariablesChangedNotFound() { + $mtime = filemtime(\OC::$SERVERROOT . '/core/css/variables.scss'); + $file = $this->createMock(ISimpleFile::class); + $folder = $this->createMock(ISimpleFolder::class); + $folder->expects($this->once()) + ->method('getFile') + ->with('styles.scss') + ->willThrowException(new NotFoundException()); + $this->assertTrue($this->invokePrivate($this->scssCacher, 'variablesChanged', ['styles.scss', $folder])); + } + + public function testVariablesChangedOlder() { + $mtime = filemtime(\OC::$SERVERROOT . '/core/css/variables.scss'); + $file = $this->createMock(ISimpleFile::class); + $folder = $this->createMock(ISimpleFolder::class); + $folder->expects($this->once()) + ->method('getFile') + ->with('styles.scss') + ->willReturn($file); + $file->expects($this->once()) + ->method('getMTime') + ->willReturn($mtime-100); + $this->assertTrue($this->invokePrivate($this->scssCacher, 'variablesChanged', ['styles.scss', $folder])); + } + + public function testVariablesChangedNewer() { + $mtime = filemtime(\OC::$SERVERROOT . '/core/css/variables.scss'); + $file = $this->createMock(ISimpleFile::class); + $folder = $this->createMock(ISimpleFolder::class); + $folder->expects($this->once()) + ->method('getFile') + ->with('styles.scss') + ->willReturn($file); + $file->expects($this->once()) + ->method('getMTime') + ->willReturn($mtime+100); + $this->assertFalse($this->invokePrivate($this->scssCacher, 'variablesChanged', ['styles.scss', $folder])); + } + +} \ No newline at end of file -- cgit v1.2.3 From 29ec58f1b5099e49539a85f734a6c8192ce295b4 Mon Sep 17 00:00:00 2001 From: Julius Härtl Date: Mon, 20 Mar 2017 12:31:29 +0100 Subject: Add tests for SCSSCacher MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- lib/private/Template/SCSSCacher.php | 27 +--- tests/data/scss/styles-error.scss | 1 + tests/data/scss/styles-success.scss | 1 + tests/lib/Template/SCSSCacherTest.php | 230 +++++++++++++++++++++++++++++----- 4 files changed, 205 insertions(+), 54 deletions(-) create mode 100644 tests/data/scss/styles-error.scss create mode 100644 tests/data/scss/styles-success.scss (limited to 'tests') diff --git a/lib/private/Template/SCSSCacher.php b/lib/private/Template/SCSSCacher.php index 3aa649da65a..4f5c66f2409 100644 --- a/lib/private/Template/SCSSCacher.php +++ b/lib/private/Template/SCSSCacher.php @@ -28,6 +28,7 @@ use Leafo\ScssPhp\Formatter\Expanded; use OC\SystemConfig; use OCP\Files\IAppData; use OCP\Files\NotFoundException; +use OCP\Files\NotPermittedException; use OCP\Files\SimpleFS\ISimpleFolder; use OCP\IConfig; use OCP\ILogger; @@ -93,7 +94,7 @@ class SCSSCacher { $folder = $this->appData->newFolder($app); } - if($this->isCached($fileNameCSS, $fileNameSCSS, $folder, $path) && !$this->variablesChanged($fileNameCSS, $folder)) { + if($this->isCached($fileNameCSS, $fileNameSCSS, $folder, $path)) { return true; } return $this->cache($path, $fileNameCSS, $fileNameSCSS, $folder, $webDir); @@ -124,28 +125,6 @@ class SCSSCacher { } catch(NotFoundException $e) { return false; } - return false; - } - - /** - * Check if the variables file has changed - * @param string $fileNameCSS - * @param ISimpleFolder $folder - * @return bool - */ - private function variablesChanged($fileNameCSS, ISimpleFolder $folder) { - $variablesFile = \OC::$SERVERROOT . '/core/css/variables.scss'; - try { - $cachedFile = $folder->getFile($fileNameCSS); - if ($cachedFile->getMTime() < filemtime($variablesFile) - || $cachedFile->getSize() === 0 - ) { - return true; - } - } catch (NotFoundException $e) { - return true; - } - return false; } /** @@ -200,7 +179,7 @@ class SCSSCacher { $depFile->putContent(json_encode($scss->getParsedFiles())); $this->logger->debug($webDir.'/'.$fileNameSCSS.' compiled and successfully cached', ['app' => 'core']); return true; - } catch(NotFoundException $e) { + } catch(NotPermittedException $e) { return false; } } diff --git a/tests/data/scss/styles-error.scss b/tests/data/scss/styles-error.scss new file mode 100644 index 00000000000..bd6c6d4ffb5 --- /dev/null +++ b/tests/data/scss/styles-error.scss @@ -0,0 +1 @@ +body { error } diff --git a/tests/data/scss/styles-success.scss b/tests/data/scss/styles-success.scss new file mode 100644 index 00000000000..bf4efa71a6a --- /dev/null +++ b/tests/data/scss/styles-success.scss @@ -0,0 +1 @@ +body { background-color: $color-primary; } \ No newline at end of file diff --git a/tests/lib/Template/SCSSCacherTest.php b/tests/lib/Template/SCSSCacherTest.php index 52c1cad5307..4ed6d17ae70 100644 --- a/tests/lib/Template/SCSSCacherTest.php +++ b/tests/lib/Template/SCSSCacherTest.php @@ -52,57 +52,227 @@ class SCSSCacherTest extends \Test\TestCase { $this->appData = $this->createMock(IAppData::class); $this->urlGenerator = $this->createMock(IURLGenerator::class); $this->config = $this->createMock(IConfig::class); - $this->defaults = $this->createMock(\OC_Defaults::class); $this->scssCacher = new SCSSCacher( $this->logger, $this->appData, $this->urlGenerator, $this->config, - $this->defaults + \OC::$SERVERROOT ); } - public function testProcess() { + public function testProcessUncachedFileNoAppDataFolder() { + $folder = $this->createMock(ISimpleFolder::class); + $this->appData->expects($this->once())->method('getFolder')->with('core')->willThrowException(new NotFoundException()); + $this->appData->expects($this->once())->method('newFolder')->with('core')->willReturn($folder); + $file = $this->createMock(ISimpleFile::class); + $file->expects($this->any())->method('getSize')->willReturn(1); + $fileDeps = $this->createMock(ISimpleFile::class); + $folder->expects($this->at(0))->method('getFile')->with('styles.css')->willReturn($file); + $folder->expects($this->at(1))->method('getFile')->with('styles.css.deps')->willThrowException(new NotFoundException()); + $folder->expects($this->at(2))->method('getFile')->with('styles.css')->willReturn($file); + $folder->expects($this->at(3))->method('getFile')->with('styles.css.deps')->willThrowException(new NotFoundException()); + $folder->expects($this->at(4))->method('newFile')->with('styles.css.deps')->willReturn($fileDeps); + $actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core'); + $this->assertTrue($actual); + } + public function testProcessUncachedFile() { + $folder = $this->createMock(ISimpleFolder::class); + $this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder); + $file = $this->createMock(ISimpleFile::class); + $file->expects($this->any())->method('getSize')->willReturn(1); + $fileDeps = $this->createMock(ISimpleFile::class); + $folder->expects($this->at(0))->method('getFile')->with('styles.css')->willReturn($file); + $folder->expects($this->at(1))->method('getFile')->with('styles.css.deps')->willThrowException(new NotFoundException()); + $folder->expects($this->at(2))->method('getFile')->with('styles.css')->willReturn($file); + $folder->expects($this->at(3))->method('getFile')->with('styles.css.deps')->willThrowException(new NotFoundException()); + $folder->expects($this->at(4))->method('newFile')->with('styles.css.deps')->willReturn($fileDeps); + $actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core'); + $this->assertTrue($actual); } - public function testVariablesChangedNotFound() { - $mtime = filemtime(\OC::$SERVERROOT . '/core/css/variables.scss'); + public function testProcessCacheFile() { + $folder = $this->createMock(ISimpleFolder::class); + $this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder); $file = $this->createMock(ISimpleFile::class); + $file->expects($this->any())->method('getSize')->willReturn(1); + $fileDeps = $this->createMock(ISimpleFile::class); + $fileDeps->expects($this->any())->method('getSize')->willReturn(1); + $fileDeps->expects($this->once())->method('getContent')->willReturn('{}'); + $folder->expects($this->at(0))->method('getFile')->with('styles.css')->willReturn($file); + $folder->expects($this->at(1))->method('getFile')->with('styles.css.deps')->willReturn($fileDeps); + $actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core'); + $this->assertTrue($actual); + } + + public function testProcessCachedFile() { + $folder = $this->createMock(ISimpleFolder::class); + $this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder); + $file = $this->createMock(ISimpleFile::class); + $file->expects($this->once())->method('getSize')->willReturn(1); + $fileDeps = $this->createMock(ISimpleFile::class); + $fileDeps->expects($this->any())->method('getSize')->willReturn(1); + $fileDeps->expects($this->once())->method('getContent')->willReturn('{}'); + $folder->expects($this->at(0))->method('getFile')->with('styles.css')->willReturn($file); + $folder->expects($this->at(1))->method('getFile')->with('styles.css.deps')->willReturn($fileDeps); + $actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core'); + $this->assertTrue($actual); + } + + public function testIsCachedNoFile() { + $fileNameCSS = "styles.css"; + $fileNameSCSS = "styles.scss"; $folder = $this->createMock(ISimpleFolder::class); - $folder->expects($this->once()) - ->method('getFile') - ->with('styles.scss') - ->willThrowException(new NotFoundException()); - $this->assertTrue($this->invokePrivate($this->scssCacher, 'variablesChanged', ['styles.scss', $folder])); + $path = \OC::$SERVERROOT . '/core/css/'; + + $folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willThrowException(new NotFoundException()); + $actual = self::invokePrivate($this->scssCacher, 'isCached', [$fileNameCSS, $fileNameSCSS, $folder, $path]); + $this->assertFalse($actual); } - public function testVariablesChangedOlder() { - $mtime = filemtime(\OC::$SERVERROOT . '/core/css/variables.scss'); + public function testIsCachedNoDepsFile() { + $fileNameCSS = "styles.css"; + $fileNameSCSS = "styles.scss"; + $folder = $this->createMock(ISimpleFolder::class); + $file = $this->createMock(ISimpleFile::class); + $path = \OC::$SERVERROOT . '/core/css/'; + + $file->expects($this->once())->method('getSize')->willReturn(1); + $folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willReturn($file); + $folder->expects($this->at(1))->method('getFile')->with($fileNameCSS . '.deps')->willThrowException(new NotFoundException()); + + $actual = self::invokePrivate($this->scssCacher, 'isCached', [$fileNameCSS, $fileNameSCSS, $folder, $path]); + $this->assertFalse($actual); + } + public function testCacheNoFile() { + $fileNameCSS = "styles.css"; + $fileNameSCSS = "styles.scss"; + $folder = $this->createMock(ISimpleFolder::class); $file = $this->createMock(ISimpleFile::class); + $depsFile = $this->createMock(ISimpleFile::class); + + $webDir = "core/css"; + $path = \OC::$SERVERROOT . '/core/css/'; + + $folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willThrowException(new NotFoundException()); + $folder->expects($this->at(1))->method('newFile')->with($fileNameCSS)->willReturn($file); + $folder->expects($this->at(2))->method('getFile')->with($fileNameCSS . '.deps')->willThrowException(new NotFoundException()); + $folder->expects($this->at(3))->method('newFile')->with($fileNameCSS . '.deps')->willReturn($depsFile); + + $file->expects($this->once())->method('putContent'); + $depsFile->expects($this->once())->method('putContent'); + + $actual = self::invokePrivate($this->scssCacher, 'cache', [$path, $fileNameCSS, $fileNameSCSS, $folder, $webDir]); + $this->assertTrue($actual); + } + + public function testCache() { + $fileNameCSS = "styles.css"; + $fileNameSCSS = "styles.scss"; $folder = $this->createMock(ISimpleFolder::class); - $folder->expects($this->once()) - ->method('getFile') - ->with('styles.scss') - ->willReturn($file); - $file->expects($this->once()) - ->method('getMTime') - ->willReturn($mtime-100); - $this->assertTrue($this->invokePrivate($this->scssCacher, 'variablesChanged', ['styles.scss', $folder])); + $file = $this->createMock(ISimpleFile::class); + $depsFile = $this->createMock(ISimpleFile::class); + + $webDir = "core/css"; + $path = \OC::$SERVERROOT; + + $folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willReturn($file); + $folder->expects($this->at(1))->method('getFile')->with($fileNameCSS . '.deps')->willReturn($depsFile); + + $file->expects($this->once())->method('putContent'); + $depsFile->expects($this->once())->method('putContent'); + + $actual = self::invokePrivate($this->scssCacher, 'cache', [$path, $fileNameCSS, $fileNameSCSS, $folder, $webDir]); + $this->assertTrue($actual); } - public function testVariablesChangedNewer() { - $mtime = filemtime(\OC::$SERVERROOT . '/core/css/variables.scss'); + public function testCacheSuccess() { + $fileNameCSS = "styles-success.css"; + $fileNameSCSS = "../../tests/data/scss/styles-success.scss"; + $folder = $this->createMock(ISimpleFolder::class); $file = $this->createMock(ISimpleFile::class); + $depsFile = $this->createMock(ISimpleFile::class); + + $webDir = "tests/data/scss"; + $path = \OC::$SERVERROOT . $webDir; + + $folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willReturn($file); + $folder->expects($this->at(1))->method('getFile')->with($fileNameCSS . '.deps')->willReturn($depsFile); + + $file->expects($this->at(0))->method('putContent')->with($this->callback( + function ($content){ + return 'body{background-color:#0082c9}' === $content; + })); + $depsFile->expects($this->at(0))->method('putContent')->with($this->callback( + function ($content) { + $deps = json_decode($content, true); + return array_key_exists(\OC::$SERVERROOT . '/core/css/variables.scss', $deps) + && array_key_exists(\OC::$SERVERROOT . '/tests/data/scss/styles-success.scss', $deps); + })); + + $actual = self::invokePrivate($this->scssCacher, 'cache', [$path, $fileNameCSS, $fileNameSCSS, $folder, $webDir]); + $this->assertTrue($actual); + } + + public function testCacheFailure() { + $fileNameCSS = "styles-error.css"; + $fileNameSCSS = "../../tests/data/scss/styles-error.scss"; $folder = $this->createMock(ISimpleFolder::class); - $folder->expects($this->once()) - ->method('getFile') - ->with('styles.scss') - ->willReturn($file); - $file->expects($this->once()) - ->method('getMTime') - ->willReturn($mtime+100); - $this->assertFalse($this->invokePrivate($this->scssCacher, 'variablesChanged', ['styles.scss', $folder])); + $file = $this->createMock(ISimpleFile::class); + $depsFile = $this->createMock(ISimpleFile::class); + + $webDir = "/tests/data/scss"; + $path = \OC::$SERVERROOT . $webDir; + + $folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willReturn($file); + $folder->expects($this->at(1))->method('getFile')->with($fileNameCSS . '.deps')->willReturn($depsFile); + + $actual = self::invokePrivate($this->scssCacher, 'cache', [$path, $fileNameCSS, $fileNameSCSS, $folder, $webDir]); + $this->assertFalse($actual); + } + + public function testRebaseUrls() { + $webDir = 'apps/files/css'; + $css = '#id { background-image: url(\'../img/image.jpg\'); }'; + $actual = self::invokePrivate($this->scssCacher, 'rebaseUrls', [$css, $webDir]); + $expected = '#id { background-image: url(\'../../../apps/files/css/../img/image.jpg\'); }'; + $this->assertEquals($expected, $actual); + } + + public function testRebaseUrlsIgnoreFrontendController() { + $this->config->expects($this->once())->method('getSystemValue')->with('htaccess.IgnoreFrontController', false)->willReturn(true); + $webDir = 'apps/files/css'; + $css = '#id { background-image: url(\'../img/image.jpg\'); }'; + $actual = self::invokePrivate($this->scssCacher, 'rebaseUrls', [$css, $webDir]); + $expected = '#id { background-image: url(\'../../apps/files/css/../img/image.jpg\'); }'; + $this->assertEquals($expected, $actual); + } + + public function dataGetCachedSCSS() { + return [ + ['core', 'core/css/styles.scss', '/css/core/styles.css'], + ['files', 'apps/files/css/styles.scss', '/css/files/styles.css'] + ]; } + /** + * @param $appName + * @param $fileName + * @param $result + * @dataProvider dataGetCachedSCSS + */ + public function testGetCachedSCSS($appName, $fileName, $result) { + $this->urlGenerator->expects($this->once()) + ->method('linkToRoute') + ->with('core.Css.getCss', [ + 'fileName' => 'styles.css', + 'appName' => $appName + ]) + ->willReturn($result); + $actual = $this->scssCacher->getCachedSCSS($appName, $fileName); + $this->assertEquals(substr($result, 1), $actual); + } + + } \ No newline at end of file -- cgit v1.2.3 From a0f7d4b6888466600698a31a50a551f915c69045 Mon Sep 17 00:00:00 2001 From: Julius Härtl Date: Mon, 20 Mar 2017 14:20:34 +0100 Subject: Fix tests MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- tests/lib/Template/SCSSCacherTest.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'tests') diff --git a/tests/lib/Template/SCSSCacherTest.php b/tests/lib/Template/SCSSCacherTest.php index 4ed6d17ae70..d49f0cdc6a1 100644 --- a/tests/lib/Template/SCSSCacherTest.php +++ b/tests/lib/Template/SCSSCacherTest.php @@ -269,7 +269,7 @@ class SCSSCacherTest extends \Test\TestCase { 'fileName' => 'styles.css', 'appName' => $appName ]) - ->willReturn($result); + ->willReturn(\OC::$WEBROOT . $result); $actual = $this->scssCacher->getCachedSCSS($appName, $fileName); $this->assertEquals(substr($result, 1), $actual); } -- cgit v1.2.3