Spiral\Tests\Storage\Unit\Builder\AdapterFactoryTest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	testBuildSimpleLocalFs()	0	7	1
A	testBuildSimpleAwsS3Fs()	0	16	1
A	testWrongFsInfoUsage()	0	18	1
A	testBuildAdvancedAwsS3Fs()	0	29	1
A	testBuildAdvancedLocalFs()	0	44	1

<?php

declare(strict_types=1);

namespace Spiral\Tests\Storage\Unit\Builder;

use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
use League\Flysystem\Local\LocalFilesystemAdapter;
use League\Flysystem\PathPrefixer;
use League\Flysystem\UnixVisibility\PortableVisibilityConverter;
use PHPUnit\Framework\MockObject\MockObject;
use Spiral\Storage\Builder\AdapterFactory;
use Spiral\Storage\Config\DTO\FileSystemInfo;
use Spiral\Storage\Exception\StorageException;
use Spiral\Tests\Storage\Traits\AwsS3FsBuilderTrait;
use Spiral\Tests\Storage\Traits\LocalFsBuilderTrait;
use Spiral\Tests\Storage\Unit\UnitTestCase;

class AdapterFactoryTest extends UnitTestCase
{
    use LocalFsBuilderTrait;
    use AwsS3FsBuilderTrait;

    /**
     * @throws StorageException
     */
    public function testBuildSimpleLocalFs(): void
    {
        $info = $this->buildLocalInfo();

        $adapter = AdapterFactory::build($info);

        $this->assertInstanceOf(LocalFilesystemAdapter::class, $adapter);
    }

    /**
     * @throws StorageException
     * @throws \ReflectionException
     */
    public function testBuildAdvancedLocalFs(): void
    {
        $options = [
            FileSystemInfo\LocalInfo::ROOT_DIR_KEY => self::ROOT_DIR,
            FileSystemInfo\LocalInfo::HOST_KEY => self::CONFIG_HOST,
            FileSystemInfo\LocalInfo::WRITE_FLAGS_KEY => LOCK_NB,
            // Not required
            FileSystemInfo\LocalInfo::LINK_HANDLING_KEY => LocalFilesystemAdapter::SKIP_LINKS,
            FileSystemInfo\LocalInfo::VISIBILITY_KEY => [
                'file' => [
                    'public' => 0777,
                    'private' => 0644,
                ],
                'dir' => [
                    'public' => 0776,
                    'private' => 0444,
                ],
            ],
        ];

        $info = new FileSystemInfo\LocalInfo(
            'debugLocal',
            [
                FileSystemInfo\LocalInfo::ADAPTER_KEY => LocalFilesystemAdapter::class,
                FileSystemInfo\LocalInfo::OPTIONS_KEY => $options,
            ]
        );

        $adapter = AdapterFactory::build($info);

        $this->assertInstanceOf(LocalFilesystemAdapter::class, $adapter);


        $this->assertEquals(
            $options[FileSystemInfo\LocalInfo::LINK_HANDLING_KEY],
            $this->getNotPublicProperty($adapter, 'linkHandling')

The function Spiral\Tests\Storage\Unit\UnitTestCase::getNotPublicProperty() has been deprecated: Tests should not use this method to call internal implementation

        );
        $this->assertEquals(
            $options[FileSystemInfo\LocalInfo::WRITE_FLAGS_KEY],
            $this->getNotPublicProperty($adapter, 'writeFlags')

The function Spiral\Tests\Storage\Unit\UnitTestCase::getNotPublicProperty() has been deprecated: Tests should not use this method to call internal implementation

        );
        $this->assertEquals(
            PortableVisibilityConverter::fromArray($options[FileSystemInfo\LocalInfo::VISIBILITY_KEY]),

It seems like $options[Spiral\Storage\Config\DTO\FileSystemInfo\LocalInfo::VISIBILITY_KEY] can also be of type integer and string; however, parameter $permissionMap of League\Flysystem\UnixVisibility\PortableVisibilityConverter::fromArray() does only seem to accept array, maybe add an additional type check?

            $this->getNotPublicProperty($adapter, 'visibility')

The function Spiral\Tests\Storage\Unit\UnitTestCase::getNotPublicProperty() has been deprecated: Tests should not use this method to call internal implementation

        );
    }

