PackageDiffTest.php

<?php

namespace IonBazan\ComposerDiff\Tests;

use Composer\DependencyResolver\Operation\InstallOperation;
use Composer\DependencyResolver\Operation\UninstallOperation;
use Composer\DependencyResolver\Operation\UpdateOperation;
use Composer\Package\AliasPackage;
use Composer\Package\Package;
use Composer\Repository\ArrayRepository;
use Composer\Repository\RepositoryInterface;
use IonBazan\ComposerDiff\Diff\DiffEntry;
use IonBazan\ComposerDiff\PackageDiff;

class PackageDiffTest extends TestCase
{
    /**
     * @param string[] $expected
     * @param bool     $dev
     * @param bool     $withPlatform
     * @param bool     $onlyDirect
     *
     * @dataProvider operationsProvider
     */
    public function testBasicUsage(array $expected, $dev, $withPlatform, $onlyDirect = false)
    {
        $diff = new PackageDiff();
        $operations = $diff->getPackageDiff(
            __DIR__.'/fixtures/base/composer.lock',
            __DIR__.'/fixtures/target/composer.lock',
            $dev,
            $withPlatform,
            $onlyDirect
        );

        $this->assertSame($expected, array_map(array($this, 'entryToString'), $operations->getArrayCopy()));
    }

    public function testBasicUsageWithDefaultArguments()
    {
        $diff = new PackageDiff();
        $operations = $diff->getPackageDiff(
            __DIR__.'/fixtures/base/composer.lock',
            __DIR__.'/fixtures/target/composer.lock',
            false,
            true
        );

        $this->assertSame(array(
            'install psr/event-dispatcher 1.0.0',
            'update roave/security-advisories from dev-master to dev-master',
            'install symfony/deprecation-contracts v2.1.2',
            'update symfony/event-dispatcher from v2.8.52 to v5.1.2',
            'install symfony/event-dispatcher-contracts v2.1.2',
            'install symfony/polyfill-php80 v1.17.1',
            'install php >=5.3',
        ), array_map(array($this, 'entryToString'), $operations->getArrayCopy()));
    }

    public function testSameBaseAndTarget()
    {
        $diff = new PackageDiff();
        $operations = $diff->getPackageDiff(
            __DIR__.'/fixtures/base/composer.lock',
            __DIR__.'/fixtures/base/composer.lock',
            true,
            true
        );

        $this->assertEmpty($operations);
    }

    /**
     * @param string[] $expected
     *
     * @dataProvider diffOperationsProvider
     */
    public function testDiff(array $expected, RepositoryInterface $oldRepository, RepositoryInterface $newRepository)
    {
        $diff = new PackageDiff();
        $operations = $diff->getDiff($oldRepository, $newRepository);

        $this->assertSame($expected, array_map(array($this, 'entryToString'), $operations->getArrayCopy()));
    }

    /**
     * @param string[] $expected
     *
     * @dataProvider diffOperationsProvider
     */
    public function testLoadFromArray()
    {
        $diff = new PackageDiff();

        $this->assertCount(1, $diff->loadPackagesFromArray(array('platform-dev' => array('php' => '>=5.3')), true, true)->getPackages());
        $this->assertCount(1, $diff->loadPackagesFromArray(array('platform' => array('php' => '>=5.3')), false, true)->getPackages());
        $this->assertCount(0, $diff->loadPackagesFromArray(array('platform' => array('php' => '>=5.3')), true, true)->getPackages());
        $this->assertCount(0, $diff->loadPackagesFromArray(array('platform-dev' => array('php' => '>=5.3')), false, true)->getPackages());
    }

    /**
     * @param string[] $expected
     * @param bool     $dev
     * @param bool     $withPlatform
     * @param bool     $onlyDirect
     *
     * @dataProvider operationsProvider
     */
    public function testGitUsage(array $expected, $dev, $withPlatform, $onlyDirect = false)
    {
        $diff = new PackageDiff();
        $this->prepareGit();
        $operations = $diff->getPackageDiff('HEAD', '', $dev, $withPlatform, $onlyDirect);

        $this->assertSame($expected, array_map(array($this, 'entryToString'), $operations->getArrayCopy()));
    }

