FirehoseAdapterTest::setUp() - Code Metrics - Inspection of "Add Kinesis Firehose adapter and tests" - graze/queue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#42)

unknown

created 2017-10-05 12:58 UTC

FirehoseAdapterTest::setUp() A

↳ Parent: FirehoseAdapterTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	8

Duplication

Lines	11
Ratio	100 %

Importance

Changes

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

<?php

/**
 * This file is part of graze/queue.
 *
 * Copyright (c) 2015 Nature Delivered Ltd. <https://www.graze.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://github.com/graze/queue/blob/master/LICENSE MIT
 *
 * @link    https://github.com/graze/queue
 */

namespace Graze\Queue\Adapter;

use Aws\ResultInterface;
use Aws\Firehose\FirehoseClient;
use Graze\DataStructure\Container\ContainerInterface;
use Graze\Queue\Adapter\Exception\MethodNotSupportedException;
use Graze\Queue\Message\MessageFactoryInterface;
use Graze\Queue\Message\MessageInterface;
use Mockery as m;
use Mockery\MockInterface;
use PHPUnit_Framework_TestCase as TestCase;

class FirehoseAdapterTest extends TestCase
{
    /** @var MessageInterface|MockInterface */
    private $messageA;
    /** @var MessageInterface|MockInterface */
    private $messageB;
    /** @var MessageInterface|MockInterface */
    private $messageC;
    /** @var MessageInterface[]|MockInterface[] */
    private $messages;
    /** @var ResultInterface|MockInterface */
    private $model;
    /** @var MessageFactoryInterface|MockInterface */
    private $factory;
    /** @var FirehoseClient */
    private $client;

    public function setUp()

    {
        $this->client = m::mock(FirehoseClient::class);
        $this->model = m::mock(ResultInterface::class);
        $this->factory = m::mock(MessageFactoryInterface::class);

        $this->messageA = $a = m::mock(MessageInterface::class);

        $this->messageB = $b = m::mock(MessageInterface::class);

        $this->messageC = $c = m::mock(MessageInterface::class);

        $this->messages = [$a, $b, $c];
    }

    public function testInterface()
    {
        assertThat(new FirehoseAdapter($this->client, 'foo'), is(anInstanceOf('Graze\Queue\Adapter\AdapterInterface')));
    }

