LogIteratorTest::testIterator() - Code Metrics - Inspection of "Use mvar/log-iterator as base" - mvar/apache2-log-parser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bc4f39...bfef40 )

by Mantas

created 2015-12-20 16:51 UTC

LogIteratorTest::testIterator() A

↳ Parent: LogIteratorTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * (c) Mantas Varatiejus <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace MVar\Apache2LogParser\Tests;

use MVar\Apache2LogParser\Exception\NoMatchesException;
use MVar\Apache2LogParser\LineParserInterface;
use MVar\Apache2LogParser\LogIterator;

class LogIteratorTest extends \PHPUnit_Framework_TestCase
{
    /**
     * Creates and returns instance of parser mock.
     *
     * @return \PHPUnit_Framework_MockObject_MockObject|LineParserInterface
     */
    protected function getParser()
    {
        return $this->getMock('\\MVar\\Apache2LogParser\\LineParserInterface');
    }

    /**
     * Test for log iterator.
     *
     * @param string $logfile
     * @param int    $rowsCount
     *
     * @dataProvider getTestIteratorData()
     */
    public function testIterator($logfile, $rowsCount)
    {
        $parser = $this->getParser();
        $expectedData = 'parsed_line';

        // Test if parser was called as many times as expected
        $parser->expects($this->exactly($rowsCount))
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.
}
            ->method('parseLine')
            ->willReturn($expectedData);

        $iterator = new LogIterator($logfile, $parser);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        foreach ($iterator as $line => $data) {
            $this->assertTrue(is_string($line));
            $this->assertEquals($data, $expectedData);
        }
    }

    /**
     * Test for iterator in case of empty lines in log.
     */
    public function testIteratorWithEmptyLines()
    {
        $parser = $this->getParser();

        $parser->expects($this->exactly(3))
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.
}
            ->method('parseLine')
            ->will(
                $this->onConsecutiveCalls(
                    $this->returnValue('parsed_line'),
                    $this->throwException(new NoMatchesException()),

                    $this->returnValue('parsed_line')
                )
            );

        $iterator = new LogIterator(__DIR__ . '/Fixtures/access.log', $parser, false);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        $result = [];
        foreach ($iterator as $data) {
            $result[] = $data;
        }

        // Test if empty line was not parsed (NULL)
        $expectedResult = ['parsed_line', null, 'parsed_line'];

        $this->assertEquals($expectedResult, $result);
    }

    /**
     * Test for iterator in case of file handler exception.
     *
     * @expectedException \MVar\Apache2LogParser\Exception\ParserException
     * @expectedExceptionMessage Can not open log file
     */
    public function testIteratorFileException()
    {
        $iterator = new LogIterator(__DIR__ . '/Fixtures/non_existing_file.log', $this->getParser());

        $iterator->rewind();
    }

    /**
     * Data provider for testIterator().
     *
     * @return array[]
     */
    public function getTestIteratorData()
    {
        $data = [];

        // Simple log
        $data[] = [__DIR__ . '/Fixtures/access.log', 2];

        // Compressed log
        $data[] = ['compress.zlib://file://' . __DIR__ . '/Fixtures/access_compressed.gz', 4];

        return $data;
    }
}


