#12 - absolute path check support

lexik · Sep 22, 2023 · c5e88c4 · c5e88c4
1 parent 2fafc7a
commit c5e88c4
Show file tree

Hide file tree

Showing 9 changed files with 87 additions and 3 deletions.
diff --git a/Command/GenerateCronCommand.php b/Command/GenerateCronCommand.php
@@ -4,6 +4,7 @@
 
 use Lexik\Bundle\CronFileGeneratorBundle\Cron\DumpFileFactory;
 use Lexik\Bundle\CronFileGeneratorBundle\Exception\CronEmptyException;
+use Lexik\Bundle\CronFileGeneratorBundle\Exception\WrongConsoleBinPathException;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -48,7 +49,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         try {
             $dumpFile = $this->dumpFileFactory->createWithEnv($input->getArgument('env-mode'));
         } catch (CronEmptyException $e) {
-            $output->writeln('<error>There is no cron in your configuration. Crons are required to execute this command.</error>');
+            $output->writeln(sprintf('<error>%s. Crons are required to execute this command.</error>', $e->getMessage()));
+
+            return 1;
+        } catch (WrongConsoleBinPathException $e) {
+            $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
 
             return 1;
         }

diff --git a/Cron/Configuration.php b/Cron/Configuration.php
@@ -91,6 +91,11 @@ public function getOutpath(): string
         return $this->globalConfig['output_path'];
     }
 
+    public function getCheckAbsolutePath()
+    {
+        return $this->globalConfig['check_absolute_path'];
+    }
+
     private function init(): void
     {
         $this->globalConfig = [
@@ -100,6 +105,7 @@ private function init(): void
             'env' => $this->env,
             'output_path' => $this->cronConfig['output_path'],
             'mailto' => $this->cronConfig['mailto'],
+            'check_absolute_path' => $this->cronConfig['check_absolute_path'][$this->env] ?? false,
         ];
     }
 

diff --git a/Cron/DumpFile.php b/Cron/DumpFile.php
@@ -3,6 +3,7 @@
 namespace Lexik\Bundle\CronFileGeneratorBundle\Cron;
 
 use Lexik\Bundle\CronFileGeneratorBundle\Exception\CronEmptyException;
+use Lexik\Bundle\CronFileGeneratorBundle\Exception\WrongConsoleBinPathException;
 use Symfony\Component\Filesystem\Filesystem;
 use Twig\Environment;
 
@@ -42,8 +43,14 @@ public function init($env): void
         $this->configuration->initWithEnv($env);
         $this->env = $env;
 
+        if ($this->configuration->getCheckAbsolutePath()
+            && false === file_exists($binPath = $this->configuration->getAbsolutePath())
+        ) {
+            throw new WrongConsoleBinPathException(sprintf('The configured "absolute_path: %s" does not exist', $binPath));
+        }
+
         if (empty($this->configuration->getCrons())) {
-            throw new CronEmptyException('There is no crons found in the configuration.');
+            throw new CronEmptyException('There is no cron found in the configuration');
         }
     }
 

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -36,6 +36,12 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->isRequired()
                     ->end()
                 ->end()
+                ->arrayNode('check_absolute_path')
+                    ->requiresAtLeastOneElement()
+                        ->prototype('boolean')
+                        ->defaultFalse()
+                    ->end()
+                ->end()
                 ->scalarNode('output_path')->isRequired()->end()
                 ->arrayNode('crons')
                     ->arrayPrototype()

diff --git a/Exception/WrongConsoleBinPathException.php b/Exception/WrongConsoleBinPathException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Lexik\Bundle\CronFileGeneratorBundle\Exception;
+
+class WrongConsoleBinPathException extends \Exception
+{
+}
diff --git a/Tests/Cron/ConfigurationTest.php b/Tests/Cron/ConfigurationTest.php
@@ -34,6 +34,7 @@ public function testInit()
         $this->assertEquals('staging', $configuration->getEnv());
         $this->assertEquals('path/to/cron_file', $configuration->getOutpath());
         $this->assertSame('[email protected]', $configuration->getMailto());