    /**
     * @throws StorageException
     * @throws \ReflectionException
     */
    public function testBuildSimpleAwsS3Fs(): void
    {
        $fsDescription = $this->buildAwsS3ServerDescription();
        $fsInfo = new FileSystemInfo\Aws\AwsS3Info('awsS3', $fsDescription);

        $adapter = AdapterFactory::build($fsInfo);

        $this->assertInstanceOf(AwsS3V3Adapter::class, $adapter);

        $this->assertEquals(
            $fsDescription[FileSystemInfo\Aws\AwsS3Info::OPTIONS_KEY][FileSystemInfo\Aws\AwsS3Info::BUCKET_KEY],
            $this->getNotPublicProperty($adapter, 'bucket')

The function Spiral\Tests\Storage\Unit\UnitTestCase::getNotPublicProperty() has been deprecated: Tests should not use this method to call internal implementation

        );
        $this->assertSame(
            $fsInfo->getClient(),
            $this->getNotPublicProperty($adapter, 'client')

The function Spiral\Tests\Storage\Unit\UnitTestCase::getNotPublicProperty() has been deprecated: Tests should not use this method to call internal implementation

        );
    }

    /**
     * @throws StorageException
     * @throws \ReflectionException
     */
    public function testBuildAdvancedAwsS3Fs(): void
    {
        $options = [
            FileSystemInfo\Aws\AwsS3Info::BUCKET_KEY => 'testBucket',
            FileSystemInfo\Aws\AwsS3Info::CLIENT_KEY => $this->getAwsS3Client(),
            FileSystemInfo\Aws\AwsS3Info::PATH_PREFIX_KEY => '/some/prefix/',
            FileSystemInfo\Aws\AwsS3Info::VISIBILITY_KEY => $this->getAwsS3VisibilityOption(),
        ];

        $info = new FileSystemInfo\Aws\AwsS3Info(
            'debugAwsS3',
            [
                FileSystemInfo\LocalInfo::ADAPTER_KEY => AwsS3V3Adapter::class,
                FileSystemInfo\LocalInfo::OPTIONS_KEY => $options,
            ]
        );

        $adapter = AdapterFactory::build($info);

        $this->assertInstanceOf(AwsS3V3Adapter::class, $adapter);


        $this->assertEquals(
            new PathPrefixer($options[FileSystemInfo\Aws\AwsS3Info::PATH_PREFIX_KEY]),
            $this->getNotPublicProperty($adapter, 'prefixer')

The function Spiral\Tests\Storage\Unit\UnitTestCase::getNotPublicProperty() has been deprecated: Tests should not use this method to call internal implementation

        );
        $this->assertEquals(
            $info->getVisibilityConverter(),
            $this->getNotPublicProperty($adapter, 'visibility')

The function Spiral\Tests\Storage\Unit\UnitTestCase::getNotPublicProperty() has been deprecated: Tests should not use this method to call internal implementation

        );
    }

    public function testWrongFsInfoUsage(): void
    {
        $this->expectException(StorageException::class);
        $this->expectExceptionMessage('Adapter can\'t be built by filesystem info');

        /** @var MockObject|FileSystemInfo\FileSystemInfo $info */
        $info = $this->getMockForAbstractClass(
            FileSystemInfo\FileSystemInfo::class,
            [
                'someName',
                [
                    FileSystemInfo\FileSystemInfo::ADAPTER_KEY => LocalFilesystemAdapter::class,
                    FileSystemInfo\FileSystemInfo::OPTIONS_KEY => [],
                ],
            ]
        );

        AdapterFactory::build($info);
    }
}