Merge pull request #214 from php-school/feature/fs-cleanup

Cleanup temp FS writes

Author: mikeymike

app/config.php

@@ -4,6 +4,7 @@
 
 use Colors\Color;
 use PhpSchool\PhpWorkshop\Listener\InitialCodeListener;
+use PhpSchool\PhpWorkshop\Listener\TearDownListener;
 use PhpSchool\PhpWorkshop\Logger\ConsoleLogger;
 use PhpSchool\PhpWorkshop\Logger\Logger;
 use Psr\Log\LoggerInterface;
@@ -242,6 +243,9 @@
         );
     },
     RealPathListener::class => create(),
+    TearDownListener::class => function (ContainerInterface $c) {
+        return new TearDownListener($c->get(Filesystem::class));
+    },
 
     //checks
     FileExistsCheck::class              => create(),
@@ -414,6 +418,11 @@ function (CgiResult $result) use ($c) {
             'exercise.selected' => [
                 containerListener(InitialCodeListener::class)
             ]
+        ],
+        'cleanup-filesystem' => [
+            'application.tear-down' => [
+                containerListener(TearDownListener::class, 'cleanupTempDir')
+            ]
         ]
     ],
 ];

src/Application.php

@@ -267,6 +267,9 @@ public function run(): int
                 );
             return 1;
         }
+
+        $this->tearDown($container);
+
         return $exitCode;
     }
 

src/Check/DatabaseCheck.php

@@ -138,10 +138,17 @@ function (CliExecuteEvent $e) {
             ],
             function () use ($db) {
                 unset($db);
-                @unlink($this->userDatabasePath);
-                @unlink($this->solutionDatabasePath);
+                $this->unlink($this->userDatabasePath);
+                $this->unlink($this->solutionDatabasePath);
                 rmdir($this->databaseDirectory);
             }
         );
     }
+
+    private function unlink(string $file): void
+    {
+        if (file_exists($file)) {
+            unlink($file);
+        }
+    }
 }

src/Exercise/ExerciseType.php

@@ -15,6 +15,9 @@
  * $typeCustom = ExerciseType::CUSTOM();
  * ```
  * @extends Enum<string>
+ * @method static self CLI()
+ * @method static self CGI()
+ * @method static self CUSTOM()
  */
 class ExerciseType extends Enum
 {

src/Listener/TearDownListener.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSchool\PhpWorkshop\Listener;
+
+use PhpSchool\PhpWorkshop\Event\EventInterface;
+use PhpSchool\PhpWorkshop\Utils\System;
+use Symfony\Component\Filesystem\Filesystem;
+
+class TearDownListener
+{
+    /**
+     * @var Filesystem
+     */
+    private $filesystem;
+
+    public function __construct(Filesystem $filesystem)
+    {
+        $this->filesystem = $filesystem;
+    }
+
+    public function cleanupTempDir(): void
+    {
+        $this->filesystem->remove(System::tempDir());
+    }
+}

src/Solution/InTempSolutionMapper.php

@@ -52,6 +52,6 @@ public static function mapFile(string $file): string
 
     private static function getDeterministicTempDir(string $path): string
     {
-        return Path::join(System::tempDir(), 'php-school', md5($path));
+        return Path::join(System::tempDir(), md5($path));
     }
 }

src/Utils/System.php

@@ -21,6 +21,6 @@ public static function realpath(string $path): string
 
     public static function tempDir(string $path = ''): string
     {
-        return Path::join(self::realpath(sys_get_temp_dir()), $path);
+        return Path::join(self::realpath(sys_get_temp_dir()), 'php-school', $path);
     }
 }

test/BaseTest.php

@@ -31,7 +31,9 @@ public function getTemporaryFile(string $filename, string $content = null): stri
             return $file;
         }
 
-        @mkdir(dirname($file), 0777, true);
+        if (!file_exists(dirname($file))) {
+            mkdir(dirname($file), 0777, true);
+        }
 
         $content !== null
             ? file_put_contents($file, $content)

test/Check/DatabaseCheckTest.php

@@ -58,7 +58,7 @@ public function setUp(): void
         $this->exercise = $this->createMock(DatabaseExerciseInterface::class);
         $this->exercise->method('getType')->willReturn(ExerciseType::CLI());
         $this->dbDir = sprintf(
-            '%s/PhpSchool_PhpWorkshop_Check_DatabaseCheck',
+            '%s/php-school/PhpSchool_PhpWorkshop_Check_DatabaseCheck',
             str_replace('\\', '/', realpath(sys_get_temp_dir()))
         );
 
@@ -89,7 +89,7 @@ private function getRunnerManager(ExerciseInterface $exercise, EventDispatcher $
     public function testIfDatabaseFolderExistsExceptionIsThrown(): void
     {
         $eventDispatcher = new EventDispatcher(new ResultAggregator());
-        @mkdir($this->dbDir);
+        mkdir($this->dbDir, 0777, true);
         try {
             $this->check->attach($eventDispatcher);
             $this->fail('Exception was not thrown');

test/Listener/TearDownListenerTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSchool\PhpWorkshopTest\Listener;
+
+use PhpSchool\PhpWorkshop\Listener\TearDownListener;
+use PhpSchool\PhpWorkshop\Utils\System;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Filesystem;
+
+class TearDownListenerTest extends TestCase
+{
+    public function testCleansUpTempDir(): void
+    {
+        $tempDir = System::tempDir();
+
+        mkdir($tempDir . '/some/path', 0777, true);
+        touch($tempDir . '/some.file');
+        touch($tempDir . '/some/path/another.file');
+
+        self::assertFileExists($tempDir . '/some.file');
+        self::assertFileExists($tempDir . '/some/path/another.file');
+
+        (new TearDownListener(new Filesystem()))->cleanupTempDir();
+
+        self::assertFileDoesNotExist($tempDir . '/some.file');
+        self::assertFileDoesNotExist($tempDir . '/some/path/another.file');
+    }
+}