    /**
     * @param string[] $expected
     * @param bool     $dev
     * @param bool     $withPlatform
     * @param bool     $onlyDirect
     *
     * @dataProvider operationsProvider
     */
    public function testGitUsageWithoutJson(array $expected, $dev, $withPlatform, $onlyDirect = false)
    {
        $diff = new PackageDiff();
        $this->prepareGit(true);
        $operations = $diff->getPackageDiff('HEAD', '', $dev, $withPlatform, $onlyDirect);

        if ($onlyDirect) {
            $expected = array(); // if there is no json file, we can't determine direct dependencies
        }

        $this->assertSame($expected, array_map(array($this, 'entryToString'), $operations->getArrayCopy()));
    }

    public function testInvalidGitRef()
    {
        $diff = new PackageDiff();
        $this->prepareGit();
        $this->setExpectedException('RuntimeException');
        $diff->getPackageDiff('invalid-ref', '', true, true);
    }

    public function testLoadFromEmptyArray()
    {
        $diff = new PackageDiff();

        $this->assertInstanceOf('Composer\Repository\ArrayRepository', $diff->loadPackagesFromArray(array(), false, true));
        $this->assertInstanceOf('Composer\Repository\ArrayRepository', $diff->loadPackagesFromArray(array(), true, true));
    }

    public function testDiffAgainstMissingBaseLockFileThrowsByDefault()
    {
        $diff = new PackageDiff();
        $this->setExpectedException('RuntimeException');
        $diff->getPackageDiff(
            __DIR__.'/fixtures/missing/composer.lock',
            __DIR__.'/fixtures/empty-target/composer.lock',
            false,
            false
        );
    }

    public function testDiffAgainstMissingBaseLockFileWithSkipIoErrors()
    {
        $diff = new PackageDiff();
        $diff->setSkipIoErrors(true);

        $prodOperations = $diff->getPackageDiff(
            __DIR__.'/fixtures/missing/composer.lock',
            __DIR__.'/fixtures/empty-target/composer.lock',
            false,
            false
        );
        $devOperations = $diff->getPackageDiff(
            __DIR__.'/fixtures/missing/composer.lock',
            __DIR__.'/fixtures/empty-target/composer.lock',
            true,
            false
        );

        $this->assertSame(array(
            'install example/package 1.2.3',
        ), array_map(array($this, 'entryToString'), $prodOperations->getArrayCopy()));
        $this->assertSame(array(
            'install example/dev-package 2.3.4',
        ), array_map(array($this, 'entryToString'), $devOperations->getArrayCopy()));
    }

    public function testDiffAgainstMissingGitLockFilePathThrowsByDefault()
    {
        $diff = new PackageDiff();
        $this->prepareGit();
        $this->setExpectedException('RuntimeException');
        $diff->getPackageDiff('HEAD:missing/composer.lock', '', false, false);
    }

    public function testDiffAgainstMissingGitLockFilePathWithSkipIoErrors()
    {
        $diff = new PackageDiff();
        $diff->setSkipIoErrors(true);
        $this->prepareGit();
        $operations = $diff->getPackageDiff('HEAD:missing/composer.lock', '', false, false);

        $this->assertNotEmpty($operations);
        foreach ($operations as $entry) {
            $this->assertInstanceOf('Composer\DependencyResolver\Operation\InstallOperation', $entry->getOperation());
        }
    }

    public function testDiffAgainstMissingWindowsAbsoluteBaseLockFileThrowsByDefault()
    {
        $diff = new PackageDiff();
        $this->setExpectedException('RuntimeException');
        $diff->getPackageDiff(
            'C:\\tmp\\missing\\composer.lock',
            __DIR__.'/fixtures/empty-target/composer.lock',
            false,
            false
        );
    }

