ApiAuthControllerTest - Code Metrics - Inspection of "Merge pull request #3 from nerds-and-company/forgo..." - nerds-and-company/craft-api-authentication-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d797db...0417d6 )

by Bart

created 2015-11-24 13:12 UTC

ApiAuthControllerTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	298
Duplicated Lines	15.44 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	5
Bugs	2	Features	1

Metric	Value
wmc	18
c	5
b	2
f	1
lcom	1
cbo	0
dl	46
loc	298
rs	10

15 Methods

Rating	Name	Duplication	Size	Complexity
A	setUpBeforeClass()	0	7	1
A	testApiAuthControllerAuthenticateShouldReturnBadCredentialsWhenLoginFails()	0	14	1
A	testApiAuthControllerAuthenticateShouldReturnInternalServerErrorWhenKeyCannotBeSaved()	16	16	1
A	testApiAuthControllerAuthenticateShouldReturnKey()	15	15	1
A	testApiAuthControllerAuthenticateShouldReturnErrorWhenNotPostRequest()	0	9	1
A	testApiAuthControllerResetPasswordShouldReturnErrorWhenNotPostRequest()	0	9	1
A	testApiAuthControllerResetPasswordShouldReturnSuccessMessageWhenUserNotFound()	0	13	1
A	testApiAuthControllerResetPasswordShouldSendMailWhenUserFound()	0	19	1
A	getMockApiAuthController()	0	14	1
A	getMockUser()	0	8	1
A	setMockRequestService()	0	23	3
A	setMockUserSessionService()	0	21	2
A	setSimpleMockApiAuthService()	0	10	1
A	setMockApiAuthService()	0	16	1
A	setMockUsersService()	15	15	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\ApiAuthController
 * @covers ::<!public>
 */
class ApiAuthControllerTest extends BaseTest
{
    /**
     * {@inheritdoc}
     */
    public static function setUpBeforeClass()
    {
        parent::setUpBeforeClass();
        //Plugin classes
        require_once __DIR__ . '/../../controllers/ApiAuthController.php';
        require_once __DIR__ . '/../../services/ApiAuthService.php';
    }

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

    /**
     * @covers ::actionAuthenticate
     */
    public function testApiAuthControllerAuthenticateShouldReturnErrorWhenNotPostRequest()
    {
        $this->setSimpleMockApiAuthService();
        $this->setMockRequestService('GET');

        $apiAuthController = $this->getMockApiAuthController('returnErrorJson', '');

        $apiAuthController->actionAuthenticate();
    }

    /**
     * @covers ::actionAuthenticate
     */
    public function testApiAuthControllerAuthenticateShouldReturnBadCredentialsWhenLoginFails()
    {
        $username = 'username';
        $password = 'test123';
        $errorMessage = Craft::t('Invalid username or password');

        $this->setSimpleMockApiAuthService();
        $this->setMockRequestService('POST', $username, $password);
        $this->setMockUserSessionService($username, $password, false);

        $apiAuthController = $this->getMockApiAuthController('returnErrorJson', $errorMessage);

        $apiAuthController->actionAuthenticate();
    }

    /**
     * @covers ::actionAuthenticate
     */
    public function testApiAuthControllerAuthenticateShouldReturnInternalServerErrorWhenKeyCannotBeSaved()

    {
        $username = 'username';
        $password = 'test123';
        $key = 'averynicekey';
        $errorMessage = Craft::t('Something went wrong');

        $mockUser = $this->getMockUser();
        $this->setMockRequestService('POST', $username, $password);
        $this->setMockUserSessionService($username, $password, true, $mockUser);
        $this->setMockApiAuthService($key, $mockUser, false);

        $apiAuthController = $this->getMockApiAuthController('returnErrorJson', $errorMessage);

        $apiAuthController->actionAuthenticate();
    }

    /**
     * @covers ::actionAuthenticate
     */
    public function testApiAuthControllerAuthenticateShouldReturnKey()

    {
        $username = 'username';
        $password = 'test123';
        $key = 'averynicekey';

        $mockUser = $this->getMockUser();
        $this->setMockRequestService('POST', $username, $password);
        $this->setMockUserSessionService($username, $password, true, $mockUser);
        $this->setMockApiAuthService($key, $mockUser, true);

        $apiAuthController = $this->getMockApiAuthController('returnJson', array('key' => $key));

        $apiAuthController->actionAuthenticate();
    }

    /**
     * @covers ::actionResetPassword
     */
    public function testApiAuthControllerResetPasswordShouldReturnErrorWhenNotPostRequest()
    {
        $this->setSimpleMockApiAuthService();
        $this->setMockRequestService('GET');

        $apiAuthController = $this->getMockApiAuthController('returnErrorJson', '');

        $apiAuthController->actionResetPassword();
    }

