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

namespace Magento\CloudPatches\Test\Functional\Acceptance;

use CliTester;

/**
 * Abstract class with implemented before/after Cest steps.
 */
class AbstractCest
{
    /**
     * @var string
     */
    protected $edition = 'EE';

    /**
     * @var array
     */
    private $dependencyListFor244 = [
        "magento/module-re-captcha-admin-ui" => "1.1.2",
        "magento/module-re-captcha-checkout" => "1.1.2",
        "magento/module-re-captcha-contact" => "1.1.1",
        "magento/module-re-captcha-customer" => "1.1.2",
        "magento/module-re-captcha-frontend-ui" => "1.1.2",
        "magento/module-re-captcha-migration" => "1.1.2",
        "magento/module-re-captcha-newsletter" => "1.1.2",
        "magento/module-re-captcha-paypal" => "1.1.2",
        "magento/module-re-captcha-review" => "1.1.2",
        "magento/module-re-captcha-send-friend" => "1.1.2",
        "magento/module-re-captcha-store-pickup" => "1.0.1",
        "magento/module-re-captcha-ui" => "1.1.2",
        "magento/module-re-captcha-user" => "1.1.2",
        "magento/module-re-captcha-validation" => "1.1.1",
        "magento/module-re-captcha-validation-api" => "1.1.1",
        "magento/module-re-captcha-version-2-checkbox" => "2.0.2",
        "magento/module-re-captcha-version-2-invisible" => "2.0.2",
        "magento/module-re-captcha-version-3-invisible" => "2.0.2",
        "magento/module-re-captcha-webapi-api" => "1.0.1",
        "magento/module-re-captcha-webapi-rest" => "1.0.1",
        "magento/module-re-captcha-webapi-graph-ql" => "1.0.1",
        "magento/module-re-captcha-webapi-ui" => "1.0.1",
        "magento/module-securitytxt" => "1.1.1",
        "magento/module-two-factor-auth" => "1.1.3",
        "magento/module-re-captcha-checkout-sales-rule" => "1.1.0",
        "magento/inventory-composer-installer" => "1.2.0",
        "magento/module-inventory" => "1.2.2",
        "magento/module-inventory-admin-ui" => "1.2.2",
        "magento/module-inventory-advanced-checkout" => "1.2.1",
        "magento/module-inventory-api" => "1.2.2",
        "magento/module-inventory-bundle-product" => "1.2.1",
        "magento/module-inventory-bundle-product-admin-ui" => "1.2.2",
        "magento/module-inventory-bundle-product-indexer" => "1.1.1",
        "magento/module-inventory-bundle-import-export" => "1.1.1",
        "magento/module-inventory-cache" => "1.2.2",
        "magento/module-inventory-catalog" => "1.2.2",
        "magento/module-inventory-catalog-admin-ui" => "1.2.2",
        "magento/module-inventory-catalog-api" => "1.3.2",
        "magento/module-inventory-catalog-search" => "1.2.2",
        "magento/module-inventory-configurable-product" => "1.2.2",
        "magento/module-inventory-configurable-product-admin-ui" => "1.2.2",
        "magento/module-inventory-configurable-product-indexer" => "1.2.2",
        "magento/module-inventory-configuration" => "1.2.2",
        "magento/module-inventory-configuration-api" => "1.2.1",
        "magento/module-inventory-distance-based-source-selection" => "1.2.2",
        "magento/module-inventory-distance-based-source-selection-admin-ui" => "1.2.1",
        "magento/module-inventory-distance-based-source-selection-api" => "1.2.1",
        "magento/module-inventory-elasticsearch" => "1.2.1",
        "magento/module-inventory-export-stock" => "1.2.1",
        "magento/module-inventory-export-stock-api" => "1.2.1",
        "magento/module-inventory-graph-ql" => "1.2.1",
        "magento/module-inventory-grouped-product" => "1.2.2",
        "magento/module-inventory-grouped-product-admin-ui" => "1.2.2",
        "magento/module-inventory-grouped-product-indexer" => "1.2.2",
        "magento/module-inventory-import-export" => "1.2.2",
        "magento/module-inventory-indexer" => "2.1.2",
        "magento/module-inventory-in-store-pickup" => "1.1.1",
        "magento/module-inventory-in-store-pickup-admin-ui" => "1.1.1",
        "magento/module-inventory-in-store-pickup-api" => "1.1.1",
        "magento/module-inventory-in-store-pickup-frontend" => "1.1.2",
        "magento/module-inventory-in-store-pickup-graph-ql" => "1.1.1",
        "magento/module-inventory-in-store-pickup-multishipping" => "1.1.1",
        "magento/module-inventory-in-store-pickup-quote" => "1.1.1",
        "magento/module-inventory-in-store-pickup-quote-graph-ql" => "1.1.1",
        "magento/module-inventory-in-store-pickup-sales" => "1.1.1",
        "magento/module-inventory-in-store-pickup-sales-admin-ui" => "1.1.2",
        "magento/module-inventory-in-store-pickup-sales-api" => "1.1.1",
        "magento/module-inventory-in-store-pickup-shipping" => "1.1.1",
        "magento/module-inventory-in-store-pickup-shipping-admin-ui" => "1.1.1",
        "magento/module-inventory-in-store-pickup-shipping-api" => "1.1.1",
        "magento/module-inventory-in-store-pickup-webapi-extension" => "1.1.1",
        "magento/module-inventory-low-quantity-notification" => "1.2.1",
        "magento/module-inventory-low-quantity-notification-admin-ui" => "1.2.2",
        "magento/module-inventory-low-quantity-notification-api" => "1.2.1",
        "magento/module-inventory-multi-dimensional-indexer-api" => "1.2.1",
        "magento/module-inventory-product-alert" => "1.2.2",
        "magento/module-inventory-quote-graph-ql" => "1.0.1",
        "magento/module-inventory-requisition-list" => "1.2.2",
        "magento/module-inventory-reservation-cli" => "1.2.2",
        "magento/module-inventory-reservations" => "1.2.1",
        "magento/module-inventory-reservations-api" => "1.2.1",
        "magento/module-inventory-sales" => "1.2.2",
        "magento/module-inventory-sales-admin-ui" => "1.2.2",
        "magento/module-inventory-sales-api" => "1.2.1",
        "magento/module-inventory-sales-frontend-ui" => "1.2.2",
        "magento/module-inventory-setup-fixture-generator" => "1.2.1",
        "magento/module-inventory-shipping" => "1.2.2",
        "magento/module-inventory-shipping-admin-ui" => "1.2.2",
        "magento/module-inventory-source-deduction-api" => "1.2.2",
        "magento/module-inventory-source-selection" => "1.2.1",
        "magento/module-inventory-source-selection-api" => "1.4.1",
        "magento/module-inventory-visual-merchandiser" => "1.1.2",
        "magento/module-inventory-swatches-frontend-ui" => "1.0.1",
        "magento/module-inventory-catalog-frontend-ui" => "1.0.2",
        "magento/module-inventory-configurable-product-frontend-ui" => "1.0.2",
        "magento/module-inventory-wishlist" => "1.0.1",
        "magento/module-inventory-catalog-search-bundle-product" => "1.0.1",
        "magento/module-inventory-catalog-search-configurable-product" => "1.0.1",
        "magento/module-page-builder" => "2.2.2",
        "magento/module-page-builder-analytics" => "1.6.2",
        "magento/module-cms-page-builder-analytics" => "1.6.2",
        "magento/module-page-builder-admin-analytics" => "1.1.2",
        "magento/module-catalog-page-builder-analytics" => "1.6.2",
        "magento/module-aws-s3-page-builder" => "1.0.2",
        "magento/module-banner-page-builder" => "2.2.2",
        "magento/module-banner-page-builder-analytics" => "1.7.1",
        "magento/module-catalog-staging-page-builder" => "1.7.1",
        "magento/module-staging-page-builder" => "2.2.2",
        "magento/module-cms-page-builder-analytics-staging" => "1.7.1",
        "magento/module-catalog-page-builder-analytics-staging" => "1.7.1",
        "magento/module-page-builder-admin-gws-admin-ui" => "1.7.1"
    ];

