Merge pull request #15752 from owncloud/feature/fix-encryption-return-values

[enc2] fixing return values and adding tests
2015-05-04 11:44:15 +02:00 · 2015-05-04 11:44:15 +02:00 · 0f7b8dd338
parent 7376ea9b26 8c0856779b
commit 0f7b8dd338
4 changed files with 300 additions and 94 deletions
--- a/apps/encryption/controller/recoverycontroller.php
+++ b/apps/encryption/controller/recoverycontroller.php
@ -26,6 +26,7 @@ namespace OCA\Encryption\Controller;

 use OCA\Encryption\Recovery;
 use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
 use OCP\IConfig;
 use OCP\IL10N;
 use OCP\IRequest;
@ -73,30 +74,35 @@ class RecoveryController extends Controller {
 		// Check if both passwords are the same
 		if (empty($recoveryPassword)) {
 			$errorMessage = (string)$this->l->t('Missing recovery key password');
-			return new DataResponse(['data' => ['message' => $errorMessage]], 500);
+			return new DataResponse(['data' => ['message' => $errorMessage]],
+				Http::STATUS_BAD_REQUEST);
 		}

 		if (empty($confirmPassword)) {
 			$errorMessage = (string)$this->l->t('Please repeat the recovery key password');
-			return new DataResponse(['data' => ['message' => $errorMessage]], 500);
+			return new DataResponse(['data' => ['message' => $errorMessage]],
+				Http::STATUS_BAD_REQUEST);
 		}

 		if ($recoveryPassword !== $confirmPassword) {
 			$errorMessage = (string)$this->l->t('Repeated recovery key password does not match the provided recovery key password');
-			return new DataResponse(['data' => ['message' => $errorMessage]], 500);
+			return new DataResponse(['data' => ['message' => $errorMessage]],
+				Http::STATUS_BAD_REQUEST);
 		}

 		if (isset($adminEnableRecovery) && $adminEnableRecovery === '1') {
 			if ($this->recovery->enableAdminRecovery($recoveryPassword)) {
-				return new DataResponse(['status'	=>'success', 'data' => array('message' => (string) $this->l->t('Recovery key successfully enabled'))]);
+				return new DataResponse(['data' => ['message' => (string)$this->l->t('Recovery key successfully enabled')]]);
 			}
-			return new DataResponse(['data' => array('message' => (string) $this->l->t('Could not enable recovery key. Please check your recovery key password!'))]);
+			return new DataResponse(['data' => ['message' => (string)$this->l->t('Could not enable recovery key. Please check your recovery key password!')]], Http::STATUS_BAD_REQUEST);
 		} elseif (isset($adminEnableRecovery) && $adminEnableRecovery === '0') {
 			if ($this->recovery->disableAdminRecovery($recoveryPassword)) {
-				return new DataResponse(['data' => array('message' => (string) $this->l->t('Recovery key successfully disabled'))]);
+				return new DataResponse(['data' => ['message' => (string)$this->l->t('Recovery key successfully disabled')]]);
 			}
-			return new DataResponse(['data' => array('message' => (string) $this->l->t('Could not disable recovery key. Please check your recovery key password!'))]);
+			return new DataResponse(['data' => ['message' => (string)$this->l->t('Could not disable recovery key. Please check your recovery key password!')]], Http::STATUS_BAD_REQUEST);
 		}
+		// this response should never be sent but just in case.
+		return new DataResponse(['data' => ['message' => (string)$this->l->t('Missing parameters')]], Http::STATUS_BAD_REQUEST);
 	}

 	/**
@ -109,42 +115,41 @@ class RecoveryController extends Controller {
 		//check if both passwords are the same
 		if (empty($oldPassword)) {
 			$errorMessage = (string)$this->l->t('Please provide the old recovery password');
-			return new DataResponse(array('data' => array('message' => $errorMessage)));
+			return new DataResponse(['data' => ['message' => $errorMessage]], Http::STATUS_BAD_REQUEST);
 		}

 		if (empty($newPassword)) {
 			$errorMessage = (string)$this->l->t('Please provide a new recovery password');
-			return new DataResponse (array('data' => array('message' => $errorMessage)));
+			return new DataResponse (['data' => ['message' => $errorMessage]], Http::STATUS_BAD_REQUEST);
 		}

 		if (empty($confirmPassword)) {
 			$errorMessage = (string)$this->l->t('Please repeat the new recovery password');
-			return new DataResponse(array('data' => array('message' => $errorMessage)));
+			return new DataResponse(['data' => ['message' => $errorMessage]], Http::STATUS_BAD_REQUEST);
 		}

 		if ($newPassword !== $confirmPassword) {
 			$errorMessage = (string)$this->l->t('Repeated recovery key password does not match the provided recovery key password');
-			return new DataResponse(array('data' => array('message' => $errorMessage)));
+			return new DataResponse(['data' => ['message' => $errorMessage]], Http::STATUS_BAD_REQUEST);
 		}

-		$result = $this->recovery->changeRecoveryKeyPassword($newPassword, $oldPassword);
+		$result = $this->recovery->changeRecoveryKeyPassword($newPassword,
+			$oldPassword);

 		if ($result) {
 			return new DataResponse(
-				array(
-					'status' => 'success' ,
-					'data' => array(
-						'message' => (string) $this->l->t('Password successfully changed.'))
-					)
-				);
-		} else {
-			return new DataResponse(
-				array(
-					'data' => array
-						('message' => (string) $this->l->t('Could not change the password. Maybe the old password was not correct.'))
-					)
+				[
+					'data' => [
+						'message' => (string)$this->l->t('Password successfully changed.')]
+				]
 			);
 		}
+		return new DataResponse(
+			[
+				'data' => [
+					'message' => (string)$this->l->t('Could not change the password. Maybe the old password was not correct.')
+				]
+			], Http::STATUS_BAD_REQUEST);
 	}

 	/**
@ -159,22 +164,29 @@ class RecoveryController extends Controller {
 			$result = $this->recovery->setRecoveryForUser($userEnableRecovery);

 			if ($result) {
+				if ($userEnableRecovery === '0') {
 					return new DataResponse(
-					array(
-					'status' => 'success',
-					'data' => array(
-						'message' => (string) $this->l->t('Recovery Key enabled'))
-					)
-				);
-			} else {
-				return new DataResponse(
-					array(
-					'data' => array
-						('message' => (string) $this->l->t('Could not enable the recovery key, please try again or contact your administrator'))
-					)
+						[
+							'data' => [
+								'message' => (string)$this->l->t('Recovery Key disabled')]
+						]
 					);
 				}
-		}
+				return new DataResponse(
+					[
+						'data' => [
+							'message' => (string)$this->l->t('Recovery Key enabled')]
+					]
+				);
+			}
+
+		}
+		return new DataResponse(
+			[
+				'data' => [
+					'message' => (string)$this->l->t('Could not enable the recovery key, please try again or contact your administrator')
+				]
+			], Http::STATUS_BAD_REQUEST);
 	}

 }
--- a/apps/encryption/js/settings-admin.js
+++ b/apps/encryption/js/settings-admin.js
@ -12,30 +12,31 @@ $(document).ready(function(){
 	$('input:radio[name="adminEnableRecovery"]').change(
 		function () {
 			var recoveryStatus = $(this).val();
-			var oldStatus = (1+parseInt(recoveryStatus, 10)) % 2;
+			var oldStatus = (1 + parseInt(recoveryStatus)) % 2;
 			var recoveryPassword = $('#encryptionRecoveryPassword').val();
 			var confirmPassword = $('#repeatEncryptionRecoveryPassword').val();
 			OC.msg.startSaving('#encryptionSetRecoveryKey .msg');
 			$.post(
 				OC.generateUrl('/apps/encryption/ajax/adminRecovery'),
-				{ adminEnableRecovery: recoveryStatus,
+				{
+					adminEnableRecovery: recoveryStatus,
 					recoveryPassword: recoveryPassword,
-					confirmPassword: confirmPassword },
-				function( result ) {
-					OC.msg.finishedSaving('#encryptionSetRecoveryKey .msg', result);
-					if (result.status === "error") {
-						$('input:radio[name="adminEnableRecovery"][value="'+oldStatus.toString()+'"]')
-							.attr("checked", "true");
-					} else {
+					confirmPassword: confirmPassword
+				}
+			).done(function (data) {
+					OC.msg.finishedSuccess('#encryptionSetRecoveryKey .msg', data.data.message);
+
 					if (recoveryStatus === "0") {
 						$('p[name="changeRecoveryPasswordBlock"]').addClass("hidden");
 					} else {
 						$('input:password[name="changeRecoveryPassword"]').val("");
 						$('p[name="changeRecoveryPasswordBlock"]').removeClass("hidden");
 					}
-					}
-				}
-			);
+				})
+				.fail(function (jqXHR) {
+					$('input:radio[name="adminEnableRecovery"][value="' + oldStatus.toString() + '"]').attr("checked", "true");
+					OC.msg.finishedError('#encryptionSetRecoveryKey .msg', JSON.parse(jqXHR.responseText).data.message);
+				});
 		}
 	);

@ -48,11 +49,17 @@ $(document).ready(function(){
 		OC.msg.startSaving('#encryptionChangeRecoveryKey .msg');
 		$.post(
 			OC.generateUrl('/apps/encryption/ajax/changeRecoveryPassword'),
-			{ oldPassword: oldRecoveryPassword, newPassword: newRecoveryPassword, confirmPassword: confirmNewPassword },
-			function( data ) {
-					OC.msg.finishedSaving('#encryptionChangeRecoveryKey .msg', data);
+			{
+				oldPassword: oldRecoveryPassword,
+				newPassword: newRecoveryPassword,
+				confirmPassword: confirmNewPassword
 			}
-		);
+		).done(function (data) {
+				OC.msg.finishedSuccess('#encryptionChangeRecoveryKey .msg', data.data.message);
+			})
+			.fail(function (jqXHR) {
+				OC.msg.finishedError('#encryptionChangeRecoveryKey .msg', JSON.parse(jqXHR.responseText).data.message);
+			});
 	});

 });
--- a/apps/encryption/js/settings-personal.js
+++ b/apps/encryption/js/settings-personal.js
@ -15,11 +15,15 @@ OC.Encryption = {
 		OC.msg.startSaving('#encryption .msg');
 		$.post(
 			OC.generateUrl('/apps/encryption/ajax/updatePrivateKeyPassword'),
-			{oldPassword: oldPrivateKeyPassword, newPassword: newPrivateKeyPassword}
-		).success(function (response) {
-			OC.msg.finishedSuccess('#encryption .msg', response.message);
-		}).fail(function (response) {
-			OC.msg.finishedError('#encryption .msg', response.responseJSON.message);
+			{
+				oldPassword: oldPrivateKeyPassword,
+				newPassword: newPrivateKeyPassword
+			}
+		).done(function (data) {
+				OC.msg.finishedSuccess('#encryption .msg', data.message);
+			})
+			.fail(function (jqXHR) {
+				OC.msg.finishedError('#encryption .msg', JSON.parse(jqXHR.responseText).message);
 			});
 	}
 };
@ -33,11 +37,15 @@ $(document).ready(function(){
 			OC.msg.startAction('#userEnableRecovery .msg', 'Updating recovery keys. This can take some time...');
 			$.post(
 				OC.generateUrl('/apps/encryption/ajax/userSetRecovery'),
-				{ userEnableRecovery: recoveryStatus },
-				function( data ) {
-					OC.msg.finishedAction('#userEnableRecovery .msg', data);
+				{
+					userEnableRecovery: recoveryStatus
 				}
-			);
+			).done(function (data) {
+					OC.msg.finishedSuccess('#userEnableRecovery .msg', data.data.message);
+				})
+				.fail(function (jqXHR) {
+					OC.msg.finishedError('#userEnableRecovery .msg', JSON.parse(jqXHR.responseText).data.message);
+				});
 			// Ensure page is not reloaded on form submit
 			return false;
 		}
--- a/apps/encryption/tests/controller/RecoveryControllerTest.php
+++ b/apps/encryption/tests/controller/RecoveryControllerTest.php
@ -0,0 +1,179 @@
+<?php
+/**
+ * @author Clark Tomlinson  <clark@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ */
+
+
+namespace OCA\Encryption\Tests\Controller;
+
+
+use OCA\Encryption\Controller\RecoveryController;
+use OCP\AppFramework\Http;
+use Test\TestCase;
+
+class RecoveryControllerTest extends TestCase {
+	/**
+	 * @var RecoveryController
+	 */
+	private $controller;
+	private $appName;
+	/**
+	 * @var \PHPUnit_Framework_MockObject_MockObject
+	 */
+	private $requestMock;
+	/**
+	 * @var \PHPUnit_Framework_MockObject_MockObject
+	 */
+	private $configMock;
+	/**
+	 * @var \PHPUnit_Framework_MockObject_MockObject
+	 */
+	private $l10nMock;
+	/**
+	 * @var \PHPUnit_Framework_MockObject_MockObject
+	 */
+	private $recoveryMock;
+
+	public function adminRecoveryProvider() {
+		return [
+			['test', 'test', '1', 'Recovery key successfully enabled', HTTP::STATUS_OK],
+			['', 'test', '1', 'Missing recovery key password', HTTP::STATUS_BAD_REQUEST],
+			['test', '', '1', 'Please repeat the recovery key password', HTTP::STATUS_BAD_REQUEST],
+			['test', 'soimething that doesn\'t match', '1', 'Repeated recovery key password does not match the provided recovery key password', HTTP::STATUS_BAD_REQUEST],
+			['test', 'test', '0', 'Recovery key successfully disabled', HTTP::STATUS_OK],
+		];
+	}
+
+	/**
+	 * @dataProvider adminRecoveryProvider
+	 * @param $recoveryPassword
+	 * @param $passconfirm
+	 * @param $enableRecovery
+	 * @param $expectedMessage
+	 * @param $expectedStatus
+	 */
+	public function testAdminRecovery($recoveryPassword, $passconfirm, $enableRecovery, $expectedMessage, $expectedStatus) {
+
+
+		$this->recoveryMock->expects($this->any())
+			->method('enableAdminRecovery')
+			->willReturn(true);
+
+		$this->recoveryMock->expects($this->any())
+			->method('disableAdminRecovery')
+			->willReturn(true);
+
+		$response = $this->controller->adminRecovery($recoveryPassword,
+			$passconfirm,
+			$enableRecovery);
+
+
+		$this->assertEquals($expectedMessage, $response->getData()['data']['message']);
+		$this->assertEquals($expectedStatus, $response->getStatus());
+
+
+	}
+
+	public function changeRecoveryPasswordProvider() {
+		return [
+			['test', 'test', 'oldtestFail', 'Could not change the password. Maybe the old password was not correct.', HTTP::STATUS_BAD_REQUEST],
+			['test', 'test', 'oldtest', 'Password successfully changed.', HTTP::STATUS_OK],
+			['test', 'notmatch', 'oldtest', 'Repeated recovery key password does not match the provided recovery key password', HTTP::STATUS_BAD_REQUEST],
+			['', 'test', 'oldtest', 'Please provide a new recovery password', HTTP::STATUS_BAD_REQUEST],
+			['test', 'test', '', 'Please provide the old recovery password', HTTP::STATUS_BAD_REQUEST]
+		];
+	}
+
+	/**
+	 * @dataProvider changeRecoveryPasswordProvider
+	 * @param $password
+	 * @param $confirmPassword
+	 * @param $oldPassword
+	 * @param $expectedMessage
+	 * @param $expectedStatus
+	 */
+	public function testChangeRecoveryPassword($password, $confirmPassword, $oldPassword, $expectedMessage, $expectedStatus) {
+		$this->recoveryMock->expects($this->any())
+			->method('changeRecoveryKeyPassword')
+			->with($password, $oldPassword)
+			->will($this->returnValueMap([
+				['test', 'oldTestFail', false],
+				['test', 'oldtest', true]
+			]));
+
+		$response = $this->controller->changeRecoveryPassword($password,
+			$oldPassword,
+			$confirmPassword);
+
+		$this->assertEquals($expectedMessage, $response->getData()['data']['message']);
+		$this->assertEquals($expectedStatus, $response->getStatus());
+
+
+	}
+
+	public function userSetRecoveryProvider() {
+		return [
+			['1', 'Recovery Key enabled', Http::STATUS_OK],
+			['0', 'Could not enable the recovery key, please try again or contact your administrator', Http::STATUS_BAD_REQUEST]
+		];
+	}
+
+	/**
+	 * @dataProvider userSetRecoveryProvider
+	 * @param $enableRecovery
+	 * @param $expectedMessage
+	 * @param $expectedStatus
+	 */
+	public function testUserSetRecovery($enableRecovery, $expectedMessage, $expectedStatus) {
+		$this->recoveryMock->expects($this->any())
+			->method('setRecoveryForUser')
+			->with($enableRecovery)
+			->will($this->returnValueMap([
+				['1', true],
+				['0', false]
+			]));
+
+
+		$response = $this->controller->userSetRecovery($enableRecovery);
+
+		$this->assertEquals($expectedMessage, $response->getData()['data']['message']);
+		$this->assertEquals($expectedStatus, $response->getStatus());
+
+	}
+
+	protected function setUp() {
+		parent::setUp();
+
+		$this->appName = 'encryption';
+		$this->requestMock = $this->getMockBuilder('\OCP\IRequest')
+			->disableOriginalConstructor()
+			->getMock();
+
+		$this->configMock = $this->getMockBuilder('OCP\IConfig')
+			->disableOriginalConstructor()
+			->getMock();
+
+		$this->l10nMock = $this->getMockBuilder('OCP\IL10N')
+			->disableOriginalConstructor()
+			->getMock();
+
+		// Make l10n work in our tests
+		$this->l10nMock->expects($this->any())
+			->method('t')
+			->willReturnArgument(0);
+
+		$this->recoveryMock = $this->getMockBuilder('OCA\Encryption\Recovery')
+			->disableOriginalConstructor()
+			->getMock();
+
+		$this->controller = new RecoveryController($this->appName,
+			$this->requestMock,
+			$this->configMock,
+			$this->l10nMock,
+			$this->recoveryMock);
+	}
+
+}