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

<?php

/*
 * This file is part of Respect/Validation.
 *
 * (c) Alexandre Gomes Gaigalas <alexandre@gaigalas.net>
 *
 * For the full copyright and license information, please view the "LICENSE.md"
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Respect\Validation\Rules;

use org\bovigo\vfs\content\LargeFileContent;
use org\bovigo\vfs\vfsStream;
use Respect\Validation\Test\TestCase;
use SplFileInfo;

/**
 * @group  rule
 * @covers \Respect\Validation\Exceptions\SizeException
 * @covers \Respect\Validation\Rules\Size
 *
 * @author Gabriel Caruso <carusogabriel34@gmail.com>
 * @author Henrique Moody <henriquemoody@gmail.com>
 */
class SizeTest extends TestCase
{
    /**
     * @return mixed[][]
     */
    public function validSizeProvider(): array
    {
        return [
            [42, 42],
            ['1b', 1],
            ['1kb', 1024],
            ['1mb', 1048576],
            ['1gb', 1073741824],
            ['1tb', 1099511627776],
            ['1pb', 1125899906842624],
            ['1eb', 1152921504606846976],
            ['1zb', 1.1805916207174113E+21],
            ['1yb', 1.2089258196146292E+24],
        ];
    }

    /**
     * @return mixed[][]
     */
    public function validFileProvider(): array
    {
        $root = vfsStream::setup();

        $file2Kb = vfsStream::newFile('2kb.txt')->withContent(LargeFileContent::withKilobytes(2))->at($root);
        $file2Mb = vfsStream::newFile('2mb.txt')->withContent(LargeFileContent::withMegabytes(2))->at($root);

        return [
            // Valid data
            [$file2Kb->url(), '1kb', null, true],
            [$file2Kb->url(), '2kb', null, true],
            [$file2Kb->url(), null, '2kb', true],
            [$file2Kb->url(), null, '3kb', true],
            [$file2Kb->url(), '1kb', '3kb', true],
            [$file2Mb->url(), '1mb', null, true],
            [$file2Mb->url(), '2mb', null, true],
            [$file2Mb->url(), null, '2mb', true],
            [$file2Mb->url(), null, '3mb', true],
            [$file2Mb->url(), '1mb', '3mb', true],
            // Invalid data
            [$file2Kb->url(), '3kb', null, false],
            [$file2Kb->url(), null, '1kb', false],
            [$file2Kb->url(), '1kb', '1.5kb', false],
            [$file2Mb->url(), '2.5mb', null, false],
            [$file2Mb->url(), '3gb', null, false],
            [$file2Mb->url(), null, '1b', false],
            [$file2Mb->url(), '1pb', '3pb', false],
        ];
    }

    /**
     * @dataProvider validSizeProvider
     *
     * @test
     *
     * @param mixed $size
     * @param mixed $bytes
     */
    public function shouldConvertUnitonConstructor($size, $bytes): void
    {
        $rule = new Size($size);

        self::assertEquals($bytes, $rule->minValue);
    }

    /**
     * @expectedException \Respect\Validation\Exceptions\ComponentException
     * @expectedExceptionMessage "42jb" is not a recognized file size
     *
     * @test
     */
    public function shouldThrowsAnExceptionWhenSizeIsNotValid(): void
    {
        new Size('42jb');
    }

    /**
     * @dataProvider validFileProvider
     *
     * @test
     */
    public function shouldValidateFile(
        string $filename,
        ?string $minSize,
        ?string $maxSize,
        bool $expectedValidation
    ): void {
        $rule = new Size($minSize, $maxSize);

        self::assertEquals($expectedValidation, $rule->validate($filename));
    }

    /**
     * @test
     */
    public function shouldValidateSplFileInfo(): void
    {
        $root = vfsStream::setup();
        $file1Gb = vfsStream::newFile('1gb.txt')->withContent(LargeFileContent::withGigabytes(1))->at($root);
        $file1GbObject = new SplFileInfo($file1Gb->url());

        $rule = new Size('1MB', '2GB');

        self::assertTrue($rule->validate($file1GbObject));
    }

    /**
     * @expectedException \Respect\Validation\Exceptions\SizeException
     * @expectedExceptionMessageRegExp #"vfs:.?/.?/root.?/1gb.txt" must be greater than "2pb"#
     *
     * @test
     */
    public function shouldThrowsSizeExceptionWhenAsserting(): void
    {
        $root = vfsStream::setup();
        $file1Gb = vfsStream::newFile('1gb.txt')->withContent(LargeFileContent::withGigabytes(1))->at($root);

        $rule = new Size('2pb');
        $rule->assert($file1Gb->url());
    }
}