    /**
     * Set up the testing environment before each test.
     *
     * @param CliTester $I
     * @return void
     */
    public function _before(CliTester $I): void
    {
        $I->cleanupWorkDir();
    }

    /**
     * Prepares the template for testing by cloning it, setting up authentication,
     * and configuring dependencies.
     *
     * @param CliTester $I
     * @param string $templateVersion
     * @param string $magentoVersion
     * @return void
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     */
    protected function prepareTemplate(CliTester $I, string $templateVersion, ?string $magentoVersion = null): void
    {
        $I->cloneTemplateToWorkDir($templateVersion);
        $I->createAuthJson();
        $I->createArtifactsDir();
        $I->createArtifactCurrentTestedCode('patches', '1.0.99');
        $I->addArtifactsRepoToComposer();
        $I->addDependencyToComposer('magento/magento-cloud-patches', '1.0.99');

        $I->addEceDockerGitRepoToComposer();
        $I->addQualityPatchesGitRepoToComposer();
        $I->addEceToolsGitRepoToComposer();
        $I->addCloudComponentsGitRepoToComposer();

        $dependencies = [
            'magento/magento-cloud-docker',
            'magento/magento-cloud-components',
            'magento/quality-patches',
            'magento/ece-tools',
        ];

        foreach ($dependencies as $dependency) {
            $I->assertTrue(
                $I->addDependencyToComposer($dependency, $I->getDependencyVersion($dependency)),
                'Can not add dependency ' . $dependency
            );
        }

        // Only apply dependency overrides for base 2.4.4 version, not patch versions
        // Patch versions (e.g., 2.4.4-p1) have their own dependency resolution
        if ($magentoVersion === '2.4.4') {
            foreach ($this->dependencyListFor244 as $package => $version) {
                $I->assertTrue(
                    $I->addDependencyToComposer($package, $version),
                    "Can not override dependency {$package} with version {$version} for Adobe Commerce 2.4.4"
                );
            }
        }

        if ($this->edition === 'CE' || $magentoVersion) {
            $version = $magentoVersion ?: $this->getVersionRangeForMagento($I);
            $I->removeDependencyFromComposer('magento/magento-cloud-metapackage');
            $I->addDependencyToComposer(
                $this->edition === 'CE' ? 'magento/product-community-edition' : 'magento/product-enterprise-edition',
                $version
            );
        }

        // Allow insecure packages for legacy Magento testing only (not used in production).
        $this->configureComposerAudit($I);

        $I->composerUpdate();
    }

