<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\CloudPatches\Test\Unit\Patch\Collector;

use Magento\CloudPatches\Composer\Package;
use Magento\CloudPatches\Environment\Config;
use Magento\CloudPatches\Filesystem\DirectoryList;
use Magento\CloudPatches\Patch\Collector\CloudCollector;
use Magento\CloudPatches\Patch\Collector\CollectorException;
use Magento\CloudPatches\Patch\Data\Patch;
use Magento\CloudPatches\Patch\Data\PatchInterface;
use Magento\CloudPatches\Patch\PatchBuilder;
use Magento\CloudPatches\Patch\PatchIntegrityException;
use Magento\CloudPatches\Patch\SourceProvider;
use Magento\CloudPatches\Patch\SourceProviderException;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\Attributes\AllowMockObjectsWithoutExpectations;
use PHPUnit\Framework\TestCase;

/**
 * @inheritDoc
 */
class CloudCollectorTest extends TestCase
{
    const CLOUD_PATCH_DIR = 'cloud/patch/dir';

    /**
     * @var CloudCollector
     */
    private $collector;

    /**
     * @var PatchBuilder|MockObject
     */
    private $patchBuilder;

    /**
     * @var SourceProvider|MockObject
     */
    private $sourceProvider;

    /**
     * @var Package|MockObject
     */
    private $package;

    /**
     * @var Config|MockObject
     */
    private $envConfig;

    /**
     * @var DirectoryList|MockObject
     */
    private $directoryList;

    /**
     * @inheritDoc
     */
    protected function setUp(): void
    {
        $this->sourceProvider = $this->createMock(SourceProvider::class);
        $this->package = $this->createMock(Package::class);
        $this->envConfig = $this->createMock(Config::class);
        $this->directoryList = $this->createMock(DirectoryList::class);
        $this->patchBuilder = $this->createMock(PatchBuilder::class);

        $this->collector = new CloudCollector(
            $this->sourceProvider,
            $this->package,
            $this->directoryList,
            $this->envConfig,
            $this->patchBuilder
        );
    }

    /**
     * Tests collecting patches - valid configuration
     *
     * @param bool $isCloud
     * @param string $expectedType
     * @dataProvider collectDataProvider
     * @return void
     */
    #[AllowMockObjectsWithoutExpectations]
    #[DataProvider('collectDataProvider')]
    public function testCollectSuccessful(bool $isCloud, string $expectedType): void
    {
        $validConfig = require __DIR__ . '/Fixture/cloud_config_valid.php';
        $this->sourceProvider->expects($this->once())
            ->method('getCloudPatches')
            ->willReturn($validConfig);
        $this->directoryList->method('getPatches')
            ->willReturn(self::CLOUD_PATCH_DIR);
        $this->envConfig->method('isCloud')
            ->willReturn($isCloud);

        $this->package->method('matchConstraint')
            ->willReturnMap([
                ['magento/magento2-base', '2.1.4 - 2.1.14', false],
                ['magento/magento2-base', '2.2.0 - 2.2.5', true],
                ['magento/magento2-ee-base', '2.2.0 - 2.2.5', true],
             ]);

        $this->patchBuilder->expects($this->exactly(3))
            ->method('setId')
            ->willReturnCallback(function ($args) {
                static $series = [
                    'MDVA-2470', 'MDVA-2470', 'MAGECLOUD-2033'
                ];
                $expectedArgs = array_shift($series);
                $this->assertSame($expectedArgs, $args);
            });
        $this->patchBuilder->expects($this->exactly(3))
            ->method('setTitle')
            ->willReturnCallback(function ($args) {
                static $series = [
                    'Fix asset locker race condition when using Redis',
                    'Fix asset locker race condition when using Redis EE',
                    'Allow DB dumps done with the support module to complete'
                ];
                $expectedArgs = array_shift($series);
                $this->assertSame($expectedArgs, $args);
            });
        $this->patchBuilder->expects($this->exactly(3))
            ->method('setFilename')
            ->willReturnCallback(function ($args) {
                static $series = [
                    'MDVA-2470__fix_asset_locking_race_condition__2.2.0.patch',
                    'MDVA-2470__fix_asset_locking_race_condition__2.2.0_ee.patch',
                    'MAGECLOUD-2033__prevent_deadlock_during_db_dump__2.2.0.patch'
                ];
                $expectedArgs = array_shift($series);
                $this->assertSame($expectedArgs, $args);
            });
        $this->patchBuilder->expects($this->exactly(3))
            ->method('setPath')
            ->willReturnCallback(function ($args) {
                static $series = [
                    self::CLOUD_PATCH_DIR . '/MDVA-2470__fix_asset_locking_race_condition__2.2.0.patch',
                    self::CLOUD_PATCH_DIR . '/MDVA-2470__fix_asset_locking_race_condition__2.2.0_ee.patch',
                    self::CLOUD_PATCH_DIR . '/MAGECLOUD-2033__prevent_deadlock_during_db_dump__2.2.0.patch'
                ];
                $expectedArgs = array_shift($series);
                $this->assertSame($expectedArgs, $args);
            });

        $this->patchBuilder->expects($this->exactly(3))
            ->method('setType')
            ->with($this->logicalOr(
                $this->equalTo($expectedType),
                $this->equalTo($expectedType),
                $this->equalTo($expectedType)
            ));
        $this->patchBuilder->expects($this->exactly(3))
            ->method('setPackageName')
            ->willReturnCallback(function ($args) {
                static $series = [
                    'magento/magento2-base',
                    'magento/magento2-ee-base',
                    'magento/magento2-ee-base'
                ];
                $expectedArgs = array_shift($series);
                $this->assertSame($expectedArgs, $args);
            });
        $this->patchBuilder->expects($this->exactly(3))
            ->method('setPackageConstraint')
            ->willReturnCallback(function ($args) {
                static $series = [
                    '2.2.0 - 2.2.5',
                    '2.2.0 - 2.2.5',
                    '2.2.0 - 2.2.5'
                ];
                $expectedArgs = array_shift($series);
                $this->assertSame($expectedArgs, $args);
            });
        $this->patchBuilder->expects($this->exactly(3))
            ->method('build')
            ->willReturn($this->createMock(Patch::class));

        $this->assertTrue(is_array($this->collector->collect()));
    }

