ImapHelperTest::createImapStorageMessage() - Code Metrics - checkdomain/Comodo - Measure and Improve Code Quality continuously with Scrutinizer

ImapHelperTest::createImapStorageMessage() A
last analyzed 2019-09-13 14:14 UTC

↳ Parent: ImapHelperTest

Complexity

Conditions	3
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	43
rs	9.232
c	0
b	0
f	0
cc	3
nc	1
nop	1

<?php
namespace Checkdomain\Comodo\Tests;

use Checkdomain\Comodo\ImapExtension;
use Checkdomain\Comodo\ImapHelper;
use Zend\Mail\Storage\Message;

/**
 * Class ImapHelperTest
 */
class ImapHelperTest extends AbstractTest
{
    /**
     * @var ImapHelper
     */
    private $imapHelper;

    /**
     * @var array
     */
    private $messages = [];

    /**
     * @param string $name
     * @param array  $data
     * @param string $dataName
     */
    public function __construct($name = null, array $data = [], $dataName = '')
    {
        parent::__construct($name, $data, $dataName);

        $this->imapHelper = new ImapHelper();
        $this->messages = json_decode(file_get_contents(__DIR__.'/data/messages/messages.json'), true);

    }


    /**
     * @param int $messageId
     *
     * @return \PHPUnit_Framework_MockObject_MockObject|\Zend\Mail\Storage\Message
     */
    public function createImapStorageMessage($messageId)
    {
        $messageData = $this->messages[$messageId];

        $message = $this
            ->getMockBuilder(Message::class)
            ->disableOriginalConstructor()
            ->disableOriginalClone()
            ->getMock();

        $message
            ->expects($this->any())
            ->method('getHeader')
            ->will($this->returnCallback(function ($index, $type) use ($messageData) {
                if ($type != 'string') {
                    return null;
                }

                if ($index == 'subject') {
                    return utf8_encode($messageData[$index]);
                }

                return $messageData[$index];
            }));

        $message
            ->expects($this->any())
            ->method('isMultipart')
            ->will($this->returnValue(false));

        $message
            ->expects($this->any())
            ->method('getContent')
            ->will($this->returnValue($this->messages[$messageId]['plainText']));

        $message
            ->expects($this->any())
            ->method('getHeaderField')
            ->will($this->returnValue('text/plain'))
            ->with($this->equalTo('Content-Type'));

        return $message;
    }

    /**
     * This test is only for validating correct decoding of the message (subject/plaintext/received)
     */
    public function testMailParse()
    {
        $imapAdapter = $this->createImapAdapter();

        /** @var \PHPUnit_Framework_MockObject_MockObject|ImapExtension $imapExtension */
        $imapExtension = $imapAdapter->getInstance();
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.
}

        $imapExtension
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.
}
            ->expects($this->any())
            ->method('search')
            ->will($this->returnValue([0]));

        $imapExtension
            ->expects($this->any())
            ->method('getMessage')
            ->will($this->returnValue($this->createImapRawMessage(
                base64_decode(file_get_contents(__DIR__.'/data/messages/raw/multipart'))
            )));

        $messages = $this->imapHelper->fetchMails($imapAdapter, null, true, true);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $message = $messages[0];

        $this->assertEquals('ORDER #12345678 - CONFIRMATION', $message['subject']);
        $this->assertEquals(1404914391, $message['received']);
        $this->assertEquals('test'.chr(10).chr(10), $message['plainText']);
    }

    /**
     * This test is only for validating correct decoding of the attachments
     */
    public function testMailAttachmentParse()
    {
        $imapAdapter = $this->createImapAdapter();

        /** @var \PHPUnit_Framework_MockObject_MockObject|ImapExtension $imapExtension */
        $imapExtension = $imapAdapter->getInstance();
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.
}

        $imapExtension
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.
}
            ->expects($this->any())
            ->method('search')
            ->will($this->returnValue([0]));

        $imapExtension
            ->expects($this->any())
            ->method('getMessage')
            ->will($this->returnValue($this->createImapRawMessage(
                base64_decode(file_get_contents(__DIR__.'/data/messages/raw/with-attachment'))
            )));

        $messages = $this->imapHelper->fetchMails($imapAdapter, null, true, true);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $attachment = $messages[0]['attachments'][0];

        $this->assertEquals('application/x-zip-compressed', $attachment['mime']);
        $this->assertEquals('finaltest_tobias-nitsche_de.zip', $attachment['filename']);
        $this->assertEquals(3962, strlen($attachment['content']));
    }

    /**
     * test for assuming domain names and ordernumbersof email
     */
    public function testMailAssume()
    {
        $asserts = array_map(function ($message) {
            static $i = 0;

            return [
                'id'          => $i++,
                'folder'      => 'INBOX',
                'subject'     => $message['subject'],
                'received'    => strtotime($message['date']),
                'plainText'   => $message['plainText'],
                'attachments' => null,
                'type'        => $message['type'],
                'domainName'  => $message['domainName'],
                'orderNumber' => $message['orderNumber'],
            ];
        }, $this->messages);

        $imapAdapter = $this->createImapAdapter();

        $imapAdapter
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.
}
            ->expects($this->any())
            ->method('search')
            ->will($this->returnValue(array_keys($this->messages)));

        $imapAdapter
            ->expects($this->any())
            ->method('getMessage')
            ->will($this->returnCallback(function ($id) {
                return $this->createImapStorageMessage($id);
            }));


        $messages = $this->imapHelper->fetchMails($imapAdapter, [], true, true);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        $this->assertEquals($asserts, $messages);
    }

    /**
     * @param string $raw
     *
     * @return Message
     */
    protected function createImapRawMessage($raw)
    {
        return new Message(['raw' => $raw]);
    }
}


