tests(export): progress

Author: Guikingone

.gitignore

@@ -16,6 +16,7 @@ summary.log
 .php-cs-fixer.cache
 
 # Tests
+tests/**/assets/
 .phpunit.result.cache
 tests/.assets/**/*.json
 

src/Command/ExportCommand.php

@@ -72,7 +72,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             });
         } catch (Throwable $throwable) {
             $style->error([
-                'An error occurred when exporting tasks',
+                'An error occurred when exporting tasks:',
                 $throwable->getMessage(),
             ]);
 

src/DependencyInjection/SchedulerBundleExtension.php

@@ -993,6 +993,9 @@ public function registerExportTools(ContainerBuilder $container): void
         $container->setAlias(ExporterRegistryInterface::class, ExporterRegistry::class);
 
         $container->register(CronTabExporter::class, CronTabExporter::class)
+            ->setArguments([
+                $container->getParameter('kernel.project_dir'),
+            ])
             ->addTag(self::TASK_EXPORTER_TAG)
             ->addTag('container.preload', [
                 'class' => CronTabExporter::class,

src/Export/AbstractExporter.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SchedulerBundle\Export;
+
+/**
+ * @author Guillaume Loulier <[email protected]>
+ */
+abstract class AbstractExporter implements ExporterInterface
+{
+    private string $projectDir;
+
+    public function __construct(string $projectDir)
+    {
+        $this->projectDir = $projectDir;
+    }
+
+    protected function getProjectDir(): string
+    {
+        return $this->projectDir;
+    }
+}

src/Export/CronTabExporter.php

@@ -5,18 +5,34 @@
 namespace SchedulerBundle\Export;
 
 use SchedulerBundle\Task\TaskInterface;
-use function file_exists;
+use Symfony\Component\Filesystem\Filesystem;
+use function sprintf;
 
 /**
  * @author Guillaume Loulier <[email protected]>
  */
-final class CronTabExporter implements ExporterInterface
+final class CronTabExporter extends AbstractExporter
 {
+    /**
+     * {@inheritdoc}
+     */
     public function export(string $filename, TaskInterface $task): void
     {
-        if (file_exists($filename)) {
+        $finalFilename = sprintf('%s/%s', $this->getProjectDir(), $task->getName());
+
+        $fs = new Filesystem();
+
+        if ($fs->exists($finalFilename)) {
             return;
         }
+
+        $fs->touch($finalFilename);
+        $fs->dumpFile($finalFilename, sprintf(
+            '%s cd %s && php bin/console scheduler:execute --name %s',
+            $task->getExpression(),
+            $this->getProjectDir(),
+            $task->getName(),
+        ));
     }
 
     /**

tests/DependencyInjection/SchedulerBundleExtensionTest.php

@@ -465,6 +465,7 @@ public function testTransportIsRegistered(): void
         $schedulerBundleExtension = new SchedulerBundleExtension();
 
         $containerBuilder = new ContainerBuilder();
+        $containerBuilder->setParameter('kernel.project_dir', 'foo');
         $containerBuilder->register(SerializerInterface::class, SerializerInterface::class);
 
         $schedulerBundleExtension->load([
@@ -1116,7 +1117,8 @@ public function testExportToolsAreRegistered(): void
         self::assertSame(ExporterRegistry::class, $container->getDefinition(ExporterRegistry::class)->getTag('container.preload')[0]['class']);
 
         self::assertTrue($container->hasDefinition(CronTabExporter::class));
-        self::assertCount(0, $container->getDefinition(CronTabExporter::class)->getArguments());
+        self::assertCount(1, $container->getDefinition(CronTabExporter::class)->getArguments());
+        self::assertSame('foo', $container->getDefinition(CronTabExporter::class)->getArgument(0));
         self::assertTrue($container->getDefinition(CronTabExporter::class)->hasTag('scheduler.task_exporter'));
         self::assertTrue($container->getDefinition(CronTabExporter::class)->hasTag('container.preload'));
         self::assertSame(CronTabExporter::class, $container->getDefinition(CronTabExporter::class)->getTag('container.preload')[0]['class']);
@@ -2315,6 +2317,7 @@ public function provideDoctrineDsn(): Generator
     private function getContainer(array $configuration = [], Closure $extraDefinitions = null, Closure $extraPasses = null): ContainerBuilder
     {
         $containerBuilder = new ContainerBuilder();
+        $containerBuilder->setParameter('kernel.project_dir', 'foo');
         $containerBuilder->registerExtension(new SchedulerBundleExtension());
         $containerBuilder->loadFromExtension('scheduler_bundle', $configuration);
 

tests/Export/CronTabExporterTest.php

@@ -5,10 +5,54 @@
 namespace Tests\SchedulerBundle\Export;
 
 use PHPUnit\Framework\TestCase;
+use SchedulerBundle\Export\CronTabExporter;
+use SchedulerBundle\Task\NullTask;
+use function file_get_contents;
+use function sprintf;
+use function unlink;
 
 /**
  * @author Guillaume Loulier <[email protected]>
  */
 final class CronTabExporterTest extends TestCase
 {
+    public function testExporterSupport(): void
+    {
+        $exporter = new CronTabExporter(__DIR__);
+
+        self::assertFalse($exporter->support('cli'));
+        self::assertTrue($exporter->support('crontab'));
+    }
+
+    public function testExporterCannotExportExistingFile(): void
+    {
+        $exporter = new CronTabExporter(__DIR__.'/assets');
+
+        self::assertFileExists(sprintf('%s/assets/foo', __DIR__));
+
+        $exporter->export('foo', new NullTask('foo'));
+
+        self::assertFileExists(sprintf('%s/assets/foo', __DIR__));
+    }
+
+    public function testExporterCanExportUndefinedFile(): void
+    {
+        unlink(__DIR__.'/assets/bar');
+
+        $task = new NullTask('bar');
+
+        $exporter = new CronTabExporter(__DIR__.'/assets');
+
+        self::assertFileDoesNotExist(sprintf('%s/bar', __DIR__.'/assets'));
+
+        $exporter->export('bar', $task);
+
+        self::assertFileExists(sprintf('%s/bar', __DIR__.'/assets'));
+        self::assertSame(sprintf(
+            '%s cd %s && php bin/console scheduler:execute --name %s',
+            $task->getExpression(),
+            __DIR__.'/assets',
+            $task->getName(),
+        ), file_get_contents(__DIR__.'/assets/bar'));
+    }
 }

tests/Export/ExporterRegistryTest.php

@@ -25,7 +25,7 @@ public function testRegistryCanReturnEmptyExporterList(): void
     public function testRegistryCanFilterExporterList(): void
     {
         $registry = new ExporterRegistry([
-            new CronTabExporter(),
+            new CronTabExporter(__DIR__),
         ]);
 
         $registry->filter(static fn (ExporterInterface $exporter): bool => $exporter instanceof CronTabExporter);
@@ -35,7 +35,7 @@ public function testRegistryCanFilterExporterList(): void
     public function testRegistryCannotFindExporterWithEmptyList(): void
     {
         $registry = new ExporterRegistry([
-            new CronTabExporter(),
+            new CronTabExporter(__DIR__),
         ]);
 
         self::expectException(InvalidArgumentException::class);
@@ -47,8 +47,8 @@ public function testRegistryCannotFindExporterWithEmptyList(): void
     public function testRegistryCannotFindExporterWithMultipleSupportingExporter(): void
     {
         $registry = new ExporterRegistry([
-            new CronTabExporter(),
-            new CronTabExporter(),
+            new CronTabExporter(__DIR__),
+            new CronTabExporter(__DIR__),
         ]);
 
         self::expectException(InvalidArgumentException::class);
@@ -60,7 +60,7 @@ public function testRegistryCannotFindExporterWithMultipleSupportingExporter():
     public function testRegistryCanFindExporter(): void
     {
         $registry = new ExporterRegistry([
-            new CronTabExporter(),
+            new CronTabExporter(__DIR__),
         ]);
 
         $exporter = $registry->find('crontab');
@@ -70,7 +70,7 @@ public function testRegistryCanFindExporter(): void
     public function testRegistryCanReturnCurrentExporter(): void
     {
         $registry = new ExporterRegistry([
-            new CronTabExporter(),
+            new CronTabExporter(__DIR__),
         ]);
 
         $exporter = $registry->current();