nextcloud/apps/settings/tests/Controller/AuthSettingsControllerTest.php

484 lines
14 KiB
PHP
Raw Normal View History

<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Daniel Kesselberg <mail@danielkesselberg.de>
* @author Fabrizio Steiner <fabrizio.steiner@gmail.com>
* @author Greta Doci <gretadoci@gmail.com>
* @author Joas Schilling <coding@schilljs.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <robin@icewind.nl>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Sergej Nikolaev <kinolaev@gmail.com>
*
* @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\Settings\Controller;
2016-05-18 19:25:05 +03:00
use OC\AppFramework\Http;
use OC\Authentication\Exceptions\ExpiredTokenException;
use OC\Authentication\Exceptions\InvalidTokenException;
use OC\Authentication\Token\DefaultToken;
2016-09-07 21:29:27 +03:00
use OC\Authentication\Token\IProvider;
2016-05-18 19:25:05 +03:00
use OC\Authentication\Token\IToken;
use OC\Authentication\Token\IWipeableToken;
use OC\Authentication\Token\RemoteWipe;
use OCA\Settings\Controller\AuthSettingsController;
use OCP\Activity\IEvent;
use OCP\Activity\IManager;
2016-05-18 19:25:05 +03:00
use OCP\AppFramework\Http\JSONResponse;
use OCP\ILogger;
2016-09-07 21:29:27 +03:00
use OCP\IRequest;
use OCP\ISession;
use OCP\IUserSession;
2016-09-07 21:29:27 +03:00
use OCP\Security\ISecureRandom;
2016-05-18 19:25:05 +03:00
use OCP\Session\Exceptions\SessionNotAvailableException;
use PHPUnit\Framework\MockObject\MockObject;
use Test\TestCase;
class AuthSettingsControllerTest extends TestCase {
/** @var AuthSettingsController */
private $controller;
/** @var IRequest|MockObject */
private $request;
/** @var IProvider|MockObject */
private $tokenProvider;
/** @var ISession|MockObject */
2016-05-18 19:25:05 +03:00
private $session;
/**@var IUserSession|MockObject */
private $userSession;
/** @var ISecureRandom|MockObject */
2016-05-18 19:25:05 +03:00
private $secureRandom;
/** @var IManager|MockObject */
private $activityManager;
/** @var RemoteWipe|MockObject */
private $remoteWipe;
private $uid = 'jane';
protected function setUp(): void {
parent::setUp();
2016-09-07 21:29:27 +03:00
$this->request = $this->createMock(IRequest::class);
$this->tokenProvider = $this->createMock(IProvider::class);
$this->session = $this->createMock(ISession::class);
$this->userSession = $this->createMock(IUserSession::class);
2016-09-07 21:29:27 +03:00
$this->secureRandom = $this->createMock(ISecureRandom::class);
$this->activityManager = $this->createMock(IManager::class);
$this->remoteWipe = $this->createMock(RemoteWipe::class);
/** @var ILogger|MockObject $logger */
$logger = $this->createMock(ILogger::class);
$this->controller = new AuthSettingsController(
'core',
$this->request,
$this->tokenProvider,
$this->session,
$this->secureRandom,
$this->uid,
$this->userSession,
$this->activityManager,
$this->remoteWipe,
$logger
);
}
2016-05-18 19:25:05 +03:00
public function testCreate() {
$name = 'Nexus 4';
2016-09-07 21:29:27 +03:00
$sessionToken = $this->createMock(IToken::class);
$deviceToken = $this->createMock(IToken::class);
2016-05-18 19:25:05 +03:00
$password = '123456';
$this->session->expects($this->once())
->method('getId')
->willReturn('sessionid');
2016-05-18 19:25:05 +03:00
$this->tokenProvider->expects($this->once())
->method('getToken')
->with('sessionid')
->willReturn($sessionToken);
2016-05-18 19:25:05 +03:00
$this->tokenProvider->expects($this->once())
->method('getPassword')
->with($sessionToken, 'sessionid')
->willReturn($password);
$sessionToken->expects($this->once())
->method('getLoginName')
->willReturn('User13');
2016-05-18 19:25:05 +03:00
$this->secureRandom->expects($this->exactly(5))
2016-05-18 19:25:05 +03:00
->method('generate')
->with(5, ISecureRandom::CHAR_HUMAN_READABLE)
->willReturn('XXXXX');
$newToken = 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX';
2016-05-18 19:25:05 +03:00
$this->tokenProvider->expects($this->once())
->method('generateToken')
->with($newToken, $this->uid, 'User13', $password, $name, IToken::PERMANENT_TOKEN)
->willReturn($deviceToken);
2016-05-18 19:25:05 +03:00
$deviceToken->expects($this->once())
->method('jsonSerialize')
->willReturn(['dummy' => 'dummy', 'canDelete' => true]);
$this->mockActivityManager();
2016-05-18 19:25:05 +03:00
$expected = [
'token' => $newToken,
'deviceToken' => ['dummy' => 'dummy', 'canDelete' => true, 'canRename' => true],
'loginName' => 'User13',
2016-05-18 19:25:05 +03:00
];
$response = $this->controller->create($name);
$this->assertInstanceOf(JSONResponse::class, $response);
$this->assertEquals($expected, $response->getData());
2016-05-18 19:25:05 +03:00
}
public function testCreateSessionNotAvailable() {
$name = 'personal phone';
$this->session->expects($this->once())
->method('getId')
->will($this->throwException(new SessionNotAvailableException()));
$expected = new JSONResponse();
$expected->setStatus(Http::STATUS_SERVICE_UNAVAILABLE);
$this->assertEquals($expected, $this->controller->create($name));
}
public function testCreateInvalidToken() {
$name = 'Company IPhone';
$this->session->expects($this->once())
->method('getId')
->willReturn('sessionid');
2016-05-18 19:25:05 +03:00
$this->tokenProvider->expects($this->once())
->method('getToken')
->with('sessionid')
->will($this->throwException(new InvalidTokenException()));
$expected = new JSONResponse();
$expected->setStatus(Http::STATUS_SERVICE_UNAVAILABLE);
$this->assertEquals($expected, $this->controller->create($name));
}
public function testDestroy() {
$tokenId = 124;
$token = $this->createMock(DefaultToken::class);
$this->mockGetTokenById($tokenId, $token);
$this->mockActivityManager();
$token->expects($this->exactly(2))
->method('getId')
->willReturn($tokenId);
$token->expects($this->once())
->method('getUID')
->willReturn('jane');
$this->tokenProvider->expects($this->once())
->method('invalidateTokenById')
->with($this->uid, $tokenId);
$this->assertEquals([], $this->controller->destroy($tokenId));
}
public function testDestroyExpired() {
$tokenId = 124;
$token = $this->createMock(DefaultToken::class);
$token->expects($this->exactly(2))
->method('getId')
->willReturn($tokenId);
$token->expects($this->once())
->method('getUID')
->willReturn($this->uid);
$this->tokenProvider->expects($this->once())
->method('getTokenById')
->with($this->equalTo($tokenId))
->willThrowException(new ExpiredTokenException($token));
$this->tokenProvider->expects($this->once())
->method('invalidateTokenById')
->with($this->uid, $tokenId);
$this->assertSame([], $this->controller->destroy($tokenId));
}
public function testDestroyWrongUser() {
$tokenId = 124;
$token = $this->createMock(DefaultToken::class);
$this->mockGetTokenById($tokenId, $token);
$token->expects($this->once())
->method('getUID')
->willReturn('foobar');
$response = $this->controller->destroy($tokenId);
$this->assertSame([], $response->getData());
$this->assertSame(\OCP\AppFramework\Http::STATUS_NOT_FOUND, $response->getStatus());
}
public function dataRenameToken(): array {
return [
'App password => Other token name' => ['App password', 'Other token name'],
'Other token name => App password' => ['Other token name', 'App password'],
];
}
/**
* @dataProvider dataRenameToken
*
* @param string $name
* @param string $newName
*/
public function testUpdateRename(string $name, string $newName): void {
$tokenId = 42;
$token = $this->createMock(DefaultToken::class);
$this->mockGetTokenById($tokenId, $token);
$this->mockActivityManager();
$token->expects($this->once())
->method('getUID')
->willReturn('jane');
$token->expects($this->once())
->method('getName')
->willReturn($name);
$token->expects($this->once())
->method('getScopeAsArray')
->willReturn(['filesystem' => true]);
$token->expects($this->once())
->method('setName')
->with($this->equalTo($newName));
$this->tokenProvider->expects($this->once())
->method('updateToken')
->with($this->equalTo($token));
$this->assertSame([], $this->controller->update($tokenId, ['filesystem' => true], $newName));
}
public function dataUpdateFilesystemScope(): array {
return [
'Grant filesystem access' => [false, true],
'Revoke filesystem access' => [true, false],
];
}
/**
* @dataProvider dataUpdateFilesystemScope
*
* @param bool $filesystem
* @param bool $newFilesystem
*/
public function testUpdateFilesystemScope(bool $filesystem, bool $newFilesystem): void {
$tokenId = 42;
$token = $this->createMock(DefaultToken::class);
$this->mockGetTokenById($tokenId, $token);
$this->mockActivityManager();
$token->expects($this->once())
->method('getUID')
->willReturn('jane');
$token->expects($this->once())
->method('getName')
->willReturn('App password');
$token->expects($this->once())
->method('getScopeAsArray')
->willReturn(['filesystem' => $filesystem]);
$token->expects($this->once())
->method('setScope')
->with($this->equalTo(['filesystem' => $newFilesystem]));
$this->tokenProvider->expects($this->once())
->method('updateToken')
->with($this->equalTo($token));
$this->assertSame([], $this->controller->update($tokenId, ['filesystem' => $newFilesystem], 'App password'));
}
public function testUpdateNoChange(): void {
$tokenId = 42;
$token = $this->createMock(DefaultToken::class);
$this->mockGetTokenById($tokenId, $token);
$token->expects($this->once())
->method('getUID')
->willReturn('jane');
$token->expects($this->once())
->method('getName')
->willReturn('App password');
$token->expects($this->once())
->method('getScopeAsArray')
->willReturn(['filesystem' => true]);
$token->expects($this->never())
->method('setName');
$token->expects($this->never())
->method('setScope');
$this->tokenProvider->expects($this->once())
->method('updateToken')
->with($this->equalTo($token));
$this->assertSame([], $this->controller->update($tokenId, ['filesystem' => true], 'App password'));
}
public function testUpdateExpired() {
$tokenId = 42;
$token = $this->createMock(DefaultToken::class);
$token->expects($this->once())
->method('getUID')
->willReturn($this->uid);
$this->tokenProvider->expects($this->once())
->method('getTokenById')
->with($this->equalTo($tokenId))
->willThrowException(new ExpiredTokenException($token));
$this->tokenProvider->expects($this->once())
->method('updateToken')
->with($this->equalTo($token));
$this->assertSame([], $this->controller->update($tokenId, ['filesystem' => true], 'App password'));
}
public function testUpdateTokenWrongUser() {
$tokenId = 42;
$token = $this->createMock(DefaultToken::class);
$this->mockGetTokenById($tokenId, $token);
$token->expects($this->once())
->method('getUID')
->willReturn('foobar');
$token->expects($this->never())
->method('setScope');
$this->tokenProvider->expects($this->never())
->method('updateToken');
$response = $this->controller->update($tokenId, ['filesystem' => true], 'App password');
$this->assertSame([], $response->getData());
$this->assertSame(\OCP\AppFramework\Http::STATUS_NOT_FOUND, $response->getStatus());
}
public function testUpdateTokenNonExisting() {
$this->tokenProvider->expects($this->once())
->method('getTokenById')
->with($this->equalTo(42))
->willThrowException(new InvalidTokenException('Token does not exist'));
$this->tokenProvider->expects($this->never())
->method('updateToken');
$response = $this->controller->update(42, ['filesystem' => true], 'App password');
$this->assertSame([], $response->getData());
$this->assertSame(\OCP\AppFramework\Http::STATUS_NOT_FOUND, $response->getStatus());
}
private function mockActivityManager(): void {
$this->activityManager->expects($this->once())
->method('generateEvent')
->willReturn($this->createMock(IEvent::class));
$this->activityManager->expects($this->once())
->method('publish');
}
/**
* @param int $tokenId
* @param $token
*/
private function mockGetTokenById(int $tokenId, $token): void {
$this->tokenProvider->expects($this->once())
->method('getTokenById')
->with($this->equalTo($tokenId))
->willReturn($token);
}
public function testRemoteWipeNotSuccessful(): void {
$token = $this->createMock(IToken::class);
$token->expects($this->once())
->method('getUID')
->willReturn($this->uid);
$this->mockGetTokenById(123, $token);
$this->remoteWipe->expects($this->once())
->method('markTokenForWipe')
->with($token)
->willReturn(false);
$response = $this->controller->wipe(123);
$expected = new JSONResponse([], Http::STATUS_BAD_REQUEST);
$this->assertEquals($expected, $response);
}
public function testRemoteWipeWrongUser(): void {
$token = $this->createMock(IToken::class);
$token->expects($this->once())
->method('getUID')
->willReturn('definetly-not-' . $this->uid);
$this->mockGetTokenById(123, $token);
$this->remoteWipe->expects($this->never())
->method('markTokenForWipe');
$response = $this->controller->wipe(123);
$expected = new JSONResponse([], Http::STATUS_NOT_FOUND);
$this->assertEquals($expected, $response);
}
public function testRemoteWipeSuccessful(): void {
$token = $this->createMock(IWipeableToken::class);
$token->expects($this->once())
->method('getUID')
->willReturn($this->uid);
$this->mockGetTokenById(123, $token);
$this->remoteWipe->expects($this->once())
->method('markTokenForWipe')
->with($token)
->willReturn(true);
$response = $this->controller->wipe(123);
$expected = new JSONResponse([]);
$this->assertEquals($expected, $response);
}
}