respect-validation/tests/unit/Rules/CallTest.php

<?php

/*
 * Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
 * SPDX-License-Identifier: MIT
 */

declare(strict_types=1);

namespace Respect\Validation\Rules;

use ErrorException;
use Exception;
use Respect\Validation\Exceptions\AlwaysInvalidException;
use Respect\Validation\Exceptions\CallException;
use Respect\Validation\Test\TestCase;
use Respect\Validation\Validatable;

use function restore_error_handler;
use function set_error_handler;
use function trigger_error;

/**
 * @group rule
 *
 * @covers \Respect\Validation\Rules\Call
 *
 * @author Alexandre Gomes Gaigalas <alganet@gmail.com>
 * @author Gabriel Caruso <carusogabriel34@gmail.com>
 * @author Henrique Moody <henriquemoody@gmail.com>
 * @author Nick Lombard <github@jigsoft.co.za>
 */
final class CallTest extends TestCase
{
    /**
     * @var ErrorException
     */
    private $errorException;

    /**
     * @test
     */
    public function assertShouldExecuteCallable(): void
    {
        $input = ' input ';
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::once())
            ->method('assert')
            ->with($callable($input));

        $sut = new Call($callable, $rule);
        $sut->assert($input);
    }

    /**
     * @test
     */
    public function assertShouldThrowCallExceptionWhenPhpTriggersAnError(): void
    {
        $input = [];
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::never())
            ->method('assert');

        $this->expectException(CallException::class);

        $sut = new Call($callable, $rule);
        $sut->assert($input);
    }

    /**
     * @test
     */
    public function assertShouldRestorePreviousPhpErrorHandler(): void
    {
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::once())
            ->method('assert');

        $sut = new Call($callable, $rule);
        $sut->assert('');

        self::expectExceptionObject($this->errorException);

        trigger_error('Forcing PHP to trigger an error');
    }

    /**
     * @test
     */
    public function assertShouldThrowCallExceptionWhenCallableThrowsAnException(): void
    {
        $input = [];
        $callable = static function (): void {
            throw new Exception();
        };

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::never())
            ->method('assert');

        $this->expectException(CallException::class);

        $sut = new Call($callable, $rule);
        $sut->assert($input);
    }

    /**
     * @test
     */
    public function assertShouldThrowExceptionOfTheDefinedRule(): void
    {
        $input = 'something';
        $callable = 'trim';

        $rule = new AlwaysInvalid();

        $this->expectException(AlwaysInvalidException::class);

        $sut = new Call($callable, $rule);
        $sut->assert($input);
    }

    /**
     * @test
     */
    public function checkShouldExecuteCallable(): void
    {
        $input = ' input ';
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::once())
            ->method('check')
            ->with($callable($input));

        $sut = new Call($callable, $rule);
        $sut->check($input);
    }

    /**
     * @test
     */
    public function checkShouldThrowCallExceptionWhenPhpTriggersAnError(): void
    {
        $input = [];
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::never())
            ->method('check');

        $this->expectException(CallException::class);

        $sut = new Call($callable, $rule);
        $sut->assert($input);
    }

    /**
     * @test
     */
    public function checkShouldRestorePreviousPhpErrorHandler(): void
    {
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::once())
            ->method('check');

        $sut = new Call($callable, $rule);
        $sut->check('');

        self::expectExceptionObject($this->errorException);

        trigger_error('Forcing PHP to trigger an error');
    }

    /**
     * @test
     */
    public function checkShouldThrowCallExceptionWhenCallableThrowsAnException(): void
    {
        $input = [];
        $callable = static function (): void {
            throw new Exception();
        };

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::never())
            ->method('check');

        $this->expectException(CallException::class);

        $sut = new Call($callable, $rule);
        $sut->assert($input);
    }

    /**
     * @test
     */
    public function checkShouldThrowExceptionOfTheDefinedRule(): void
    {
        $rule = new AlwaysInvalid();

        $this->expectException(AlwaysInvalidException::class);

        $sut = new Call('trim', $rule);
        $sut->check('something');
    }

    /**
     * @test
     */
    public function validateShouldExecuteCallable(): void
    {
        $input = ' input ';
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::once())
            ->method('check')
            ->with($callable($input));

        $sut = new Call($callable, $rule);

        self::assertTrue($sut->validate($input));
    }

    /**
     * @test
     */
    public function validateShouldReturnFalseWhenPhpTriggersAnError(): void
    {
        $input = [];
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::never())
            ->method('check');

        $sut = new Call($callable, $rule);

        self::assertFalse($sut->validate($input));
    }

    /**
     * @test
     */
    public function validateShouldReturnFalseWhenDefinedRuleFails(): void
    {
        $sut = new Call('trim', new AlwaysInvalid());

        self::assertFalse($sut->validate('something'));
    }

    /**
     * @test
     */
    public function validateShouldRestorePreviousPhpErrorHandler(): void
    {
        $callable = 'trim';

        $rule = $this->createMock(Validatable::class);
        $rule
            ->expects(self::once())
            ->method('check');

        $sut = new Call($callable, $rule);
        $sut->validate('');

        self::expectExceptionObject($this->errorException);

        trigger_error('Forcing PHP to trigger an error');
    }

    /**
     * {@inheritDoc}
     */
    protected function setUp(): void
    {
        $this->errorException = new ErrorException('This is a PHP error');

        set_error_handler(function (): void {
            throw $this->errorException;
        });
    }

    /**
     * {@inheritDoc}
     */
    protected function tearDown(): void
    {
        restore_error_handler();
    }
}