ApiAuthServiceTest - Code Metrics - nerds-and-company/craft-api-authentication-plugin - Measure and Improve Code Quality continuously with Scrutinizer

ApiAuthServiceTest A
last analyzed 2016-01-28 10:30 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	292
Duplicated Lines	11.99 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	5
Bugs	0	Features	1

Metric	Value
wmc	18
c	5
b	0
f	1
lcom	1
cbo	1
dl	35
loc	292
rs	10

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setUpBeforeClass()	0	8	1
A	testGenerateKeyShouldReturnRandomKey()	0	8	1
A	testAuthenticateKeyShouldReturnFalseWhenKeyExpired()	0	14	1
A	testAuthenticateKeyShouldReturnFalseWhenKeyNotFound()	0	7	1
A	testAuthenticateKeyShouldLoginUserWhenKeyValid()	0	17	1
A	testSaveKeyShouldReturnTrueWhenSavingSucceeds()	10	10	1
A	testSaveKeyShouldReturnFalseWhenSavingFails()	10	10	1
A	testIsOptionsRequestShouldReturnFalseByDefault()	0	8	1
A	testIsOptionsRequestShouldReturnTrueWhenOptionsRequest()	0	10	1
A	testSetCorsHeaderShouldSetCorsHeaders()	0	14	1
A	provideValidUserKeyModelAttributes()	0	10	1
A	provideInvalidUserKeyModelAttributes()	0	10	1
A	setMockUserSessionService()	15	15	1
A	getMockUserKeyModel()	0	8	1
A	getMockUser()	0	13	1
A	setMockApiAuthService()	0	12	2
A	setMockUserKeyModelSaveExpectation()	0	8	1

How to fix Duplicated Code

<?php

namespace Craft;

use \PHPUnit_Framework_MockObject_MockObject as mock;

/**
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015, Nerds & Company
 * @license   MIT
 *
 * @link      http://www.nerds.company
 *
 * @coversDefaultClass Craft\ApiAuthService
 * @covers ::<!public>
 */
class ApiAuthServiceTest extends BaseTest
{
    /**
     * {@inheritdoc}
     */
    public static function setUpBeforeClass()
    {
        parent::setUpBeforeClass();
        //Plugin classes
        require_once __DIR__ . '/../../services/ApiAuthService.php';
        require_once __DIR__ . '/../../models/ApiAuth_UserKeyModel.php';
        require_once __DIR__ . '/../../records/ApiAuth_UserKeyRecord.php';
    }

    //==============================================================================================================
    //=================================================  TESTS  ====================================================
    //==============================================================================================================

    /**
     * @covers ::generateKey
     */
    public function testGenerateKeyShouldReturnRandomKey()
    {
        $service = new ApiAuthService();
        $token1 = $service->generateKey();
        $token2 = $service->generateKey();

        $this->assertNotSame($token1, $token2);
    }

    /**
     * @covers ::authenticateKey
     * @dataProvider provideInvalidUserKeyModelAttributes
     *
     * @param string $key
     * @param int $userId
     * @param DateTime $expires
     */
    public function testAuthenticateKeyShouldReturnFalseWhenKeyExpired($key, $userId, DateTime $expires)
    {
        $mockUserKeyModel = $this->getMockUserKeyModel();
        $mockUserKeyModel->expects($this->exactly(1))
            ->method('__get')
            ->willReturnMap(array(
                array('expires', $expires),
            ));

        $service = $this->setMockApiAuthService('getUserKeyModelByKey', $key, $mockUserKeyModel);

        $result = $service->authenticateKey($key);
        $this->assertFalse($result);
    }

    /**
     * @covers ::authenticateKey
     * @dataProvider provideValidUserKeyModelAttributes
     *
     * @param string $key
     */
    public function testAuthenticateKeyShouldReturnFalseWhenKeyNotFound($key)
    {
        $service = $this->setMockApiAuthService('getUserKeyModelByKey', $key);

        $result = $service->authenticateKey($key);
        $this->assertFalse($result);
    }

