Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

unit tests for ConfigController::oauthRedirect #28

Merged
merged 2 commits into from
Jan 29, 2022
Merged

unit tests for ConfigController::oauthRedirect #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a92770
unit tests for ConfigController::oauthRedirect
individual-it Jan 28, 2022
2df119d
improve error reporting
individual-it Jan 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions lib/Controller/ConfigController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
}
Expand Down
162 changes: 162 additions & 0 deletions tests/lib/Controller/ConfigControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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());
}
}