+        $this->assertTrue($configuration->getCheckAbsolutePath());
 
         /** @var Cron $cron */
         foreach ($configuration->getCrons() as $cron) {
@@ -135,6 +136,10 @@ private function getFullConfig()
                 'staging' => 'path/to/staging',
                 'prod' => 'path/to/prod',
             ],
+            'check_absolute_path' => [
+                'staging' => true,
+                'prod' => false,
+            ],
             'output_path' => 'path/to/cron_file',
             'crons' => [
                 [

diff --git a/Tests/Cron/DumpFileTest.php b/Tests/Cron/DumpFileTest.php
@@ -5,6 +5,7 @@
 use Lexik\Bundle\CronFileGeneratorBundle\Cron\Configuration;
 use Lexik\Bundle\CronFileGeneratorBundle\Cron\DumpFile;
 use Lexik\Bundle\CronFileGeneratorBundle\Exception\CronEmptyException;
+use Lexik\Bundle\CronFileGeneratorBundle\Exception\WrongConsoleBinPathException;
 use PHPUnit\Framework\TestCase;
 use Twig\Environment;
 
@@ -90,4 +91,34 @@ public function testEmptyCron()
         $dumpFile = new DumpFile($templating, $configuration);
         $dumpFile->init('staging');
     }
+
+    public function testWrongAbsolutePath()
+    {
+        self::expectException(WrongConsoleBinPathException::class);
+
+        $templating = $this->createMock(Environment::class);
+        $templating->expects($this->never())->method('render');
+
+        $configuration = new Configuration([
+            'mailto' => null,
+            'env_available' => [
+                'staging',
+            ],
+            'user' => [
+                'staging' => 'project_staging',
+            ],
+            'php_version' => 'php7.3',
+            'absolute_path' => [
+                'staging' => 'path/to/staging',
+            ],
+            'check_absolute_path' => [
+                'staging' => true,
+            ],
+            'output_path' => $this->outputDir.'/cron_file',
+            'crons' => [],
+        ]);
+
+        $dumpFile = new DumpFile($templating, $configuration);
+        $dumpFile->init('staging');
+    }
 }
diff --git a/Tests/Functional/Command/GenerateCronFileCommandTest.php b/Tests/Functional/Command/GenerateCronFileCommandTest.php
@@ -34,7 +34,22 @@ public function testGenerateEmptyCrons()
 
         $this->assertSame(1, $tester->execute(['env-mode' => 'staging']));
 
-        $expected = 'There is no cron in your configuration. Crons are required to execute this command';
+        $expected = 'There is no cron found in the configuration. Crons are required to execute this command';
+
+        $this->assertStringContainsString($expected, $tester->getDisplay());
+    }
+
+    public function testGenerateWithAbsolutePathCheck()
+    {
+        $kernel = $this->bootKernel();
+
+        $tester = new CommandTester(
+            $kernel->getContainer()->get('lexik_bundle_cron_file_generator.command.generate_cron_command')
+        );
+
+        $this->assertSame(1, $tester->execute(['env-mode' => 'prod']));
+
+        $expected = 'The configured "absolute_path: path/to/prod" does not exist';
 
         $this->assertStringContainsString($expected, $tester->getDisplay());
     }

diff --git a/Tests/Functional/app/config/base_config.yml b/Tests/Functional/app/config/base_config.yml
@@ -19,6 +19,8 @@ lexik_cron_file_generator:
   absolute_path:
     staging: path/to/staging
     prod: path/to/prod
+  check_absolute_path:
+    prod: true
   output_path: '%kernel.cache_dir%/cron_test'
   crons:
     - { name: 'send email', command: 'app:test', env: { staging: '* * * * *', prod: '* 5 * * *' } }