    /**
     * @covers ::actionResetPassword
     */
    public function testApiAuthControllerResetPasswordShouldReturnSuccessMessageWhenUserNotFound()
    {
        $username = 'username';
        $message = array('message' => Craft::t('Email has been sent if address exists'));

        $this->setSimpleMockApiAuthService();
        $this->setMockUsersService($username);
        $this->setMockRequestService('POST', $username, null, 1);

        $apiAuthController = $this->getMockApiAuthController('returnJson', $message);

        $apiAuthController->actionResetPassword();
    }

    /**
     * @covers ::actionResetPassword
     */
    public function testApiAuthControllerResetPasswordShouldSendMailWhenUserFound()
    {
        $username = 'username';
        $message = array('message' => Craft::t('Email has been sent if address exists'));

        $this->setSimpleMockApiAuthService();
        $this->setMockRequestService('POST', $username, null, 1);

        $mockUser = $this->getMockUser();
        $mockUsersService = $this->setMockUsersService($username, $mockUser);

        $mockUsersService->expects($this->exactly(1))
            ->method('sendPasswordResetEmail')
            ->with($mockUser);

        $apiAuthController = $this->getMockApiAuthController('returnJson', $message);

        $apiAuthController->actionResetPassword();
    }

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

    /**
     * @param string $method
     * @param mixed $param
     * @param mixed $return
     * @return ApiAuthController|mock
     */
    private function getMockApiAuthController($method, $param, $return = null)
    {
        $apiAuthController = $this->getMockBuilder('Craft\ApiAuthController')
            ->disableOriginalConstructor()
            ->setMethods(array($method))
            ->getMock();

        $apiAuthController->expects($this->exactly(1))
            ->method($method)
            ->with($param)
            ->willReturn($return);

        return $apiAuthController;
    }

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

