checkIntegrityComposer.php

Go to the documentation of this file.

#!/usr/bin/env php
<?php
declare(strict_types=1);
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
require __DIR__ . '/../../vendor/autoload.php';
 
if (PHP_SAPI !== 'cli') {
    die('Script must be called from command line.' . chr(10));
}
 
class ‪checkIntegrityComposer
{
    private ‪$rootComposerJson = [];
 
    private ‪$testResults = [];
 
    public function ‪execute(): int
    {
        ‪$rootComposerJson = __DIR__ . '/../../composer.json';
        $this->rootComposerJson = json_decode(file_get_contents(‪$rootComposerJson), true);
        $filesToProcess = $this->‪findExtensionComposerJson();
        ‪$output = new \Symfony\Component\Console\Output\ConsoleOutput();
 
        $resultAcrossAllFiles = 0;
        foreach ($filesToProcess as $composerJsonFile) {
            $fullFilePath = $composerJsonFile->getRealPath();
            $this->‪validateComposerJson($fullFilePath);
        }
        if (!empty($this->testResults)) {
            $table = new \Symfony\Component\Console\Helper\Table(‪$output);
            $table->setHeaders([
                'EXT',
                'type',
                'Dependency',
                'should be',
                'actually is'
            ]);
            foreach ($this->testResults as $extKey => $results) {
                foreach ($results as $result) {
                    $table->addRow([
                        $extKey,
                        $result['type'],
                        $result['dependency'],
                        $result['shouldBe'],
                        $result['actuallyIs']
                    ]);
                }
            }
            $table->render();
            $resultAcrossAllFiles = 1;
        }
        return $resultAcrossAllFiles;
    }
 
    private function ‪findExtensionComposerJson(): \Symfony\Component\Finder\Finder
    {
        ‪$finder = new Symfony\Component\Finder\Finder();
        $composerFiles = ‪$finder
            ->files()
            ->in(__DIR__ . '/../../typo3/sysext/*')
            ->name('composer.json');
        return $composerFiles;
    }
 
    private function ‪validateComposerJson(string $composerJsonFile)
    {
        $extensionKey = $this->‪extractExtensionKey($composerJsonFile);
        $extensionComposerJson = json_decode(file_get_contents($composerJsonFile), true);
        // Check require section
        foreach ($this->rootComposerJson['require'] as $requireKey => $requireItem) {
            if (isset($extensionComposerJson['require'][$requireKey]) && $extensionComposerJson['require'][$requireKey] !== $requireItem) {
                // log inconsistency
                $this->testResults[$extensionKey][] = [
                    'type' => 'require',
                    'dependency' => $requireKey,
                    'shouldBe' => $requireItem,
                    'actuallyIs' => $extensionComposerJson['require'][$requireKey]
                ];
            }
        }
        // Check require-dev section
        foreach ($this->rootComposerJson['require-dev'] as $requireDevKey => $requireDevItem) {
            if (isset($extensionComposerJson['require-dev'][$requireDevKey]) && $extensionComposerJson['require-dev'][$requireDevKey] !== $requireDevItem) {
                // log inconsistency
                $this->testResults[$extensionKey][] = [
                    'type' => 'require-dev',
                    'dependency' => $requireDevKey,
                    'shouldBe' => $requireDevItem,
                    'actuallyIs' => $extensionComposerJson['require-dev'][$requireDevKey]
                ];
            }
        }
    }
 
    private function ‪extractExtensionKey(string $filename): string
    {
        $pattern = '/typo3\/sysext\/(?<extName>[a-z].+?)\//';
        preg_match_all($pattern, $filename, $matches, PREG_SET_ORDER, 0);
        return $matches[0]['extName'];
    }
}
 
‪$composerIntegrityChecker = new ‪checkIntegrityComposer();
exit(‪$composerIntegrityChecker->execute());