BridgeTest::testSomeFailingCalls() - Code Metrics - Inspection of "Merge pull request #24 from groupby/BBD-667" - groupby/api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 50dbcf...bff7e0 )

by Ben

created 2017-08-22 15:13 UTC

BridgeTest::testSomeFailingCalls() A

↳ Parent: BridgeTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	11

Duplication

Lines	16
Ratio	100 %

Importance

Changes

Metric	Value
dl	16
loc	16
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	11
nc	1
nop	0

<?php

use GroupByInc\API\AbstractBridge;
use GroupByInc\API\Bridge;
use GroupByInc\API\Model\RefinementsResult;
use GroupByInc\API\Model\Results;
use GroupByInc\API\Query;
use GroupByInc\API\Util\StringUtils;
use Httpful\Request;
use Httpful\Response;

class BridgeTest extends PHPUnit_Framework_TestCase
namespace YourVendor;

class YourClass { }
{
    const CLIENT_KEY = 'randomkey';
    const HOST = 'localhost';
    const PORT = 8080;
    const SEARCH_URL = 'http://localhost:8080/search';
    const REFINEMENT_SEARCH_URL = 'http://localhost:8080/search/refinements';
    const HEADERS = "Status 200\r\nContent-Type:application/json\n";
    // Must match expected bridge json
    const TEST_QUERY = '{"clientKey":"randomkey","sort":[],"fields":[],"orFields":[],"refinements":[],"customUrlParams":[],"skip":0,"pageSize":10,"pruneRefinements":true,"wildcardSearchEnabled":false}';
    const TEST_RESPONSE = '{"query":"foobar","pageInfo":{"recordStart":14,"recordEnd":23}}';

    public function testErroneousStatusCode()

    {
        $bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
            ->thenReturn(new Response('{"foo":"bar"}', 'Status 400', Request::post('')));

        $query = new Query();
        try {
            /** @var Bridge $bridge */
            $bridge->search($query);
            $this->fail("Should have thrown exception here");
        } catch (RuntimeException $e) {
            if (strpos($e->getMessage(), '404 Not Found') !== false) {
                $this->fail("Expected status code 400, found 404");
            }
            // Should throw exception
        }
    }

    public function testErrorOnReturnBinary()

    {
        $bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
            ->thenReturn(new Response('{"foo":"bar"}', "Status 200\r\nContent-Type:application/bson\n", Request::post('')));

        $query = new Query();
        try {
            /** @var Bridge $bridge */
            $bridge->search($query);
            $this->fail("Should have thrown exception here");
        } catch (RuntimeException $e) {
            // Should throw exception
        }
    }

    public function testSearch()

    {
        $bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
            ->thenReturn(new Response('{"query":"foobar"}', self::HEADERS, Request::post('')));

        $query = new Query();
        /** @var Bridge $bridge */
        /** @var Results $results */
        $results = $bridge->search($query);

        $this->assertEquals('foobar', $results->getQuery());
    }

    public function testSearchCompressedResponse()

    {
        $bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
            ->thenReturn(new Response('{"query":"foobar"}', self::HEADERS . "Content-Encoding:gzip\n", Request::post('')));

        $query = new Query();
        /** @var Bridge $bridge */
        /** @var Results $results */
        $results = $bridge->search($query);

        $this->assertEquals('foobar', $results->getQuery());
    }

    public function testSearchRefinements()

    {
        $refinementsQuery = '{"originalQuery":' . self::TEST_QUERY . ',"navigationName":"height"}';
        $bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
        Phake::when($bridge)->execute(self::REFINEMENT_SEARCH_URL, $refinementsQuery, 0)
            ->thenReturn(new Response('{"navigation":{"name":"foobar"}}', self::HEADERS, Request::post('')));

        $query = new Query();
        /** @var Bridge $bridge */
        /** @var RefinementsResult $results */
        $results = $bridge->refinements($query, "height");

        $this->assertEquals('foobar', $results->getNavigation()->getName());
    }

    public function testMultipleFailingCalls()