    /**
     * @covers ::authenticateKey
     * @dataProvider provideValidUserKeyModelAttributes
     *
     * @param string $key
     * @param int $userId
     * @param DateTime $expires
     */
    public function testAuthenticateKeyShouldLoginUserWhenKeyValid($key, $userId, DateTime $expires)
    {
        $mockUserKeyModel = $this->getMockUserKeyModel();
        $mockUserKeyModel->expects($this->exactly(2))
            ->method('__get')
            ->willReturnMap(array(
                array('expires', $expires),
                array('userId', $userId)
            ));

        $this->setMockUserSessionService($userId);

        $service = $this->setMockApiAuthService('getUserKeyModelByKey', $key, $mockUserKeyModel);

        $result = $service->authenticateKey($key);
        $this->assertTrue($result);
    }

    /**
     * @covers ::saveKey
     * @dataProvider provideValidUserKeyModelAttributes
     *
     * @param string $key
     * @param int $userId
     */
    public function testSaveKeyShouldReturnTrueWhenSavingSucceeds($key, $userId)

    {
        $mockUser = $this->getMockUser($userId);
        $mockUserKeyModel = $this->setMockUserKeyModelSaveExpectation(true);
        $service = $this->setMockApiAuthService('getNewUserKeyModel', 'skip', $mockUserKeyModel);

        $result = $service->saveKey($mockUser, $key);

        $this->assertTrue($result);
    }

    /**
     * @covers ::saveKey
     * @dataProvider provideInvalidUserKeyModelAttributes
     *
     * @param string $key
     * @param int $userId
     */
    public function testSaveKeyShouldReturnFalseWhenSavingFails($key, $userId)

    {
        $mockUser = $this->getMockUser($userId);
        $mockUserKeyModel = $this->setMockUserKeyModelSaveExpectation(false);
        $service = $this->setMockApiAuthService('getNewUserKeyModel', 'skip', $mockUserKeyModel);

        $result = $service->saveKey($mockUser, $key);

        $this->assertFalse($result);
    }

    /**
     * @covers ::isOptionsRequest
     */
    public function testIsOptionsRequestShouldReturnFalseByDefault()
    {
        $service = new ApiAuthService();

        $result = $service->isOptionsRequest();

        $this->assertFalse($result);
    }

    /**
     * @covers ::isOptionsRequest
     */
    public function testIsOptionsRequestShouldReturnTrueWhenOptionsRequest()
    {
        $_SERVER['REQUEST_METHOD'] = 'OPTIONS';

        $service = new ApiAuthService();

        $result = $service->isOptionsRequest();

        $this->assertTrue($result);
    }

    /**
     * @covers ::setCorsHeaders
     */
    public function testSetCorsHeaderShouldSetCorsHeaders()
    {
        /** @var ApiAuthService|mock $service */
        $service = $this->getMock('Craft\ApiAuthService', array('setHeader'));

        $service->expects($this->exactly(2))
            ->method('setHeader')
            ->withConsecutive(
                array('Access-Control-Allow-Headers', 'Authorization'),
                array('Access-Control-Allow-Origin', '*')
            );

        $service->setCorsHeaders();
    }

    //==============================================================================================================
    //==============================================  PROVIDERS  ===================================================
    //==============================================================================================================

    /**
     * @return array
     */
    public function provideValidUserKeyModelAttributes()
    {
        return array(
            'valid key' => array(
                'key' => 'test123',
                'userId' => 1,
                'expires' => new DateTime('+ 1 minute'),
            )
        );
    }

    /**
     * @return array
     */
    public function provideInvalidUserKeyModelAttributes()
    {
        return array(
            'invalid key' => array(
                'key' => 'anotherkey',
                'userId' => 2,
                'expires' => new DateTime('- 1 minute'),
            )
        );
    }

    //==============================================================================================================
    //=================================================  MOCKS  ====================================================
    //==============================================================================================================

    /**
     * @param int $userId
     * @param bool $success
     * @return UserSessionService|mock
     */
    private function setMockUserSessionService($userId, $success = true)