    public function testDiffAgainstMissingWindowsAbsoluteBaseLockFileWithSkipIoErrors()
    {
        $diff = new PackageDiff();
        $diff->setSkipIoErrors(true);

        $prodOperations = $diff->getPackageDiff(
            'C:\\tmp\\missing\\composer.lock',
            __DIR__.'/fixtures/empty-target/composer.lock',
            false,
            false
        );
        $devOperations = $diff->getPackageDiff(
            'C:\\tmp\\missing\\composer.lock',
            __DIR__.'/fixtures/empty-target/composer.lock',
            true,
            false
        );

        $this->assertSame(array(
            'install example/package 1.2.3',
        ), array_map(array($this, 'entryToString'), $prodOperations->getArrayCopy()));
        $this->assertSame(array(
            'install example/dev-package 2.3.4',
        ), array_map(array($this, 'entryToString'), $devOperations->getArrayCopy()));
    }

    public function testOneLetterGitRefPath()
    {
        $diff = new PackageDiff();
        $this->prepareGit();
        exec('git branch -f z');
        $operations = $diff->getPackageDiff('z:composer.lock', '', false, false);

        $this->assertNotEmpty($operations);
    }

    public function diffOperationsProvider()
    {
        return array(
            'update alias version' => array(
                array(),
                new ArrayRepository(array(
                    new AliasPackage(new Package('vendor/package-a', '1.0', '1.0'), '1.0', '1.0'),
                )),
                new ArrayRepository(array(
                    new AliasPackage(new Package('vendor/package-a', '1.0', '1.0'), '2.0', '2.0'),
                )),
            ),
            'same alias version but different actual package version' => array(
                array(
                    'update vendor/package-a from 1.0 to 2.0',
                ),
                new ArrayRepository(array(
                    new AliasPackage(new Package('vendor/package-a', '1.0', '1.0'), '1.0', '1.0'),
                )),
                new ArrayRepository(array(
                    new AliasPackage(new Package('vendor/package-a', '2.0', '2.0'), '1.0', '1.0'),
                )),
            ),
            'uninstall aliased package' => array(
                array(
                    'uninstall vendor/package-a 1.0',
                ),
                new ArrayRepository(array(
                    new AliasPackage(new Package('vendor/package-a', '1.0', '1.0'), '2.0', '2.0'),
                )),
                new ArrayRepository(array(
                )),
            ),
            'add aliased package' => array(
                array(
                    'install vendor/package-a 1.0',
                ),
                new ArrayRepository(array()),
                new ArrayRepository(array(
                    new AliasPackage(new Package('vendor/package-a', '1.0', '1.0'), '2.0', '2.0'),
                )),
            ),
        );
    }

