mvar / apache2-log-parser

tests/LogIteratorTest.php

<?php

/*
 * (c) Mantas Varatiejus <var.mantas@gmail.com>
 *
 * 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))

The method expects does only exist in PHPUnit_Framework_MockObject_MockObject, but not in MVar\Apache2LogParser\LineParserInterface.

            ->method('parseLine')
            ->willReturn($expectedData);

        $iterator = new LogIterator($logfile, $parser);

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?

The class MVar\Apache2LogParser\LogIterator has been deprecated with message: Will be removed in 3.0. Use \MVar\LogParser\LogIterator instead.

        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))

The method expects does only exist in PHPUnit_Framework_MockObject_MockObject, but not in MVar\Apache2LogParser\LineParserInterface.

            ->method('parseLine')
            ->will(
                $this->onConsecutiveCalls(
                    $this->returnValue('parsed_line'),
                    $this->throwException(new NoMatchesException()),

The class MVar\Apache2LogParser\Exception\NoMatchesException has been deprecated with message: Will be removed in 3.0. Use \MVar\LogParser\Exception\MatchException instead.

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

        $iterator = new LogIterator(__DIR__ . '/Fixtures/access.log', $parser, false);

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?

The class MVar\Apache2LogParser\LogIterator has been deprecated with message: Will be removed in 3.0. Use \MVar\LogParser\LogIterator instead.

        $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());

It seems like $this->getParser() targeting MVar\Apache2LogParser\Tests\LogIteratorTest::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?

The class MVar\Apache2LogParser\LogIterator has been deprecated with message: Will be removed in 3.0. Use \MVar\LogParser\LogIterator instead.

        $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;
    }
}