Merge pull request #844 from carlobeltrame/fix/remove-proxy-directory-after-database-initialization

Remove Doctrine proxy directory after fixture loading CLI command

Author: pmattmann

.docker-hub/backend/docker-entrypoint.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -euo pipefail
 
 php bin/wait-for-db.php
 vendor/bin/laminas rebuild-database

backend/module/eCampLib/src/Command/LoadDataFixturesCommand.php

@@ -8,15 +8,18 @@
 use Laminas\Cli\Input\PathParam;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Filesystem\Filesystem;
 
 class LoadDataFixturesCommand extends AbstractParamAwareCommand {
     private $entityManager;
     private $fixtureLoader;
+    private $filesystem;
 
-    public function __construct(EntityManager $entityManager, FixtureLoader $fixtureLoader) {
+    public function __construct(EntityManager $entityManager, FixtureLoader $fixtureLoader, Filesystem $filesystem) {
         parent::__construct();
         $this->entityManager = $entityManager;
         $this->fixtureLoader = $fixtureLoader;
+        $this->filesystem = $filesystem;
     }
 
     protected function configure() {
@@ -35,7 +38,14 @@ protected function execute(InputInterface $input, OutputInterface $output) {
             $this->entityManager,
             new \Doctrine\Common\DataFixtures\Purger\ORMPurger()
         );
-        $executor->execute($this->fixtureLoader->getFixtures(), true);
+        $fixtures = $this->fixtureLoader->getFixtures();
+        $executor->execute($fixtures, true);
+
+        if (count($fixtures) > 0) {
+            // Cleaning up the generated Doctrine proxies is necessary because the command might be run by a user other
+            // than www-data.
+            $this->filesystem->remove(__DIR__.'/../../../../data/DoctrineORMModule');
+        }
 
         return 0;
     }

backend/module/eCampLib/test/Command/LoadDataFixturesCommandTest.php

@@ -6,9 +6,11 @@
 use eCamp\LibTest\PHPUnit\AbstractConsoleControllerTestCase;
 use PHPUnit\Framework\Constraint\IsEqual;
 use PHPUnit\Framework\Constraint\StringContains;
+use PHPUnit\Framework\Constraint\StringEndsWith;
 use Symfony\Component\Console\Input\StringInput;
 use Symfony\Component\Console\Output\BufferedOutput;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * @internal
@@ -17,12 +19,17 @@ class LoadDataFixturesCommandTest extends AbstractConsoleControllerTestCase {
     public function testLoadsFilesFromGivenPath() {
         // given
         $services = $this->getApplicationServiceLocator();
-        /** @var LoadDataFixturesCommand $command */
-        $command = $services->get(LoadDataFixturesCommand::class);
+
         $input = new StringInput('load-data-fixtures --path='.__DIR__.'/../data/fixtures');
         $output = new BufferedOutput();
         $services->setService(OutputInterface::class, $output);
 
+        $mockFilesystem = $this->createMock(Filesystem::class);
+        $services->setService(Filesystem::class, $mockFilesystem);
+
+        /** @var LoadDataFixturesCommand $command */
+        $command = $services->get(LoadDataFixturesCommand::class);
+
         // when
         $result = $this->runCommand($command, $input, $output);
 
@@ -36,12 +43,20 @@ public function testLoadsFilesFromGivenPath() {
     public function testDoesNotCrashWhenGivenNonexistentLocation() {
         // given
         $services = $this->getApplicationServiceLocator();
-        /** @var LoadDataFixturesCommand $command */
-        $command = $services->get(LoadDataFixturesCommand::class);
+
         $input = new StringInput('load-data-fixtures --path='.__DIR__.'/../data/some-dir-that-does-not-exist');
         $output = new BufferedOutput();
         $services->setService(OutputInterface::class, $output);
 
+        $mockFilesystem = $this->createMock(Filesystem::class);
+        $services->setService(Filesystem::class, $mockFilesystem);
+
+        /** @var LoadDataFixturesCommand $command */
+        $command = $services->get(LoadDataFixturesCommand::class);
+
+        // then
+        $mockFilesystem->expects($this->never())->method('remove');
+
         // when
         $result = $this->runCommand($command, $input, $output);
 
@@ -50,4 +65,24 @@ public function testDoesNotCrashWhenGivenNonexistentLocation() {
         $consoleOutput = $output->fetch();
         $this->assertThat($consoleOutput, new IsEqual(''));
     }
+
+    public function testCleansUpDoctrineProxies() {
+        // given
+        $services = $this->getApplicationServiceLocator();
+        $input = new StringInput('load-data-fixtures --path='.__DIR__.'/../data/fixtures');
+        $output = new BufferedOutput();
+        $services->setService(OutputInterface::class, $output);
+
+        $mockFilesystem = $this->createMock(Filesystem::class);
+        $services->setService(Filesystem::class, $mockFilesystem);
+
+        /** @var LoadDataFixturesCommand $command */
+        $command = $services->get(LoadDataFixturesCommand::class);
+
+        // then
+        $mockFilesystem->expects($this->once())->method('remove')->with(new StringEndsWith('DoctrineORMModule'));
+
+        // when
+        $this->runCommand($command, $input, $output);
+    }
 }

backend/module/eCampLib/test/Command/RebuildDatabaseSchemaCommandTest.php

@@ -16,6 +16,7 @@ class RebuildDatabaseSchemaCommandTest extends AbstractConsoleControllerTestCase
     public function testRebuildsDatabaseSchema() {
         // given
         $services = $this->getApplicationServiceLocator();
+
         $mockMetadata = [];
         $mockMetadataFactory = $this->createMock(ClassMetadataFactory::class);
         $mockMetadataFactory->method('getAllMetadata')->willReturn($mockMetadata);

backend/module/eCampLib/test/Command/UpdateDatabaseSchemaCommandTest.php

@@ -16,6 +16,7 @@ class UpdateDatabaseSchemaCommandTest extends AbstractConsoleControllerTestCase
     public function testUpdatesDatabaseSchema() {
         // given
         $services = $this->getApplicationServiceLocator();
+
         $mockMetadata = [];
         $mockMetadataFactory = $this->createMock(ClassMetadataFactory::class);
         $mockMetadataFactory->method('getAllMetadata')->willReturn($mockMetadata);