archived-pie/test/integration/Command/DownloadCommandTest.php

<?php

declare(strict_types=1);

namespace Php\PieIntegrationTest\Command;

use Composer\Util\Platform;
use Php\Pie\Command\DownloadCommand;
use Php\Pie\Container;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\RequiresOperatingSystemFamily;
use PHPUnit\Framework\Attributes\RequiresPhp;
use PHPUnit\Framework\TestCase;

use function array_combine;
use function array_map;
use function file_exists;
use function is_executable;

use const PHP_VERSION_ID;

#[CoversClass(DownloadCommand::class)]
class DownloadCommandTest extends TestCase
{
    private const TEST_PACKAGE_LATEST = '2.0.9';
    private const TEST_PACKAGE        = 'asgrim/example-pie-extension';

    private CommandTester $commandTester;

    public function setUp(): void
    {
        $this->commandTester = new CommandTester(Container::testFactory()->get(DownloadCommand::class));
    }

    /**
     * Note: this data provider is not intended to provide a fully comprehensive list of supported version mappings
     * since it is slightly slower to run (as it actually downloads). For a fuller list of version resolution tests,
     * please see {@see \Php\PieIntegrationTest\DependencyResolver\ResolveDependencyWithComposerTest}, which is much
     * faster to execute!
     *
     * @return array<non-empty-string, array{0: non-empty-string, 1: non-empty-string}>
     */
    public static function validVersionsList(): array
    {
        $versionsAndExpected = [
            [self::TEST_PACKAGE, self::TEST_PACKAGE . ':' . self::TEST_PACKAGE_LATEST],
            [self::TEST_PACKAGE . ':*', self::TEST_PACKAGE . ':' . self::TEST_PACKAGE_LATEST],
            [self::TEST_PACKAGE . ':^2.0', self::TEST_PACKAGE . ':' . self::TEST_PACKAGE_LATEST],
        ];

        if (PHP_VERSION_ID >= 80300 && PHP_VERSION_ID < 80400) {
            $versionsAndExpected[] = [self::TEST_PACKAGE . ':^1.0', self::TEST_PACKAGE . ':1.0.1'];
            $versionsAndExpected[] = [self::TEST_PACKAGE . ':1.0.1-alpha.3@alpha', self::TEST_PACKAGE . ':1.0.1-alpha.3'];
            $versionsAndExpected[] = [self::TEST_PACKAGE . ':~1.0.0@alpha', self::TEST_PACKAGE . ':1.0.1'];
            $versionsAndExpected[] = [self::TEST_PACKAGE . ':~1.0.0', self::TEST_PACKAGE . ':1.0.1'];
        }

        return array_combine(
            array_map(static fn ($item) => $item[0], $versionsAndExpected),
            $versionsAndExpected,
        );
    }

    #[DataProvider('validVersionsList')]
    public function testDownloadCommandWillDownloadCompatibleExtension(
        string $requestedVersion,
        string $expectedVersion,
    ): void {
        $this->commandTester->execute(['requested-package-and-version' => $requestedVersion]);

        $this->commandTester->assertCommandIsSuccessful();

        $outputString = $this->commandTester->getDisplay();
        self::assertStringContainsString('Found package: ' . $expectedVersion . ' which provides', $outputString);
        self::assertStringContainsString('Extracted ' . $expectedVersion . ' source to', $outputString);
    }

    public function testDownloadCommandWillDownloadSpecificCommits(): void
    {
        if (Platform::isWindows()) {
            self::markTestSkipped('This test can only run on non-Windows systems');
        }

        $this->commandTester->execute(['requested-package-and-version' => 'asgrim/example-pie-extension:dev-main#9b5e6c80a1e05556e4e6824f0c112a4992cee001']);

        $this->commandTester->assertCommandIsSuccessful();

        $outputString = $this->commandTester->getDisplay();
        self::assertStringContainsString('Found package: asgrim/example-pie-extension:dev-main which provides', $outputString);
        self::assertStringContainsString(
            'Extracted asgrim/example-pie-extension:dev-main source to:',
            $outputString,
        );
    }

    #[RequiresOperatingSystemFamily('Windows')]
    #[DataProvider('validVersionsList')]
    public function testDownloadingWithPhpConfig(string $requestedVersion, string $expectedVersion): void
    {
        // @todo This test makes an assumption you're using `ppa:ondrej/php` to have multiple PHP versions. This allows
        //       us to test scenarios where you run with PHP 8.1 but want to install to a PHP 8.3 instance, for example.
        //       However, this test isn't very portable, and won't run in CI, so we could do with improving this later.
        $phpConfigPath = '/usr/bin/php-config8.3';

        if (! file_exists($phpConfigPath) || ! is_executable($phpConfigPath)) {
            self::markTestSkipped('This test can only run where "' . $phpConfigPath . '" exists and is executable, to target PHP 8.3');
        }

        $this->commandTester->execute([
            '--with-php-config' => $phpConfigPath,
            'requested-package-and-version' => $requestedVersion,
        ]);

        $this->commandTester->assertCommandIsSuccessful();

        $outputString = $this->commandTester->getDisplay();
        self::assertStringContainsString('Found package: ' . $expectedVersion . ' which provides', $outputString);
        self::assertStringContainsString('Extracted ' . $expectedVersion . ' source to', $outputString);
    }

    #[RequiresOperatingSystemFamily('Windows')]
    #[DataProvider('validVersionsList')]
    public function testDownloadingWithPhpPath(string $requestedVersion, string $expectedVersion): void
    {
        $phpBinaryPath = 'C:\php-8.3.6\php.exe';

        if (! file_exists($phpBinaryPath) || ! is_executable($phpBinaryPath)) {
            self::markTestSkipped('This test can only run where "' . $phpBinaryPath . '" exists and is executable, to target PHP 8.3');
        }

        $this->commandTester->execute([
            '--with-php-path' => $phpBinaryPath,
            'requested-package-and-version' => $requestedVersion,
        ]);

        $this->commandTester->assertCommandIsSuccessful();

        $outputString = $this->commandTester->getDisplay();
        self::assertStringContainsString('Found package: ' . $expectedVersion . ' which provides', $outputString);
        self::assertStringContainsString('Extracted ' . $expectedVersion . ' source to', $outputString);
    }

    #[RequiresPhp('<8.2')]
    public function testDownloadCommandFailsWhenUsingIncompatiblePhpVersion(): void
    {
        // 1.0.0 is only compatible with PHP 8.3.0
        self::assertSame(1, $this->commandTester->execute(['requested-package-and-version' => self::TEST_PACKAGE . ':1.0.0']));

        $output = $this->commandTester->getDisplay();
        self::assertStringContainsString(
            'Unable to find an installable package asgrim/example-pie-extension for version 1.0.0, with minimum stability stable.',
            $output,
        );
    }

    #[RequiresOperatingSystemFamily('Linux')]
    #[RequiresPhp('<8.2')]
    public function testDownloadCommandPassesWhenUsingIncompatiblePhpVersionWithForceOption(): void
    {
        // 1.0.1 is only compatible with PHP 8.3.0
        $incompatiblePackage = self::TEST_PACKAGE . ':1.0.1';

        $this->commandTester->execute(
            [
                'requested-package-and-version' => $incompatiblePackage,
                '--force' => true,
            ],
        );

        $this->commandTester->assertCommandIsSuccessful();

        $outputString = $this->commandTester->getDisplay();

        self::assertStringContainsString('Found package: ' . $incompatiblePackage . ' which provides', $outputString);
        self::assertStringContainsString('Extracted ' . $incompatiblePackage . ' source to', $outputString);
    }
}