App\Test\TestCase\Controller\DevelopersControllerTest

Complexity

Total Complexity

4

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	testLogout()	0	7	1
A	setUp()	0	3	1
A	testCallback()	0	87	1
A	testLogin()	0	8	1

<?php

/**
 * 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 Cake\ORM\TableRegistry;
use Cake\TestSuite\IntegrationTestTrait;
use Cake\TestSuite\TestCase;
use phpmock\phpunit\PHPMock;

use function file_get_contents;
use function json_encode;

use const DS;

/**
 * App\Controller\DevelopersController Test Case
 */
class DevelopersControllerTest extends TestCase
{
    use PHPMock;
    use IntegrationTestTrait;

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

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

    /**
     * Test login method
     */
    public function testLogin(): void
    {
        // Empty session during initiation
        $this->session([]);

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

    /**
     * Test callback method
     */
    public function testCallback(): void
    {
        // 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(['access_token' => 'abc']);
        $emptyAccessTokenResponse = json_encode(['access_token' => null]);

        $nonSuccessUserResponse = json_encode(['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([]);

        $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(
            [
                'last_page' => [
                    '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(
            [
                'last_page' => [
                    '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('pma-bot@phpmyadmin.net', $developer->email);

        // Case 4. Successful response code (returning user)
        // check whether session variables are init
        $this->session(['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
     */
    public function testLogout(): void
    {
        $this->session(['Developer.id' => 1]);

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