Cleanup of the cache and log directory after kernel shutdown (#59)

* feat: Add cleanup after shutdown

* docs(changelog): Add cleanup of cache and log directory

* fix: Reorder requires

* fix: Fix tests

* fix: Fix CS

* fix: Make tests compatible with older phpunit version

Author: chapterjason

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 2.0.0
+
+### Added
+
+- Cleanup of the cache and log directory after kernel shutdown
+
 ## 1.8.1
 
 ### Fixed

composer.json

@@ -12,6 +12,7 @@
     "require": {
         "php": "^7.2 || ^8.0",
         "symfony/dependency-injection": "^4.4 || ^5.3 || ^6.0",
+        "symfony/filesystem": "^4.4 || ^5.3 || ^6.0",
         "symfony/framework-bundle": "^4.4 || ^5.3 || ^6.0",
         "symfony/http-kernel": "^4.4 || ^5.3 || ^6.0",
         "symfony/yaml": "^4.4 || ^5.3 || ^6.0"

src/TestKernel.php

@@ -8,6 +8,7 @@
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\HttpKernel\Bundle\BundleInterface;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
@@ -179,4 +180,22 @@ protected function configureRoutes($routes): void
             $routes->import($routingFile);
         }
     }
+
+    public function shutdown(): void
+    {
+        parent::shutdown();
+
+        $cacheDirectory = $this->getCacheDir();
+        $logDirectory = $this->getLogDir();
+
+        $filesystem = new Filesystem();
+
+        if ($filesystem->exists($cacheDirectory)) {
+            $filesystem->remove($cacheDirectory);
+        }
+
+        if ($filesystem->exists($logDirectory)) {
+            $filesystem->remove($logDirectory);
+        }
+    }
 }

tests/Functional/BundleInitializationTest.php

@@ -3,9 +3,7 @@
 namespace Nyholm\BundleTest\Tests\Functional;
 
 use Nyholm\BundleTest\TestKernel;
-use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
-use Symfony\Component\HttpKernel\KernelInterface;
 
 /**
  * @author Tobias Nyholm <[email protected]>
@@ -17,17 +15,6 @@ protected static function getKernelClass(): string
         return TestKernel::class;
     }
 
-    protected static function createKernel(array $options = []): KernelInterface
-    {
-        /**
-         * @var TestKernel $kernel
-         */
-        $kernel = parent::createKernel($options);
-        $kernel->addTestBundle(FrameworkBundle::class);
-
-        return $kernel;
-    }
-
     public function testRegisterBundle(): void
     {
         $kernel = self::bootKernel();

tests/Functional/BundleShutdownTest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Nyholm\BundleTest\Tests\Functional;
+
+use Nyholm\BundleTest\TestKernel;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\Filesystem\Filesystem;
+
+/**
+ * @author Jason Schilling <[email protected]>
+ */
+class BundleShutdownTest extends KernelTestCase
+{
+    protected static function getKernelClass(): string
+    {
+        return TestKernel::class;
+    }
+
+    public function testCleanupTemporaryDirectories(): void
+    {
+        $kernel = self::bootKernel();
+        $cacheDirectory = $kernel->getCacheDir();
+        $logDirectory = $kernel->getLogDir();
+        $filesystem = new Filesystem();
+
+        self::assertTrue($filesystem->exists($cacheDirectory));
+        self::assertTrue($filesystem->exists($logDirectory));
+
+        self::ensureKernelShutdown();
+
+        self::assertFalse($filesystem->exists($cacheDirectory));
+        self::assertFalse($filesystem->exists($logDirectory));
+    }
+}