Make configuration and dependency injection container immutable

lib/Doctrine/Migrations/Configuration/Configuration.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\Migrations\Configuration;
 
+use Doctrine\Migrations\Configuration\Exception\FrozenConfiguration;
 use Doctrine\Migrations\Configuration\Exception\MissingNamespaceConfiguration;
 use Doctrine\Migrations\Configuration\Exception\UnknownConfigurationValue;
 use Doctrine\Migrations\Exception\MigrationException;
@@ -49,8 +50,27 @@ final class Configuration
     /** @var MetadataStorageConfiguration */
     private $metadataStorageConfiguration;
 
+    /** @var bool */
+    private $frozen = false;
+
+    public function freeze() : void
+    {
+        if (! $this->frozen) {
+            $this->validate();
+        }
+        $this->frozen = true;
+    }
+
+    private function assertNotFrozen() : void
+    {
+        if ($this->frozen) {
+            throw FrozenConfiguration::new();
+        }
+    }
+
     public function setMetadataStorageConfiguration(MetadataStorageConfiguration $metadataStorageConfiguration) : void
     {
+        $this->assertNotFrozen();
         $this->metadataStorageConfiguration = $metadataStorageConfiguration;
     }
 
@@ -64,6 +84,7 @@ public function getMigrationClasses() : array
 
     public function addMigrationClass(string $className) : void
     {
+        $this->assertNotFrozen();
         $this->migrationClasses[] = $className;
     }
 
@@ -74,6 +95,7 @@ public function getMetadataStorageConfiguration() : ?MetadataStorageConfiguratio
 
     public function addMigrationsDirectory(string $namespace, string $path) : void
     {
+        $this->assertNotFrozen();
         $this->migrationsDirectories[$namespace] = $path;
     }
 
@@ -87,6 +109,7 @@ public function getMigrationDirectories() : array
 
     public function setName(string $name) : void
     {
+        $this->assertNotFrozen();
         $this->name = $name;
     }
 
@@ -97,6 +120,7 @@ public function getName() : ?string
 
     public function setCustomTemplate(?string $customTemplate) : void
     {
+        $this->assertNotFrozen();
         $this->customTemplate = $customTemplate;
     }
 
@@ -116,6 +140,7 @@ public function areMigrationsOrganizedByYear() : bool
     public function setMigrationsAreOrganizedByYear(
         bool $migrationsAreOrganizedByYear = true
     ) : void {
+        $this->assertNotFrozen();
         $this->migrationsAreOrganizedByYear = $migrationsAreOrganizedByYear;
     }
 
@@ -125,6 +150,7 @@ public function setMigrationsAreOrganizedByYear(
     public function setMigrationsAreOrganizedByYearAndMonth(
         bool $migrationsAreOrganizedByYearAndMonth = true
     ) : void {
+        $this->assertNotFrozen();
         $this->migrationsAreOrganizedByYear         = $migrationsAreOrganizedByYearAndMonth;
         $this->migrationsAreOrganizedByYearAndMonth = $migrationsAreOrganizedByYearAndMonth;
     }
@@ -134,8 +160,7 @@ public function areMigrationsOrganizedByYearAndMonth() : bool
         return $this->migrationsAreOrganizedByYearAndMonth;
     }
 