        return $mockUser;
    }

    /**
     * @param string $requestType
     * @param string $username
     * @param string $password
     * @param int $count
     *
     * @return UserPermissionsService|mock
     */
    private function setMockRequestService($requestType, $username = null, $password = null, $count = 2)
    {
        $mockRequestService = $this->getMockBuilder('Craft\HttpRequestService')
            ->disableOriginalConstructor()
            ->getMock();

        $mockRequestService->expects($this->exactly(1))
            ->method('getRequestType')
            ->willReturn($requestType);

        if ($username !== null || $password !== null) {
            $mockRequestService->expects($this->exactly($count))
                ->method('getRequiredPost')
                ->willReturnMap(array(
                    array('username', $username),
                    array('password', $password),
                ));
        }

        $this->setComponent(craft(), 'request', $mockRequestService);

        return $mockRequestService;
    }

    /**
     * @param string $username
     * @param string $password
     * @param bool $success
     * @param UserModel $mockUser
     *
     * @return UserSessionService|mock
     */
    private function setMockUserSessionService($username, $password, $success = true, UserModel $mockUser = null)
    {
        $mockUserSessionService = $this->getMockBuilder('Craft\UserSessionService')
            ->disableOriginalConstructor()
            ->getMock();

        $mockUserSessionService->expects($this->exactly(1))
            ->method('login')
            ->with($username, $password)
            ->willReturn($success);

        if ($mockUser) {
            $mockUserSessionService->expects($this->exactly(1))
                ->method('getUser')
                ->willReturn($mockUser);
        }

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

        return $mockUserSessionService;
    }

    /**
     * @return mock|ApiAuthService
     */
    private function setSimpleMockApiAuthService()
    {
        $mockApiAuthService = $this->getMockBuilder('Craft\ApiAuthService')
            ->disableOriginalConstructor()
            ->getMock();

        $this->setComponent(craft(), 'apiAuth', $mockApiAuthService);

        return $mockApiAuthService;
    }

    /**
     * @param string $key
     * @param UserModel $mockUser
     * @param bool $success
     *
     * @return mock|ApiAuthService
     */
    private function setMockApiAuthService($key, UserModel $mockUser, $success)
    {
        $mockApiAuthService = $this->setSimpleMockApiAuthService();

        $mockApiAuthService->expects($this->exactly(1))
            ->method('generateKey')
            ->willReturn($key);

        $mockApiAuthService->expects($this->exactly(1))
            ->method('saveKey')
            ->with($mockUser, $key)
            ->willReturn($success);


        return $mockApiAuthService;
    }

    /**
     * @param string $username
     * @param UserModel $user
     * @return mock|UsersService
     */
    private function setMockUsersService($username, UserModel $user = null)

    {
        $mockUsersService = $this->getMockBuilder('Craft\UsersService')
            ->disableOriginalConstructor()
            ->getMock();

        $mockUsersService->expects($this->exactly(1))
            ->method('getUserByUsernameOrEmail')
            ->with($username)
            ->willReturn($user);

        $this->setComponent(craft(), 'users', $mockUsersService);

        return $mockUsersService;
    }
}


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\ApiAuthController
15		* @covers ::<!public>
16		*/
17		class ApiAuthControllerTest extends BaseTest
18		{
19		/**
20		* {@inheritdoc}
21		*/
22		public static function setUpBeforeClass()
23		{
24		parent::setUpBeforeClass();
25		//Plugin classes
26		require_once __DIR__ . '/../../controllers/ApiAuthController.php';
27		require_once __DIR__ . '/../../services/ApiAuthService.php';
28		}
29
30		//==============================================================================================================
31		//================================================= TESTS ====================================================
32		//==============================================================================================================
33
34		/**
35		* @covers ::actionAuthenticate
36		*/
37		public function testApiAuthControllerAuthenticateShouldReturnErrorWhenNotPostRequest()
38		{
39		$this->setSimpleMockApiAuthService();
40		$this->setMockRequestService('GET');
41
42		$apiAuthController = $this->getMockApiAuthController('returnErrorJson', '');
43
44		$apiAuthController->actionAuthenticate();
45		}
46
47		/**
48		* @covers ::actionAuthenticate
49		*/
50		public function testApiAuthControllerAuthenticateShouldReturnBadCredentialsWhenLoginFails()
51		{
52		$username = 'username';
53		$password = 'test123';
54		$errorMessage = Craft::t('Invalid username or password');
55
56		$this->setSimpleMockApiAuthService();
57		$this->setMockRequestService('POST', $username, $password);
58		$this->setMockUserSessionService($username, $password, false);
59
60		$apiAuthController = $this->getMockApiAuthController('returnErrorJson', $errorMessage);
61
62		$apiAuthController->actionAuthenticate();
63		}
64
65		/**
66		* @covers ::actionAuthenticate
67		*/
68	View Code Duplication	public function testApiAuthControllerAuthenticateShouldReturnInternalServerErrorWhenKeyCannotBeSaved()
		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...
69		{
70		$username = 'username';
71		$password = 'test123';
72		$key = 'averynicekey';
73		$errorMessage = Craft::t('Something went wrong');
74
75		$mockUser = $this->getMockUser();
76		$this->setMockRequestService('POST', $username, $password);
77		$this->setMockUserSessionService($username, $password, true, $mockUser);
78		$this->setMockApiAuthService($key, $mockUser, false);
79
80		$apiAuthController = $this->getMockApiAuthController('returnErrorJson', $errorMessage);
81
82		$apiAuthController->actionAuthenticate();
83		}
84
85		/**
86		* @covers ::actionAuthenticate
87		*/
88	View Code Duplication	public function testApiAuthControllerAuthenticateShouldReturnKey()
		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...
89		{
90		$username = 'username';
91		$password = 'test123';
92		$key = 'averynicekey';
93
94		$mockUser = $this->getMockUser();
95		$this->setMockRequestService('POST', $username, $password);
96		$this->setMockUserSessionService($username, $password, true, $mockUser);
97		$this->setMockApiAuthService($key, $mockUser, true);
98
99		$apiAuthController = $this->getMockApiAuthController('returnJson', array('key' => $key));
100
101		$apiAuthController->actionAuthenticate();
102		}
103
104		/**
105		* @covers ::actionResetPassword
106		*/
107		public function testApiAuthControllerResetPasswordShouldReturnErrorWhenNotPostRequest()
108		{
109		$this->setSimpleMockApiAuthService();
110		$this->setMockRequestService('GET');
111
112		$apiAuthController = $this->getMockApiAuthController('returnErrorJson', '');
113
114		$apiAuthController->actionResetPassword();
115		}
116
117		/**
118		* @covers ::actionResetPassword
119		*/
120		public function testApiAuthControllerResetPasswordShouldReturnSuccessMessageWhenUserNotFound()
121		{
122		$username = 'username';
123		$message = array('message' => Craft::t('Email has been sent if address exists'));
124
125		$this->setSimpleMockApiAuthService();
126		$this->setMockUsersService($username);
127		$this->setMockRequestService('POST', $username, null, 1);
128
129		$apiAuthController = $this->getMockApiAuthController('returnJson', $message);
130
131		$apiAuthController->actionResetPassword();
132		}
133
134		/**
135		* @covers ::actionResetPassword
136		*/
137		public function testApiAuthControllerResetPasswordShouldSendMailWhenUserFound()
138		{
139		$username = 'username';
140		$message = array('message' => Craft::t('Email has been sent if address exists'));
141
142		$this->setSimpleMockApiAuthService();
143		$this->setMockRequestService('POST', $username, null, 1);
144
145		$mockUser = $this->getMockUser();
146		$mockUsersService = $this->setMockUsersService($username, $mockUser);
147
148		$mockUsersService->expects($this->exactly(1))
149		->method('sendPasswordResetEmail')
150		->with($mockUser);
151
152		$apiAuthController = $this->getMockApiAuthController('returnJson', $message);
153
154		$apiAuthController->actionResetPassword();
155		}
156
157		//==============================================================================================================
158		//================================================= MOCKS ====================================================
159		//==============================================================================================================
160
161		/**
162		* @param string $method
163		* @param mixed $param
164		* @param mixed $return
165		* @return ApiAuthController\|mock
166		*/
167		private function getMockApiAuthController($method, $param, $return = null)
168		{
169		$apiAuthController = $this->getMockBuilder('Craft\ApiAuthController')
170		->disableOriginalConstructor()
171		->setMethods(array($method))
172		->getMock();
173
174		$apiAuthController->expects($this->exactly(1))
175		->method($method)
176		->with($param)
177		->willReturn($return);
178
179		return $apiAuthController;
180		}
181
182		/**
183		* @return UserModel\|mock
184		*/
185		private function getMockUser()
186		{
187		$mockUser = $this->getMockBuilder('Craft\UserModel')
188		->disableOriginalConstructor()
189		->getMock();
190
191		return $mockUser;
192		}
193
194		/**
195		* @param string $requestType
196		* @param string $username
197		* @param string $password
198		* @param int $count
199		*
200		* @return UserPermissionsService\|mock
201		*/
202		private function setMockRequestService($requestType, $username = null, $password = null, $count = 2)
203		{
204		$mockRequestService = $this->getMockBuilder('Craft\HttpRequestService')
205		->disableOriginalConstructor()
206		->getMock();
207
208		$mockRequestService->expects($this->exactly(1))
209		->method('getRequestType')
210		->willReturn($requestType);
211
212		if ($username !== null \|\| $password !== null) {
213		$mockRequestService->expects($this->exactly($count))
214		->method('getRequiredPost')
215		->willReturnMap(array(
216		array('username', $username),
217		array('password', $password),
218		));
219		}
220
221		$this->setComponent(craft(), 'request', $mockRequestService);
222
223		return $mockRequestService;
224		}
225
226		/**
227		* @param string $username
228		* @param string $password
229		* @param bool $success
230		* @param UserModel $mockUser
231		*
232		* @return UserSessionService\|mock
233		*/
234		private function setMockUserSessionService($username, $password, $success = true, UserModel $mockUser = null)
235		{
236		$mockUserSessionService = $this->getMockBuilder('Craft\UserSessionService')
237		->disableOriginalConstructor()
238		->getMock();
239
240		$mockUserSessionService->expects($this->exactly(1))
241		->method('login')
242		->with($username, $password)
243		->willReturn($success);
244
245		if ($mockUser) {
246		$mockUserSessionService->expects($this->exactly(1))
247		->method('getUser')
248		->willReturn($mockUser);
249		}
250
251		$this->setComponent(craft(), 'userSession', $mockUserSessionService);
252
253		return $mockUserSessionService;
254		}
255
256		/**
257		* @return mock\|ApiAuthService
258		*/
259		private function setSimpleMockApiAuthService()
260		{
261		$mockApiAuthService = $this->getMockBuilder('Craft\ApiAuthService')
262		->disableOriginalConstructor()
263		->getMock();
264
265		$this->setComponent(craft(), 'apiAuth', $mockApiAuthService);
266
267		return $mockApiAuthService;
268		}
269
270		/**
271		* @param string $key
272		* @param UserModel $mockUser
273		* @param bool $success
274		*
275		* @return mock\|ApiAuthService
276		*/
277		private function setMockApiAuthService($key, UserModel $mockUser, $success)
278		{
279		$mockApiAuthService = $this->setSimpleMockApiAuthService();
280
281		$mockApiAuthService->expects($this->exactly(1))
282		->method('generateKey')
283		->willReturn($key);
284
285		$mockApiAuthService->expects($this->exactly(1))
286		->method('saveKey')
287		->with($mockUser, $key)
288		->willReturn($success);
289
290
291		return $mockApiAuthService;
292		}
293
294		/**
295		* @param string $username
296		* @param UserModel $user
297		* @return mock\|UsersService
298		*/
299	View Code Duplication	private function setMockUsersService($username, UserModel $user = null)
		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...
300		{
301		$mockUsersService = $this->getMockBuilder('Craft\UsersService')
302		->disableOriginalConstructor()
303		->getMock();
304
305		$mockUsersService->expects($this->exactly(1))
306		->method('getUserByUsernameOrEmail')
307		->with($username)
308		->willReturn($user);
309
310		$this->setComponent(craft(), 'users', $mockUsersService);
311
312		return $mockUsersService;
313		}
314		}
315

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

Push — master ( d797db...0417d6 )

ApiAuthControllerTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like