Merge pull request #28 from nextcloud/tests/ConfigController/oauthRed…

…irect unit tests for ConfigController::oauthRedirect
nextcloud · Jan 29, 2022 · aadaf35 · aadaf35
2 parents 6bd294e + 2df119d
commit aadaf35
Show file tree

Hide file tree

Showing 2 changed files with 174 additions and 2 deletions.
diff --git a/lib/Controller/ConfigController.php b/lib/Controller/ConfigController.php
@@ -136,20 +136,30 @@ public function oauthRedirect(string $code = '', string $state = ''): RedirectRe
 				'redirect_uri' => $redirect_uri,
 				'grant_type' => 'authorization_code'
 			], 'POST');
-			if (isset($result['access_token'])) {
+			if (isset($result['access_token']) && isset($result['refresh_token'])) {
 				$accessToken = $result['access_token'];
 				$this->config->setUserValue($this->userId, Application::APP_ID, 'token', $accessToken);
 				$this->config->setUserValue($this->userId, Application::APP_ID, 'token_type', 'oauth');
 				$refreshToken = $result['refresh_token'];
 				$this->config->setUserValue($this->userId, Application::APP_ID, 'refresh_token', $refreshToken);
 				// get user info
+				// ToDo check response for errors
 				$this->storeUserInfo($accessToken);
 				return new RedirectResponse(
 					$this->urlGenerator->linkToRoute('settings.PersonalSettings.index', ['section' => 'connected-accounts']) .
 					'?openprojectToken=success'
 				);
 			}
-			$result = $this->l->t('Error getting OAuth access token.') . ' ' . $result['error'];
+			$error = '';
+			if (!isset($result['access_token'])) {
+				$error = $this->l->t('Error getting OAuth access token.');
+			} elseif (!isset($result['refresh_token'])) {
+				$error = $this->l->t('Error getting OAuth refresh token.');
+			}
+			if (isset($result['error'])) {
+				$error = $error . ' ' . $result['error'];
+			}
+			$result =  $error;
 		} else {
 			$result = $this->l->t('Error during OAuth exchanges');
 		}