-    /** @throws MigrationException */
-    public function validate() : void
+    private function validate() : void
     {
         if (count($this->migrationsDirectories) === 0) {
             throw MissingNamespaceConfiguration::new();
@@ -144,6 +169,7 @@ public function validate() : void
 
     public function setIsDryRun(bool $isDryRun) : void
     {
+        $this->assertNotFrozen();
         $this->isDryRun = $isDryRun;
     }
 
@@ -154,6 +180,7 @@ public function isDryRun() : bool
 
     public function setAllOrNothing(bool $allOrNothing) : void
     {
+        $this->assertNotFrozen();
         $this->allOrNothing = $allOrNothing;
     }
 
@@ -174,6 +201,7 @@ public function isDatabasePlatformChecked() : bool
 
     public function setMigrationOrganization(string $migrationOrganization) : void
     {
+        $this->assertNotFrozen();
         if (strcasecmp($migrationOrganization, self::VERSIONS_ORGANIZATION_BY_YEAR) === 0) {
             $this->setMigrationsAreOrganizedByYear();
         } elseif (strcasecmp($migrationOrganization, self::VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH) === 0) {

lib/Doctrine/Migrations/Configuration/Exception/FrozenConfiguration.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Configuration\Exception;
+
+use LogicException;
+
+final class FrozenConfiguration extends LogicException implements ConfigurationException
+{
+    public static function new() : self
+    {
+        return new self('The configuration is frozen and cannot be edited anymore.');
+    }
+}

lib/Doctrine/Migrations/DependencyFactory.php

@@ -6,6 +6,7 @@
 
 use Doctrine\DBAL\Connection;
 use Doctrine\Migrations\Configuration\Configuration;
+use Doctrine\Migrations\Exception\FrozenDependencies;
 use Doctrine\Migrations\Exception\MissingDependency;
 use Doctrine\Migrations\Finder\GlobFinder;
 use Doctrine\Migrations\Finder\MigrationFinder;
@@ -35,6 +36,7 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Symfony\Component\Stopwatch\Stopwatch as SymfonyStopwatch;
+use function array_key_exists;
 use function preg_quote;
 use function sprintf;
 
@@ -45,10 +47,12 @@
  */
 class DependencyFactory
 {
+    public const MIGRATIONS_SORTER = 'Doctrine\Migrations\MigrationsSorter';
+
     /** @var Configuration */
     private $configuration;
 
-    /** @var object[] */
+    /** @var object[]|callable[] */
     private $dependencies = [];
 
     /** @var LoggerInterface */
@@ -57,12 +61,12 @@ class DependencyFactory
     /** @var Connection */
     private $connection;
 
-    /** @var callable */
-    private $sorter;
-
     /** @var EntityManagerInterface|null */
     private $em;
 
+    /** @var bool */
+    private $frozen = false;
+
     public function __construct(Configuration $configuration, Connection $connection, ?EntityManagerInterface $em = null, ?LoggerInterface $logger = null)
     {
         $this->configuration = $configuration;
@@ -71,6 +75,19 @@ public function __construct(Configuration $configuration, Connection $connection
         $this->em            = $em;
     }
 
+    public function freeze() : void
+    {
+        $this->frozen = true;
+        $this->configuration->freeze();
+    }
+
+    private function assertNotFrozen() : void
+    {
+        if ($this->frozen) {
+            throw FrozenDependencies::new();
+        }
+    }
+
     public function getConfiguration() : Configuration
     {
         return $this->configuration;
@@ -81,6 +98,13 @@ private function getConnection() : Connection
         return $this->connection;
     }
 
+    public function getSorter() : ?callable
+    {
+        return $this->getDependency(self::MIGRATIONS_SORTER, static function () {
+            return null;
+        });
+    }
+
     public function getEventDispatcher() : EventDispatcher
     {
         return $this->getDependency(EventDispatcher::class, function () : EventDispatcher {
@@ -179,11 +203,6 @@ public function getMigrationsFinder() : MigrationFinder
         });
     }
 
-    public function setSorter(callable $sorter) : void
-    {
-        $this->sorter = $sorter;
-    }
-
     public function getMigrationRepository() : MigrationRepository
     {
         return $this->getDependency(MigrationRepository::class, function () : MigrationRepository {
@@ -192,14 +211,18 @@ public function getMigrationRepository() : MigrationRepository
                 $this->getConfiguration()->getMigrationDirectories(),
                 $this->getMigrationsFinder(),
                 new MigrationFactory($this->getConnection(), $this->getLogger()),
-                $this->sorter
+                $this->getSorter()
             );
         });
     }
 
-    public function setMetadataStorageConfiguration(MetadataStorageConfiguration $metadataStorageConfigration) : void
+    /**
+     * @param object|callable $service
+     */
+    public function setService(string $id, $service) : void
     {
-        $this->dependencies[MetadataStorageConfiguration::class] = $metadataStorageConfigration;
+        $this->assertNotFrozen();
+        $this->dependencies[$id] = $service;
     }
 
     private function getMetadataStorageConfiguration() : MetadataStorageConfiguration
@@ -347,12 +370,12 @@ public function getRollup() : Rollup
     /**
      * @return mixed
      */
-    private function getDependency(string $className, callable $callback)
+    private function getDependency(string $id, callable $callback)
     {
-        if (! isset($this->dependencies[$className])) {
-            $this->dependencies[$className] = $callback();
+        if (! array_key_exists($id, $this->dependencies)) {
+            $this->dependencies[$id] = $callback();
         }
 
-        return $this->dependencies[$className];
+        return $this->dependencies[$id];
     }
 }

lib/Doctrine/Migrations/Exception/FrozenDependencies.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Exception;
+
+use LogicException;
+
+final class FrozenDependencies extends LogicException implements MigrationException
+{
+    public static function new() : self
+    {
+        return new self('The dependencies are frozen and cannot be edited anymore.');
+    }
+}

lib/Doctrine/Migrations/Tools/Console/Command/DoctrineCommand.php

@@ -31,14 +31,6 @@ abstract class DoctrineCommand extends Command
     /** @var DependencyFactory|null */
     private $dependencyFactory;
 
-    public function initialize(
-        InputInterface $input,
-        OutputInterface $output
-    ) : void {
-        $this->initializeDependencies($input, $output);
-        $this->getDependencyFactory()->getConfiguration()->validate();
-    }
-
     public function __construct(?string $name = null, ?DependencyFactory $dependencyFactory = null)
     {
         parent::__construct($name);
@@ -74,13 +66,14 @@ protected function outputHeader(
         $output->writeln('');
     }
 
-    protected function initializeDependencies(
-        InputInterface $input,
-        OutputInterface $output
-    ) : void {
+    protected function initialize(InputInterface $input, OutputInterface $output) : void
+    {
         if ($this->dependencyFactory !== null) {
+            $this->dependencyFactory->freeze();
+
             return;
         }
+
         $helperSet = $this->getHelperSet() ?: new HelperSet();
 
         if ($helperSet->has('configuration') && $helperSet->get('configuration') instanceof ConfigurationHelper) {
@@ -104,6 +97,7 @@ protected function initializeDependencies(
 
         $logger                  = new ConsoleLogger($output);
         $this->dependencyFactory = new DependencyFactory($configuration, $connection, $em, $logger);
+        $this->dependencyFactory->freeze();
     }
 
     protected function getDependencyFactory() : DependencyFactory

tests/Doctrine/Migrations/Tests/Configuration/ConfigurationTest.php

@@ -5,6 +5,7 @@
 namespace Doctrine\Migrations\Tests\Configuration;
 
 use Doctrine\Migrations\Configuration\Configuration;
+use Doctrine\Migrations\Configuration\Exception\FrozenConfiguration;
 use Doctrine\Migrations\Configuration\Exception\MissingNamespaceConfiguration;
 use Doctrine\Migrations\Configuration\Exception\UnknownConfigurationValue;
 use Doctrine\Migrations\Metadata\Storage\MetadataStorageConfiguration;
@@ -53,7 +54,18 @@ public function testNoNamespaceConfigured() : void
         $this->expectExceptionMessage('There are no namespaces configured.');
 
         $config = new Configuration();
-        $config->validate();
+        $config->freeze();
+    }
+
+    public function testFreezeConfiguration() : void
+    {
+        $config = new Configuration();
+        $config->addMigrationsDirectory('foo', 'bar');
+        $config->freeze();
+
+        $this->expectException(FrozenConfiguration::class);
+        $this->expectExceptionMessage('The configuration is frozen and cannot be edited anymore.');
+        $config->setName('foo');
     }
 
     public function testMigrationOrganizationByYear() : void

tests/Doctrine/Migrations/Tests/DependencyFactoryTest.php

@@ -7,9 +7,11 @@
 use Doctrine\DBAL\Connection;
 use Doctrine\Migrations\Configuration\Configuration;
 use Doctrine\Migrations\DependencyFactory;
+use Doctrine\Migrations\Exception\FrozenDependencies;
 use Doctrine\Migrations\Finder\GlobFinder;
 use Doctrine\Migrations\Finder\RecursiveRegexFinder;
 use PHPUnit\Framework\MockObject\MockObject;
+use stdClass;
 
 final class DependencyFactoryTest extends MigrationTestCase
 {
@@ -21,6 +23,19 @@ public function setUp() : void
         $this->connection = $this->createMock(Connection::class);
     }
 
+    public function testFreeze() : void
+    {
+        $conf = new Configuration();
+        $conf->addMigrationsDirectory('foo', 'bar');
+
+        $di = new DependencyFactory($conf, $this->connection);
+        $di->freeze();
+
+        $this->expectException(FrozenDependencies::class);
+        $this->expectExceptionMessage('The dependencies are frozen and cannot be edited anymore.');
+        $di->setService('foo', new stdClass());
+    }
+
     public function testFinderForYearMonthStructure() : void
     {
         $conf = new Configuration();