Implement guest avatar endpoint

Signed-off-by: Michael Weimann <mail@michael-weimann.eu>

3 files changed, 474 insertions, 0 deletions

diff --git a/tests/lib/Avatar/AvatarManagerTest.php b/tests/lib/Avatar/AvatarManagerTest.php
new file mode 100644
index 00000000000..7466f664eb5
--- /dev/null
+++ b/tests/lib/Avatar/AvatarManagerTest.php
@@ -0,0 +1,129 @@
+<?php
+/**
+ * @author Roeland Jago Douma <rullzer@owncloud.com>
+ * @author Lukas Reschke <lukas@statuscode.ch>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @copyright Copyright (c) 2016, Lukas Reschke <lukas@statuscode.ch>
+ *
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace Test\Avatar;
+
+use OC\Avatar\UserAvatar;
+use OC\Avatar\AvatarManager;
+use OC\User\Manager;
+use OCP\Files\IAppData;
+use OCP\Files\SimpleFS\ISimpleFolder;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\ILogger;
+use OCP\IUser;
+
+/**
+ * Class AvatarManagerTest
+ */
+class AvatarManagerTest extends \Test\TestCase {
+	/** @var Manager|\PHPUnit_Framework_MockObject_MockObject */
+	private $userManager;
+	/** @var IAppData|\PHPUnit_Framework_MockObject_MockObject */
+	private $appData;
+	/** @var IL10N|\PHPUnit_Framework_MockObject_MockObject */
+	private $l10n;
+	/** @var ILogger|\PHPUnit_Framework_MockObject_MockObject */
+	private $logger;
+	/** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */
+	private $config;
+	/** @var AvatarManager | \PHPUnit_Framework_MockObject_MockObject */
+	private $avatarManager;
+
+	public function setUp() {
+		parent::setUp();
+
+		$this->userManager = $this->createMock(Manager::class);
+		$this->appData = $this->createMock(IAppData::class);
+		$this->l10n = $this->createMock(IL10N::class);
+		$this->logger = $this->createMock(ILogger::class);
+		$this->config = $this->createMock(IConfig::class);
+
+		$this->avatarManager = new AvatarManager(
+			$this->userManager,
+			$this->appData,
+			$this->l10n,
+			$this->logger,
+			$this->config
+		);
+	}
+
+	/**
+	 * @expectedException \Exception
+	 * @expectedExceptionMessage user does not exist
+	 */
+	public function testGetAvatarInvalidUser() {
+		$this->userManager
+			->expects($this->once())
+			->method('get')
+			->with('invalidUser')
+			->willReturn(null);
+
+		$this->avatarManager->getAvatar('invalidUser');
+	}
+
+	public function testGetAvatarValidUser() {
+		$user = $this->createMock(IUser::class);
+		$user
+			->expects($this->once())
+			->method('getUID')
+			->willReturn('valid-user');
+		$this->userManager
+			->expects($this->once())
+			->method('get')
+			->with('valid-user')
+			->willReturn($user);
+		$folder = $this->createMock(ISimpleFolder::class);
+		$this->appData
+			->expects($this->once())
+			->method('getFolder')
+			->with('valid-user')
+			->willReturn($folder);
+
+		$expected = new UserAvatar($folder, $this->l10n, $user, $this->logger, $this->config);
+		$this->assertEquals($expected, $this->avatarManager->getAvatar('valid-user'));
+	}
+
+	public function testGetAvatarValidUserDifferentCasing() {
+		$user = $this->createMock(IUser::class);
+		$this->userManager->expects($this->once())
+			->method('get')
+			->with('vaLid-USER')
+			->willReturn($user);
+
+		$user->expects($this->once())
+			->method('getUID')
+			->willReturn('valid-user');
+
+		$folder = $this->createMock(ISimpleFolder::class);
+		$this->appData
+			->expects($this->once())
+			->method('getFolder')
+			->with('valid-user')
+			->willReturn($folder);
+
+		$expected = new UserAvatar($folder, $this->l10n, $user, $this->logger, $this->config);
+		$this->assertEquals($expected, $this->avatarManager->getAvatar('vaLid-USER'));
+	}
+}
diff --git a/tests/lib/Avatar/GuestAvatarTest.php b/tests/lib/Avatar/GuestAvatarTest.php
new file mode 100644
index 00000000000..8762d063f5d
--- /dev/null
+++ b/tests/lib/Avatar/GuestAvatarTest.php
@@ -0,0 +1,80 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2018, Michael Weimann <mail@michael-weimann.eu>
+ *
+ * @author Michael Weimann <mail@michael-weimann.eu>
+ *
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ */
+
+namespace Test\Avatar;
+
+use OC\Avatar\GuestAvatar;
+use OCP\Files\SimpleFS\InMemoryFile;
+use OCP\ILogger;
+use PHPUnit\Framework\MockObject\MockObject;
+use Test\TestCase;
+
+/**
+ * This class provides test cases for the GuestAvatar class.
+ *
+ * @package Test\Avatar
+ */
+class GuestAvatarTest extends TestCase {
+	/**
+	 * @var GuestAvatar
+	 */
+	private $guestAvatar;
+
+	/**
+	 * Setups a guest avatar instance for tests.
+	 *
+	 * @before
+	 * @return void
+	 */
+	public function setupGuestAvatar() {
+		/* @var MockObject|ILogger $logger */
+		$logger = $this->getMockBuilder(ILogger::class)->getMock();
+		$this->guestAvatar = new GuestAvatar('einstein', $logger);
+	}
+
+	/**
+	 * Asserts that testGet() returns the expected avatar.
+	 *
+	 * For the test a static name "einstein" is used and
+	 * the generated image is compared with an expected one.
+	 *
+	 * @return void
+	 */
+	public function testGet() {
+		$avatar = $this->guestAvatar->getFile(32);
+		self::assertInstanceOf(InMemoryFile::class, $avatar);
+		$expectedFile = file_get_contents(
+			__DIR__ . '/../../data/guest_avatar_einstein_32.svg'
+		);
+		self::assertEquals(trim($expectedFile), trim($avatar->getContent()));
+	}
+
+	/**
+	 * Asserts that "testIsCustomAvatar" returns false for guests.
+	 *
+	 * @return void
+	 */
+	public function testIsCustomAvatar() {
+		self::assertFalse($this->guestAvatar->isCustomAvatar());
+	}
+}
diff --git a/tests/lib/Avatar/UserAvatarTest.php b/tests/lib/Avatar/UserAvatarTest.php
new file mode 100644
index 00000000000..049725c78c9
--- /dev/null
+++ b/tests/lib/Avatar/UserAvatarTest.php
@@ -0,0 +1,265 @@
+<?php
+/**
+ * Copyright (c) 2013 Christopher Schäpers <christopher@schaepers.it>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace Test\Avatar;
+
+use OC\Files\SimpleFS\SimpleFolder;
+use OC\User\User;
+use OCP\Files\File;
+use OCP\Files\Folder;
+use OCP\Files\NotFoundException;
+use OCP\Files\SimpleFS\ISimpleFile;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\ILogger;
+
+class UserAvatarTest extends \Test\TestCase {
+	/** @var Folder | \PHPUnit_Framework_MockObject_MockObject */
+	private $folder;
+
+	/** @var \OC\Avatar\UserAvatar */
+	private $avatar;
+
+	/** @var \OC\User\User | \PHPUnit_Framework_MockObject_MockObject $user */
+	private $user;
+
+	/** @var \OCP\IConfig|\PHPUnit_Framework_MockObject_MockObject */
+	private $config;
+
+	public function setUp() {
+		parent::setUp();
+
+		$this->folder = $this->createMock(SimpleFolder::class);
+		/** @var \OCP\IL10N | \PHPUnit_Framework_MockObject_MockObject $l */
+		$l = $this->createMock(IL10N::class);
+		$l->method('t')->will($this->returnArgument(0));
+		$this->user = $this->createMock(User::class);
+		$this->config = $this->createMock(IConfig::class);
+
+		$this->avatar = new \OC\Avatar\UserAvatar(
+			$this->folder,
+			$l,
+			$this->user,
+			$this->createMock(ILogger::class),
+			$this->config
+		);
+
+		// abcdefghi is a convenient name that our algorithm convert to our nextcloud blue 0082c9
+		$this->user->method('getDisplayName')->willReturn('abcdefghi');
+	}
+
+	public function testGetNoAvatar() {
+		$file = $this->createMock(ISimpleFile::class);
+		$this->folder->method('newFile')
+			->willReturn($file);
+
+		$this->folder->method('getFile')
+			->will($this->returnCallback(function($path) {
+				if ($path === 'avatar.64.png') {
+					throw new NotFoundException();
+				}
+			}));
+		$this->folder->method('fileExists')
+			->will($this->returnCallback(function($path) {
+				if ($path === 'generated') {
+					return true;
+				}
+				return false;
+			}));
+
+		$data = NULL;
+		$file->method('putContent')
+			->with($this->callback(function ($d) use (&$data) {
+				$data = $d;
+				return true;
+			}));
+
+		$file->method('getContent')
+			->willReturn($data);
+
+		$this->assertEquals($data, $this->avatar->get()->data());
+	}
+
+	public function testGetAvatarSizeMatch() {
+		$this->folder->method('fileExists')
+			->will($this->returnValueMap([
+				['avatar.jpg', true],
+				['avatar.128.jpg', true],
+			]));
+
+		$expected = new \OC_Image();
+		$expected->loadFromFile(\OC::$SERVERROOT . '/tests/data/testavatar.png');
+
+		$file = $this->createMock(File::class);
+		$file->method('getContent')->willReturn($expected->data());
+		$this->folder->method('getFile')->with('avatar.128.jpg')->willReturn($file);
+
+		$this->assertEquals($expected->data(), $this->avatar->get(128)->data());
+	}
+
+	public function testGetAvatarSizeMinusOne() {
+		$this->folder->method('fileExists')
+			->will($this->returnValueMap([
+				['avatar.jpg', true],
+			]));
+
+		$expected = new \OC_Image();
+		$expected->loadFromFile(\OC::$SERVERROOT . '/tests/data/testavatar.png');
+
+		$file = $this->createMock(File::class);
+		$file->method('getContent')->willReturn($expected->data());
+		$this->folder->method('getFile')->with('avatar.jpg')->willReturn($file);
+
+		$this->assertEquals($expected->data(), $this->avatar->get(-1)->data());
+	}
+
+	public function testGetAvatarNoSizeMatch() {
+		$this->folder->method('fileExists')
+			->will($this->returnValueMap([
+				['avatar.png', true],
+				['avatar.32.png', false],
+			]));
+
+		$expected = new \OC_Image();
+		$expected->loadFromFile(\OC::$SERVERROOT . '/tests/data/testavatar.png');
+		$expected2 = new \OC_Image();
+		$expected2->loadFromFile(\OC::$SERVERROOT . '/tests/data/testavatar.png');
+		$expected2->resize(32);
+
+		$file = $this->createMock(File::class);
+		$file->method('getContent')->willReturn($expected->data());
+
+		$this->folder->method('getFile')
+			->will($this->returnCallback(
+				function($path) use ($file) {
+					if ($path === 'avatar.png') {
+						return $file;
+					} else {
+						throw new \OCP\Files\NotFoundException;
+					}
+				}
+			));
+
+		$newFile = $this->createMock(File::class);
+		$newFile->expects($this->once())
+			->method('putContent')
+			->with($expected2->data());
+		$newFile->expects($this->once())
+			->method('getContent')
+			->willReturn($expected2->data());
+		$this->folder->expects($this->once())
+			->method('newFile')
+			->with('avatar.32.png')
+			->willReturn($newFile);
+
+		$this->assertEquals($expected2->data(), $this->avatar->get(32)->data());
+	}
+
+	public function testExistsNo() {
+		$this->assertFalse($this->avatar->exists());
+	}
+
+	public function testExiststJPG() {
+		$this->folder->method('fileExists')
+			->will($this->returnValueMap([
+				['avatar.jpg', true],
+				['avatar.png', false],
+			]));
+		$this->assertTrue($this->avatar->exists());
+	}
+
+	public function testExistsPNG() {
+		$this->folder->method('fileExists')
+			->will($this->returnValueMap([
+				['avatar.jpg', false],
+				['avatar.png', true],
+			]));
+		$this->assertTrue($this->avatar->exists());
+	}
+
+	public function testSetAvatar() {
+		$avatarFileJPG = $this->createMock(File::class);
+		$avatarFileJPG->method('getName')
+			->willReturn('avatar.jpg');
+		$avatarFileJPG->expects($this->once())->method('delete');
+
+		$avatarFilePNG = $this->createMock(File::class);
+		$avatarFilePNG->method('getName')
+			->willReturn('avatar.png');
+		$avatarFilePNG->expects($this->once())->method('delete');
+
+		$resizedAvatarFile = $this->createMock(File::class);
+		$resizedAvatarFile->method('getName')
+			->willReturn('avatar.32.jpg');
+		$resizedAvatarFile->expects($this->once())->method('delete');
+
+		$this->folder->method('getDirectoryListing')
+			->willReturn([$avatarFileJPG, $avatarFilePNG, $resizedAvatarFile]);
+
+		$generated = $this->createMock(File::class);
+		$this->folder->method('getFile')
+			->with('generated')
+			->willReturn($generated);
+
+		$newFile = $this->createMock(File::class);
+		$this->folder->expects($this->once())
+			->method('newFile')
+			->with('avatar.png')
+			->willReturn($newFile);
+
+		$image = new \OC_Image();
+		$image->loadFromFile(\OC::$SERVERROOT . '/tests/data/testavatar.png');
+		$newFile->expects($this->once())
+			->method('putContent')
+			->with($image->data());
+
+		$this->config->expects($this->exactly(3))
+			->method('setUserValue');
+		$this->config->expects($this->once())
+			->method('getUserValue');
+
+		// One on remove and once on setting the new avatar
+		$this->user->expects($this->exactly(2))->method('triggerChange');
+
+		$this->avatar->set($image->data());
+	}
+
+	public function testGenerateSvgAvatar() {
+		$avatar = $this->invokePrivate($this->avatar, 'getAvatarVector', [64]);
+
+		$svg = '<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+		<svg width="64" height="64" version="1.1" viewBox="0 0 500 500" xmlns="http://www.w3.org/2000/svg">
+			<rect width="100%" height="100%" fill="#0082c9"></rect>
+			<text x="50%" y="350" style="font-weight:normal;font-size:279px;font-family:\'Nunito\';text-anchor:middle;fill:#fff">A</text>
+		</svg>';
+		$this->assertEquals($avatar, $svg);
+	}
+
+	public function testHashToInt() {
+		$hashToInt = $this->invokePrivate($this->avatar, 'hashToInt', ['abcdef', 18]);
+		$this->assertTrue(gettype($hashToInt) === 'integer');
+	}
+
+	public function testMixPalette() {
+		$colorFrom = new \OC\Color(0,0,0);
+		$colorTo = new \OC\Color(6,12,18);
+		$steps = 6;
+		$palette = $this->invokePrivate($this->avatar, 'mixPalette', [$steps, $colorFrom, $colorTo]);
+		foreach($palette as $j => $color) {
+			// calc increment
+			$incR = $colorTo->r / $steps * $j;
+			$incG = $colorTo->g / $steps * $j;
+			$incB = $colorTo->b / $steps * $j;
+			// ensure everything is equal
+			$this->assertEquals($color, new \OC\Color($incR, $incG,$incB));
+		}
+		$hashToInt = $this->invokePrivate($this->avatar, 'hashToInt', ['abcdef', 18]);
+		$this->assertTrue(gettype($hashToInt) === 'integer');
+	}
+
+}