Merge pull request #584 from CakeDC/issue/565

Add message if migrations/seeds folders do not exist and debug is dis…
cakephp · Oct 30, 2022 · b496bf2 · b496bf2
2 parents 017d343 + a3e5bc3
commit b496bf2
Show file tree

Hide file tree

Showing 2 changed files with 113 additions and 2 deletions.
diff --git a/src/ConfigurationTrait.php b/src/ConfigurationTrait.php
@@ -83,11 +83,23 @@ public function getConfig($forceRefresh = false)
         $seedsPath = $this->getOperationsPath($this->input(), 'Seeds');
         $plugin = $this->getPlugin($this->input());
 
-        if (Configure::read('debug') && !is_dir($migrationsPath)) {
+        if (!is_dir($migrationsPath)) {
+            if (!Configure::read('debug')) {
+                throw new \RuntimeException(sprintf(
+                    'Migrations path `%s` does not exist and cannot be created because `debug` is disabled.',
+                    $migrationsPath
+                ));
+            }
             mkdir($migrationsPath, 0777, true);
         }
 
-        if (Configure::read('debug') && !is_dir($seedsPath)) {
+        if (!is_dir($seedsPath)) {
+            if (!Configure::read('debug')) {
+                throw new \RuntimeException(sprintf(
+                    'Seeds path `%s` does not exist and cannot be created because `debug` is disabled.',
+                    $seedsPath
+                ));
+            }
             mkdir($seedsPath, 0777, true);
         }
 

diff --git a/tests/TestCase/ConfigurationTraitTest.php b/tests/TestCase/ConfigurationTraitTest.php
@@ -14,6 +14,7 @@
 namespace Migrations\Test\TestCase;
 
 use Cake\Core\BasePlugin;
+use Cake\Core\Configure;
 use Cake\Core\Plugin;
 use Cake\Datasource\ConnectionManager;
 use Cake\TestSuite\TestCase;
@@ -269,4 +270,102 @@ public function testGetConfigWithConnectionName()
         $this->assertSame('the_database2', $environment['name']);
         $this->assertSame('utf-8', $environment['charset']);
     }
+
+    /**
+     * Generates Command mock to override getOperationsPath return value
+     *
+     * @param string $migrationsPath
+     * @param string $seedsPath
+     * @return ExampleCommand
+     */
+    protected function _getCommandMock(string $migrationsPath, string $seedsPath): ExampleCommand
+    {
+        $command = $this
+            ->getMockBuilder(ExampleCommand::class)
+            ->onlyMethods(['getOperationsPath'])
+            ->getMock();
+        /** @var \Symfony\Component\Console\Input\InputInterface|\PHPUnit\Framework\MockObject\MockObject $input */
+        $input = $this->getMockBuilder(InputInterface::class)->getMock();
+        $command->setInput($input);
+        $command->expects($this->any())
+            ->method('getOperationsPath')
+            ->will(
+                $this->returnValueMap([
+                    [$input, 'Migrations', $migrationsPath],
+                    [$input, 'Seeds', $seedsPath],
+                ])
+            );
+
+        return $command;
+    }
+
+    /**
+     * Test getConfig, migrations path does not exist, debug is disabled
+     *
+     * @return void
+     */
+    public function testGetConfigNoMigrationsFolderDebugDisabled()
+    {
+        Configure::write('debug', false);
+
+        $migrationsPath = ROOT . DS . 'config' . DS . 'TestGetConfigMigrations';
+        $seedsPath = ROOT . DS . 'config' . DS . 'TestGetConfigSeeds';
+
+        $command = $this->_getCommandMock($migrationsPath, $seedsPath);
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage(sprintf(
+            'Migrations path `%s` does not exist and cannot be created because `debug` is disabled.',
+            $migrationsPath
+        ));
+        $config = $command->getConfig();
+    }
+
+    /**
+     * Test getConfig, migrations path does exist but seeds path does not, debug is disabled
+     *
+     * @return void
+     */
+    public function testGetConfigNoSeedsFolderDebugDisabled()
+    {
+        Configure::write('debug', false);
+
+        $migrationsPath = ROOT . DS . 'config' . DS . 'TestGetConfigMigrations';
+        mkdir($migrationsPath, 0777, true);
+        $seedsPath = ROOT . DS . 'config' . DS . 'TestGetConfigSeeds';
+
+        $command = $this->_getCommandMock($migrationsPath, $seedsPath);
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage(sprintf(
+            'Seeds path `%s` does not exist and cannot be created because `debug` is disabled.',
+            $seedsPath
+        ));
+        try {
+            $config = $command->getConfig();
+        } finally {
+            rmdir($migrationsPath);
+        }
+    }
+
+    /**
+     * Test getConfig, migrations and seeds paths do not exist, debug is enabled
+     *
+     * @return void
+     */
+    public function testGetConfigNoMigrationsOrSeedsFolderDebugEnabled()
+    {
+        $migrationsPath = ROOT . DS . 'config' . DS . 'TestGetConfigMigrations';
+        $seedsPath = ROOT . DS . 'config' . DS . 'TestGetConfigSeeds';
+        mkdir($migrationsPath, 0777, true);
+        mkdir($seedsPath, 0777, true);
+
+        $command = $this->_getCommandMock($migrationsPath, $seedsPath);
+
+        $config = $command->getConfig();
+
+        $this->assertTrue(is_dir($migrationsPath));
+        $this->assertTrue(is_dir($seedsPath));
+
+        rmdir($migrationsPath);
+        rmdir($seedsPath);
+    }
 }