ComposerLockTest.php

Go to the documentation of this file.

<?php
namespace Magento\Test\Integrity;

class ComposerLockTest extends \PHPUnit\Framework\TestCase
{
    public function testLockFileExists()
    {
        $lockFilePath = BP . '/composer.lock';
        $this->assertLockFileExists($lockFilePath);
        return $lockFilePath;
    }

    public function testLockFileReadable($lockFilePath)
    {
        $this->assertLockFileReadable($lockFilePath);
        return $lockFilePath;
    }

    public function testLockFileContainsJson($lockFilePath)
    {
        $lockFileContent = file_get_contents($lockFilePath);
        $this->assertLockFileContainsValidJson($lockFileContent);
        return $lockFileContent;
    }

    public function testUpToDate($lockFileContent)
    {
        $lockData = json_decode($lockFileContent, true);
        $composerFilePath = BP . '/composer.json';
        $this->assertLockDataRelevantToComposerFile($lockData, $composerFilePath);
    }

    private function assertLockFileExists($lockFilePath)
    {
        $this->assertFileExists($lockFilePath, 'composer.lock file does not exist');
    }

    private function assertLockFileReadable($lockFilePath)
    {
        if (!is_readable($lockFilePath)) {
            $this->fail('composer.lock file is not readable');
        }
    }

    private function assertLockFileContainsValidJson($lockFileContent)
    {
        $this->assertJson($lockFileContent, 'composer.lock file does not contains valid json');
    }

    private function assertLockDataRelevantToComposerFile(array $lockData, $composerFilePath)
    {
        if (isset($lockData['content-hash'])) {
            $this->assertLockDataRelevantToMeaningfulComposerConfig($lockData, $composerFilePath);
        } else if (isset($lockData['hash'])) {
            $this->assertLockDataRelevantToFullComposerConfig($lockData, $composerFilePath);
        } else {
            $this->fail('composer.lock does not linked to composer.json data');
        }
    }

    private function assertLockDataRelevantToMeaningfulComposerConfig(array $lockData, $composerFilePath)
    {
        $contentHashCalculator = 'Composer\Package\Locker::getContentHash';
        if (!is_callable($contentHashCalculator)) {
            $this->markTestSkipped('Unable to check composer.lock file by content hash');
        }

        $composerContentHash = call_user_func($contentHashCalculator, file_get_contents($composerFilePath));
        $this->assertSame(
            $composerContentHash,
            $lockData['content-hash'],
            'composer.lock file is not up to date (composer.json file was modified)'
        );
    }

    private function assertLockDataRelevantToFullComposerConfig(array $lockData, $composerFilePath)
    {
        $composerFileHash = hash_file('md5', $composerFilePath);
        $this->assertSame(
            $composerFileHash,
            $lockData['hash'],
            'composer.lock file is not up to date (composer.json file was modified)'
        );
    }
}