GitHub Access Token became invalid

ImapHelperTest::createImapStorageMessage() A
last analyzed 2019-09-13 14:14 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			namespace Checkdomain\Comodo\Tests;
3
4			use Checkdomain\Comodo\ImapExtension;
5			use Checkdomain\Comodo\ImapHelper;
6			use Zend\Mail\Storage\Message;
7
8			/**
9			* Class ImapHelperTest
10			*/
11			class ImapHelperTest extends AbstractTest
12			{
13			/**
14			* @var ImapHelper
15			*/
16			private $imapHelper;
17
18			/**
19			* @var array
20			*/
21			private $messages = [];
22
23			/**
24			* @param string $name
25			* @param array $data
26			* @param string $dataName
27			*/
28			public function __construct($name = null, array $data = [], $dataName = '')
29			{
30			parent::__construct($name, $data, $dataName);
31
32			$this->imapHelper = new ImapHelper();
33			$this->messages = json_decode(file_get_contents(__DIR__.'/data/messages/messages.json'), true);
			0 ignored issues – show Documentation Bug introduced 2017-09-25 07:35 UTC by Report Bug Copy Issue Report It seems like `json_decode(file_get_con.../messages.json'), true)` of type `*` is incompatible with the declared type `array` of property `$messages`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
34			}
35
36
37			/**
38			* @param int $messageId
39			*
40			* @return \PHPUnit_Framework_MockObject_MockObject\|\Zend\Mail\Storage\Message
41			*/
42			public function createImapStorageMessage($messageId)
43			{
44			$messageData = $this->messages[$messageId];
45
46			$message = $this
47			->getMockBuilder(Message::class)
48			->disableOriginalConstructor()
49			->disableOriginalClone()
50			->getMock();
51
52			$message
53			->expects($this->any())
54			->method('getHeader')
55			->will($this->returnCallback(function ($index, $type) use ($messageData) {
56			if ($type != 'string') {
57			return null;
58			}
59
60			if ($index == 'subject') {
61			return utf8_encode($messageData[$index]);
62			}
63
64			return $messageData[$index];
65			}));
66
67			$message
68			->expects($this->any())
69			->method('isMultipart')
70			->will($this->returnValue(false));
71
72			$message
73			->expects($this->any())
74			->method('getContent')
75			->will($this->returnValue($this->messages[$messageId]['plainText']));
76
77			$message
78			->expects($this->any())
79			->method('getHeaderField')
80			->will($this->returnValue('text/plain'))
81			->with($this->equalTo('Content-Type'));
82
83			return $message;
84			}
85
86			/**
87			* This test is only for validating correct decoding of the message (subject/plaintext/received)
88			*/
89			public function testMailParse()
90			{
91			$imapAdapter = $this->createImapAdapter();
92
93			/** @var \PHPUnit_Framework_MockObject_MockObject\|ImapExtension $imapExtension */
94			$imapExtension = $imapAdapter->getInstance();
			0 ignored issues – show Bug introduced 2016-11-30 16:51 UTC by Report Bug Copy Issue Report The method `getInstance` does only exist in `Checkdomain\Comodo\ImapAdapter`, but not in `PHPUnit_Framework_MockObject_MockObject`. 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...
95
96			$imapExtension
			0 ignored issues – show Bug introduced 2016-11-30 16:51 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Checkdomain\Comodo\ImapExtension`. 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...
97			->expects($this->any())
98			->method('search')
99			->will($this->returnValue([0]));
100
101			$imapExtension
102			->expects($this->any())
103			->method('getMessage')
104			->will($this->returnValue($this->createImapRawMessage(
105			base64_decode(file_get_contents(__DIR__.'/data/messages/raw/multipart'))
106			)));
107
108			$messages = $this->imapHelper->fetchMails($imapAdapter, null, true, true);
			0 ignored issues – show Bug introduced 2017-01-10 14:41 UTC by Report Bug Copy Issue Report It seems like `$imapAdapter` defined by `$this->createImapAdapter()` on line `91` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `Checkdomain\Comodo\ImapHelper::fetchMails()` does only seem to accept `object<Checkdomain\Comodo\ImapAdapter>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
109			$message = $messages[0];
110
111			$this->assertEquals('ORDER #12345678 - CONFIRMATION', $message['subject']);
112			$this->assertEquals(1404914391, $message['received']);
113			$this->assertEquals('test'.chr(10).chr(10), $message['plainText']);
114			}
115
116			/**
117			* This test is only for validating correct decoding of the attachments
118			*/
119			public function testMailAttachmentParse()
120			{
121			$imapAdapter = $this->createImapAdapter();
122
123			/** @var \PHPUnit_Framework_MockObject_MockObject\|ImapExtension $imapExtension */
124			$imapExtension = $imapAdapter->getInstance();
			0 ignored issues – show Bug introduced 2016-11-30 16:51 UTC by Report Bug Copy Issue Report The method `getInstance` does only exist in `Checkdomain\Comodo\ImapAdapter`, but not in `PHPUnit_Framework_MockObject_MockObject`. 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...
125
126			$imapExtension
			0 ignored issues – show Bug introduced 2016-11-30 16:51 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Checkdomain\Comodo\ImapExtension`. 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...
127			->expects($this->any())
128			->method('search')
129			->will($this->returnValue([0]));
130
131			$imapExtension
132			->expects($this->any())
133			->method('getMessage')
134			->will($this->returnValue($this->createImapRawMessage(
135			base64_decode(file_get_contents(__DIR__.'/data/messages/raw/with-attachment'))
136			)));
137
138			$messages = $this->imapHelper->fetchMails($imapAdapter, null, true, true);
			0 ignored issues – show Bug introduced 2017-01-10 14:41 UTC by Report Bug Copy Issue Report It seems like `$imapAdapter` defined by `$this->createImapAdapter()` on line `121` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `Checkdomain\Comodo\ImapHelper::fetchMails()` does only seem to accept `object<Checkdomain\Comodo\ImapAdapter>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
139			$attachment = $messages[0]['attachments'][0];
140
141			$this->assertEquals('application/x-zip-compressed', $attachment['mime']);
142			$this->assertEquals('finaltest_tobias-nitsche_de.zip', $attachment['filename']);
143			$this->assertEquals(3962, strlen($attachment['content']));
144			}
145
146			/**
147			* test for assuming domain names and ordernumbersof email
148			*/
149			public function testMailAssume()
150			{
151			$asserts = array_map(function ($message) {
152			static $i = 0;
153
154			return [
155			'id' => $i++,
156			'folder' => 'INBOX',
157			'subject' => $message['subject'],
158			'received' => strtotime($message['date']),
159			'plainText' => $message['plainText'],
160			'attachments' => null,
161			'type' => $message['type'],
162			'domainName' => $message['domainName'],
163			'orderNumber' => $message['orderNumber'],
164			];
165			}, $this->messages);
166
167			$imapAdapter = $this->createImapAdapter();
168
169			$imapAdapter
			0 ignored issues – show Bug introduced 2016-11-30 16:51 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Checkdomain\Comodo\ImapAdapter`. 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...
170			->expects($this->any())
171			->method('search')
172			->will($this->returnValue(array_keys($this->messages)));
173
174			$imapAdapter
175			->expects($this->any())
176			->method('getMessage')
177			->will($this->returnCallback(function ($id) {
178			return $this->createImapStorageMessage($id);
179			}));
180
181
182			$messages = $this->imapHelper->fetchMails($imapAdapter, [], true, true);
			0 ignored issues – show Bug introduced 2017-01-10 12:43 UTC by Report Bug Copy Issue Report It seems like `$imapAdapter` defined by `$this->createImapAdapter()` on line `167` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `Checkdomain\Comodo\ImapHelper::fetchMails()` does only seem to accept `object<Checkdomain\Comodo\ImapAdapter>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history... Documentation introduced 2017-01-09 12:33 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `string`. 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...
183
184			$this->assertEquals($asserts, $messages);
185			}
186
187			/**
188			* @param string $raw
189			*
190			* @return Message
191			*/
192			protected function createImapRawMessage($raw)
193			{
194			return new Message(['raw' => $raw]);
195			}
196			}
197

checkdomain / Comodo

GitHub Access Token became invalid

ImapHelperTest::createImapStorageMessage() A last analyzed 2019-09-13 14:14 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

ImapHelperTest::createImapStorageMessage() A
last analyzed 2019-09-13 14:14 UTC