    {
        $mockUserSessionService = $this->getMockBuilder('Craft\UserSessionService')
            ->disableOriginalConstructor()
            ->getMock();

        $mockUserSessionService->expects($this->exactly(1))
            ->method('loginByUserId')
            ->with($userId)
            ->willReturn($success);

        $this->setComponent(craft(), 'userSession', $mockUserSessionService);

        return $mockUserSessionService;
    }

    /**
     * @return ApiAuth_UserKeyModel|mock
     */
    private function getMockUserKeyModel()
    {
        $mockUserKeyModel = $this->getMockBuilder('Craft\ApiAuth_UserKeyModel')
            ->disableOriginalConstructor()
            ->getMock();

        return $mockUserKeyModel;
    }

    /**
     * @param int $userId
     * @return UserModel|mock
     */
    private function getMockUser($userId)
    {
        $mockUser = $this->getMockBuilder('Craft\UserModel')
            ->disableOriginalConstructor()
            ->getMock();

        $mockUser->expects($this->exactly(1))
            ->method('getAttribute')
            ->with('id')
            ->willReturn($userId);

        return $mockUser;
    }

    /**
     * @param array $methodName
     * @param mixed $param
     * @param ApiAuth_UserKeyModel $mockUserKeyModel
     * @return ApiAuthService|mock
     */
    private function setMockApiAuthService($methodName, $param, ApiAuth_UserKeyModel $mockUserKeyModel = null)
    {
        $service = $this->getMock('Craft\ApiAuthService', array($methodName));

        $method = $service->expects($this->exactly(1))->method($methodName);
        if ($param !== 'skip') {
            $method->with($param);
        }
        $method->willReturn($mockUserKeyModel);

        return $service;
    }

    /**
     * @param $success
     * @return ApiAuth_UserKeyModel|mock
     */
    private function setMockUserKeyModelSaveExpectation($success)
    {
        $mockUserKeyModel = $this->getMockUserKeyModel();
        $mockUserKeyModel->expects($this->exactly(1))
            ->method('save')
            ->willReturn($success);
        return $mockUserKeyModel;
    }
}


