spryker / spryker-core

Bundles/ContentProductSetDataImport/tests/SprykerTest/Zed/ContentProductSetDataImport/Communication/Plugin/ContentProductSetDataImportPluginTest.php

<?php

/**
 * MIT License
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

namespace SprykerTest\Zed\ContentProductSetDataImport\Communication\Plugin;

use Codeception\Test\Unit;
use Generated\Shared\Transfer\DataImporterConfigurationTransfer;
use Generated\Shared\Transfer\DataImporterReaderConfigurationTransfer;
use Generated\Shared\Transfer\DataImporterReportTransfer;
use Orm\Zed\ProductSet\Persistence\SpyProductSet;
use Orm\Zed\ProductSet\Persistence\SpyProductSetQuery;
use Spryker\Zed\ContentProductSetDataImport\Communication\Plugin\ContentProductSetDataImportPlugin;
use Spryker\Zed\ContentProductSetDataImport\ContentProductSetDataImportConfig;
use Spryker\Zed\ContentProductSetDataImport\ContentProductSetDataImportDependencyProvider;
use Spryker\Zed\DataImport\Business\Exception\DataImportException;

/**
 * Auto-generated group annotations
 *
 * @group SprykerTest
 * @group Zed
 * @group ContentProductSetDataImport
 * @group Communication
 * @group Plugin
 * @group ContentProductSetDataImportPluginTest
 * Add your own group annotations below this line
 */
class ContentProductSetDataImportPluginTest extends Unit
{
    /**
     * @var string
     */
    protected const ERROR_MESSAGE_PRODUCT_SET_WRONG_KEY = 'Please check "product_set_key.default" in the row with key: "ps-1". The wrong product set key passed.';

    /**
     * @var string
     */
    protected const KEY_ID_PRODUCT_SET = 'id_product_set';

    /**
     * @var \SprykerTest\Zed\ContentProductSetDataImport\ContentProductSetDataImportCommunicationTester
     */
    protected $tester;

    /**
     * @return void
     */
    protected function _before(): void
    {
        parent::_before();
        $this->tester->ensureDatabaseTableIsEmpty();
    }

    /**
     * @return void
     */
    public function testImportProductSetData(): void
    {
        // Arrange
        $dataImportConfigurationTransfer = $this->createConfigurationTransfer(
            'import/content_product_set.csv',
        );

        // Act
        $dataImporterReportTransfer = (new ContentProductSetDataImportPlugin())->import($dataImportConfigurationTransfer);

        // Assert
        $this->assertInstanceOf(DataImporterReportTransfer::class, $dataImporterReportTransfer);

        $this->tester->assertDatabaseTableContainsData('ps-1');
        $this->tester->assertDatabaseTableContainsData('ps-2');
        $this->tester->assertDatabaseTableContainsData('ps-3');
    }

    /**
     * @return void
     */
    public function testImportProductSetDataWithWrongProductSetKeyFails(): void
    {
        // Arrange
        $dataImportConfigurationTransfer = $this->createConfigurationTransfer(
            'import/content_product_set_wrong_key.csv',
        )->setThrowException(true);

        // Assert
        $this->expectExceptionObject(new DataImportException(static::ERROR_MESSAGE_PRODUCT_SET_WRONG_KEY));

        // Act
        (new ContentProductSetDataImportPlugin())->import($dataImportConfigurationTransfer);
    }

    /**
     * @return void
     */
    public function testGetImportTypeReturnsTypeOfImporter(): void
    {
        // Arrange
        $contentProductSetDataImportPlugin = new ContentProductSetDataImportPlugin();

        // Assert
        $this->assertSame(ContentProductSetDataImportConfig::IMPORT_TYPE_CONTENT_PRODUCT_SET, $contentProductSetDataImportPlugin->getImportType());
    }

