断言

Testing Is Documentation

tests/Validate/AssertTest.php

这里为系统提供的基础的断言功能，断言的规则与验证器共享校验规则。

Uses

<?php

use Leevel\Kernel\Utils\Api;
use Leevel\Validate\Assert;
use Leevel\Validate\AssertException;

基本断言测试

断言和验证器共享规则，所以可以直接参考验证器有哪些规则，排查掉依赖验证器自身的校验规则。

支持格式

Assert::foo($value, string $message);
Assert::foo($value, array $param, string $message);

public function testBaseUse(): void
{
    Assert::notEmpty(1);
    Assert::notEmpty(55);
    Assert::notEmpty(66);
    Assert::lessThan(4, [5]);
    self::assertSame(1, 1);
}

断言失败默认错误消息

public function testAssertFailedWithDefaultMessage(): void
{
    $this->expectException(AssertException::class);
    $this->expectExceptionMessage(
        'No exception messsage specified.'
    );

    Assert::notEmpty(0);
}

断言失败自定义消息

public function testAssertFailedWithCustomMessage(): void
{
    $this->expectException(AssertException::class);
    $this->expectExceptionMessage(
        'No exception messsage specified.'
    );

    Assert::notEmpty(0);
}

可选断言支持

如果值为 null 直接返回正确结果。

public function testAssertOptional(): void
{
    Assert::optionalNotEmpty(null);

    self::assertSame(1, 1);
}

可选断言失败

public function testAssertOptionalFailed(): void
{
    $this->expectException(AssertException::class);
    $this->expectExceptionMessage(
        'No exception messsage specified.'
    );

    Assert::optionalNotEmpty(0);
}

断言支持多个校验

必须每一个都满足规则才算校验成功。

public function testAssertMulti(): void
{
    Assert::multiNotEmpty([3, ['hello'], 'bar', 'yes']);

    self::assertSame(1, 1);
}

断言支持多个校验

必须每一个都满足规则才算校验成功。

public function testAssertMultiFailed(): void
{
    $this->expectException(AssertException::class);
    $this->expectExceptionMessage(
        'No exception messsage specified.'
    );

    Assert::multiNotEmpty([3, ['hello'], '', 'yes']);
}

断言支持多个校验也支持可选

必须每一个都满足规则才算校验成功, 可选会跳过验证，可选必须在最前面，即不支持 multiOptional 这种写法。

public function testAssertMultiWithOptional(): void
{
    Assert::optionalMultiNotEmpty([null, ['hello'], 'bar', 'yes', null]);

    self::assertSame(1, 1);
}

断言支持链式表达式

我们可以使用链式表达式来校验规则。

make 原型

Assert::make($value, ?string $message)

第一个参数为待校验的值，第二个为默认校验失败消息，每一条验证规则也支持自己的失败消息。

public function testAssertChain(): void
{
    Assert::make(5, 'Assert success.')
        ->notEmpty()
        ->lessThan([7])
    ;

    self::assertSame(1, 1);
}

断言链式表达式支持可选和多个校验

链式表达式数据值只支持单个，但是可以调用多个校验方法，系统做了统一兼容。一般来说多个校验这种用法在链式调用中没有必要，如果调用了也是没有什么问题。

public function testAssertChainSupportOptionalMulti(): void
{
    Assert::make(5, 'Assert success.')
        ->notEmpty()
        ->lessThan([7])
        ->multiNotEmpty()
        ->optionalNotEmpty()
        ->optionalMultiNotEmpty()
    ;

    self::assertSame(1, 1);
}

断言支持延迟释放

可以将所有错误几种抛出。

lazy 原型

Assert::lazy($value, ?string $message, bool $all = true)

第一个参数为待校验的值，第二个为默认校验失败消息，第三个为是否全部验证，每一条验证规则也支持自己的失败消息。

public function testAssertLazyChain(): void
{
    $result = Assert::lazy(5, 'Assert success.')
        ->notEmpty()
        ->lessThan([7], '5 not less than 3')
        ->lessThan([8], '5 not less than 4')
        ->lessThan([9], '5 not less than 2')
        ->flush()
    ;

    $this->assert($result);
}

断言失败延迟释放

public function testAssertLazyChainFailed(): void
{
    $this->expectException(AssertException::class);
    $this->expectExceptionMessage(
        '["5 not less than 3","5 not less than 4","5 not less than 2"]'
    );

    Assert::lazy(5, 'Assert success.')
        ->notEmpty()
        ->lessThan([3], '5 not less than 3')
        ->lessThan([4], '5 not less than 4')
        ->lessThan([2], '5 not less than 2')
        ->flush()
    ;
}

断言失败延迟释放自定义格式化

public function testAssertLazyChainFailedWithCustomFormat(): void
{
    $this->expectException(AssertException::class);
    $this->expectExceptionMessage(
        '5 not less than 3'.PHP_EOL.
        '5 not less than 4'.PHP_EOL.
        '5 not less than 2'
    );

    Assert::lazy(5, 'Assert success.')
        ->notEmpty()
        ->lessThan([3], '5 not less than 3')
        ->lessThan([4], '5 not less than 4')
        ->lessThan([2], '5 not less than 2')
        ->flush(static function (array $error): string {
            return implode(PHP_EOL, $error);
        })
    ;
}