HttpRequestTest::testInputStream() - Code Metrics - Inspection of "Merge pull request #16 from Vectorface/dev" - Vectorface/SnappyRouter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 224bd1...c10904 )

by Jonathan

created 2017-11-08 13:32 UTC

HttpRequestTest::testInputStream() A

↳ Parent: HttpRequestTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	10
c	2
b	0
f	0
nc	1
nop	0
dl	0
loc	18
rs	9.4285

<?php

namespace Vectorface\SnappyRouterTests\Request;

use \PHPUnit_Framework_TestCase;
use Vectorface\SnappyRouter\Request\HttpRequest;

/**
 * Tests the HttpRequest class.
 * @copyright Copyright (c) 2014, VectorFace, Inc.
 * @author Dan Bruce <[email protected]>
 */
class HttpRequestTest extends PHPUnit_Framework_TestCase
{
    /**
     * An overview of how to use the RPCRequest class.
     * @test
     */
    public function synopsis()
    {
        // instantiate the class
        $request = new HttpRequest('MyService', 'MyMethod', 'GET', 'php://memory');

        $this->assertEquals('GET', $request->getVerb());
        $this->assertEquals('POST', $request->setVerb('POST')->getVerb());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        $queryData = array('id' => '1234');
        $this->assertTrue(
            1234 === $request->setQuery($queryData)->getQuery('id', 0, 'int')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $postData = array('username' => ' TEST_USER ');
        $this->assertEquals(
            'test_user',
            $request->setPost($postData)->getPost('username', '', array('trim', 'lower'))
        );

        $this->assertEquals(
            array('id' => '1234', 'username' => ' TEST_USER '),
            $request->getAllInput()
        );
    }

    /**
     * Tests successful input stream set and fetch cases
     */
    public function testInputStream()
    {
        $tempStream = fopen('php://memory', 'w');
        fwrite($tempStream, "test");
        rewind($tempStream);

        /* Mock a stream in memory */
        $request = new HttpRequest('TestService', 'TestMethod', 'GET', $tempStream);
        $this->assertEquals("test", $request->getBody());
        fclose($tempStream);

        /* Fetch previously stored value */
        $this->assertEquals("test", $request->getBody());

        /* Specify php://memory as a string */
        $request = new HttpRequest('TestService', 'TestMethod', 'GET', 'php://memory');
        $this->assertEquals("", $request->getBody());
    }

    /**
     * Tests the input stream functionality where the stream source is not a string or a stream
     * @expectedException Vectorface\SnappyRouter\Exception\InternalErrorException
     */
    public function testInputStreamIncorrectTypeFailure()
    {
        $request = new HttpRequest('TestService', 'TestMethod', 'GET', 1);
        $request->getBody();
    }

    /**
     * Tests the input stream functionality where the stream source does not exist
     * @expectedException Vectorface\SnappyRouter\Exception\InternalErrorException
     */
    public function testInputStreamIncorrectFileFailure()
    {
        $request = new HttpRequest('TestService', 'TestMethod', 'GET', 'file');
        $request->getBody();
    }

    /**
     * Tests the various filters.
     * @dataProvider filtersProvider
     */
    public function testInputFilters($expected, $value, $filters)
    {
        $request = new HttpRequest('TestService', 'TestMethod', 'GET', 'php://input');
        $request->setQuery(array('key' => $value));
        $this->assertTrue($expected === $request->getQuery('key', null, $filters));
    }

    /**
     * The data provider for testInputFilters.
     */
    public function filtersProvider()
    {
        return array(
            array(
                1234,
                '1234',
                'int'
            ),
            array(
                1234.5,
                ' 1234.5   ',
                'float'
            ),
            array(
                'hello world',
                "\t".'hello world  '.PHP_EOL,
                'trim'
            ),
            array(
                'hello world',
                'HELLO WORLD',
                'lower'
            ),
            array(
                'HELLO WORLD',
                'hello world',
                'upper'
            ),
            array(
                'test'.PHP_EOL.'string',
                'test'.PHP_EOL.'  '.PHP_EOL.PHP_EOL.'string',
                'squeeze'
            ),
        );
    }
}


1			<?php
2
3			namespace Vectorface\SnappyRouterTests\Request;
4
5			use \PHPUnit_Framework_TestCase;
6			use Vectorface\SnappyRouter\Request\HttpRequest;
7
8			/**
9			* Tests the HttpRequest class.
10			* @copyright Copyright (c) 2014, VectorFace, Inc.
11			* @author Dan Bruce <[email protected]>
12			*/
13			class HttpRequestTest extends PHPUnit_Framework_TestCase
14			{
15			/**
16			* An overview of how to use the RPCRequest class.
17			* @test
18			*/
19			public function synopsis()
20			{
21			// instantiate the class
22			$request = new HttpRequest('MyService', 'MyMethod', 'GET', 'php://memory');
23
24			$this->assertEquals('GET', $request->getVerb());
25			$this->assertEquals('POST', $request->setVerb('POST')->getVerb());
			0 ignored issues – show Bug introduced 2016-08-26 19:47 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Vectorface\SnappyRouter\Request\RequestInterface` as the method `getVerb()` does only exist in the following implementations of said interface: `Vectorface\SnappyRouter\Request\HttpRequest`, `Vectorface\SnappyRouter\Request\JsonRpcRequest`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
26
27			$queryData = array('id' => '1234');
28			$this->assertTrue(
29			1234 === $request->setQuery($queryData)->getQuery('id', 0, 'int')
			0 ignored issues – show Documentation introduced 2016-08-26 19:47 UTC by Report Bug Copy Issue Report `'int'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
30			);
31
32			$postData = array('username' => ' TEST_USER ');
33			$this->assertEquals(
34			'test_user',
35			$request->setPost($postData)->getPost('username', '', array('trim', 'lower'))
36			);
37
38			$this->assertEquals(
39			array('id' => '1234', 'username' => ' TEST_USER '),
40			$request->getAllInput()
41			);
42			}
43
44			/**
45			* Tests successful input stream set and fetch cases
46			*/
47			public function testInputStream()
48			{
49			$tempStream = fopen('php://memory', 'w');
50			fwrite($tempStream, "test");
51			rewind($tempStream);
52
53			/* Mock a stream in memory */
54			$request = new HttpRequest('TestService', 'TestMethod', 'GET', $tempStream);
55			$this->assertEquals("test", $request->getBody());
56			fclose($tempStream);
57
58			/* Fetch previously stored value */
59			$this->assertEquals("test", $request->getBody());
60
61			/* Specify php://memory as a string */
62			$request = new HttpRequest('TestService', 'TestMethod', 'GET', 'php://memory');
63			$this->assertEquals("", $request->getBody());
64			}
65
66			/**
67			* Tests the input stream functionality where the stream source is not a string or a stream
68			* @expectedException Vectorface\SnappyRouter\Exception\InternalErrorException
69			*/
70			public function testInputStreamIncorrectTypeFailure()
71			{
72			$request = new HttpRequest('TestService', 'TestMethod', 'GET', 1);
73			$request->getBody();
74			}
75
76			/**
77			* Tests the input stream functionality where the stream source does not exist
78			* @expectedException Vectorface\SnappyRouter\Exception\InternalErrorException
79			*/
80			public function testInputStreamIncorrectFileFailure()
81			{
82			$request = new HttpRequest('TestService', 'TestMethod', 'GET', 'file');
83			$request->getBody();
84			}
85
86			/**
87			* Tests the various filters.
88			* @dataProvider filtersProvider
89			*/
90			public function testInputFilters($expected, $value, $filters)
91			{
92			$request = new HttpRequest('TestService', 'TestMethod', 'GET', 'php://input');
93			$request->setQuery(array('key' => $value));
94			$this->assertTrue($expected === $request->getQuery('key', null, $filters));
95			}
96
97			/**
98			* The data provider for testInputFilters.
99			*/
100			public function filtersProvider()
101			{
102			return array(
103			array(
104			1234,
105			'1234',
106			'int'
107			),
108			array(
109			1234.5,
110			' 1234.5 ',
111			'float'
112			),
113			array(
114			'hello world',
115			"\t".'hello world '.PHP_EOL,
116			'trim'
117			),
118			array(
119			'hello world',
120			'HELLO WORLD',
121			'lower'
122			),
123			array(
124			'HELLO WORLD',
125			'hello world',
126			'upper'
127			),
128			array(
129			'test'.PHP_EOL.'string',
130			'test'.PHP_EOL.' '.PHP_EOL.PHP_EOL.'string',
131			'squeeze'
132			),
133			);
134			}
135			}
136

Vectorface / SnappyRouter

Push — master ( 224bd1...c10904 )

HttpRequestTest::testInputStream() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like