    {
        $bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
            ->thenThrow(new Exception('the request failed!'));
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 1)
            ->thenThrow(new Exception('the request failed!'));
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 2)
            ->thenThrow(new Exception('the request failed!'));

        $query = new Query();
        /** @var Bridge $bridge */
        try {
            $bridge->search($query);
            $this->fail('expected a "retry failed" exceptions but got none');
        } catch (Exception $e) {
            $this->assertTrue(StringUtils::endsWith($e->getMessage(), 'failed after ' . AbstractBridge::MAX_TRIES . ' tries'));
        }
    }

    public function testSomeFailingCalls()

    {
        $bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
            ->thenThrow(new Exception('the request failed!'));
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 1)
            ->thenThrow(new Exception('the request failed!'));
        Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 2)
            ->thenReturn(new Response('{"query":"foobar"}', self::HEADERS, Request::post('')));

        $query = new Query();
        /** @var Bridge $bridge */
        /** @var Results $results */
        $results = $bridge->search($query);

        $this->assertNotNull($results);
    }

//    public function testClusterSearch()

//    {
//        $http = Mockery::mock('API\Util\AbstractRequest');
//        $http->shouldReceive('setOption');
//        $http->shouldReceive('getHttpStatusCode')->andReturn(200);
//        $http->shouldReceive('execute')->andReturn(true);
//        $http->shouldReceive('getHttpContentType')->andReturn('application/json');
//        //create fake bridge with empty query, assign the mock http session, try to search, should not get exception
//        $myBridge = new Bridge('randomkey', 'somewhere', 9050);
//        $myQuery = new Query();
//        /** @noinspection PhpParamsInspection */
//        $myBridge->setSessionCluster($http);
//        $myBridge->searchCluster($myQuery);
//    }
}


1		<?php
2
3		use GroupByInc\API\AbstractBridge;
4		use GroupByInc\API\Bridge;
5		use GroupByInc\API\Model\RefinementsResult;
6		use GroupByInc\API\Model\Results;
7		use GroupByInc\API\Query;
8		use GroupByInc\API\Util\StringUtils;
9		use Httpful\Request;
10		use Httpful\Response;
11
12		class BridgeTest extends PHPUnit_Framework_TestCase
		0 ignored issues – show Coding Style Compatibility introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