1		<?php
2
3		namespace Craft;
4
5		use \PHPUnit_Framework_MockObject_MockObject as mock;
6
7		/**
8		* @author Nerds & Company
9		* @copyright Copyright (c) 2015, Nerds & Company
10		* @license MIT
11		*
12		* @link http://www.nerds.company
13		*
14		* @coversDefaultClass Craft\ApiAuthService
15		* @covers ::<!public>
16		*/
17		class ApiAuthServiceTest extends BaseTest
18		{
19		/**
20		* {@inheritdoc}
21		*/
22		public static function setUpBeforeClass()
23		{
24		parent::setUpBeforeClass();
25		//Plugin classes
26		require_once __DIR__ . '/../../services/ApiAuthService.php';
27		require_once __DIR__ . '/../../models/ApiAuth_UserKeyModel.php';
28		require_once __DIR__ . '/../../records/ApiAuth_UserKeyRecord.php';
29		}
30
31		//==============================================================================================================
32		//================================================= TESTS ====================================================
33		//==============================================================================================================
34
35		/**
36		* @covers ::generateKey
37		*/
38		public function testGenerateKeyShouldReturnRandomKey()
39		{
40		$service = new ApiAuthService();
41		$token1 = $service->generateKey();
42		$token2 = $service->generateKey();
43
44		$this->assertNotSame($token1, $token2);
45		}
46
47		/**
48		* @covers ::authenticateKey
49		* @dataProvider provideInvalidUserKeyModelAttributes
50		*
51		* @param string $key
52		* @param int $userId
53		* @param DateTime $expires
54		*/
55		public function testAuthenticateKeyShouldReturnFalseWhenKeyExpired($key, $userId, DateTime $expires)
56		{
57		$mockUserKeyModel = $this->getMockUserKeyModel();
58		$mockUserKeyModel->expects($this->exactly(1))
59		->method('__get')
60		->willReturnMap(array(
61		array('expires', $expires),
62		));
63
64		$service = $this->setMockApiAuthService('getUserKeyModelByKey', $key, $mockUserKeyModel);
65
66		$result = $service->authenticateKey($key);
67		$this->assertFalse($result);
68		}
69
70		/**
71		* @covers ::authenticateKey
72		* @dataProvider provideValidUserKeyModelAttributes
73		*
74		* @param string $key
75		*/
76		public function testAuthenticateKeyShouldReturnFalseWhenKeyNotFound($key)
77		{
78		$service = $this->setMockApiAuthService('getUserKeyModelByKey', $key);
79
80		$result = $service->authenticateKey($key);
81		$this->assertFalse($result);
82		}
83
84		/**
85		* @covers ::authenticateKey
86		* @dataProvider provideValidUserKeyModelAttributes
87		*
88		* @param string $key
89		* @param int $userId
90		* @param DateTime $expires
91		*/
92		public function testAuthenticateKeyShouldLoginUserWhenKeyValid($key, $userId, DateTime $expires)
93		{
94		$mockUserKeyModel = $this->getMockUserKeyModel();
95		$mockUserKeyModel->expects($this->exactly(2))
96		->method('__get')
97		->willReturnMap(array(
98		array('expires', $expires),
99		array('userId', $userId)
100		));
101
102		$this->setMockUserSessionService($userId);
103
104		$service = $this->setMockApiAuthService('getUserKeyModelByKey', $key, $mockUserKeyModel);
105
106		$result = $service->authenticateKey($key);
107		$this->assertTrue($result);
108		}
109
110		/**
111		* @covers ::saveKey
112		* @dataProvider provideValidUserKeyModelAttributes
113		*
114		* @param string $key
115		* @param int $userId
116		*/
117	View Code Duplication	public function testSaveKeyShouldReturnTrueWhenSavingSucceeds($key, $userId)
		0 ignored issues – show Duplication introduced 2015-11-24 09:56 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
118		{
119		$mockUser = $this->getMockUser($userId);
120		$mockUserKeyModel = $this->setMockUserKeyModelSaveExpectation(true);
121		$service = $this->setMockApiAuthService('getNewUserKeyModel', 'skip', $mockUserKeyModel);
122
123		$result = $service->saveKey($mockUser, $key);
124
125		$this->assertTrue($result);
126		}
127
128		/**
129		* @covers ::saveKey
130		* @dataProvider provideInvalidUserKeyModelAttributes
131		*
132		* @param string $key
133		* @param int $userId
134		*/
135	View Code Duplication	public function testSaveKeyShouldReturnFalseWhenSavingFails($key, $userId)
		0 ignored issues – show Duplication introduced 2015-11-24 09:56 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
136		{
137		$mockUser = $this->getMockUser($userId);
138		$mockUserKeyModel = $this->setMockUserKeyModelSaveExpectation(false);
139		$service = $this->setMockApiAuthService('getNewUserKeyModel', 'skip', $mockUserKeyModel);
140
141		$result = $service->saveKey($mockUser, $key);
142
143		$this->assertFalse($result);
144		}
145
146		/**
147		* @covers ::isOptionsRequest
148		*/
149		public function testIsOptionsRequestShouldReturnFalseByDefault()
150		{
151		$service = new ApiAuthService();
152
153		$result = $service->isOptionsRequest();
154
155		$this->assertFalse($result);
156		}
157
158		/**
159		* @covers ::isOptionsRequest
160		*/
161		public function testIsOptionsRequestShouldReturnTrueWhenOptionsRequest()
162		{
163		$_SERVER['REQUEST_METHOD'] = 'OPTIONS';
164
165		$service = new ApiAuthService();
166
167		$result = $service->isOptionsRequest();
168
169		$this->assertTrue($result);
170		}
171
172		/**
173		* @covers ::setCorsHeaders
174		*/
175		public function testSetCorsHeaderShouldSetCorsHeaders()
176		{
177		/** @var ApiAuthService\|mock $service */
178		$service = $this->getMock('Craft\ApiAuthService', array('setHeader'));
179
180		$service->expects($this->exactly(2))
181		->method('setHeader')
182		->withConsecutive(
183		array('Access-Control-Allow-Headers', 'Authorization'),
184		array('Access-Control-Allow-Origin', '*')
185		);
186
187		$service->setCorsHeaders();
188		}
189
190		//==============================================================================================================
191		//============================================== PROVIDERS ===================================================
192		//==============================================================================================================
193
194		/**
195		* @return array
196		*/
197		public function provideValidUserKeyModelAttributes()
198		{
199		return array(
200		'valid key' => array(
201		'key' => 'test123',
202		'userId' => 1,
203		'expires' => new DateTime('+ 1 minute'),
204		)
205		);
206		}
207
208		/**
209		* @return array
210		*/
211		public function provideInvalidUserKeyModelAttributes()
212		{
213		return array(
214		'invalid key' => array(
215		'key' => 'anotherkey',
216		'userId' => 2,
217		'expires' => new DateTime('- 1 minute'),
218		)
219		);
220		}
221
222		//==============================================================================================================
223		//================================================= MOCKS ====================================================
224		//==============================================================================================================
225
226		/**
227		* @param int $userId
228		* @param bool $success
229		* @return UserSessionService\|mock
230		*/
231	View Code Duplication	private function setMockUserSessionService($userId, $success = true)
		0 ignored issues – show Duplication introduced 2015-11-24 10:40 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
232		{
233		$mockUserSessionService = $this->getMockBuilder('Craft\UserSessionService')
234		->disableOriginalConstructor()
235		->getMock();
236
237		$mockUserSessionService->expects($this->exactly(1))
238		->method('loginByUserId')
239		->with($userId)
240		->willReturn($success);
241
242		$this->setComponent(craft(), 'userSession', $mockUserSessionService);
243
244		return $mockUserSessionService;
245		}
246
247		/**
248		* @return ApiAuth_UserKeyModel\|mock
249		*/
250		private function getMockUserKeyModel()
251		{
252		$mockUserKeyModel = $this->getMockBuilder('Craft\ApiAuth_UserKeyModel')
253		->disableOriginalConstructor()
254		->getMock();
255
256		return $mockUserKeyModel;
257		}
258
259		/**
260		* @param int $userId
261		* @return UserModel\|mock
262		*/
263		private function getMockUser($userId)
264		{
265		$mockUser = $this->getMockBuilder('Craft\UserModel')
266		->disableOriginalConstructor()
267		->getMock();
268
269		$mockUser->expects($this->exactly(1))
270		->method('getAttribute')
271		->with('id')
272		->willReturn($userId);
273
274		return $mockUser;
275		}
276
277		/**
278		* @param array $methodName
279		* @param mixed $param
280		* @param ApiAuth_UserKeyModel $mockUserKeyModel
281		* @return ApiAuthService\|mock
282		*/
283		private function setMockApiAuthService($methodName, $param, ApiAuth_UserKeyModel $mockUserKeyModel = null)
284		{
285		$service = $this->getMock('Craft\ApiAuthService', array($methodName));
286
287		$method = $service->expects($this->exactly(1))->method($methodName);
288		if ($param !== 'skip') {
289		$method->with($param);
290		}
291		$method->willReturn($mockUserKeyModel);
292
293		return $service;
294		}
295
296		/**
297		* @param $success
298		* @return ApiAuth_UserKeyModel\|mock
299		*/
300		private function setMockUserKeyModelSaveExpectation($success)
301		{
302		$mockUserKeyModel = $this->getMockUserKeyModel();
303		$mockUserKeyModel->expects($this->exactly(1))
304		->method('save')
305		->willReturn($success);
306		return $mockUserKeyModel;
307		}
308		}
309

nerds-and-company / craft-api-authentication-plugin

ApiAuthServiceTest A last analyzed 2016-01-28 10:30 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

ApiAuthServiceTest A
last analyzed 2016-01-28 10:30 UTC