    /**
     * Configures Composer audit settings to allow insecure packages for testing.
     *
     * @param CliTester $I
     * @return void
     */
    protected function configureComposerAudit(CliTester $I): void
    {
        $composerJsonPath = $I->getWorkDirPath() . '/composer.json';
        if (!file_exists($composerJsonPath)) {
            return;
        }

        $composer = json_decode(file_get_contents($composerJsonPath), true);
        if (!isset($composer['config'])) {
            $composer['config'] = [];
        }

        // Disable blocking insecure packages for test environments
        if (!isset($composer['config']['audit'])) {
            $composer['config']['audit'] = [];
        }
        $composer['config']['audit']['block-insecure'] = false;

        file_put_contents($composerJsonPath, json_encode($composer, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
    }

    /**
     * Converts an array of environment variables to a JSON string format
     * suitable for use in shell commands.
     * The resulting JSON string is escaped to ensure it can be safely used in shell contexts.
     *
     * @param array $data
     * @return string
     */
    protected function convertEnvFromArrayToJson(array $data): string
    {
        return addslashes(json_encode($data));
    }

    /**
     * Retrieves the Magento version range from the composer.json file in the working directory.
     * This method reads the composer.json file, decodes it, and extracts
     * the version constraint for the magento/magento-cloud-metapackage.
     * If the package is not found, it returns an empty string.
     *
     * @param CliTester $I
     * @return string
     */
    protected function getVersionRangeForMagento(CliTester $I): string
    {
        $composer = json_decode(file_get_contents($I->getWorkDirPath() . '/composer.json'), true);

        return $composer['require']['magento/magento-cloud-metapackage'] ?? '';
    }

    /**
     * Cleans up after each test by stopping the environment and removing the working directory.
     *
     * @param CliTester $I
     * @return void
     */
    public function _after(CliTester $I): void
    {
        $I->stopEnvironment();
        $I->removeWorkDir();
    }
}