ServiceTests::getUserData() - Code Metrics - Inspection of "feature/Small todo tasks were done" - alexdodonov/mezon-service - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( ad6921...16742d )

by Alex
created 2020-09-18 06:16 UTC
ServiceTests::getUserData() A

↳ Parent: ServiceTests
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	1	Features	0
Metric	Value
eloc	3
c	2
b	1
f	0
dl	0
loc	5
rs	10
cc	1
nc	1
nop	0
<?php
namespace Mezon\Service\Tests;

use Mezon\Functional\Fetcher;

/**
 * Class ServiceTests
 *
 * @package Service
 * @subpackage ServiceTests
 * @author Dodonov A.A.
 * @version v.1.0 (2019/08/17)
 * @copyright Copyright (c) 2019, aeon.org
 */

/**
 * Predefined set of tests for service
 *
 * @author Dodonov A.A.
 * @group baseTests
 */
abstract class ServiceTests extends \PHPUnit\Framework\TestCase
{

    /**
     * Session id
     */
    protected $sessionId = false;

    /**
     * Server path
     */
    protected static $serverPath = false;

    /**
     * Headers
     *
     * @var string
     */
    protected $headers = false;

    /**
     * Method asserts for errors and warnings in the html code
     *
     * @param string $content
     *            Asserting content
     * @param string $message
     *            Message to be displayed in case of error
     */
    protected function assertErrors($content, $message)
    {
        if (strpos($content, 'Warning') !== false || strpos($content, 'Error') !== false ||
            strpos($content, 'Fatal error') !== false || strpos($content, 'Access denied') !== false ||
            strpos($content, "doesn't exist in statement") !== false) {
            throw (new \Exception($message . "\r\n" . $content));
        }

        $this->addToAssertionCount(1);
    }

    /**
     * Method asserts JSON
     *
     * @param mixed $jsonResult
     *            Result of the call
     * @param string $result
     *            Raw result of the call
     */
    protected function assertJsonResponse($jsonResult, string $result)
    {
        if ($jsonResult === null && $result !== '') {
            $this->fail("JSON result is invalid because of:\r\n$result");
        }

        if (isset($jsonResult->message)) {
            print("message    : " . $jsonResult->message . "\r\n");
            print("code       : " . ($jsonResult->code ?? '') . "\r\n");
            print("call_stack : ");
            print(json_encode($jsonResult->call_stack ?? 'not provided'));
            $this->fail();
        }
    }

    /**
     * Method sends post request
     *
     * @param array $data
     *            Request data
     * @param string $url
     *            Requesting endpoint
     * @return mixed Request result
     */
    protected function postHttpRequest(array $data, string $url)
    {
        $options = [
            'http' => [
                'header' => "Content-Type: application/x-www-form-urlencoded\r\n" .
                "User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\r\n" .
                ($this->sessionId !== false ? "Cgi-Authorization: Basic " . $this->sessionId . "\r\n" : '') .
                ($this->sessionId !== false ? "Cgi-Authorization: Basic " . /** @scrutinizer ignore-type */ $this->sessionId . "\r\n" : '') .
                ($this->headers !== false ? implode("\r\n", $this->headers) . "\r\n" : ''),
                ($this->headers !== false ? implode("\r\n", /** @scrutinizer ignore-type */ $this->headers) . "\r\n" : ''),
                'method' => 'POST',
                'content' => http_build_query($data)
            ]
        ];

        $context = stream_context_create($options);
        $result = file_get_contents($url, false, $context);

        $this->assertErrors($result, 'Request have returned warnings/errors');

        return json_decode($result);
    }

    /**
     * Method prepares GET request options
     */
    protected function prepareGetOptions()
    {
        return [
            'http' => [
                'header' => "Content-Type: application/x-www-form-urlencoded\r\n" .
                "User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\r\n" .
                ($this->sessionId !== false ? "Cgi-Authorization: Basic " . $this->sessionId . "\r\n" : '') .
                ($this->sessionId !== false ? "Cgi-Authorization: Basic " . /** @scrutinizer ignore-type */ $this->sessionId . "\r\n" : '') .
                ($this->headers !== false ? implode("\r\n", $this->headers) . "\r\n" : ''),
                ($this->headers !== false ? implode("\r\n", /** @scrutinizer ignore-type */ $this->headers) . "\r\n" : ''),
                'method' => 'GET'
            ]
        ];
    }

    /**
     * Method sends GET request
     *
     * @param string $url
     *            Requesting URL
     * @return mixed Result off the request
     */
    protected function getHttpRequest(string $url)
    {
        $options = $this->prepareGetOptions();

        $context = stream_context_create($options);
        $result = file_get_contents($url, false, $context);

        $this->assertErrors($result, 'Request have returned warnings/errors');

        return json_decode($result);
    }

    /**
     * Method returns test data
     *
     * @return array Test data
     */
    protected abstract function getUserData(): array;

    /**
     * Method performs valid connect.
     *
     * @return mixed Result of the connection.
     */
    protected function validConnect()
    {
        $data = $this->getUserData();

        $url = self::serverPath . '/connect/';


        $result = $this->postHttpRequest($data, $url);

        if (isset($result->session_id) !== false) {
            $this->sessionId = $result->session_id;
        }

        return $result;
    }

    /**
     * Testing API connection.
     */
    public function testValidConnect()
    {
        // authorization
        $result = $this->validConnect();

        $this->assertNotEquals($result, null, 'Connection failed');

        if (isset($result->session_id) === false) {
            $this->assertEquals(true, false, 'Field "session_id" was not set');
        }

        $this->sessionId = $result->session_id;
    }

    /**
     * Testing API invalid connection.
     */
    public function testInvalidConnect()
    {
        // setup
        $data = $this->getUserData();
        $data['password'] = '1234';
        $url = self::serverPath . '/connect/';


        // test body
        $result = $this->postHttpRequest($data, $url);

        // assertions
        $this->assertTrue(isset($result->message));
        $this->assertTrue(isset($result->code));
        $this->assertTrue($result->code == - 1 || $result->code == 4);
    }

    /**
     * Testing setting valid token.
     */
    public function testSetValidToken()
    {
        $this->testValidConnect();

        $data = [
            'token' => $this->sessionId
        ];

        $url = self::serverPath . '/token/' . $this->sessionId . '/';


        $result = $this->postHttpRequest($data, $url);

        $this->assertEquals(isset($result->session_id), true, 'Connection failed');
    }

    /**
     * Testing setting invalid token.
     */
    public function testSetInvalidToken()
    {
        // setup
        $this->testValidConnect();

        $data = [
            'token' => ''
        ];

        $url = self::serverPath . '/token/unexisting/';


        // assertions
        $this->expectException(\Exception::class);
        $this->expectExceptionCode(2);
        $this->expectExceptionMessage('Invalid session token');

        // test body
        $this->postHttpRequest($data, $url);
    }

    /**
     * Testing login under another user
     */
    public function testLoginAs()
    {
        // setup
        $this->testValidConnect();

        $data = [
            'login' => '[email protected]'
        ];
        $url = self::serverPath . '/login-as/';

        $this->postHttpRequest($data, $url);

        // test body
        $url = self::serverPath . '/self/login/';
        $result = $this->getHttpRequest($url);

        // assertions
        $this->assertEquals(
            '[email protected]',
            Fetcher::getField($result, 'login'),
            'Session user must be [email protected]');
    }
}

alexdodonov / mezon-service

Push — master ( ad6921...16742d )

ServiceTests::getUserData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
