DevelopersControllerTest::testCallback() - Code Metrics - Inspection of "Add tests for Developers Model and Controller" - phpmyadmin/error-reporting-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#171)

by Deven

created 2017-07-05 03:32 UTC

DevelopersControllerTest::testCallback() B

↳ Parent: DevelopersControllerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	82
Code Lines	48

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	82
rs	8.7769
cc	1
eloc	48
nc	1
nop	0

How to fix Long Method

<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */

/**
 * Tests for Developers Controller
 *
 * phpMyAdmin Error reporting server
 * Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
 * @license   https://opensource.org/licenses/mit-license.php MIT License
 *
 * @see      https://www.phpmyadmin.net/
 */
namespace App\Test\TestCase\Controller;

use App\Controller\DevelopersController;
use Cake\ORM\TableRegistry;
use Cake\TestSuite\IntegrationTestCase;

/**
 * App\Controller\DevelopersController Test Case
 */
class DevelopersControllerTest extends IntegrationTestCase
{
    use \phpmock\phpunit\PHPMock;

    /**
     * Fixtures
     *
     * @var array
     */
    public $fixtures = [
        'app.developers',
        'app.notifications'
    ];

    public function setUp()
    {
        $this->Developers = TableRegistry::get('Developers');
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Test login method
     *
     * @return void
     */
    public function testLogin()
    {
        // Empty session during initiation
        $this->session(array());

        $this->get('developers/login');
        $this->assertRedirectContains('https://github.com/login/oauth/authorize');
        $this->assertRedirectContains('developers%2Fcallback');
    }

    /**
     * Test callback method
     *
     * @return void
     */
    public function testCallback()
    {
        // Mock functions `curl_exec` and `curl_getinfo` in GithubApiComponent
        // so that we don't actually hit the Github Api
        $curlExecMock = $this->getFunctionMock('\App\Controller\Component', 'curl_exec');
        $curlGetInfoMock = $this->getFunctionMock('\App\Controller\Component', 'curl_getinfo');

        $accessTokenResponse = json_encode(array('access_token' => 'abc'));
        $emptyAccessTokenResponse = json_encode(array('access_token' => null));

        $nonSuccessUserResponse = json_encode(array('message' => 'Unauthorized access'));
        $userResponse = file_get_contents(TESTS . 'Fixture' . DS . 'user_response.json');

        // Github unsuccessful response followed by successful response
        $curlExecMock->expects($this->exactly(10))->willReturnOnConsecutiveCalls(
            $emptyAccessTokenResponse,
            $emptyAccessTokenResponse,
            $accessTokenResponse, $nonSuccessUserResponse,
            $accessTokenResponse, $userResponse, null,
            $accessTokenResponse, $userResponse, null
        );
        $curlGetInfoMock->expects($this->exactly(5))->willReturnOnConsecutiveCalls(
            401,
            200, 404,
            200, 204
        );

        // Case 1.1 Test no access_token in Github response (with last_page not set in session)
        // So, empty the session
        $this->session(array());

        $this->get('developers/callback/?code=123123123');
        $this->assertRedirect(['controller' => '', 'action' => 'index']);

        // Case 1.2 Test no access_token in Github response (with last_page set in session)
        $this->session(
            array(
                'last_page' => array(
                    'controller' => 'notifications',
                    'action' => 'index'
                )
            )
        );

        $this->get('developers/callback/?code=123123123');
        $this->assertRedirect(['controller' => '', 'action' => 'index']);

        // Case 2. Non successful response code from Github
        $this->session(
            array(
                'last_page' => array(
                    'controller' => 'reports',
                    'action' => 'index'
                )
            )
        );
        $this->get('developers/callback/?code=123123123');
        $this->assertRedirect(['controller' => '', 'action' => 'index']);


        // Case 3. Successful response code (new user), check whether session variables are init
        $this->get('developers/callback/?code=123123123');
        $this->assertSession(3, 'Developer.id');
        $this->assertSession(true, 'read_only');
        $this->assertSession('abc', 'access_token');

        $developer = $this->Developers->get(3);
        $this->assertEquals('abc', $developer->access_token);
        $this->assertEquals('[email protected]', $developer->email);

        // Case 4. Successful response code (returning user)
        // check whether session variables are init
        $this->session(array('last_page' => null));

        $this->get('developers/callback/?code=123123123');
        $this->assertSession(3, 'Developer.id');
        $this->assertSession(false, 'read_only');
        $this->assertSession('abc', 'access_token');

        $developer = $this->Developers->get(3);
        $this->assertEquals(1, $developer->has_commit_access);
    }

    /**
     * Test logout method
     *
     * @return void
     */
    public function testLogout()
    {
        $this->session(array('Developer.id' => 1));

        $this->get('developers/logout');
        $this->assertSession(null, 'Developer.id');
        $this->assertRedirect(['controller' => '', 'action' => 'index']);
    }
}


1			<?php
2			/* vim: set expandtab sw=4 ts=4 sts=4: */
3
4			/**
5			* Tests for Developers Controller
6			*
7			* phpMyAdmin Error reporting server
8			* Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
9			*
10			* Licensed under The MIT License
11			* For full copyright and license information, please see the LICENSE.txt
12			* Redistributions of files must retain the above copyright notice.
13			*
14			* @copyright Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
15			* @license https://opensource.org/licenses/mit-license.php MIT License
16			*
17			* @see https://www.phpmyadmin.net/
18			*/
19			namespace App\Test\TestCase\Controller;
20
21			use App\Controller\DevelopersController;
22			use Cake\ORM\TableRegistry;
23			use Cake\TestSuite\IntegrationTestCase;
24
25			/**
26			* App\Controller\DevelopersController Test Case
27			*/
28			class DevelopersControllerTest extends IntegrationTestCase
29			{
30			use \phpmock\phpunit\PHPMock;
31
32			/**
33			* Fixtures
34			*
35			* @var array
36			*/
37			public $fixtures = [
38			'app.developers',
39			'app.notifications'
40			];
41
42			public function setUp()
43			{
44			$this->Developers = TableRegistry::get('Developers');
			0 ignored issues – show Bug introduced 2017-07-05 03:35 UTC by Report Bug Copy Issue Report The property `Developers` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
45			}
46
47			/**
48			* Test login method
49			*
50			* @return void
51			*/
52			public function testLogin()
53			{
54			// Empty session during initiation
55			$this->session(array());
56
57			$this->get('developers/login');
58			$this->assertRedirectContains('https://github.com/login/oauth/authorize');
59			$this->assertRedirectContains('developers%2Fcallback');
60			}
61
62			/**
63			* Test callback method
64			*
65			* @return void
66			*/
67			public function testCallback()
68			{
69			// Mock functions `curl_exec` and `curl_getinfo` in GithubApiComponent
70			// so that we don't actually hit the Github Api
71			$curlExecMock = $this->getFunctionMock('\App\Controller\Component', 'curl_exec');
72			$curlGetInfoMock = $this->getFunctionMock('\App\Controller\Component', 'curl_getinfo');
73
74			$accessTokenResponse = json_encode(array('access_token' => 'abc'));
75			$emptyAccessTokenResponse = json_encode(array('access_token' => null));
76
77			$nonSuccessUserResponse = json_encode(array('message' => 'Unauthorized access'));
78			$userResponse = file_get_contents(TESTS . 'Fixture' . DS . 'user_response.json');
79
80			// Github unsuccessful response followed by successful response
81			$curlExecMock->expects($this->exactly(10))->willReturnOnConsecutiveCalls(
82			$emptyAccessTokenResponse,
83			$emptyAccessTokenResponse,
84			$accessTokenResponse, $nonSuccessUserResponse,
85			$accessTokenResponse, $userResponse, null,
86			$accessTokenResponse, $userResponse, null
87			);
88			$curlGetInfoMock->expects($this->exactly(5))->willReturnOnConsecutiveCalls(
89			401,
90			200, 404,
91			200, 204
92			);
93
94			// Case 1.1 Test no access_token in Github response (with last_page not set in session)
95			// So, empty the session
96			$this->session(array());
97
98			$this->get('developers/callback/?code=123123123');
99			$this->assertRedirect(['controller' => '', 'action' => 'index']);
100
101			// Case 1.2 Test no access_token in Github response (with last_page set in session)
102			$this->session(
103			array(
104			'last_page' => array(
105			'controller' => 'notifications',
106			'action' => 'index'
107			)
108			)
109			);
110
111			$this->get('developers/callback/?code=123123123');
112			$this->assertRedirect(['controller' => '', 'action' => 'index']);
113
114			// Case 2. Non successful response code from Github
115			$this->session(
116			array(
117			'last_page' => array(
118			'controller' => 'reports',
119			'action' => 'index'
120			)
121			)
122			);
123			$this->get('developers/callback/?code=123123123');
124			$this->assertRedirect(['controller' => '', 'action' => 'index']);
125
126
127			// Case 3. Successful response code (new user), check whether session variables are init
128			$this->get('developers/callback/?code=123123123');
129			$this->assertSession(3, 'Developer.id');
130			$this->assertSession(true, 'read_only');
131			$this->assertSession('abc', 'access_token');
132
133			$developer = $this->Developers->get(3);
134			$this->assertEquals('abc', $developer->access_token);
135			$this->assertEquals('[email protected]', $developer->email);
136
137			// Case 4. Successful response code (returning user)
138			// check whether session variables are init
139			$this->session(array('last_page' => null));
140
141			$this->get('developers/callback/?code=123123123');
142			$this->assertSession(3, 'Developer.id');
143			$this->assertSession(false, 'read_only');
144			$this->assertSession('abc', 'access_token');
145
146			$developer = $this->Developers->get(3);
147			$this->assertEquals(1, $developer->has_commit_access);
148			}
149
150			/**
151			* Test logout method
152			*
153			* @return void
154			*/
155			public function testLogout()
156			{
157			$this->session(array('Developer.id' => 1));
158
159			$this->get('developers/logout');
160			$this->assertSession(null, 'Developer.id');
161			$this->assertRedirect(['controller' => '', 'action' => 'index']);
162			}
163			}
164

phpmyadmin / error-reporting-server

Pull Request — master (#171)

DevelopersControllerTest::testCallback() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like