MonarcAppFO/tests/Unit/Stats/Validator/GetStatsQueryParamsValidatorTest.php

<?php declare(strict_types=1);

namespace MonarcAppFo\Tests\Unit\Stats\Validator;

use Doctrine\ORM\EntityNotFoundException;
use Laminas\InputFilter\InputFilter;
use Monarc\FrontOffice\Model\Entity\Anr;
use Monarc\FrontOffice\Model\Table\AnrTable;
use Monarc\FrontOffice\Stats\DataObject\StatsDataObject;
use Monarc\FrontOffice\Stats\Service\StatsAnrService;
use Monarc\FrontOffice\Stats\Validator\GetStatsQueryParamsValidator;
use Monarc\FrontOffice\Validator\FieldValidator\AnrExistenceValidator;
use MonarcAppFo\Tests\Unit\AbstractUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

class GetStatsQueryParamsValidatorTest extends AbstractUnitTestCase
{
    /** @var AnrTable|MockObject */
    private $anrTable;

    /** @var GetStatsQueryParamsValidator */
    private $getStatsQueryParamsValidator;

    public function setUp(): void
    {
        parent::setUp();

        $this->anrTable = $this->createMock(AnrTable::class);
        $this->getStatsQueryParamsValidator = new GetStatsQueryParamsValidator(
            new InputFilter(),
            $this->anrTable
        );
    }

    public function testItIsNotValidWhenDateToLowerThenDateFromOrBiggerThenCurrentDate()
    {
        static::assertFalse($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'dateFrom' => '2020-01-01',
            'dateTo' => '2019-12-01',
        ]));

        static::assertEquals(
            [
                'dateFrom' => ['"dateFrom" should be lower or equal to "dateTo".'],
                'dateTo' => ['"dateTo" should be bigger or equal to "dateFrom".'],
            ],
            $this->getStatsQueryParamsValidator->getErrorMessages()
        );

        static::assertFalse($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'dateFrom' => '3020-01-01',
            'dateTo' => '3019-12-01',
        ]));

        static::assertEquals(
            [
                'dateFrom' => ['"dateFrom" should be lower or equal to current date.'],
                'dateTo' => ['"dateTo" should be lower or equal to current date.'],
            ],
            $this->getStatsQueryParamsValidator->getErrorMessages()
        );
    }

    public function testItIsValidWhenTheDatesAreTheSameOrDateFromIsLessThenDateTo()
    {
        static::assertTrue($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'dateFrom' => '2019-12-01',
            'dateTo' => '2020-06-01',
        ]));

        static::assertEmpty($this->getStatsQueryParamsValidator->getErrorMessages());
        static::assertEquals(
            [
                'dateFrom' => '2019-12-01',
                'dateTo' => '2020-06-01',
                'anrs' => [],
                'type' => StatsDataObject::TYPE_RISK,
                'aggregationPeriod' => null,
                'getLast' => false,
            ],
            $this->getStatsQueryParamsValidator->getValidData()
        );

        static::assertTrue($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'dateFrom' => '2019-12-01',
            'dateTo' => '2019-12-01',
        ]));

        static::assertEmpty($this->getStatsQueryParamsValidator->getErrorMessages());
        static::assertEquals(
            [
                'dateFrom' => '2019-12-01',
                'dateTo' => '2019-12-01',
                'anrs' => [],
                'type' => StatsDataObject::TYPE_RISK,
                'aggregationPeriod' => null,
                'getLast' => false,
            ],
            $this->getStatsQueryParamsValidator->getValidData()
        );
    }

    public function testItThrowAnExceptionWhenSomeAnrsAreNotPresentedInTheTable()
    {
        $this->anrTable->expects($this->at(0))->method('findById')->willReturn(new Anr());
        $this->anrTable->expects($this->at(1))->method('findById')->willReturn(new Anr());
        $this->anrTable->expects($this->at(2))->method('findById')->willThrowException(new EntityNotFoundException());

        static::assertFalse($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'anrs' => [1, 2, 3, 7],
        ]));

        static::assertEquals(
            [
                'anrs' => [AnrExistenceValidator::ANR_DOES_NOT_EXIST => 'Anr with the ID (3) does not exist.']
            ],
            $this->getStatsQueryParamsValidator->getErrorMessages()
        );
    }

    public function testItIsNotValidWhenTypeIsNotPassedOrWrong()
    {
        static::assertFalse($this->getStatsQueryParamsValidator->isValid([]));
        static::assertEquals(
            [
                'type' => ['isEmpty' => 'Value is required and can\'t be empty']
            ],
            $this->getStatsQueryParamsValidator->getErrorMessages()
        );

        static::assertFalse($this->getStatsQueryParamsValidator->isValid([
            'type' => 'not-existed-type'
        ]));
        static::assertEquals(
            [
                'type' => [
                    'notInArray' => 'Should be one of the values: '
                        . implode(', ', StatsDataObject::getAvailableTypes())
                ]
            ],
            $this->getStatsQueryParamsValidator->getErrorMessages()
        );
    }

    public function testItIsNotValidOnlyWhenPassedWrongAggregationPeriod()
    {
        static::assertFalse($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'aggregationPeriod' => 'not-existed-period'
        ]));
        static::assertEquals(
            [
                'aggregationPeriod' => [
                    'notInArray' => 'Should be one of the values: '
                        . implode(', ', StatsAnrService::AVAILABLE_AGGREGATION_FIELDS)
                ]
            ],
            $this->getStatsQueryParamsValidator->getErrorMessages()
        );

        static::assertTrue($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
        ]));
        static::assertTrue($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'aggregationType' => 'week',
        ]));
    }

    public function testGetLastIsSetToFalseWhenNotPassed()
    {
        static::assertTrue($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
        ]));
        static::assertEquals(
            [
                'type' => StatsDataObject::TYPE_RISK,
                'getLast' => false,
                'anrs' => [],
                'dateFrom' => null,
                'dateTo' => null,
                'aggregationPeriod' => null,
            ],
            $this->getStatsQueryParamsValidator->getValidData()
        );

        static::assertTrue($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'getLast' => true,
        ]));
        static::assertEquals(
            [
                'type' => StatsDataObject::TYPE_RISK,
                'getLast' => true,
                'anrs' => [],
                'dateFrom' => null,
                'dateTo' => null,
                'aggregationPeriod' => null,
            ],
            $this->getStatsQueryParamsValidator->getValidData()
        );

        static::assertTrue($this->getStatsQueryParamsValidator->isValid([
            'type' => StatsDataObject::TYPE_RISK,
            'getLast' => 'the value is converted to boolean.',
        ]));
        static::assertEquals(
            [
                'type' => StatsDataObject::TYPE_RISK,
                'getLast' => true,
                'anrs' => [],
                'dateFrom' => null,
                'dateTo' => null,
                'aggregationPeriod' => null,
            ],
            $this->getStatsQueryParamsValidator->getValidData()
        );
    }
}