    /**
     * Collector data provider method.
     *
     * @return array
     */
    public static function collectDataProvider(): array
    {
        return [
            ['isCloud' => false, 'expectedType' => PatchInterface::TYPE_OPTIONAL],
            ['isCloud' => true, 'expectedType' => PatchInterface::TYPE_REQUIRED]
        ];
    }

    /**
     * Tests collecting patches - invalid configuration, patch filename
     *
     * @param array $invalidConfig
     * @dataProvider invalidPatchFilenameDataProvider
     * @return void
     */
    #[AllowMockObjectsWithoutExpectations]
    #[DataProvider('invalidPatchFilenameDataProvider')]
    public function testInvalidConfigurationPatchFilename(array $invalidConfig): void
    {
        $this->sourceProvider->expects($this->once())
            ->method('getCloudPatches')
            ->willReturn($invalidConfig);

        $this->package->expects($this->never())
            ->method('matchConstraint');

        $this->expectException(CollectorException::class);
        $this->collector->collect();
    }

    /**
     * Invalid patch filename data provider method.
     *
     * @return array
     */
    public static function invalidPatchFilenameDataProvider(): array
    {
        return [
            [self::createConfig('fix_asset_locking_race_condition__2.1.4.patch')],
            [self::createConfig('MDVA-2470__fix_asset_locking_race_condition.patch')],
            [self::createConfig('MDVA-2470_fix_asset_locking_race_condition__2.1.4.patch')],
            [self::createConfig('MDVA-2470__fix_asset_locking_race_condition_2.1.4.patch')],
        ];
    }

    /**
     * Returns config.
     *
     * @param string $filename
     * @return array
     */
    private static function createConfig(string $filename): array
    {
        return [
            'magento/magento2-base' => [
                'Fix asset locker race condition when using Redis' => [
                    '2.1.4 - 2.1.14' => $filename
                ]
            ]
        ];
    }

    /**
     * Tests collecting patches - invalid configuration, patch title section
     *
     * @param array $config
     * @dataProvider invalidTitleSectionDataProvider
     * @return void
     */
    #[AllowMockObjectsWithoutExpectations]
    #[DataProvider('invalidTitleSectionDataProvider')]
    public function testInvalidConfigurationTitleSection(array $config): void
    {
        $this->sourceProvider->expects($this->once())
            ->method('getCloudPatches')
            ->willReturn($config);

        $this->patchBuilder->expects($this->never())
            ->method('build');

        $this->expectException(CollectorException::class);
        $this->collector->collect();
    }

    /**
     * Invalid title section data provider method.
     *
     * @return array
     */
    public static function invalidTitleSectionDataProvider(): array
    {
        return [
            [
                [
                    'magento/magento2-base' => [
                        'Fix asset locker race condition when using Redis' => [],
                    ]
                ]
            ],
            [
                [
                    'magento/magento2-base' => [
                        'Fix asset locker race condition when using Redis' => 'String instead of array',
                    ]
                ]
            ]
        ];
    }

    /**
     * Tests case when patch factory can't create a patch for some reason.
     *
     * @return void
     */
    #[AllowMockObjectsWithoutExpectations]
    public function testPatchIntegrityException(): void
    {
        $validConfig = require __DIR__ . '/Fixture/cloud_config_valid.php';
        $this->sourceProvider->expects($this->once())
            ->method('getCloudPatches')
            ->willReturn($validConfig);

        $this->package->method('matchConstraint')
            ->willReturnMap([
                ['magento/magento2-base', '2.1.4 - 2.1.14', false],
                ['magento/magento2-base', '2.2.0 - 2.2.5', true],
                ['magento/magento2-ee-base', '2.2.0 - 2.2.5', true],
            ]);

        $this->patchBuilder->method('build')
            ->willThrowException(new PatchIntegrityException(''));

        $this->expectException(CollectorException::class);
        $this->collector->collect();
    }

    /**
     * Tests case when configuration can't be retrieved from source.
     *
     * @return void
     */
    #[AllowMockObjectsWithoutExpectations]
    public function testSourceProviderException(): void
    {
        $this->sourceProvider->expects($this->once())
            ->method('getCloudPatches')
            ->willThrowException(new SourceProviderException(''));

        $this->patchBuilder->expects($this->never())
            ->method('build');

        $this->expectException(CollectorException::class);
        $this->collector->collect();
    }
}