humbug / box

src/Console/Command/GenerateDockerFile.php

<?php

declare(strict_types=1);

/*
 * This file is part of the box project.
 *
 * (c) Kevin Herrera <kevin@herrera.io>
 *     Théo Fidry <theo.fidry@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace KevinGH\Box\Console\Command;

use Fidry\Console\Command\CommandAware;
use Fidry\Console\Command\CommandAwareness;
use Fidry\Console\Command\Configuration;
use Fidry\Console\ExitCode;
use Fidry\Console\IO;

The type Fidry\Console\IO was not found. Maybe you did not declare it correctly or list all dependencies?

use Fidry\FileSystem\FS;
use KevinGH\Box\DockerFileGenerator;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\StringInput;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Filesystem\Path;
use Webmozart\Assert\Assert;
use function file_exists;
use function getcwd;
use function realpath;
use function sprintf;

/**
 * @private
 */
final class GenerateDockerFile implements CommandAware
{
    use CommandAwareness;

    public const NAME = 'docker';

    private const PHAR_ARG = 'phar';
    private const DOCKER_FILE_NAME = 'Dockerfile';

    public function getConfiguration(): Configuration
    {
        return new Configuration(
            'docker',
            '🐳  Generates a Dockerfile for the given PHAR',
            '',
            [
                new InputArgument(
                    self::PHAR_ARG,
                    InputArgument::OPTIONAL,
                    'The PHAR file',
                ),
            ],
            [
                ConfigOption::getOptionInput(),
                ChangeWorkingDirOption::getOptionInput(),
            ],
        );
    }

    public function execute(IO $io): int
    {
        ChangeWorkingDirOption::changeWorkingDirectory($io);

        $pharFilePath = $this->getPharFilePath($io);

        if (null === $pharFilePath) {
            return ExitCode::FAILURE;
        }

        $io->newLine();
        $io->writeln(
            sprintf(
                '🐳  Generating a Dockerfile for the PHAR "<comment>%s</comment>"',
                $pharFilePath,
            ),
        );
        $io->newLine();

        $requirementsFilePhar = 'phar://'.$pharFilePath.'/.box/.requirements.php';

        return $this->generateFile(
            $pharFilePath,
            $requirementsFilePhar,
            $io,
        );
    }

    /**
     * @return null|non-empty-string

The doc comment null|non-empty-string at position 2 could not be parsed: Unknown type name 'non-empty-string' at position 2 in null|non-empty-string.

     */
    private function getPharFilePath(IO $io): ?string
    {
        $pharFilePath = $io->getTypedArgument(self::PHAR_ARG)->asNullableNonEmptyString();

        if (null === $pharFilePath) {
            $pharFilePath = $this->guessPharPath($io);
        }

        if (null === $pharFilePath) {
            return null;
        }

        $pharFilePath = Path::canonicalize($pharFilePath);
        Assert::file($pharFilePath);

        return false !== realpath($pharFilePath) ? realpath($pharFilePath) : $pharFilePath;
    }

    private function guessPharPath(IO $io): ?string
    {
        $config = ConfigOption::getConfig($io, true);

        if (file_exists($config->getOutputPath())) {
            return $config->getOutputPath();
        }

        $compile = $io->askQuestion(
            new ConfirmationQuestion(
                'The output PHAR could not be found, do you wish to generate it by running "<comment>box compile</comment>"?',
                true,
            ),
        );

        if (false === $compile) {
            $io->error('Could not find the PHAR to generate the docker file for');

            return null;
        }

        $this->getCompileCommand()->execute(
            new IO(
                self::createCompileInput($io),
                clone $io->getOutput(),
            ),
        );

        return $config->getOutputPath();
    }

    private function getCompileCommand(): Compile
    {
        /* @noinspection PhpIncompatibleReturnTypeInspection */
        return $this->getCommandRegistry()->findCommand(Compile::NAME);

The expression return $this->getCommandRegistry()->findCommand(KevinGH\Box\Console\Command\Compile::NAME) returns the type Fidry\Console\Bridge\Command\ReversedSymfonyCommand which is incompatible with the type-hinted return KevinGH\Box\Console\Command\Compile.

    }

    private static function createCompileInput(IO $io): InputInterface
    {
        if ($io->isQuiet()) {
            $compileInput = '--quiet';
        } elseif ($io->isVerbose()) {
            $compileInput = '--verbose 1';
        } elseif ($io->isVeryVerbose()) {
            $compileInput = '--verbose 2';
        } elseif ($io->isDebug()) {
            $compileInput = '--verbose 3';
        } else {
            $compileInput = '';
        }

        $compileInput = new StringInput($compileInput);
        $compileInput->setInteractive(false);

        return $compileInput;
    }

    private function generateFile(string $pharPath, string $requirementsPhar, IO $io): int
    {
        if (false === file_exists($requirementsPhar)) {
            $io->error(
                'Cannot retrieve the requirements for the PHAR. Make sure the PHAR has been built with Box and the requirement checker enabled.',
            );

            return ExitCode::FAILURE;
        }

        $requirements = include $requirementsPhar;

        $dockerFileContents = DockerFileGenerator::createForRequirements(
            $requirements,
            Path::makeRelative($pharPath, getcwd()),
        )
            ->generateStub();

        if (file_exists(self::DOCKER_FILE_NAME)) {
            $remove = $io->askQuestion(
                new ConfirmationQuestion(
                    'A Docker file has already been found, are you sure you want to override it?',
                    true,
                ),
            );

            if (false === $remove) {
                $io->writeln('Skipped the docker file generation.');

                return ExitCode::SUCCESS;
            }
        }

        FS::dumpFile(self::DOCKER_FILE_NAME, $dockerFileContents);

        $io->success('Done');

        $io->writeln(
            [
                sprintf(
                    'You can now inspect your <comment>%s</comment> file or build your container with:',
                    self::DOCKER_FILE_NAME,
                ),
                '$ <comment>docker build .</comment>',
            ],
        );

        return ExitCode::SUCCESS;
    }
}