diff --git a/tests/lib/Controller/ConfigControllerTest.php b/tests/lib/Controller/ConfigControllerTest.php
@@ -0,0 +1,162 @@
+<?php
+
+namespace OCA\OpenProject\Controller;
+
+use OCA\OpenProject\Service\OpenProjectAPIService;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\IRequest;
+use OCP\IURLGenerator;
+use PHPUnit\Framework\TestCase;
+
+class ConfigControllerTest extends TestCase
+{
+
+	/**
+	 * @var IL10N
+	 */
+	private IL10N $l;
+
+	/**
+	 * @var IConfig
+	 */
+	private IConfig $configMock;
+
+	/**
+	 * @return void
+	 * @before
+	 */
+	function setUpMocks(): void {
+		$apiServiceMock = $this->getMockBuilder(OpenProjectAPIService::class)
+			->disableOriginalConstructor()
+			->getMock();
+
+		$apiServiceMock
+			->method('request')
+			->with(
+				'http://openproject.org',
+				'oAuthAccessToken',
+				'oauth',
+				'oAuthRefreshToken',
+				'clientID',
+				'clientSecret',
+				'testUser',
+				'users/me'
+			)
+			->willReturn(['lastName' => 'Himal', 'firstName' => 'Tripatti', 'id' => 1]);
+
+		$apiServiceMock
+			->method('requestOAuthAccessToken')
+			->willReturn(['access_token' => 'oAuthAccessToken', 'refresh_token' => 'oAuthRefreshToken']);
+
+		$this->l = $this->createMock(IL10N::class);
+		$this->l->expects($this->any())
+			->method('t')
+			->willReturnCallback(function ($string, $args) {
+				return vsprintf($string, $args);
+			});
+
+		$this->configMock = $this->getMockBuilder(IConfig::class)->getMock();
+		$this->configMock
+			->method('getAppValue')
+			->withConsecutive(
+				['integration_openproject', 'client_id'],
+				['integration_openproject', 'client_secret'],
+				['integration_openproject', 'client_id'],
+				['integration_openproject', 'client_secret'],
+			)->willReturnOnConsecutiveCalls('clientID', 'clientSecret', 'clientID', 'clientSecret');
+		$this->configMock
+			->method('getUserValue')
+			->withConsecutive(
+				['testUser', 'integration_openproject', 'oauth_state'],
+				['testUser', 'integration_openproject', 'redirect_uri'],
+				['testUser', 'integration_openproject', 'url'],
+				['testUser', 'integration_openproject', 'token_type'],
+				['testUser', 'integration_openproject', 'refresh_token'],
+				['testUser', 'integration_openproject', 'url'],
+			)
+			->willReturnOnConsecutiveCalls(
+				'randomString',
+				'http://redirect.back.to.here/some/url',
+				'http://openproject.org',
+				'oauth',
+				'oAuthRefreshToken',
+				'http://openproject.org'
+			);
+
+		$this->configController = new ConfigController(
+			'integration_openproject',
+			$this->createMock(IRequest::class),
+			$this->configMock,
+			$this->createMock(IURLGenerator::class),
+			$this->l,
+			$apiServiceMock,
+			'testUser'
+		);
+	}
+
+	public function testOauthRedirect() {
+		$result = $this->configController->oauthRedirect('code','randomString');
+		$this->assertSame('?openprojectToken=success', $result->getRedirectURL());
+	}
+
+	public function testOauthRedirectWrongState() {
+		$result = $this->configController->oauthRedirect('code','stateNotSameAsSaved');
+		$this->assertSame('?openprojectToken=error&message=Error+during+OAuth+exchanges', $result->getRedirectURL());
+	}
+
+	public function badOAuthResponseDataProvider() {
+		return [
+			[
+				['error' => 'something went wrong'],
+				'?openprojectToken=error&message=Error+getting+OAuth+access+token.+something+went+wrong'
+			],
+			[
+				[],
+				'?openprojectToken=error&message=Error+getting+OAuth+access+token.'
+			],
+			[   // access token given but no refresh token
+				['access_token' => '123'],
+				'?openprojectToken=error&message=Error+getting+OAuth+refresh+token.'
+			],
+			[   // access token & error given but no refresh token
+				['access_token' => '123', 'error' => 'issue'],
+				'?openprojectToken=error&message=Error+getting+OAuth+refresh+token.+issue'
+			],
+			[   //refresh token given but no access token
+				['refresh_token' => '123'],
+				'?openprojectToken=error&message=Error+getting+OAuth+access+token.'
+			],
+			[   //refresh token & error given but no access token
+				['refresh_token' => '123', 'error' => 'issue'],
+				'?openprojectToken=error&message=Error+getting+OAuth+access+token.+issue'
+			]
+		];
+	}
+
+	/**
+	 * @return void
+	 * @dataProvider badOAuthResponseDataProvider
+	 */
+	public function testOauthNoAccessTokenInResponse($oauthResponse, $expectedRedirect) {
+		$apiServiceMock = $this->getMockBuilder(OpenProjectAPIService::class)
+			->disableOriginalConstructor()
+			->getMock();
+
+		$apiServiceMock
+			->method('requestOAuthAccessToken')
+			->willReturn($oauthResponse);
+
+		$configController = new ConfigController(
+			'integration_openproject',
+			$this->createMock(IRequest::class),
+			$this->configMock,
+			$this->createMock(IURLGenerator::class),
+			$this->l,
+			$apiServiceMock,
+			'testUser'
+		);
+		$result = $configController->oauthRedirect('code','randomString');
+		$this->assertSame($expectedRedirect, $result->getRedirectURL());
+	}
+}