    public function testEnqueue()
    {
        $adapter = new FirehoseAdapter($this->client, 'foo');

        $metadata = m::mock(ContainerInterface::class);
        $metadata->shouldReceive('get')
                 ->with('MessageAttributes')
                 ->times(3)
                 ->andReturn(null);

        $this->messageA->shouldReceive('getBody')->once()->withNoArgs()->andReturn('foo');
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $this->messageB->shouldReceive('getBody')->once()->withNoArgs()->andReturn('bar');
        $this->messageC->shouldReceive('getBody')->once()->withNoArgs()->andReturn('baz');
        $this->messageA->shouldReceive('getMetadata')->andReturn($metadata);
        $this->messageB->shouldReceive('getMetadata')->andReturn($metadata);
        $this->messageC->shouldReceive('getMetadata')->andReturn($metadata);

        $this->model->shouldReceive('get')->once()->with('RequestResponses')->andReturn([]);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $this->client->shouldReceive('putRecordBatch')->once()->with([
            'DeliveryStreamName' => 'foo',
            'Records' => [
                ['Data' => json_encode(['Id' => 0, 'MessageBody' => 'foo', 'MessageAttributes' => []])],
                ['Data' => json_encode(['Id' => 1, 'MessageBody' => 'bar', 'MessageAttributes' => []])],
                ['Data' => json_encode(['Id' => 2, 'MessageBody' => 'baz', 'MessageAttributes' => []])]
            ],
        ])->andReturn($this->model);

        $adapter->enqueue($this->messages);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * @expectedException \Graze\Queue\Adapter\Exception\MethodNotSupportedException
     */
    public function testAcknowledge()
    {
        $adapter = new FirehoseAdapter($this->client, 'foo');
        $adapter->acknowledge($this->messages);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * @expectedException \Graze\Queue\Adapter\Exception\MethodNotSupportedException
     */
    public function testDequeue()
    {
        $adapter = new FirehoseAdapter($this->client, 'foo');
        $adapter->dequeue($this->factory, 10);
    }

    /**
     * @expectedException \Graze\Queue\Adapter\Exception\MethodNotSupportedException
     */
    public function testPurge()
    {
        $adapter = new FirehoseAdapter($this->client, 'foo');
        $adapter->purge();
    }

    /**
     * @expectedException \Graze\Queue\Adapter\Exception\MethodNotSupportedException
     */
    public function testDelete()
    {
        $adapter = new FirehoseAdapter($this->client, 'foo');
        $adapter->delete();
    }
}


1		<?php
2
3		/**
4		* This file is part of graze/queue.
5		*
6		* Copyright (c) 2015 Nature Delivered Ltd. <https://www.graze.com>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* @license https://github.com/graze/queue/blob/master/LICENSE MIT
12		*
13		* @link https://github.com/graze/queue
14		*/
15
16		namespace Graze\Queue\Adapter;
17
18		use Aws\ResultInterface;
19		use Aws\Firehose\FirehoseClient;
20		use Graze\DataStructure\Container\ContainerInterface;
21		use Graze\Queue\Adapter\Exception\MethodNotSupportedException;
22		use Graze\Queue\Message\MessageFactoryInterface;
23		use Graze\Queue\Message\MessageInterface;
24		use Mockery as m;
25		use Mockery\MockInterface;
26		use PHPUnit_Framework_TestCase as TestCase;
27
28		class FirehoseAdapterTest extends TestCase
29		{
30		/** @var MessageInterface\|MockInterface */
31		private $messageA;
32		/** @var MessageInterface\|MockInterface */
33		private $messageB;
34		/** @var MessageInterface\|MockInterface */
35		private $messageC;
36		/** @var MessageInterface[]\|MockInterface[] */
37		private $messages;
38		/** @var ResultInterface\|MockInterface */
39		private $model;
40		/** @var MessageFactoryInterface\|MockInterface */
41		private $factory;
42		/** @var FirehoseClient */
43		private $client;
44
45	View Code Duplication	public function setUp()
		0 ignored issues – show Duplication introduced 2017-10-05 13:04 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...
46		{
47		$this->client = m::mock(FirehoseClient::class);
48		$this->model = m::mock(ResultInterface::class);
49		$this->factory = m::mock(MessageFactoryInterface::class);
50
51		$this->messageA = $a = m::mock(MessageInterface::class);
		0 ignored issues – show Comprehensibility introduced 2017-10-05 13:04 UTC by Report Bug Copy Issue Report Avoid variables with short names like $a. Configured minimum length is 2. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
52		$this->messageB = $b = m::mock(MessageInterface::class);
		0 ignored issues – show Comprehensibility introduced 2017-10-05 13:04 UTC by Report Bug Copy Issue Report Avoid variables with short names like $b. Configured minimum length is 2. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
53		$this->messageC = $c = m::mock(MessageInterface::class);
		0 ignored issues – show Comprehensibility introduced 2017-10-05 13:04 UTC by Report Bug Copy Issue Report Avoid variables with short names like $c. Configured minimum length is 2. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
54		$this->messages = [$a, $b, $c];
55		}
56
57		public function testInterface()
58		{
59		assertThat(new FirehoseAdapter($this->client, 'foo'), is(anInstanceOf('Graze\Queue\Adapter\AdapterInterface')));
60		}
61
62		public function testEnqueue()
63		{
64		$adapter = new FirehoseAdapter($this->client, 'foo');
65
66		$metadata = m::mock(ContainerInterface::class);
67		$metadata->shouldReceive('get')
68		->with('MessageAttributes')
69		->times(3)
70		->andReturn(null);
71
72		$this->messageA->shouldReceive('getBody')->once()->withNoArgs()->andReturn('foo');
		0 ignored issues – show Bug introduced 2017-10-05 13:04 UTC by Report Bug Copy Issue Report The method `shouldReceive` does only exist in `Mockery\MockInterface`, but not in `Graze\Queue\Message\MessageInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
73		$this->messageB->shouldReceive('getBody')->once()->withNoArgs()->andReturn('bar');
74		$this->messageC->shouldReceive('getBody')->once()->withNoArgs()->andReturn('baz');
75		$this->messageA->shouldReceive('getMetadata')->andReturn($metadata);
76		$this->messageB->shouldReceive('getMetadata')->andReturn($metadata);
77		$this->messageC->shouldReceive('getMetadata')->andReturn($metadata);
78
79		$this->model->shouldReceive('get')->once()->with('RequestResponses')->andReturn([]);
		0 ignored issues – show Bug introduced 2017-10-05 13:04 UTC by Report Bug Copy Issue Report The method `shouldReceive` does only exist in `Mockery\MockInterface`, but not in `Aws\ResultInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
80
81		$this->client->shouldReceive('putRecordBatch')->once()->with([
82		'DeliveryStreamName' => 'foo',
83		'Records' => [
84		['Data' => json_encode(['Id' => 0, 'MessageBody' => 'foo', 'MessageAttributes' => []])],
85		['Data' => json_encode(['Id' => 1, 'MessageBody' => 'bar', 'MessageAttributes' => []])],
86		['Data' => json_encode(['Id' => 2, 'MessageBody' => 'baz', 'MessageAttributes' => []])]
87		],
88		])->andReturn($this->model);
89
90		$adapter->enqueue($this->messages);
		0 ignored issues – show Documentation introduced 2017-10-05 13:04 UTC by Report Bug Copy Issue Report `$this->messages` is of type `array<integer,object<Mockery\MockInterface>>`, but the function expects a `array<integer,object<Gra...sage\MessageInterface>>`. 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...
91		}
92
93		/**
94		* @expectedException \Graze\Queue\Adapter\Exception\MethodNotSupportedException
95		*/
96		public function testAcknowledge()
97		{
98		$adapter = new FirehoseAdapter($this->client, 'foo');
99		$adapter->acknowledge($this->messages);
		0 ignored issues – show Documentation introduced 2017-10-05 13:04 UTC by Report Bug Copy Issue Report `$this->messages` is of type `array<integer,object<Mockery\MockInterface>>`, but the function expects a `array<integer,object<Gra...sage\MessageInterface>>`. 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...
100		}
101
102		/**
103		* @expectedException \Graze\Queue\Adapter\Exception\MethodNotSupportedException
104		*/
105		public function testDequeue()
106		{
107		$adapter = new FirehoseAdapter($this->client, 'foo');
108		$adapter->dequeue($this->factory, 10);
109		}
110
111		/**
112		* @expectedException \Graze\Queue\Adapter\Exception\MethodNotSupportedException
113		*/
114		public function testPurge()
115		{
116		$adapter = new FirehoseAdapter($this->client, 'foo');
117		$adapter->purge();
118		}
119
120		/**
121		* @expectedException \Graze\Queue\Adapter\Exception\MethodNotSupportedException
122		*/
123		public function testDelete()
124		{
125		$adapter = new FirehoseAdapter($this->client, 'foo');
126		$adapter->delete();
127		}
128		}
129

graze / queue

Pull Request — master (#42)

FirehoseAdapterTest::setUp() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like