13		{
14		const CLIENT_KEY = 'randomkey';
15		const HOST = 'localhost';
16		const PORT = 8080;
17		const SEARCH_URL = 'http://localhost:8080/search';
18		const REFINEMENT_SEARCH_URL = 'http://localhost:8080/search/refinements';
19		const HEADERS = "Status 200\r\nContent-Type:application/json\n";
20		// Must match expected bridge json
21		const TEST_QUERY = '{"clientKey":"randomkey","sort":[],"fields":[],"orFields":[],"refinements":[],"customUrlParams":[],"skip":0,"pageSize":10,"pruneRefinements":true,"wildcardSearchEnabled":false}';
22		const TEST_RESPONSE = '{"query":"foobar","pageInfo":{"recordStart":14,"recordEnd":23}}';
23
24	View Code Duplication	public function testErroneousStatusCode()
		0 ignored issues – show Duplication introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
25		{
26		$bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
27		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
28		->thenReturn(new Response('{"foo":"bar"}', 'Status 400', Request::post('')));
29
30		$query = new Query();
31		try {
32		/** @var Bridge $bridge */
33		$bridge->search($query);
34		$this->fail("Should have thrown exception here");
35		} catch (RuntimeException $e) {
36		if (strpos($e->getMessage(), '404 Not Found') !== false) {
37		$this->fail("Expected status code 400, found 404");
38		}
39		// Should throw exception
40		}
41		}
42
43	View Code Duplication	public function testErrorOnReturnBinary()
		0 ignored issues – show Duplication introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
44		{
45		$bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
46		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
47		->thenReturn(new Response('{"foo":"bar"}', "Status 200\r\nContent-Type:application/bson\n", Request::post('')));
48
49		$query = new Query();
50		try {
51		/** @var Bridge $bridge */
52		$bridge->search($query);
53		$this->fail("Should have thrown exception here");
54		} catch (RuntimeException $e) {
55		// Should throw exception
56		}
57		}
58
59	View Code Duplication	public function testSearch()
		0 ignored issues – show Duplication introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
60		{
61		$bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
62		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
63		->thenReturn(new Response('{"query":"foobar"}', self::HEADERS, Request::post('')));
64
65		$query = new Query();
66		/** @var Bridge $bridge */
67		/** @var Results $results */
68		$results = $bridge->search($query);
		0 ignored issues – show Bug introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report The method `search()` does not seem to exist on `object<Phake_IMock>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
69		$this->assertEquals('foobar', $results->getQuery());
70		}
71
72	View Code Duplication	public function testSearchCompressedResponse()
		0 ignored issues – show Duplication introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
73		{
74		$bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
75		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
76		->thenReturn(new Response('{"query":"foobar"}', self::HEADERS . "Content-Encoding:gzip\n", Request::post('')));
77
78		$query = new Query();
79		/** @var Bridge $bridge */
80		/** @var Results $results */
81		$results = $bridge->search($query);
		0 ignored issues – show Bug introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report The method `search()` does not seem to exist on `object<Phake_IMock>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
82		$this->assertEquals('foobar', $results->getQuery());
83		}
84
85	View Code Duplication	public function testSearchRefinements()
		0 ignored issues – show Duplication introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
86		{
87		$refinementsQuery = '{"originalQuery":' . self::TEST_QUERY . ',"navigationName":"height"}';
88		$bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
89		Phake::when($bridge)->execute(self::REFINEMENT_SEARCH_URL, $refinementsQuery, 0)
90		->thenReturn(new Response('{"navigation":{"name":"foobar"}}', self::HEADERS, Request::post('')));
91
92		$query = new Query();
93		/** @var Bridge $bridge */
94		/** @var RefinementsResult $results */
95		$results = $bridge->refinements($query, "height");
		0 ignored issues – show Bug introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report The method `refinements()` does not seem to exist on `object<Phake_IMock>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
96		$this->assertEquals('foobar', $results->getNavigation()->getName());
97		}
98
99	View Code Duplication	public function testMultipleFailingCalls()
		0 ignored issues – show Duplication introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
100		{
101		$bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
102		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
103		->thenThrow(new Exception('the request failed!'));
104		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 1)
105		->thenThrow(new Exception('the request failed!'));
106		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 2)
107		->thenThrow(new Exception('the request failed!'));
108
109		$query = new Query();
110		/** @var Bridge $bridge */
111		try {
112		$bridge->search($query);
113		$this->fail('expected a "retry failed" exceptions but got none');
114		} catch (Exception $e) {
115		$this->assertTrue(StringUtils::endsWith($e->getMessage(), 'failed after ' . AbstractBridge::MAX_TRIES . ' tries'));
116		}
117		}
118
119	View Code Duplication	public function testSomeFailingCalls()
		0 ignored issues – show Duplication introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
120		{
121		$bridge = Phake::partialMock('GroupByInc\API\Bridge', self::CLIENT_KEY, self::HOST, self::PORT);
122		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 0)
123		->thenThrow(new Exception('the request failed!'));
124		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 1)
125		->thenThrow(new Exception('the request failed!'));
126		Phake::when($bridge)->execute(self::SEARCH_URL, self::TEST_QUERY, 2)
127		->thenReturn(new Response('{"query":"foobar"}', self::HEADERS, Request::post('')));
128
129		$query = new Query();
130		/** @var Bridge $bridge */
131		/** @var Results $results */
132		$results = $bridge->search($query);
		0 ignored issues – show Bug introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report The method `search()` does not seem to exist on `object<Phake_IMock>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
133		$this->assertNotNull($results);
134		}
135
136		// public function testClusterSearch()
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-22 14:45 UTC by Report Bug Copy Issue Report `55%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
137		// {
138		// $http = Mockery::mock('API\Util\AbstractRequest');
139		// $http->shouldReceive('setOption');
140		// $http->shouldReceive('getHttpStatusCode')->andReturn(200);
141		// $http->shouldReceive('execute')->andReturn(true);
142		// $http->shouldReceive('getHttpContentType')->andReturn('application/json');
143		// //create fake bridge with empty query, assign the mock http session, try to search, should not get exception
144		// $myBridge = new Bridge('randomkey', 'somewhere', 9050);
145		// $myQuery = new Query();
146		// /** @noinspection PhpParamsInspection */
147		// $myBridge->setSessionCluster($http);
148		// $myBridge->searchCluster($myQuery);
149		// }
150		}
151

groupby / api-php

Push — develop ( 50dbcf...bff7e0 )

BridgeTest::testSomeFailingCalls() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like