    /**
     * @return void
     */
    public function testUpdateLocale(): void
    {
        // Arrange
        $this->setProductSetQueryReturn(2);
        $dataImportConfigurationTransfer = $this->createConfigurationTransfer(
            'import/content_product_set(update).csv',
        );

        // Act
        $dataImporterReportTransfer = (new ContentProductSetDataImportPlugin())->import($dataImportConfigurationTransfer);

        // Assert
        $this->assertInstanceOf(DataImporterReportTransfer::class, $dataImporterReportTransfer);
        $this->assertTrue($dataImporterReportTransfer->getIsSuccess());

        $this->tester->assertContentLocalizedHasSetId(66, [static::KEY_ID_PRODUCT_SET => 2]);
        $this->tester->assertContentLocalizedHasSetId(46, [static::KEY_ID_PRODUCT_SET => 2]);
    }

    /**
     * @return void
     */
    public function testUpdateLocaleFromDefault(): void
    {
        // Arrange
        $this->setProductSetQueryReturn(1);
        $dataImportConfigurationTransfer = $this->createConfigurationTransfer(
            'import/content_product_set(update_locale_from_default).csv',
        );

        // Act
        $dataImporterReportTransfer = (new ContentProductSetDataImportPlugin())->import($dataImportConfigurationTransfer);

        // Assert
        $this->assertInstanceOf(DataImporterReportTransfer::class, $dataImporterReportTransfer);
        $this->assertTrue($dataImporterReportTransfer->getIsSuccess());

        $this->tester->assertContentLocalizedHasSetId(66, [static::KEY_ID_PRODUCT_SET => 1]);
        $this->tester->assertContentLocalizedHasSetId(46, [static::KEY_ID_PRODUCT_SET => 1]);
    }

    /**
     * @return void
     */
    public function testUpdateLocaleToDefault(): void
    {
        // Arrange
        $this->setProductSetQueryReturn(3);
        $dataImportConfigurationTransfer = $this->createConfigurationTransfer(
            'import/content_product_set(update_locale_to_default).csv',
        );

        // Act
        $dataImporterReportTransfer = (new ContentProductSetDataImportPlugin())->import($dataImportConfigurationTransfer);

        // Assert
        $this->assertInstanceOf(DataImporterReportTransfer::class, $dataImporterReportTransfer);
        $this->assertTrue($dataImporterReportTransfer->getIsSuccess());

        $this->tester->assertContentLocalizedHasSetId(66, [static::KEY_ID_PRODUCT_SET => 3]);
        $this->tester->assertContentLocalizedDoesNotExist(46);
    }

    /**
     * @param string $importFilePath
     *
     * @return \Generated\Shared\Transfer\DataImporterConfigurationTransfer
     */
    protected function createConfigurationTransfer(string $importFilePath): DataImporterConfigurationTransfer
    {
        // Arrange
        $dataImporterReaderConfigurationTransfer = new DataImporterReaderConfigurationTransfer();
        $dataImporterReaderConfigurationTransfer->setFileName(codecept_data_dir() . $importFilePath);

The function codecept_data_dir was not found. Maybe you did not declare it correctly or list all dependencies?

        $dataImportConfigurationTransfer = new DataImporterConfigurationTransfer();

        return $dataImportConfigurationTransfer->setReaderConfiguration($dataImporterReaderConfigurationTransfer);
    }

    /**
     * @param int $idProductSet
     *
     * @return void
     */
    protected function setProductSetQueryReturn(int $idProductSet): void
    {
        $productSetQueryMock = $this->getMockBuilder(SpyProductSetQuery::class)
            ->setMethods(['findOneByProductSetKey'])
            ->getMock();

        $productSetQueryMock->method('findOneByProductSetKey')
            ->willReturn((new SpyProductSet())->setIdProductSet($idProductSet));

        $this->tester->setDependency(ContentProductSetDataImportDependencyProvider::PROPEL_QUERY_PRODUCT_SET, $productSetQueryMock);
    }
}