SameSubnetStrategyTest - Code Metrics - Inspection of "Authentication Strategy Multi, configurable" - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#619)

unknown

created 2017-10-16 12:17 UTC

SameSubnetStrategyTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	56
Duplicated Lines	23.21 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	3
lcom	1
cbo	5
dl	13
loc	56
rs	10
c	1
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	12	12	1
A	testApplyHeader()	0	8	1
A	testApplyHeaderReturnEmpty()	0	8	1

How to fix Duplicated Code

<?php
/**
 * Handling authentication for clients in the same network.
 */

namespace Graviton\SecurityBundle\Authentication\Strategies;

use Graviton\TestBundle\Test\WebTestCase;
use Symfony\Bundle\FrameworkBundle\Client;

/**
 * Class SameSubnetStrategyTest
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class SameSubnetStrategyTest extends WebTestCase
{
    protected $strategy;
    /** @var Client */
    protected $client;
    protected $propertyKey;

    /**
     * UnitTest Starts this on reach test
     * @return void
     */
    public function setUp()
    {
        parent::setUp();

        $this->client = static::createClient();
        $this->propertyKey = $this->client->getKernel()
            ->getContainer()
            ->getParameter('graviton.security.authentication.strategy.subnet.key');
        $this->strategy = new SameSubnetStrategy(
            $this->propertyKey
        );
    }

    /**
     * @covers \Graviton\SecurityBundle\Authentication\Strategies\SameSubnetStrategy::apply
     * @covers \Graviton\SecurityBundle\Authentication\Strategies\AbstractHttpStrategy::extractFieldInfo
     * @covers \Graviton\SecurityBundle\Authentication\Strategies\AbstractHttpStrategy::validateField
     *
     * @return void
     */
    public function testApplyHeader()
    {
        $client = static::createClient([], ['HTTP_X-GRAVITON-AUTHENTICATION' => 'test-user-name']);
        $this->strategy->setSubnetIp('127.0.0.0/7');
        $client->request('GET', '/');

        $this->assertSame('test-user-name', $this->strategy->apply($client->getRequest()));
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * @covers \Graviton\SecurityBundle\Authentication\Strategies\SameSubnetStrategy::apply
     * @covers \Graviton\SecurityBundle\Authentication\Strategies\AbstractHttpStrategy::extractFieldInfo
     * @covers \Graviton\SecurityBundle\Authentication\Strategies\AbstractHttpStrategy::validateField
     *
     * @return void
     */
    public function testApplyHeaderReturnEmpty()
    {
        $options = ['HTTP_X-GRAVITON-AUTHENTICATION' => 'test-user-name', 'REMOTE_ADDR' => '126.0.0.1'];
        $client = static::createClient([], $options);
        $client->request('GET', '/');

        $this->assertSame('', $this->strategy->apply($client->getRequest()));
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }
}


1		<?php
2		/**
3		* Handling authentication for clients in the same network.
4		*/
5
6		namespace Graviton\SecurityBundle\Authentication\Strategies;
7
8		use Graviton\TestBundle\Test\WebTestCase;
9		use Symfony\Bundle\FrameworkBundle\Client;
10
11		/**
12		* Class SameSubnetStrategyTest
13		*
14		* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
15		* @license http://opensource.org/licenses/gpl-license.php GNU Public License
16		* @link http://swisscom.ch
17		*/
18		class SameSubnetStrategyTest extends WebTestCase
19		{
20		protected $strategy;
21		/** @var Client */
22		protected $client;
23		protected $propertyKey;
24
25		/**
26		* UnitTest Starts this on reach test
27		* @return void
28		*/
29	View Code Duplication	public function setUp()
30		{
31		parent::setUp();
32
33		$this->client = static::createClient();
34		$this->propertyKey = $this->client->getKernel()
35		->getContainer()
36		->getParameter('graviton.security.authentication.strategy.subnet.key');
37		$this->strategy = new SameSubnetStrategy(
38		$this->propertyKey
39		);
40		}
41
42		/**
43		* @covers \Graviton\SecurityBundle\Authentication\Strategies\SameSubnetStrategy::apply
44		* @covers \Graviton\SecurityBundle\Authentication\Strategies\AbstractHttpStrategy::extractFieldInfo
45		* @covers \Graviton\SecurityBundle\Authentication\Strategies\AbstractHttpStrategy::validateField
46		*
47		* @return void
48		*/
49		public function testApplyHeader()
50		{
51		$client = static::createClient([], ['HTTP_X-GRAVITON-AUTHENTICATION' => 'test-user-name']);
52		$this->strategy->setSubnetIp('127.0.0.0/7');
53		$client->request('GET', '/');
54
55		$this->assertSame('test-user-name', $this->strategy->apply($client->getRequest()));
		0 ignored issues – show Bug introduced 2017-03-06 11:32 UTC by Report Bug Copy Issue Report It seems like `$client->getRequest()` can be `null`; however, `apply()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
56		}
57
58		/**
59		* @covers \Graviton\SecurityBundle\Authentication\Strategies\SameSubnetStrategy::apply
60		* @covers \Graviton\SecurityBundle\Authentication\Strategies\AbstractHttpStrategy::extractFieldInfo
61		* @covers \Graviton\SecurityBundle\Authentication\Strategies\AbstractHttpStrategy::validateField
62		*
63		* @return void
64		*/
65		public function testApplyHeaderReturnEmpty()
66		{
67		$options = ['HTTP_X-GRAVITON-AUTHENTICATION' => 'test-user-name', 'REMOTE_ADDR' => '126.0.0.1'];
68		$client = static::createClient([], $options);
69		$client->request('GET', '/');
70
71		$this->assertSame('', $this->strategy->apply($client->getRequest()));
		0 ignored issues – show Bug introduced 2017-10-16 09:26 UTC by Report Bug Copy Issue Report It seems like `$client->getRequest()` can be `null`; however, `apply()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
72		}
73		}
74

libgraviton / graviton

Pull Request — develop (#619)

SameSubnetStrategyTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like