1			<?php
2
3			/*
4			* (c) Mantas Varatiejus <[email protected]>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace MVar\Apache2LogParser\Tests;
11
12			use MVar\Apache2LogParser\Exception\NoMatchesException;
13			use MVar\Apache2LogParser\LineParserInterface;
14			use MVar\Apache2LogParser\LogIterator;
15
16			class LogIteratorTest extends \PHPUnit_Framework_TestCase
17			{
18			/**
19			* Creates and returns instance of parser mock.
20			*
21			* @return \PHPUnit_Framework_MockObject_MockObject\|LineParserInterface
22			*/
23			protected function getParser()
24			{
25			return $this->getMock('\\MVar\\Apache2LogParser\\LineParserInterface');
26			}
27
28			/**
29			* Test for log iterator.
30			*
31			* @param string $logfile
32			* @param int $rowsCount
33			*
34			* @dataProvider getTestIteratorData()
35			*/
36			public function testIterator($logfile, $rowsCount)
37			{
38			$parser = $this->getParser();
39			$expectedData = 'parsed_line';
40
41			// Test if parser was called as many times as expected
42			$parser->expects($this->exactly($rowsCount))
			0 ignored issues – show Bug introduced 2015-12-05 17:57 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `MVar\Apache2LogParser\LineParserInterface`. 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...
43			->method('parseLine')
44			->willReturn($expectedData);
45
46			$iterator = new LogIterator($logfile, $parser);
			0 ignored issues – show Bug introduced 2015-12-20 16:54 UTC by Report Bug Copy Issue Report It seems like `$parser` defined by `$this->getParser()` on line `38` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `MVar\LogParser\LogIterator::__construct()` does only seem to accept `object<MVar\LogParser\LineParserInterface>`, 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... Deprecated Code introduced 2015-12-20 16:54 UTC by Report Bug Copy Issue Report The class `MVar\Apache2LogParser\LogIterator` has been deprecated with message: Will be removed in 3.0. Use \MVar\LogParser\LogIterator instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
47
48			foreach ($iterator as $line => $data) {
49			$this->assertTrue(is_string($line));
50			$this->assertEquals($data, $expectedData);
51			}
52			}
53
54			/**
55			* Test for iterator in case of empty lines in log.
56			*/
57			public function testIteratorWithEmptyLines()
58			{
59			$parser = $this->getParser();
60
61			$parser->expects($this->exactly(3))
			0 ignored issues – show Bug introduced 2015-12-05 17:57 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `MVar\Apache2LogParser\LineParserInterface`. 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...
62			->method('parseLine')
63			->will(
64			$this->onConsecutiveCalls(
65			$this->returnValue('parsed_line'),
66			$this->throwException(new NoMatchesException()),
			0 ignored issues – show Deprecated Code introduced 2015-12-20 16:54 UTC by Report Bug Copy Issue Report The class `MVar\Apache2LogParser\Exception\NoMatchesException` has been deprecated with message: Will be removed in 3.0. Use \MVar\LogParser\Exception\MatchException instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
67			$this->returnValue('parsed_line')
68			)
69			);
70
71			$iterator = new LogIterator(__DIR__ . '/Fixtures/access.log', $parser, false);
			0 ignored issues – show Bug introduced 2015-12-20 16:54 UTC by Report Bug Copy Issue Report It seems like `$parser` defined by `$this->getParser()` on line `59` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `MVar\LogParser\LogIterator::__construct()` does only seem to accept `object<MVar\LogParser\LineParserInterface>`, 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... Deprecated Code introduced 2015-12-20 16:54 UTC by Report Bug Copy Issue Report The class `MVar\Apache2LogParser\LogIterator` has been deprecated with message: Will be removed in 3.0. Use \MVar\LogParser\LogIterator instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
72
73			$result = [];
74			foreach ($iterator as $data) {
75			$result[] = $data;
76			}
77
78			// Test if empty line was not parsed (NULL)
79			$expectedResult = ['parsed_line', null, 'parsed_line'];
80
81			$this->assertEquals($expectedResult, $result);
82			}
83
84			/**
85			* Test for iterator in case of file handler exception.
86			*
87			* @expectedException \MVar\Apache2LogParser\Exception\ParserException
88			* @expectedExceptionMessage Can not open log file
89			*/
90			public function testIteratorFileException()
91			{
92			$iterator = new LogIterator(__DIR__ . '/Fixtures/non_existing_file.log', $this->getParser());
			0 ignored issues – show Bug introduced 2015-12-20 16:54 UTC by Report Bug Copy Issue Report It seems like `$this->getParser()` targeting `MVar\Apache2LogParser\Te...eratorTest::getParser()` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `MVar\LogParser\LogIterator::__construct()` does only seem to accept `object<MVar\LogParser\LineParserInterface>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history... Deprecated Code introduced 2015-12-20 16:54 UTC by Report Bug Copy Issue Report The class `MVar\Apache2LogParser\LogIterator` has been deprecated with message: Will be removed in 3.0. Use \MVar\LogParser\LogIterator instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
93			$iterator->rewind();
94			}
95
96			/**
97			* Data provider for testIterator().
98			*
99			* @return array[]
100			*/
101			public function getTestIteratorData()
102			{
103			$data = [];
104
105			// Simple log
106			$data[] = [__DIR__ . '/Fixtures/access.log', 2];
107
108			// Compressed log
109			$data[] = ['compress.zlib://file://' . __DIR__ . '/Fixtures/access_compressed.gz', 4];
110
111			return $data;
112			}
113			}
114

mvar / apache2-log-parser

Push — master ( bc4f39...bfef40 )

LogIteratorTest::testIterator() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like