mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Controller tests fixes 

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
This commit is contained in:
John Molakvoæ (skjnldsv) 2018-05-07 08:48:38 +02:00
parent c1766b2abc
commit eea6f74ca4
No known key found for this signature in database
GPG Key ID: 60C25B8C072916CF
4 changed files with 127 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
core/Controller/AvatarController.php
View File

@ -8,6 +8,7 @@
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license AGPL-3.0
*
@ -146,13 +147,22 @@ class AvatarController extends Controller {
$size = 64;
}
// Serve png as a fallback only
if ($png === false) {
$avatar = $this->avatarManager->getAvatar($userId)->getAvatarVector($size);
$resp = new DataDisplayResponse(
$avatar,
Http::STATUS_OK,
['Content-Type' => 'image/svg+xml'
]);
try {
$avatar = $this->avatarManager->getAvatar($userId)->getAvatarVector($size);
$resp = new DataDisplayResponse(
$avatar,
Http::STATUS_OK,
['Content-Type' => 'image/svg+xml'
]);
} catch (\Exception $e) {
$resp = new Http\Response();
$resp->setStatus(Http::STATUS_NOT_FOUND);
return $resp;
}
} else {
try {

5
lib/private/Avatar.php
View File

@ -11,6 +11,7 @@
* @author Robin Appelman <robin@icewind.nl>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license AGPL-3.0
*
@ -280,7 +281,7 @@ class Avatar implements IAvatar {
* @return string
*
*/
public function getAvatarVector($size) {
public function getAvatarVector(int $size): string {
$userDisplayName = $this->user->getDisplayName();
$bgRGB = $this->avatarBackgroundColor($userDisplayName);
@ -410,7 +411,7 @@ class Avatar implements IAvatar {
* @param string $text
* @return Color Object containting r g b int in the range [0, 255]
*/
public function avatarBackgroundColor($text) {
public function avatarBackgroundColor(string $text) {
$hash = preg_replace('/[^0-9a-f]+/', '', $text);
$hash = md5($hash);

104
lib/public/IAvatar.php
View File

@ -8,6 +8,7 @@
* @author Robin Appelman <robin@icewind.nl>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license AGPL-3.0
*
@ -26,6 +27,7 @@
*/
namespace OCP;
use OCP\Files\File;
use OCP\Files\NotFoundException;
@ -35,52 +37,66 @@ use OCP\Files\NotFoundException;
*/
interface IAvatar {
/**
* get the users avatar
* @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image
* @return boolean|\OCP\IImage containing the avatar or false if there's no image
* @since 6.0.0 - size of -1 was added in 9.0.0
*/
public function get($size = 64);
/**
* get the users avatar
* @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image
* @return boolean|\OCP\IImage containing the avatar or false if there's no image
* @since 6.0.0 - size of -1 was added in 9.0.0
*/
public function get($size = 64);
/**
* Check if an avatar exists for the user
*
* @return bool
* @since 8.1.0
*/
public function exists();
/**
* sets the users avatar
* @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar
* @throws \Exception if the provided file is not a jpg or png image
* @throws \Exception if the provided image is not valid
* @throws \OC\NotSquareException if the image is not square
* @return void
* @since 6.0.0
*/
public function set($data);
/**
* remove the users avatar
* @return void
* @since 6.0.0
*/
public function remove();
/**
* Get the file of the avatar
* @param int $size -1 can be used to not scale the image
* @return File
* @throws NotFoundException
* @since 9.0.0
*/
public function getFile($size);
/**
* Generate SVG avatar
* @param int $size -1 can be used to not scale the image
* @return string
* @since 14.0.0
*/
public function getAvatarVector(int $size): string;
/**
* Check if an avatar exists for the user
*
* @return bool
* @since 8.1.0
* @param string $text
* @return Color Object containting r g b int in the range [0, 255]
*/
public function exists();
public function avatarBackgroundColor(string $text);
/**
* sets the users avatar
* @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar
* @throws \Exception if the provided file is not a jpg or png image
* @throws \Exception if the provided image is not valid
* @throws \OC\NotSquareException if the image is not square
* @return void
* @since 6.0.0
*/
public function set($data);
/**
* remove the users avatar
* @return void
* @since 6.0.0
*/
public function remove();
/**
* Get the file of the avatar
* @param int $size -1 can be used to not scale the image
* @return File
* @throws NotFoundException
* @since 9.0.0
*/
public function getFile($size);
/**
* Handle a changed user
* @since 13.0.0
*/
public function userChanged($feature, $oldValue, $newValue);
/**
* Handle a changed user
* @since 13.0.0
*/
public function userChanged($feature, $oldValue, $newValue);
}

58
tests/Core/Controller/AvatarControllerTest.php
View File

@ -94,6 +94,7 @@ class AvatarControllerTest extends \Test\TestCase {
$this->timeFactory = $this->getMockBuilder('OC\AppFramework\Utility\TimeFactory')->getMock();
$this->avatarMock = $this->getMockBuilder('OCP\IAvatar')->getMock();
$this->color = new \OC\Color(0, 130, 201);
$this->userMock = $this->getMockBuilder(IUser::class)->getMock();
$this->avatarController = new AvatarController(
@ -119,6 +120,8 @@ class AvatarControllerTest extends \Test\TestCase {
$this->avatarFile->method('getContent')->willReturn('image data');
$this->avatarFile->method('getMimeType')->willReturn('image type');
$this->avatarFile->method('getEtag')->willReturn('my etag');
$this->avatarMock->method('avatarBackgroundColor')->willReturn($this->color);
}
public function tearDown() {
@ -130,10 +133,21 @@ class AvatarControllerTest extends \Test\TestCase {
*/
public function testGetAvatarNoAvatar() {
$this->avatarManager->method('getAvatar')->willReturn($this->avatarMock);
$this->avatarMock->method('getFile')->will($this->throwException(new NotFoundException()));
$this->avatarMock->method('getAvatarVector')->willReturn('<svg></svg>');
$response = $this->avatarController->getAvatar('userId', 32);
//Comment out until JS is fixed
$this->assertEquals(Http::STATUS_OK, $response->getStatus());
$this->assertEquals('<svg></svg>', $response->getData());
}
/**
* Fetch a png avatar if a user has no avatar
*/
public function testGetPngAvatarNoAvatar() {
$this->avatarManager->method('getAvatar')->willReturn($this->avatarMock);
$this->avatarMock->method('getFile')->will($this->throwException(new NotFoundException()));
$response = $this->avatarController->getAvatar('userId', 32, true);
$this->assertEquals(Http::STATUS_NOT_FOUND, $response->getStatus());
}
@ -141,11 +155,27 @@ class AvatarControllerTest extends \Test\TestCase {
* Fetch the user's avatar
*/
public function testGetAvatar() {
$this->avatarMock->method('getFile')->willReturn($this->avatarFile);
$this->avatarMock->method('getAvatarVector')->willReturn('<svg></svg>');
$this->avatarManager->method('getAvatar')->with('userId')->willReturn($this->avatarMock);
$response = $this->avatarController->getAvatar('userId', 32);
$this->assertEquals(Http::STATUS_OK, $response->getStatus());
$this->assertArrayHasKey('Content-Type', $response->getHeaders());
$this->assertEquals('image/svg+xml', $response->getHeaders()['Content-Type']);
$this->assertEquals('<svg></svg>', $response->getData());
}
/**
* Fetch the user's avatar
*/
public function testGetPngAvatar() {
$this->avatarMock->method('getFile')->willReturn($this->avatarFile);
$this->avatarManager->method('getAvatar')->with('userId')->willReturn($this->avatarMock);
$response = $this->avatarController->getAvatar('userId', 32, true);
$this->assertEquals(Http::STATUS_OK, $response->getStatus());
$this->assertArrayHasKey('Content-Type', $response->getHeaders());
$this->assertEquals('image type', $response->getHeaders()['Content-Type']);
@ -171,7 +201,7 @@ class AvatarControllerTest extends \Test\TestCase {
/**
* Make sure we get the correct size
*/
public function testGetAvatarSize() {
public function testGetPngAvatarSize() {
$this->avatarMock->expects($this->once())
->method('getFile')
->with($this->equalTo(32))
@ -179,13 +209,13 @@ class AvatarControllerTest extends \Test\TestCase {
$this->avatarManager->method('getAvatar')->willReturn($this->avatarMock);
$this->avatarController->getAvatar('userId', 32);
$this->avatarController->getAvatar('userId', 32, true);
}
/**
* We cannot get avatars that are 0 or negative
*/
public function testGetAvatarSizeMin() {
public function testGetPngAvatarSizeMin() {
$this->avatarMock->expects($this->once())
->method('getFile')
->with($this->equalTo(64))
@ -193,13 +223,13 @@ class AvatarControllerTest extends \Test\TestCase {
$this->avatarManager->method('getAvatar')->willReturn($this->avatarMock);
$this->avatarController->getAvatar('userId', 0);
$this->avatarController->getAvatar('userId', 0, true);
}
/**
* We do not support avatars larger than 2048*2048
*/
public function testGetAvatarSizeMax() {
public function testGetPngAvatarSizeMax() {
$this->avatarMock->expects($this->once())
->method('getFile')
->with($this->equalTo(2048))
@ -207,7 +237,7 @@ class AvatarControllerTest extends \Test\TestCase {
$this->avatarManager->method('getAvatar')->willReturn($this->avatarMock);
$this->avatarController->getAvatar('userId', 2049);
$this->avatarController->getAvatar('userId', 2049, true);
}
/**
@ -486,7 +516,6 @@ class AvatarControllerTest extends \Test\TestCase {
$this->assertEquals($expectedResponse, $this->avatarController->postCroppedAvatar(['x' => 0, 'y' => 0, 'w' => 10, 'h' => 11]));
}
/**
* Check for proper reply on proper crop argument
*/
@ -501,4 +530,13 @@ class AvatarControllerTest extends \Test\TestCase {
$this->assertEquals('File is too big', $response->getData()['data']['message']);
}
/**
* Test get Avatar BG colour algorithm
*/
public function testAvatarBackgroundColor() {
$bgRGB = $this->avatarMock->avatarBackgroundColor('TestBlue');
$this->assertEquals($bgRGB, $this->color);
$this->assertEquals(sprintf("%02x%02x%02x", $bgRGB->r, $bgRGB->g, $bgRGB->b), '0082c9');
}
}