    public function operationsProvider()
    {
        return array(
            'prod, with platform' => array(
                'expected' => array(
                    'install psr/event-dispatcher 1.0.0',
                    'update roave/security-advisories from dev-master to dev-master',
                    'install symfony/deprecation-contracts v2.1.2',
                    'update symfony/event-dispatcher from v2.8.52 to v5.1.2',
                    'install symfony/event-dispatcher-contracts v2.1.2',
                    'install symfony/polyfill-php80 v1.17.1',
                    'install php >=5.3',
                ),
                'dev' => false,
                'withPlatform' => true,
            ),
            'prod, no platform' => array(
                'expected' => array(
                    'install psr/event-dispatcher 1.0.0',
                    'update roave/security-advisories from dev-master to dev-master',
                    'install symfony/deprecation-contracts v2.1.2',
                    'update symfony/event-dispatcher from v2.8.52 to v5.1.2',
                    'install symfony/event-dispatcher-contracts v2.1.2',
                    'install symfony/polyfill-php80 v1.17.1',
                ),
                'dev' => false,
                'withPlatform' => false,
            ),
            'dev, no platform' => array(
                'expected' => array(
                    'update phpunit/php-code-coverage from 8.0.2 to 7.0.10',
                    'update phpunit/php-file-iterator from 3.0.2 to 2.0.2',
                    'update phpunit/php-text-template from 2.0.1 to 1.2.1',
                    'update phpunit/php-timer from 5.0.0 to 2.1.2',
                    'update phpunit/php-token-stream from 4.0.2 to 3.1.1',
                    'update phpunit/phpunit from 9.2.5 to 8.5.8',
                    'update sebastian/code-unit-reverse-lookup from 2.0.1 to 1.0.1',
                    'update sebastian/comparator from 4.0.2 to 3.0.2',
                    'update sebastian/diff from 4.0.1 to 3.0.2',
                    'update sebastian/environment from 5.1.1 to 4.2.3',
                    'update sebastian/exporter from 4.0.1 to 3.1.2',
                    'update sebastian/global-state from 4.0.0 to 3.0.0',
                    'update sebastian/object-enumerator from 4.0.1 to 3.0.3',
                    'update sebastian/object-reflector from 2.0.1 to 1.1.1',
                    'update sebastian/recursion-context from 4.0.1 to 3.0.0',
                    'update sebastian/resource-operations from 3.0.1 to 2.0.1',
                    'update sebastian/type from 2.1.0 to 1.1.3',
                    'update sebastian/version from 3.0.0 to 2.0.1',
                    'uninstall phpunit/php-invoker 3.0.1',
                    'uninstall sebastian/code-unit 1.0.3',
                ),
                'dev' => true,
                'withPlatform' => false,
            ),
            'prod, only direct' => array(
                'expected' => array(
                    'update roave/security-advisories from dev-master to dev-master',
                    'update symfony/event-dispatcher from v2.8.52 to v5.1.2',
                ),
                'dev' => false,
                'withPlatform' => false,
                'onlyDirect' => true,
            ),
            'dev, only direct' => array(
                'expected' => array(
                    'update phpunit/phpunit from 9.2.5 to 8.5.8',
                ),
                'dev' => true,
                'withPlatform' => false,
                'onlyDirect' => true,
            ),
        );
    }

    private function prepareGit($onlyLock = false)
    {
        $gitDir = __DIR__.'/test-git';
        @mkdir($gitDir);
        chdir($gitDir);
        @unlink($gitDir.'/composer.json');
        @unlink($gitDir.'/composer.lock');
        @unlink($gitDir.'/.git/index');
        exec('git config init.defaultBranch main');
        exec('git init');
        exec('git config user.name test');
        exec('git config user.email test@example.com');
        file_put_contents($gitDir.'/composer.lock', file_get_contents(__DIR__.'/fixtures/base/composer.lock'));
        !$onlyLock && file_put_contents($gitDir.'/composer.json', file_get_contents(__DIR__.'/fixtures/base/composer.json'));
        exec('git add composer.* && git commit -m "init"');
        file_put_contents($gitDir.'/composer.lock', file_get_contents(__DIR__.'/fixtures/target/composer.lock'));
        !$onlyLock && file_put_contents($gitDir.'/composer.json', file_get_contents(__DIR__.'/fixtures/target/composer.json'));
    }

    private function entryToString(DiffEntry $entry)
    {
        $operation = $entry->getOperation();

        if ($operation instanceof InstallOperation) {
            return sprintf('install %s %s', $operation->getPackage()->getName(), $operation->getPackage()->getPrettyVersion());
        }

        if ($operation instanceof UpdateOperation) {
            return sprintf('update %s from %s to %s', $operation->getInitialPackage()->getName(), $operation->getInitialPackage()->getPrettyVersion(), $operation->getTargetPackage()->getPrettyVersion());
        }

        if ($operation instanceof UninstallOperation) {
            return sprintf('uninstall %s %s', $operation->getPackage()->getName(), $operation->getPackage()->getPrettyVersion());
        }

        throw new \InvalidArgumentException('Invalid operation provided');
    }
}